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-1773777818.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`.
107 changes: 56 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Welcome to the MagicbellUserClient SDK documentation. This guide will help you get started with integrating and using the MagicbellUserClient SDK in your project.

[![This SDK was generated by liblab](https://public-liblab-readme-assets.s3.us-east-1.amazonaws.com/built-by-liblab-icon.svg)](https://liblab.com/?utm_source=readme)
[![This SDK was generated by liblab](https://raw.githubusercontent.com/liblaber/liblab-assets/main/assets/built-by-liblab-icon.svg)](https://liblab.com/?utm_source=readme)

## Versions

Expand Down Expand Up @@ -116,9 +116,9 @@ Below is a comprehensive example demonstrating how to authenticate and call a si
```java
import com.magicbell.magicbelluserclient.MagicbellUserClient;
import com.magicbell.magicbelluserclient.config.MagicbellUserClientConfig;
import com.magicbell.magicbelluserclient.exceptions.ApiException;
import com.magicbell.magicbelluserclient.models.GetInAppInboxTokensParameters;
import com.magicbell.magicbelluserclient.exceptions.ApiError;
import com.magicbell.magicbelluserclient.models.InboxTokenResponseCollection;
import com.magicbell.magicbelluserclient.models.ListInboxTokensParameters;

public class Main {

Expand All @@ -127,17 +127,17 @@ public class Main {

MagicbellUserClient magicbellUserClient = new MagicbellUserClient(config);

GetInAppInboxTokensParameters requestParameters = GetInAppInboxTokensParameters.builder()
.limit(10L)
ListInboxTokensParameters requestParameters = ListInboxTokensParameters.builder()
.limit(0L)
.startingAfter("starting_after")
.endingBefore("ending_before")
.build();

try {
InboxTokenResponseCollection response = magicbellUserClient.channels.getInAppInboxTokens(requestParameters);
InboxTokenResponseCollection response = magicbellUserClient.channels.listInboxTokens(requestParameters);

System.out.println(response);
} catch (ApiException e) {
} catch (ApiError e) {
e.printStackTrace();
}

Expand All @@ -151,7 +151,7 @@ public class Main {

The SDK provides various services to interact with the API.

<details>
<details>
<summary>Below is a list of all available services with links to their detailed documentation:</summary>

| Name |
Expand All @@ -166,51 +166,56 @@ The SDK provides various services to interact with the API.

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

<details>
<details>
<summary>Below is a list of all available models with links to their detailed documentation:</summary>

| Name | Description |
| :--------------------------------------------------------------------------------------------- | :---------- |
| [InboxTokenResponseCollection](documentation/models/InboxTokenResponseCollection.md) | |
| [InboxToken](documentation/models/InboxToken.md) | |
| [InboxTokenResponse](documentation/models/InboxTokenResponse.md) | |
| [DiscardResult](documentation/models/DiscardResult.md) | |
| [ApnsTokenCollection](documentation/models/ApnsTokenCollection.md) | |
| [ApnsTokenPayload](documentation/models/ApnsTokenPayload.md) | |
| [ApnsToken](documentation/models/ApnsToken.md) | |
| [ExpoTokenCollection](documentation/models/ExpoTokenCollection.md) | |
| [ExpoTokenPayload](documentation/models/ExpoTokenPayload.md) | |
| [ExpoToken](documentation/models/ExpoToken.md) | |
| [FcmTokenCollection](documentation/models/FcmTokenCollection.md) | |
| [FcmTokenPayload](documentation/models/FcmTokenPayload.md) | |
| [FcmToken](documentation/models/FcmToken.md) | |
| [SlackTokenCollection](documentation/models/SlackTokenCollection.md) | |
| [SlackTokenPayload](documentation/models/SlackTokenPayload.md) | |
| [SlackToken](documentation/models/SlackToken.md) | |
| [TeamsTokenCollection](documentation/models/TeamsTokenCollection.md) | |
| [TeamsTokenPayload](documentation/models/TeamsTokenPayload.md) | |
| [TeamsToken](documentation/models/TeamsToken.md) | |
| [WebPushTokenCollection](documentation/models/WebPushTokenCollection.md) | |
| [WebPushTokenPayload](documentation/models/WebPushTokenPayload.md) | |
| [WebPushToken](documentation/models/WebPushToken.md) | |
| [InboxConfigPayload](documentation/models/InboxConfigPayload.md) | |
| [SlackInstallation](documentation/models/SlackInstallation.md) | |
| [SlackFinishInstallResponse](documentation/models/SlackFinishInstallResponse.md) | |
| [SlackStartInstall](documentation/models/SlackStartInstall.md) | |
| [SlackStartInstallResponseContent](documentation/models/SlackStartInstallResponseContent.md) | |
| [TemplatesInstallation](documentation/models/TemplatesInstallation.md) | |
| [WebPushStartInstallationResponse](documentation/models/WebPushStartInstallationResponse.md) | |
| [NotificationCollection](documentation/models/NotificationCollection.md) | |
| [Links](documentation/models/Links.md) | |
| [Notification](documentation/models/Notification.md) | |
| [GetInAppInboxTokensParameters](documentation/models/GetInAppInboxTokensParameters.md) | |
| [GetMobilePushApnsTokensParameters](documentation/models/GetMobilePushApnsTokensParameters.md) | |
| [GetMobilePushExpoTokensParameters](documentation/models/GetMobilePushExpoTokensParameters.md) | |
| [GetMobilePushFcmTokensParameters](documentation/models/GetMobilePushFcmTokensParameters.md) | |
| [GetSlackTokensParameters](documentation/models/GetSlackTokensParameters.md) | |
| [GetTeamsTokensParameters](documentation/models/GetTeamsTokensParameters.md) | |
| [GetWebPushTokensParameters](documentation/models/GetWebPushTokensParameters.md) | |
| [ListNotificationsParameters](documentation/models/ListNotificationsParameters.md) | |
| Name | Description |
| :--------------------------------------------------------------------------------------------------------- | :---------- |
| [InboxTokenResponseCollection](documentation/models/InboxTokenResponseCollection.md) | |
| [InboxTokenResponse](documentation/models/InboxTokenResponse.md) | |
| [Links](documentation/models/Links.md) | |
| [ListInboxTokensParameters](documentation/models/ListInboxTokensParameters.md) | |
| [InboxToken](documentation/models/InboxToken.md) | |
| [DiscardResult](documentation/models/DiscardResult.md) | |
| [ApnsTokenCollection](documentation/models/ApnsTokenCollection.md) | |
| [ApnsToken](documentation/models/ApnsToken.md) | |
| [ListApnsTokensParameters](documentation/models/ListApnsTokensParameters.md) | |
| [ApnsTokenPayload](documentation/models/ApnsTokenPayload.md) | |
| [ExpoTokenCollection](documentation/models/ExpoTokenCollection.md) | |
| [ExpoToken](documentation/models/ExpoToken.md) | |
| [ListExpoTokensParameters](documentation/models/ListExpoTokensParameters.md) | |
| [ExpoTokenPayload](documentation/models/ExpoTokenPayload.md) | |
| [FcmTokenCollection](documentation/models/FcmTokenCollection.md) | |
| [FcmToken](documentation/models/FcmToken.md) | |
| [ListFcmTokensParameters](documentation/models/ListFcmTokensParameters.md) | |
| [FcmTokenPayload](documentation/models/FcmTokenPayload.md) | |
| [SlackTokenCollection](documentation/models/SlackTokenCollection.md) | |
| [SlackToken](documentation/models/SlackToken.md) | |
| [ListMagicbellSlackbotTokensParameters](documentation/models/ListMagicbellSlackbotTokensParameters.md) | |
| [SlackTokenPayload](documentation/models/SlackTokenPayload.md) | |
| [ListSlackTokensParameters](documentation/models/ListSlackTokensParameters.md) | |
| [TeamsTokenCollection](documentation/models/TeamsTokenCollection.md) | |
| [TeamsToken](documentation/models/TeamsToken.md) | |
| [ListTeamsTokensParameters](documentation/models/ListTeamsTokensParameters.md) | |
| [TeamsTokenPayload](documentation/models/TeamsTokenPayload.md) | |
| [UserPreferences](documentation/models/UserPreferences.md) | |
| [WebPushTokenCollection](documentation/models/WebPushTokenCollection.md) | |
| [WebPushToken](documentation/models/WebPushToken.md) | |
| [ListWebPushTokensParameters](documentation/models/ListWebPushTokensParameters.md) | |
| [WebPushTokenPayload](documentation/models/WebPushTokenPayload.md) | |
| [InboxConfigPayload](documentation/models/InboxConfigPayload.md) | |
| [SlackInstallation](documentation/models/SlackInstallation.md) | |
| [SlackFinishInstallResponse](documentation/models/SlackFinishInstallResponse.md) | |
| [SlackStartInstallResponseContent](documentation/models/SlackStartInstallResponseContent.md) | |
| [SlackStartInstall](documentation/models/SlackStartInstall.md) | |
| [WebPushStartInstallationResponse](documentation/models/WebPushStartInstallationResponse.md) | |
| [NotificationCollection](documentation/models/NotificationCollection.md) | |
| [Notification](documentation/models/Notification.md) | |
| [ListNotificationsParameters](documentation/models/ListNotificationsParameters.md) | |
| [ArchiveAllNotificationsParameters](documentation/models/ArchiveAllNotificationsParameters.md) | |
| [MarkAllNotificationsReadParameters](documentation/models/MarkAllNotificationsReadParameters.md) | |
| [CountResponse](documentation/models/CountResponse.md) | |
| [FetchUnreadNotificationsCountParameters](documentation/models/FetchUnreadNotificationsCountParameters.md) | |

</details>

Expand Down
18 changes: 9 additions & 9 deletions documentation/models/ApnsToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

**Properties**

| Name | Type | Required | Description |
| :------------- | :---------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| createdAt | String | ✅ | |
| deviceToken | String | ✅ | |
| id | String | ✅ | |
| appId | String | ❌ | (Optional) The bundle identifier of the application that is registering this token. Use this field to override the default identifier specified in the projects APNs integration. |
| discardedAt | String | ❌ | |
| installationId | ApnsTokenInstallationId | ❌ | (Optional) The APNs environment the token is registered for. If none is provided we assume the token is used in `production`. |
| updatedAt | String | ❌ | |
| Name | Type | Required | Description |
| :------------- | :---------------------- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------- |
| createdAt | String | ✅ | The timestamp when the token was created. |
| deviceToken | String | ✅ | The APNs device token to register with MagicBell. |
| id | String | ✅ | The unique identifier for the token. |
| appId | String | ❌ | The bundle identifier of the application registering this token. Use this to override the default identifier configured on the APNs integration. |
| 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. |
8 changes: 4 additions & 4 deletions documentation/models/ApnsTokenCollection.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Properties**

| Name | Type | Required | Description |
| :---- | :---------------- | :------- | :---------- |
| data | List\<ApnsToken\> | ❌ | |
| links | Links | ❌ | |
| Name | Type | Required | Description |
| :---- | :------------------------------ | :------- | :---------- |
| data | List<[ApnsToken](ApnsToken.md)> | ❌ | |
| links | [Links](Links.md) | ❌ | |
2 changes: 1 addition & 1 deletion documentation/models/ApnsTokenInstallationId.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ApnsTokenInstallationId

(Optional) The APNs environment the token is registered for. If none is provided we assume the token is used in `production`.
The APNs environment this token belongs to. If omitted we assume it targets `production`.

**Properties**

Expand Down
Loading