chore: Rename SDK to magicbell-swift-user-client (#14)

* chore: renaming lib to magicbell-swift-user-client * changeset * chore: adjust update-version script
magicbell · Dec 20, 2024 · 6236c20 · 6236c20
1 parent d96791e
commit 6236c20
Show file tree

Hide file tree

Showing 47 changed files with 225 additions and 28 deletions.
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -1,6 +1,6 @@
 {
   "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
-  "changelog": ["@changesets/changelog-github", { "repo": "magicbell/magicbell-swift-client" }],
+  "changelog": ["@changesets/changelog-github", { "repo": "magicbell/magicbell-swift-user-client" }],
   "commit": false,
   "fixed": [],
   "linked": [],

diff --git a/.changeset/great-needles-remember.md b/.changeset/great-needles-remember.md
@@ -0,0 +1,5 @@
+---
+"magicbell-swift-user-client": minor
+---
+
+Renaming library to magicbell-swift-user-client
diff --git a/.github/sync.yml b/.github/sync.yml
@@ -1,3 +1,3 @@
 magicbell/magicbell:
   - source: docs-dist
-    dest: src/go/app/site/docs/mdx/03-libraries/magicbell-swift-client
+    dest: src/go/app/site/docs/mdx/03-libraries/magicbell-swift-user-client
diff --git a/.github/workflows/regen.yml b/.github/workflows/regen.yml
@@ -1,4 +1,4 @@
-name: Regen magicbell-swift-client
+name: Regen
 
 on:
   workflow_dispatch:
@@ -32,7 +32,7 @@ jobs:
           cp .build/release/sourcedocs /usr/local/bin
           popd
 
-      - name: Regen `magicbell-swift-client`
+      - name: Regen
         run: yarn codegen
         env:
           LIBLAB_TOKEN: ${{ secrets.LIBLAB_ACTION_TOKEN }}

diff --git a/.github/workflows/release-discussion.yml b/.github/workflows/release-discussion.yml
@@ -18,6 +18,6 @@ jobs:
           repo: magicbell/community
           category: changelog
           cycle: week
-          release-prefix: magicbell-swift-client
+          release-prefix: magicbell-swift-user-client
         env:
           GITHUB_TOKEN: ${{ secrets.BELLA_ACTION_TOKEN }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,4 @@
-# magicbell-swift-client
+# magicbell-swift-user-client
 
 ## 0.2.0
 

diff --git a/Package.swift b/Package.swift
@@ -3,11 +3,11 @@
 import PackageDescription
 
 let package = Package(
-  name: "MagicBellClient",
+  name: "MagicBellUserClient",
   platforms: [.macOS(.v10_15), .iOS(.v13), .tvOS(.v13), .watchOS(.v6), .visionOS(.v1)],
   products: [
-    .library(name: "MagicBellClient", targets: ["MagicBellClient"]),
-    .executable(name: "MagicBellClientExample", targets: ["MagicBellClientExample"]),
+    .library(name: "MagicBellUserClient", targets: ["MagicBellUserClient"]),
+    .executable(name: "Example", targets: ["Example"]),
   ],
   dependencies: [
     .package(url: "https://github.com/apple/swift-openapi-generator", from: "1.0.0"),
@@ -16,14 +16,14 @@ let package = Package(
   ],
   targets: [
     .target(
-      name: "MagicBellClient",
+      name: "MagicBellUserClient",
       dependencies: [
         .product(name: "OpenAPIRuntime", package: "swift-openapi-runtime"),
         .product(name: "OpenAPIURLSession", package: "swift-openapi-urlsession"),
       ]),
     .executableTarget(
-      name: "MagicBellClientExample",
-      dependencies: ["MagicBellClient"]
+      name: "Example",
+      dependencies: ["MagicBellUserClient"]
     )
   ]
 )
diff --git a/README.md b/README.md
@@ -1,14 +1,14 @@
-# MagicBellClient Swift SDK 0.2.0
+# MagicBellUserClient Swift SDK 0.2.0
 
-Welcome to the MagicBellClient SDK documentation. This guide will help you get started with integrating and using the MagicBellClient SDK in your project.
+Welcome to the MagicBellUserClient SDK documentation. This guide will help you get started with integrating and using the MagicBellUserClient SDK in your project.
 
 ## About the API
 
 OpenAPI 3.0.3 Specification for MagicBell API.
 
 ## Table of Contents
 
-- [MagicBellClient Swift SDK 0.2.0](#magicbellclient-swift-sdk-010)
+- [MagicBellUserClient Swift SDK 0.2.0](#magicbelluserclient-swift-sdk-020)
   - [About the API](#about-the-api)
   - [Table of Contents](#table-of-contents)
 - [Setup \& Configuration](#setup--configuration)
@@ -41,7 +41,7 @@ To install MagicBell using [Swift Package Manager](https://www.swift.org/package
 
 ```swift
 dependencies: [
-    .package(url: "https://github.com/magicbell/magicbell-swift-client", .upToNextMajor(from: "0.1.0"))
+    .package(url: "https://github.com/magicbell/magicbell-swift-user-client", .upToNextMajor(from: "0.1.0"))
 ]
 ```
 
@@ -60,7 +60,7 @@ When you initialize the SDK, you can set the access token via the `Authenticatio
 ```swift
 let authMiddleware = AuthenticationMiddleware(jwtToken: token)
 
-let client = MagicBellClient.Client(
+let client = MagicBellUserClient.Client(
             serverURL: try Servers.Server1.url(),
             configuration: .init(dateTranscoder: .iso8601WithFractionalSeconds),
             transport: URLSessionTransport(),
@@ -75,7 +75,7 @@ Below is a comprehensive example demonstrating how to authenticate and call a si
 
 ```swift
 import Foundation
-import MagicBellClient
+import MagicBellUserClient
 import OpenAPIURLSession
 
 let token = "YOUR_ACCESS_TOKEN"
@@ -84,7 +84,7 @@ let token = "YOUR_ACCESS_TOKEN"
 struct MainApp {
     static func main() async throws {
 
-        let client = MagicBellClient.Client(
+        let client = MagicBellUserClient.Client(
             serverURL: try Servers.Server1.url(),
             configuration: .init(dateTranscoder: .iso8601WithFractionalSeconds),
             transport: URLSessionTransport(),

diff --git a/Sources/MagicBellClientExample/Main.swift → Sources/Example/Main.swift b/Sources/MagicBellClientExample/Main.swift → Sources/Example/Main.swift
@@ -1,5 +1,5 @@
 import Foundation
-import MagicBellClient
+import MagicBellUserClient
 import OpenAPIURLSession
 
 let token =
@@ -12,7 +12,7 @@ let fakeDeviceToken =
 struct MainApp {
     static func main() async throws {
 
-        let client = MagicBellClient.Client(
+        let client = MagicBellUserClient.Client(
             serverURL: try Servers.Server1.url(),
             configuration: .init(dateTranscoder: .iso8601WithFractionalSeconds),
             transport: URLSessionTransport(),

diff --git a/...BellClient/AuthenticationMiddleware.swift → ...UserClient/AuthenticationMiddleware.swift b/...BellClient/AuthenticationMiddleware.swift → ...UserClient/AuthenticationMiddleware.swift
diff --git a/...es/MagicBellClient/generated/Client.swift → ...agicBellUserClient/generated/Client.swift b/...es/MagicBellClient/generated/Client.swift → ...agicBellUserClient/generated/Client.swift
diff --git a/...ces/MagicBellClient/generated/Types.swift → ...MagicBellUserClient/generated/Types.swift b/...ces/MagicBellClient/generated/Types.swift → ...MagicBellUserClient/generated/Types.swift
diff --git a/...tation/enums/Operations.discard_mobile_push_apns_token.AcceptableContentType.md b/...tation/enums/Operations.discard_mobile_push_apns_token.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/...tation/enums/Operations.discard_mobile_push_expo_token.AcceptableContentType.md b/...tation/enums/Operations.discard_mobile_push_expo_token.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/...ntation/enums/Operations.discard_mobile_push_fcm_token.AcceptableContentType.md b/...ntation/enums/Operations.discard_mobile_push_fcm_token.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/documentation/enums/Operations.discard_slack_token.AcceptableContentType.md b/documentation/enums/Operations.discard_slack_token.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/documentation/enums/Operations.discard_teams_token.AcceptableContentType.md b/documentation/enums/Operations.discard_teams_token.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/documentation/enums/Operations.discard_web_push_token.AcceptableContentType.md b/documentation/enums/Operations.discard_web_push_token.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/documentation/enums/Operations.finish_slack_installation.AcceptableContentType.md b/documentation/enums/Operations.finish_slack_installation.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/documentation/enums/Operations.get_mobile_push_apns_token.AcceptableContentType.md b/documentation/enums/Operations.get_mobile_push_apns_token.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/...mentation/enums/Operations.get_mobile_push_apns_tokens.AcceptableContentType.md b/...mentation/enums/Operations.get_mobile_push_apns_tokens.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/documentation/enums/Operations.get_mobile_push_expo_token.AcceptableContentType.md b/documentation/enums/Operations.get_mobile_push_expo_token.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/...mentation/enums/Operations.get_mobile_push_expo_tokens.AcceptableContentType.md b/...mentation/enums/Operations.get_mobile_push_expo_tokens.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/documentation/enums/Operations.get_mobile_push_fcm_token.AcceptableContentType.md b/documentation/enums/Operations.get_mobile_push_fcm_token.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/documentation/enums/Operations.get_mobile_push_fcm_tokens.AcceptableContentType.md b/documentation/enums/Operations.get_mobile_push_fcm_tokens.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/documentation/enums/Operations.get_slack_token.AcceptableContentType.md b/documentation/enums/Operations.get_slack_token.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/documentation/enums/Operations.get_slack_tokens.AcceptableContentType.md b/documentation/enums/Operations.get_slack_tokens.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/documentation/enums/Operations.get_teams_token.AcceptableContentType.md b/documentation/enums/Operations.get_teams_token.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/documentation/enums/Operations.get_teams_tokens.AcceptableContentType.md b/documentation/enums/Operations.get_teams_tokens.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/documentation/enums/Operations.get_web_push_token.AcceptableContentType.md b/documentation/enums/Operations.get_web_push_token.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/documentation/enums/Operations.get_web_push_tokens.AcceptableContentType.md b/documentation/enums/Operations.get_web_push_tokens.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/documentation/enums/Operations.save_inbox_installation.AcceptableContentType.md b/documentation/enums/Operations.save_inbox_installation.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/...mentation/enums/Operations.save_mobile_push_apns_token.AcceptableContentType.md b/...mentation/enums/Operations.save_mobile_push_apns_token.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |
diff --git a/...mentation/enums/Operations.save_mobile_push_expo_token.AcceptableContentType.md b/...mentation/enums/Operations.save_mobile_push_expo_token.AcceptableContentType.md
@@ -49,3 +49,9 @@ public static var allCases: [Self]
 ```swift
 public init?(rawValue: Swift.String)
 ```
+
+#### Parameters
+
+| Name | Description |
+| ---- | ----------- |
+| rawValue | The raw value to use for the new instance. |