Skip to content

chore: regen sdk #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 14, 2025
Merged

chore: regen sdk #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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-1747218288.md
View file
Open in desktop
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`.
71 changes: 42 additions & 29 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Welcome to the MagicbellUserClient SDK documentation. This guide will help you g

## About the API

OpenAPI 3.0.3 Specification for MagicBell API.
OpenAPI 3.1.0 Specification for MagicBell API.

## Table of Contents

Expand Down Expand Up @@ -116,8 +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.models.ArrayOfMetadataApnsTokens;
import com.magicbell.magicbelluserclient.models.GetMobilePushApnsTokensParameters;
import com.magicbell.magicbelluserclient.exceptions.ApiException;
import com.magicbell.magicbelluserclient.models.GetInAppInboxTokensParameters;
import com.magicbell.magicbelluserclient.models.InboxTokenResponseCollection;

public class Main {

Expand All @@ -126,16 +127,21 @@ public class Main {

MagicbellUserClient magicbellUserClient = new MagicbellUserClient(config);

GetMobilePushApnsTokensParameters requestParameters = GetMobilePushApnsTokensParameters
.builder()
.pageSize(8L)
.pageAfter("page[after]")
.pageBefore("page[before]")
GetInAppInboxTokensParameters requestParameters = GetInAppInboxTokensParameters.builder()
.limit(10L)
.startingAfter("starting_after")
.endingBefore("ending_before")
.build();

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

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

System.exit(0);
}
}

Expand All @@ -148,10 +154,11 @@ The SDK provides various services to interact with the API.
<details>
<summary>Below is a list of all available services with links to their detailed documentation:</summary>

| Name |
| :---------------------------------------------------------------------------------------------------------------------------------------- |
| ChannelsService: [[Java](documentation/services/ChannelsService.md)] [[Kotlin](documentation/services/ChannelsService.kt.md)] |
| IntegrationsService: [[Java](documentation/services/IntegrationsService.md)] [[Kotlin](documentation/services/IntegrationsService.kt.md)] |
| Name |
| :------------------------------------------------------------------------------------------------------------------------------------------- |
| ChannelsService: [[Java](documentation/services/ChannelsService.md)] [[Kotlin](documentation/services/ChannelsService.kt.md)] |
| IntegrationsService: [[Java](documentation/services/IntegrationsService.md)] [[Kotlin](documentation/services/IntegrationsService.kt.md)] |
| NotificationsService: [[Java](documentation/services/NotificationsService.md)] [[Kotlin](documentation/services/NotificationsService.kt.md)] |

</details>

Expand All @@ -164,40 +171,46 @@ The SDK includes several models that represent the data structures used in API r

| Name | Description |
| :--------------------------------------------------------------------------------------------- | :---------- |
| [ArrayOfMetadataApnsTokens](documentation/models/ArrayOfMetadataApnsTokens.md) | |
| [ApnsToken](documentation/models/ApnsToken.md) | |
| [MetadataApnsToken](documentation/models/MetadataApnsToken.md) | |
| [InboxTokenResponseCollection](documentation/models/InboxTokenResponseCollection.md) | |
| [InboxToken](documentation/models/InboxToken.md) | |
| [InboxTokenResponse](documentation/models/InboxTokenResponse.md) | |
| [DiscardResult](documentation/models/DiscardResult.md) | |
| [ArrayOfMetadataExpoTokens](documentation/models/ArrayOfMetadataExpoTokens.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) | |
| [MetadataExpoToken](documentation/models/MetadataExpoToken.md) | |
| [ArrayOfMetadataFcmTokens](documentation/models/ArrayOfMetadataFcmTokens.md) | |
| [FcmTokenCollection](documentation/models/FcmTokenCollection.md) | |
| [FcmTokenPayload](documentation/models/FcmTokenPayload.md) | |
| [FcmToken](documentation/models/FcmToken.md) | |
| [MetadataFcmToken](documentation/models/MetadataFcmToken.md) | |
| [ArrayOfMetadataSlackTokens](documentation/models/ArrayOfMetadataSlackTokens.md) | |
| [SlackTokenCollection](documentation/models/SlackTokenCollection.md) | |
| [SlackTokenPayload](documentation/models/SlackTokenPayload.md) | |
| [SlackToken](documentation/models/SlackToken.md) | |
| [MetadataSlackToken](documentation/models/MetadataSlackToken.md) | |
| [ArrayOfMetadataTeamsTokens](documentation/models/ArrayOfMetadataTeamsTokens.md) | |
| [TeamsTokenCollection](documentation/models/TeamsTokenCollection.md) | |
| [TeamsTokenPayload](documentation/models/TeamsTokenPayload.md) | |
| [TeamsToken](documentation/models/TeamsToken.md) | |
| [MetadataTeamsToken](documentation/models/MetadataTeamsToken.md) | |
| [ArrayOfMetadataWebPushTokens](documentation/models/ArrayOfMetadataWebPushTokens.md) | |
| [WebPushTokenCollection](documentation/models/WebPushTokenCollection.md) | |
| [WebPushTokenPayload](documentation/models/WebPushTokenPayload.md) | |
| [WebPushToken](documentation/models/WebPushToken.md) | |
| [MetadataWebPushToken](documentation/models/MetadataWebPushToken.md) | |
| [InboxConfig](documentation/models/InboxConfig.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) | |
| [TokenMetadata](documentation/models/TokenMetadata.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) | |

</details>

Expand Down
4 changes: 4 additions & 0 deletions documentation/models/ApnsToken.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

| 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 | ❌ | |
8 changes: 8 additions & 0 deletions documentation/models/ApnsTokenCollection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# ApnsTokenCollection

**Properties**

| Name | Type | Required | Description |
| :---- | :---------------- | :------- | :---------- |
| data | List\<ApnsToken\> | ❌ | |
| links | Links | ❌ | |
9 changes: 9 additions & 0 deletions documentation/models/ApnsTokenPayload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# ApnsTokenPayload

**Properties**

| Name | Type | Required | Description |
| :------------- | :----------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| deviceToken | 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. |
| installationId | ApnsTokenPayloadInstallationId | ❌ | (Optional) The APNs environment the token is registered for. If none is provided we assume the token is used in `production`. |
10 changes: 10 additions & 0 deletions documentation/models/ApnsTokenPayloadInstallationId.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# ApnsTokenPayloadInstallationId

(Optional) The APNs environment the token is registered for. If none is provided we assume the token is used in `production`.

**Properties**

| Name | Type | Required | Description |
| :---------- | :----- | :------- | :------------ |
| DEVELOPMENT | String | ✅ | "development" |
| PRODUCTION | String | ✅ | "production" |
8 changes: 0 additions & 8 deletions documentation/models/ArrayOfMetadataApnsTokens.md
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions documentation/models/ArrayOfMetadataExpoTokens.md
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions documentation/models/ArrayOfMetadataFcmTokens.md
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions documentation/models/ArrayOfMetadataSlackTokens.md
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions documentation/models/ArrayOfMetadataWebPushTokens.md
View file
Open in desktop

This file was deleted.

4 changes: 4 additions & 0 deletions documentation/models/ExpoToken.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,8 @@

| Name | Type | Required | Description |
| :---------- | :----- | :------- | :---------- |
| createdAt | String | ✅ | |
| deviceToken | String | ✅ | |
| id | String | ✅ | |
| discardedAt | String | ❌ | |
| updatedAt | String | ❌ | |
8 changes: 8 additions & 0 deletions documentation/models/ExpoTokenCollection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# ExpoTokenCollection

**Properties**

| Name | Type | Required | Description |
| :---- | :---------------- | :------- | :---------- |
| data | List\<ExpoToken\> | ❌ | |
| links | Links | ❌ | |
7 changes: 7 additions & 0 deletions documentation/models/ExpoTokenPayload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# ExpoTokenPayload

**Properties**

| Name | Type | Required | Description |
| :---------- | :----- | :------- | :---------- |
| deviceToken | String | ✅ | |
4 changes: 4 additions & 0 deletions documentation/models/FcmToken.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,9 @@

| Name | Type | Required | Description |
| :------------- | :--------------------- | :------- | :---------- |
| createdAt | String | ✅ | |
| deviceToken | String | ✅ | |
| id | String | ✅ | |
| discardedAt | String | ❌ | |
| installationId | FcmTokenInstallationId | ❌ | |
| updatedAt | String | ❌ | |
8 changes: 8 additions & 0 deletions documentation/models/FcmTokenCollection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# FcmTokenCollection

**Properties**

| Name | Type | Required | Description |
| :---- | :--------------- | :------- | :---------- |
| data | List\<FcmToken\> | ❌ | |
| links | Links | ❌ | |
8 changes: 8 additions & 0 deletions documentation/models/FcmTokenPayload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# FcmTokenPayload

**Properties**

| Name | Type | Required | Description |
| :------------- | :---------------------------- | :------- | :---------- |
| deviceToken | String | ✅ | |
| installationId | FcmTokenPayloadInstallationId | ❌ | |
8 changes: 8 additions & 0 deletions documentation/models/FcmTokenPayloadInstallationId.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# FcmTokenPayloadInstallationId

**Properties**

| Name | Type | Required | Description |
| :---------- | :----- | :------- | :------------ |
| DEVELOPMENT | String | ✅ | "development" |
| PRODUCTION | String | ✅ | "production" |
9 changes: 9 additions & 0 deletions documentation/models/GetInAppInboxTokensParameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# GetInAppInboxTokensParameters

**Properties**

| Name | Type | Required | Description |
| :------------ | :----- | :------- | :---------- |
| limit | Long | ❌ | |
| startingAfter | String | ❌ | |
| endingBefore | String | ❌ | |
10 changes: 5 additions & 5 deletions documentation/models/GetMobilePushApnsTokensParameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

**Properties**

| Name | Type | Required | Description |
| :--------- | :----- | :------- | :---------- |
| pageSize | Long | ❌ | |
| pageAfter | String | ❌ | |
| pageBefore | String | ❌ | |
| Name | Type | Required | Description |
| :------------ | :----- | :------- | :---------- |
| limit | Long | ❌ | |
| startingAfter | String | ❌ | |
| endingBefore | String | ❌ | |
10 changes: 5 additions & 5 deletions documentation/models/GetMobilePushExpoTokensParameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

**Properties**

| Name | Type | Required | Description |
| :--------- | :----- | :------- | :---------- |
| pageSize | Long | ❌ | |
| pageAfter | String | ❌ | |
| pageBefore | String | ❌ | |
| Name | Type | Required | Description |
| :------------ | :----- | :------- | :---------- |
| limit | Long | ❌ | |
| startingAfter | String | ❌ | |
| endingBefore | String | ❌ | |
10 changes: 5 additions & 5 deletions documentation/models/GetMobilePushFcmTokensParameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

**Properties**

| Name | Type | Required | Description |
| :--------- | :----- | :------- | :---------- |
| pageSize | Long | ❌ | |
| pageAfter | String | ❌ | |
| pageBefore | String | ❌ | |
| Name | Type | Required | Description |
| :------------ | :----- | :------- | :---------- |
| limit | Long | ❌ | |
| startingAfter | String | ❌ | |
| endingBefore | String | ❌ | |
Loading