Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/auto-bump-magicbell-java-user-client-1781506349.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"magicbell-java-user-client": minor
---

Automatic minor version bump for changes in `magicbell-java-user-client`.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,3 +224,5 @@ The SDK includes several models that represent the data structures used in API r
This SDK is licensed under the MIT License.

See the [LICENSE](LICENSE) file for more details.

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/ApnsToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@
| discardedAt | String | ❌ | The timestamp when the token was discarded, if applicable. |
| installationId | ApnsTokenInstallationId | ❌ | The APNs environment this token belongs to. If omitted we assume it targets `production`. |
| updatedAt | String | ❌ | The timestamp when the token metadata last changed. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/ApnsTokenCollection.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@
| :---- | :------------------------------ | :------- | :---------- |
| data | List<[ApnsToken](ApnsToken.md)> | ❌ | |
| links | [Links](Links.md) | ❌ | |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/ApnsTokenInstallationId.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ The APNs environment this token belongs to. If omitted we assume it targets `pro
| :---------- | :----- | :------- | :------------ |
| DEVELOPMENT | String | ✅ | "development" |
| PRODUCTION | String | ✅ | "production" |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/ApnsTokenPayload.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@
| deviceToken | String | ✅ | The APNs device token to register with MagicBell. |
| appId | String | ❌ | The bundle identifier of the application registering this token. Use this to override the default identifier configured on the APNs integration. |
| installationId | ApnsTokenPayloadInstallationId | ❌ | The APNs environment this token belongs to. If omitted we assume it targets `production`. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/ApnsTokenPayloadInstallationId.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ The APNs environment this token belongs to. If omitted we assume it targets `pro
| :---------- | :----- | :------- | :------------ |
| DEVELOPMENT | String | ✅ | "development" |
| PRODUCTION | String | ✅ | "production" |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/ArchiveAllNotificationsParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@
| :------- | :----- | :------- | :------------------------------------- |
| category | String | ❌ | filter notifications by their category |
| topic | String | ❌ | filter notifications by their topic |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/AuthedUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@
| refreshToken | String | ❌ | Refresh token for the authed user. |
| scope | String | ❌ | Space-delimited OAuth scopes granted to the user token. |
| tokenType | String | ❌ | Token type value provided by Slack. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/Banner.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@ Top banner styling options.
| fontSize | String | ✅ | Font size for banner text. |
| textColor | String | ✅ | Banner text color. |
| backgroundOpacity | Double | ❌ | Opacity applied to the banner background. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/Categories.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@
| channels | List<[Channels](Channels.md)> | ❌ | |
| key | String | ❌ | |
| label | String | ❌ | |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/Channels.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@
| :------ | :------ | :------- | :---------- |
| enabled | Boolean | ❌ | |
| name | String | ❌ | |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/CountResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@
| Name | Type | Required | Description |
| :---- | :--- | :------- | :--------------------------------------------- |
| count | Long | ✅ | The count of notifications matching the query. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/DefaultHover.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@ Styles applied when a notification is hovered.
| Name | Type | Required | Description |
| :-------------- | :----- | :------- | :------------------------- |
| backgroundColor | String | ✅ | Background color on hover. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/DefaultState.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@ Accent colors for notification state indicators.
| Name | Type | Required | Description |
| :---- | :----- | :------- | :---------------------------------- |
| color | String | ✅ | Color used for the state indicator. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/Default_.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ Base styles applied to every notification item.
| textColor | String | ✅ | Default text color for notifications. |
| hover | DefaultHover | ❌ | Styles applied when a notification is hovered. |
| state | DefaultState | ❌ | Accent colors for notification state indicators. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/Dialog.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ Styling for confirmation and action dialogs.
| accentColor | String | ✅ | Accent color for dialog buttons and highlights. |
| backgroundColor | String | ✅ | Dialog background color. |
| textColor | String | ✅ | Dialog text color. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/DiscardResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@
| :---------- | :----- | :------- | :--------------------------------------------- |
| discardedAt | String | ❌ | The timestamp when the token was discarded. |
| id | String | ❌ | The unique identifier for the discarded token. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/Enterprise.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@
| :--- | :----- | :------- | :-------------------------- |
| id | String | ✅ | Enterprise grid identifier. |
| name | String | ✅ | Enterprise grid name. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/ExpoToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@
| id | String | ✅ | The unique identifier for the token. |
| discardedAt | String | ❌ | The timestamp when the token was discarded, if applicable. |
| updatedAt | String | ❌ | The timestamp when the token metadata last changed. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/ExpoTokenCollection.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@
| :---- | :------------------------------ | :------- | :---------- |
| data | List<[ExpoToken](ExpoToken.md)> | ❌ | |
| links | [Links](Links.md) | ❌ | |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/ExpoTokenPayload.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@
| Name | Type | Required | Description |
| :---------- | :----- | :------- | :----------------------------------------------- |
| deviceToken | String | ✅ | The Expo push token returned by the Expo client. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/FcmToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@
| id | String | ✅ | The unique identifier for the token. |
| discardedAt | String | ❌ | The timestamp when the token was discarded, if applicable. |
| updatedAt | String | ❌ | The timestamp when the token metadata last changed. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/FcmTokenCollection.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@
| :---- | :---------------------------- | :------- | :---------- |
| data | List<[FcmToken](FcmToken.md)> | ❌ | |
| links | [Links](Links.md) | ❌ | |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/FcmTokenPayload.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@
| Name | Type | Required | Description |
| :---------- | :----- | :------- | :--------------------------------------------------------------------------------- |
| deviceToken | String | ✅ | The Firebase Cloud Messaging device registration token to associate with the user. |

<!-- This file was generated by liblab | https://liblab.com/ -->
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@
| :------- | :----- | :------- | :------------------------------------- |
| category | String | ❌ | filter notifications by their category |
| topic | String | ❌ | filter notifications by their topic |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/Footer.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@ Footer styling for the inbox modal.
| borderRadius | String | ✅ | Border radius applied to the footer container. |
| fontSize | String | ✅ | Font size used in the footer. |
| textColor | String | ✅ | Footer text color. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/Header.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@ Header styling for the inbox modal.
| fontFamily | String | ✅ | CSS font family for the header title. |
| fontSize | String | ✅ | Font size used in the header. |
| textColor | String | ✅ | Header text color. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/Icon.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ Launcher icon styling overrides.
| :---------- | :----- | :------- | :------------------------------------------- |
| borderColor | String | ✅ | CSS color used for the icon border. |
| width | String | ✅ | Width of the launcher icon (any CSS length). |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/Images.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@ Image overrides for assets used in the inbox UI.
| Name | Type | Required | Description |
| :------------ | :----- | :------- | :------------------------------------------------------ |
| emptyInboxUrl | String | ✅ | URL for the illustration shown when the inbox is empty. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/InboxConfigPayload.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@
| images | Images | ✅ | Image overrides for assets used in the inbox UI. |
| locale | String | ✅ | Locale code (ISO language tag) used to localize built-in strings. |
| theme | Theme | ✅ | Visual customization options for the hosted inbox widget. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/InboxToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@
| :----------- | :----- | :------- | :------------------------------------------------------------------------- |
| token | String | ✅ | The in-app inbox token generated for this user. |
| connectionId | String | ❌ | Realtime connection ID to restrict delivery to a specific Ably connection. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/InboxTokenResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@
| connectionId | String | ❌ | Realtime connection ID to restrict delivery to a specific Ably connection. |
| discardedAt | String | ❌ | The timestamp when the token was discarded, if applicable. |
| updatedAt | String | ❌ | The timestamp when the token metadata last changed. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/InboxTokenResponseCollection.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@
| :---- | :------------------------------------------------ | :------- | :---------- |
| data | List<[InboxTokenResponse](InboxTokenResponse.md)> | ❌ | |
| links | [Links](Links.md) | ❌ | |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/IncomingWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@
| channel | String | ✅ | Human readable name for the webhook channel. |
| configurationUrl | String | ✅ | URL users can visit to manage the webhook. |
| url | String | ✅ | Webhook URL that Slack posts events to. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/Links.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@
| first | String | ❌ | |
| next | String | ❌ | |
| prev | String | ❌ | |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/ListApnsTokensParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@
| limit | Long | ❌ | defines the maximum number of items to return per page (default: 50) |
| startingAfter | String | ❌ | a cursor for use in pagination, points to the last ID in previous page |
| endingBefore | String | ❌ | a cursor for use in pagination, points to the first ID in next page |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/ListExpoTokensParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@
| limit | Long | ❌ | defines the maximum number of items to return per page (default: 50) |
| startingAfter | String | ❌ | a cursor for use in pagination, points to the last ID in previous page |
| endingBefore | String | ❌ | a cursor for use in pagination, points to the first ID in next page |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/ListFcmTokensParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@
| limit | Long | ❌ | defines the maximum number of items to return per page (default: 50) |
| startingAfter | String | ❌ | a cursor for use in pagination, points to the last ID in previous page |
| endingBefore | String | ❌ | a cursor for use in pagination, points to the first ID in next page |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/ListInboxTokensParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@
| limit | Long | ❌ | defines the maximum number of items to return per page (default: 50) |
| startingAfter | String | ❌ | a cursor for use in pagination, points to the last ID in previous page |
| endingBefore | String | ❌ | a cursor for use in pagination, points to the first ID in next page |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/ListMagicbellSlackbotTokensParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@
| limit | Long | ❌ | defines the maximum number of items to return per page (default: 50) |
| startingAfter | String | ❌ | a cursor for use in pagination, points to the last ID in previous page |
| endingBefore | String | ❌ | a cursor for use in pagination, points to the first ID in next page |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/ListNotificationsParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@
| status | String | ❌ | filter notifications by their read state, one of 'unread' \| 'read' \| 'archived' |
| category | String | ❌ | filter notifications by their category |
| topic | String | ❌ | filter notifications by their topic |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/ListSlackTokensParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@
| limit | Long | ❌ | defines the maximum number of items to return per page (default: 50) |
| startingAfter | String | ❌ | a cursor for use in pagination, points to the last ID in previous page |
| endingBefore | String | ❌ | a cursor for use in pagination, points to the first ID in next page |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/ListTeamsTokensParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@
| limit | Long | ❌ | defines the maximum number of items to return per page (default: 50) |
| startingAfter | String | ❌ | a cursor for use in pagination, points to the last ID in previous page |
| endingBefore | String | ❌ | a cursor for use in pagination, points to the first ID in next page |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/ListWebPushTokensParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@
| limit | Long | ❌ | defines the maximum number of items to return per page (default: 50) |
| startingAfter | String | ❌ | a cursor for use in pagination, points to the last ID in previous page |
| endingBefore | String | ❌ | a cursor for use in pagination, points to the first ID in next page |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/MarkAllNotificationsReadParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@
| :------- | :----- | :------- | :------------------------------------- |
| category | String | ❌ | filter notifications by their category |
| topic | String | ❌ | filter notifications by their topic |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/Notification.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,5 @@
| seenAt | String | ❌ | The timestamp when the notification was seen. |
| sentAt | String | ❌ | The timestamp when the notification was sent. |
| topic | String | ❌ | The topic for additional classification. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/NotificationCollection.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@
| :---- | :------------------------------------ | :------- | :---------- |
| data | List<[Notification](Notification.md)> | ❌ | |
| links | [Links](Links.md) | ❌ | |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/SlackFinishInstallResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@
| appId | String | ✅ | The app ID of the Slack app that was originally configured at the project-level. |
| code | String | ✅ | The code that was returned from the OAuth flow, and found in the query string of the redirect URL. |
| redirectUrl | String | ❌ | |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/SlackInstallation.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,5 @@
| refreshToken | String | ❌ | Refresh token for regenerating the bot access token. |
| scope | String | ❌ | Space-delimited OAuth scopes granted to the bot token. |
| tokenType | String | ❌ | Type of bot token returned by Slack. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/SlackStartInstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@
| authUrl | String | ❌ | Optional override for the authorization URL returned to the client. |
| extraScopes | List<String> | ❌ | Additional OAuth scopes to request during installation. |
| redirectUrl | String | ❌ | Custom redirect URL to use after OAuth completes. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/SlackStartInstallResponseContent.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@
| appId | String | ❌ | |
| authUrl | String | ❌ | |
| scopes | List<String> | ❌ | |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/SlackToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@
| oauth | SlackTokenOauth | ❌ | |
| updatedAt | String | ❌ | The timestamp when the token metadata last changed. |
| webhook | SlackTokenWebhook | ❌ | Obtained directly from the incoming_webhook object in the installation response from the Slack API. |

<!-- This file was generated by liblab | https://liblab.com/ -->
2 changes: 2 additions & 0 deletions documentation/models/SlackTokenCollection.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@
| :---- | :-------------------------------- | :------- | :---------- |
| data | List<[SlackToken](SlackToken.md)> | ❌ | |
| links | [Links](Links.md) | ❌ | |

<!-- This file was generated by liblab | https://liblab.com/ -->
Loading