Skip to content

chore: regen sdks #575

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: regen sdks #575

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-js-1762150072.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'magicbell-js': minor
---

Automatic minor version bump for changes in `magicbell-js`.
15 changes: 13 additions & 2 deletions packages/magicbell-js/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ import { Client } from 'magicbell-js/project-client';
});

const { data } = await client.broadcasts.listBroadcasts({
limit: 5,
limit: 10,
startingAfter: 'starting_after',
endingBefore: 'ending_before',
});
Expand All @@ -87,6 +87,7 @@ The SDK provides various services to interact with the API.
| [EventsService](docs/project-client/services/EventsService.md) |
| [IntegrationsService](docs/project-client/services/IntegrationsService.md) |
| [UsersService](docs/project-client/services/UsersService.md) |
| [WorkflowsService](docs/project-client/services/WorkflowsService.md) |

</details>

Expand Down Expand Up @@ -129,6 +130,9 @@ The SDK includes several models that represent the data structures used in API r
| [ApnsConfigCollection](docs/project-client/models/ApnsConfigCollection.md) | |
| [ApnsConfig](docs/project-client/models/ApnsConfig.md) | |
| [ApnsConfigPayload](docs/project-client/models/ApnsConfigPayload.md) | |
| [EventSourceConfigCollection](docs/project-client/models/EventSourceConfigCollection.md) | |
| [EventSourceConfig](docs/project-client/models/EventSourceConfig.md) | |
| [EventSourceConfigPayload](docs/project-client/models/EventSourceConfigPayload.md) | |
| [ExpoConfigCollection](docs/project-client/models/ExpoConfigCollection.md) | |
| [ExpoConfig](docs/project-client/models/ExpoConfig.md) | |
| [ExpoConfigPayload](docs/project-client/models/ExpoConfigPayload.md) | |
Expand Down Expand Up @@ -168,6 +172,13 @@ The SDK includes several models that represent the data structures used in API r
| [UserCollection](docs/project-client/models/UserCollection.md) | |
| [User](docs/project-client/models/User.md) | |
| [Links](docs/project-client/models/Links.md) | |
| [WorkflowDefinition](docs/project-client/models/WorkflowDefinition.md) | |
| [ExecuteWorkflowRequest](docs/project-client/models/ExecuteWorkflowRequest.md) | |
| [CreateRunResponse](docs/project-client/models/CreateRunResponse.md) | |
| [GetRunResponse](docs/project-client/models/GetRunResponse.md) | |
| [WorkflowRunCollection](docs/project-client/models/WorkflowRunCollection.md) | |
| [WorkflowRun](docs/project-client/models/WorkflowRun.md) | |
| [Links](docs/project-client/models/Links.md) | |

</details>

Expand Down Expand Up @@ -221,7 +232,7 @@ import { Client } from 'magicbell-js/user-client';
});

const { data } = await client.channels.listInboxTokens({
limit: 3,
limit: 6,
startingAfter: 'starting_after',
endingBefore: 'ending_before',
});
Expand Down
21 changes: 19 additions & 2 deletions packages/magicbell-js/docs/project-client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,18 @@ This SDK is compatible with the following versions: `TypeScript >= 4.8.4`

## Installation

To get started with the SDK, we recommend installing using `npm`:
To get started with the SDK, we recommend installing using `npm` or `yarn`:

```bash
npm install magicbell-js
```

or

```bash
yarn add magicbell-js/project-client
```

## Authentication

### Access Token Authentication
Expand Down Expand Up @@ -60,7 +66,7 @@ import { Client } from 'magicbell-js/project-client';
});

const { data } = await client.broadcasts.listBroadcasts({
limit: 5,
limit: 10,
startingAfter: 'starting_after',
endingBefore: 'ending_before',
});
Expand All @@ -83,6 +89,7 @@ The SDK provides various services to interact with the API.
| [EventsService](services/EventsService.md) |
| [IntegrationsService](services/IntegrationsService.md) |
| [UsersService](services/UsersService.md) |
| [WorkflowsService](services/WorkflowsService.md) |

</details>

Expand Down Expand Up @@ -125,6 +132,9 @@ The SDK includes several models that represent the data structures used in API r
| [ApnsConfigCollection](models/ApnsConfigCollection.md) | |
| [ApnsConfig](models/ApnsConfig.md) | |
| [ApnsConfigPayload](models/ApnsConfigPayload.md) | |
| [EventSourceConfigCollection](models/EventSourceConfigCollection.md) | |
| [EventSourceConfig](models/EventSourceConfig.md) | |
| [EventSourceConfigPayload](models/EventSourceConfigPayload.md) | |
| [ExpoConfigCollection](models/ExpoConfigCollection.md) | |
| [ExpoConfig](models/ExpoConfig.md) | |
| [ExpoConfigPayload](models/ExpoConfigPayload.md) | |
Expand Down Expand Up @@ -164,5 +174,12 @@ The SDK includes several models that represent the data structures used in API r
| [UserCollection](models/UserCollection.md) | |
| [User](models/User.md) | |
| [Links](models/Links.md) | |
| [WorkflowDefinition](models/WorkflowDefinition.md) | |
| [ExecuteWorkflowRequest](models/ExecuteWorkflowRequest.md) | |
| [CreateRunResponse](models/CreateRunResponse.md) | |
| [GetRunResponse](models/GetRunResponse.md) | |
| [WorkflowRunCollection](models/WorkflowRunCollection.md) | |
| [WorkflowRun](models/WorkflowRun.md) | |
| [Links](models/Links.md) | |

</details>
10 changes: 5 additions & 5 deletions packages/magicbell-js/docs/project-client/models/ApnsConfig.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 |
| :----- | :---------------- | :------- | :---------- |
| config | ApnsConfigPayload | ✅ | |
| id | string | ✅ | |
| name | string | ✅ | |
| Name | Type | Required | Description |
| :----- | :---------------------------------------- | :------- | :---------- |
| config | [ApnsConfigPayload](ApnsConfigPayload.md) | ✅ | |
| id | string | ✅ | |
| name | string | ✅ | |
8 changes: 4 additions & 4 deletions packages/magicbell-js/docs/project-client/models/ApnsConfigCollection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Properties**

| Name | Type | Required | Description |
| :---- | :----------- | :------- | :---------- |
| data | ApnsConfig[] | ❌ | |
| links | Links | ❌ | |
| Name | Type | Required | Description |
| :---- | :---------------------------- | :------- | :---------- |
| data | [ApnsConfig](ApnsConfig.md)[] | ❌ | |
| links | [Links](Links.md) | ❌ | |
8 changes: 4 additions & 4 deletions packages/magicbell-js/docs/project-client/models/ApnsTokenCollection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Properties**

| Name | Type | Required | Description |
| :---- | :---------- | :------- | :---------- |
| data | ApnsToken[] | ❌ | |
| links | Links | ❌ | |
| Name | Type | Required | Description |
| :---- | :-------------------------- | :------- | :---------- |
| data | [ApnsToken](ApnsToken.md)[] | ❌ | |
| links | [Links](Links.md) | ❌ | |
36 changes: 18 additions & 18 deletions packages/magicbell-js/docs/project-client/models/Broadcast.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

**Properties**

| Name | Type | Required | Description |
| :--------------- | :-------------- | :------- | :-------------------------------------------- |
| recipients | User[] | ✅ | |
| title | string | ✅ | |
| actionUrl | string | ❌ | |
| category | string | ❌ | |
| content | string | ❌ | |
| createdAt | string | ❌ | The timestamp when the broadcast was created. |
| customAttributes | any | ❌ | |
| id | string | ❌ | The unique id for this broadcast. |
| overrides | Overrides | ❌ | |
| status | BroadcastStatus | ❌ | |
| topic | string | ❌ | |
| Name | Type | Required | Description |
| :--------------- | :---------------- | :------- | :-------------------------------------------- |
| recipients | [User](User.md)[] | ✅ | |
| title | string | ✅ | |
| actionUrl | string | ❌ | |
| category | string | ❌ | |
| content | string | ❌ | |
| createdAt | string | ❌ | The timestamp when the broadcast was created. |
| customAttributes | any | ❌ | |
| id | string | ❌ | The unique id for this broadcast. |
| overrides | Overrides | ❌ | |
| status | BroadcastStatus | ❌ | |
| topic | string | ❌ | |

# Overrides

Expand Down Expand Up @@ -97,11 +97,11 @@

**Properties**

| Name | Type | Required | Description |
| :------ | :----------- | :------- | :---------- |
| errors | Errors[] | ✅ | |
| status | StatusStatus | ✅ | |
| summary | Summary | ✅ | |
| Name | Type | Required | Description |
| :------ | :-------------------- | :------- | :---------- |
| errors | [Errors](Errors.md)[] | ✅ | |
| status | StatusStatus | ✅ | |
| summary | Summary | ✅ | |

# StatusStatus

Expand Down
8 changes: 4 additions & 4 deletions packages/magicbell-js/docs/project-client/models/BroadcastCollection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Properties**

| Name | Type | Required | Description |
| :---- | :---------- | :------- | :---------- |
| data | Broadcast[] | ❌ | |
| links | Links | ❌ | |
| Name | Type | Required | Description |
| :---- | :-------------------------- | :------- | :---------- |
| data | [Broadcast](Broadcast.md)[] | ❌ | |
| links | [Links](Links.md) | ❌ | |
10 changes: 5 additions & 5 deletions packages/magicbell-js/docs/project-client/models/CategoryDeliveryConfig.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 |
| :------- | :------------------------------- | :------- | :---------- |
| channels | CategoryDeliveryConfigChannels[] | ✅ | |
| key | string | ✅ | |
| disabled | boolean | ❌ | |
| Name | Type | Required | Description |
| :------- | :-------------------------------------------------------------------- | :------- | :---------- |
| channels | [CategoryDeliveryConfigChannels](CategoryDeliveryConfigChannels.md)[] | ✅ | |
| key | string | ✅ | |
| disabled | boolean | ❌ | |
7 changes: 7 additions & 0 deletions packages/magicbell-js/docs/project-client/models/CreateRunResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# CreateRunResponse

**Properties**

| Name | Type | Required | Description |
| :--- | :----- | :------- | :---------- |
| id | string | ✅ | |
8 changes: 4 additions & 4 deletions packages/magicbell-js/docs/project-client/models/EventCollection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Properties**

| Name | Type | Required | Description |
| :---- | :------ | :------- | :---------- |
| data | Event[] | ❌ | |
| links | Links | ❌ | |
| Name | Type | Required | Description |
| :---- | :------------------ | :------- | :---------- |
| data | [Event](Event.md)[] | ❌ | |
| links | [Links](Links.md) | ❌ | |
9 changes: 9 additions & 0 deletions packages/magicbell-js/docs/project-client/models/EventSourceConfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# EventSourceConfig

**Properties**

| Name | Type | Required | Description |
| :----- | :------------------------------------------------------ | :------- | :---------- |
| config | [EventSourceConfigPayload](EventSourceConfigPayload.md) | ✅ | |
| id | string | ✅ | |
| name | string | ✅ | |
8 changes: 8 additions & 0 deletions packages/magicbell-js/docs/project-client/models/EventSourceConfigCollection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# EventSourceConfigCollection

**Properties**

| Name | Type | Required | Description |
| :---- | :------------------------------------------ | :------- | :---------- |
| data | [EventSourceConfig](EventSourceConfig.md)[] | ❌ | |
| links | [Links](Links.md) | ❌ | |
7 changes: 7 additions & 0 deletions packages/magicbell-js/docs/project-client/models/EventSourceConfigPayload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# EventSourceConfigPayload

**Properties**

| Name | Type | Required | Description |
| :----- | :----- | :------- | :---------- |
| source | string | ✅ | |
8 changes: 8 additions & 0 deletions packages/magicbell-js/docs/project-client/models/ExecuteWorkflowRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# ExecuteWorkflowRequest

**Properties**

| Name | Type | Required | Description |
| :---- | :----- | :------- | :---------- |
| key | string | ✅ | |
| input | any | ❌ | |
10 changes: 5 additions & 5 deletions packages/magicbell-js/docs/project-client/models/ExpoConfig.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 |
| :----- | :---------------- | :------- | :---------- |
| config | ExpoConfigPayload | ✅ | |
| id | string | ✅ | |
| name | string | ✅ | |
| Name | Type | Required | Description |
| :----- | :---------------------------------------- | :------- | :---------- |
| config | [ExpoConfigPayload](ExpoConfigPayload.md) | ✅ | |
| id | string | ✅ | |
| name | string | ✅ | |
8 changes: 4 additions & 4 deletions packages/magicbell-js/docs/project-client/models/ExpoConfigCollection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Properties**

| Name | Type | Required | Description |
| :---- | :----------- | :------- | :---------- |
| data | ExpoConfig[] | ❌ | |
| links | Links | ❌ | |
| Name | Type | Required | Description |
| :---- | :---------------------------- | :------- | :---------- |
| data | [ExpoConfig](ExpoConfig.md)[] | ❌ | |
| links | [Links](Links.md) | ❌ | |
8 changes: 4 additions & 4 deletions packages/magicbell-js/docs/project-client/models/ExpoTokenCollection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Properties**

| Name | Type | Required | Description |
| :---- | :---------- | :------- | :---------- |
| data | ExpoToken[] | ❌ | |
| links | Links | ❌ | |
| Name | Type | Required | Description |
| :---- | :-------------------------- | :------- | :---------- |
| data | [ExpoToken](ExpoToken.md)[] | ❌ | |
| links | [Links](Links.md) | ❌ | |
10 changes: 5 additions & 5 deletions packages/magicbell-js/docs/project-client/models/FcmConfig.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 |
| :----- | :--------------- | :------- | :---------- |
| config | FcmConfigPayload | ✅ | |
| id | string | ✅ | |
| name | string | ✅ | |
| Name | Type | Required | Description |
| :----- | :-------------------------------------- | :------- | :---------- |
| config | [FcmConfigPayload](FcmConfigPayload.md) | ✅ | |
| id | string | ✅ | |
| name | string | ✅ | |
8 changes: 4 additions & 4 deletions packages/magicbell-js/docs/project-client/models/FcmConfigCollection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Properties**

| Name | Type | Required | Description |
| :---- | :---------- | :------- | :---------- |
| data | FcmConfig[] | ❌ | |
| links | Links | ❌ | |
| Name | Type | Required | Description |
| :---- | :-------------------------- | :------- | :---------- |
| data | [FcmConfig](FcmConfig.md)[] | ❌ | |
| links | [Links](Links.md) | ❌ | |
8 changes: 4 additions & 4 deletions packages/magicbell-js/docs/project-client/models/FcmTokenCollection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Properties**

| Name | Type | Required | Description |
| :---- | :--------- | :------- | :---------- |
| data | FcmToken[] | ❌ | |
| links | Links | ❌ | |
| Name | Type | Required | Description |
| :---- | :------------------------ | :------- | :---------- |
| data | [FcmToken](FcmToken.md)[] | ❌ | |
| links | [Links](Links.md) | ❌ | |
22 changes: 22 additions & 0 deletions packages/magicbell-js/docs/project-client/models/GetRunResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# GetRunResponse

**Properties**

| Name | Type | Required | Description |
| :---------- | :------------------- | :------- | :---------- |
| createdAt | string | ❌ | |
| id | string | ❌ | |
| status | GetRunResponseStatus | ❌ | |
| workflowKey | string | ❌ | |

# GetRunResponseStatus

**Properties**

| Name | Type | Required | Description |
| :---------- | :----- | :------- | :---------- |
| completedAt | string | ❌ | |
| error | string | ❌ | |
| nextStep | number | ❌ | |
| startedAt | string | ❌ | |
| state | number | ❌ | |
10 changes: 5 additions & 5 deletions packages/magicbell-js/docs/project-client/models/GithubConfig.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 |
| :----- | :------------------ | :------- | :---------- |
| config | GithubConfigPayload | ✅ | |
| id | string | ✅ | |
| name | string | ✅ | |
| Name | Type | Required | Description |
| :----- | :-------------------------------------------- | :------- | :---------- |
| config | [GithubConfigPayload](GithubConfigPayload.md) | ✅ | |
| id | string | ✅ | |
| name | string | ✅ | |
Loading
Loading