chore: 🐝 Update SDK - Generate 0.3.0 (#51)

* ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.494.0 * empty commit to trigger [run-tests] workflow --------- Co-authored-by: speakeasybot <[email protected]> Co-authored-by: speakeasy-github[bot] <128539517+speakeasy-github[bot]@users.noreply.github.com>
novuhq · Feb 21, 2025 · cc44b8e · cc44b8e
1 parent 5b4ccac
commit cc44b8e
Show file tree

Hide file tree

Showing 98 changed files with 2,218 additions and 602 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: 6bff3a53-3f0b-40b4-942f-ff70dc583ae5
 management:
-  docChecksum: a3b9e1f5c5fd6328866eea116d03a7a6
+  docChecksum: e581b83557f00a8a1f177ccc3d920d23
   docVersion: "1.0"
-  speakeasyVersion: 1.490.0
-  generationVersion: 2.512.0
-  releaseVersion: 0.2.1
-  configChecksum: f58cb0b941edc8bdebac2443dea15081
+  speakeasyVersion: 1.494.0
+  generationVersion: 2.515.0
+  releaseVersion: 0.3.0
+  configChecksum: 35683929341d803bc9d28ca5eb899567
   repoURL: https://github.com/novuhq/novu-ts.git
   installationURL: https://github.com/novuhq/novu-ts
   published: true
@@ -15,7 +15,7 @@ features:
     acceptHeaders: 2.81.2
     additionalDependencies: 0.1.0
     constsAndDefaults: 0.1.11
-    core: 3.19.0
+    core: 3.20.0
     defaultEnabledRetries: 0.1.0
     deprecations: 2.81.1
     enumUnions: 0.1.0
@@ -80,7 +80,6 @@ generatedFiles:
   - docs/models/components/createintegrationrequestdto.md
   - docs/models/components/createintegrationrequestdtochannel.md
   - docs/models/components/createsubscriberrequestdto.md
-  - docs/models/components/createsubscriberrequestdtodata.md
   - docs/models/components/createtopicrequestdto.md
   - docs/models/components/createtopicresponsedto.md
   - docs/models/components/credentialsdto.md
@@ -216,6 +215,7 @@ generatedFiles:
   - docs/models/components/weekdays.md
   - docs/models/components/workflowinfodto.md
   - docs/models/components/workflowintegrationstatus.md
+  - docs/models/components/workfloworiginenum.md
   - docs/models/components/workflowpreferencedto.md
   - docs/models/components/workflowresponse.md
   - docs/models/components/workflowresponsedata.md
@@ -515,6 +515,7 @@ generatedFiles:
   - src/models/components/updatesubscriberchannelrequestdto.ts
   - src/models/components/updatesubscriberonlineflagrequestdto.ts
   - src/models/components/workflowinfodto.ts
+  - src/models/components/workfloworiginenum.ts
   - src/models/components/workflowpreferencedto.ts
   - src/models/components/workflowresponse.ts
   - src/models/errors/errordto.ts
@@ -586,6 +587,7 @@ generatedFiles:
   - src/sdk/subscribers.ts
   - src/sdk/topics.ts
   - src/sdk/webhooks.ts
+  - src/types/async.ts
   - src/types/blobs.ts
   - src/types/constdatetime.ts
   - src/types/enums.ts
@@ -674,6 +676,7 @@ examples:
       parameters:
         query:
           page: 0
+          limit: 10
         header: {}
       responses:
         "200":

diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -7,14 +7,15 @@ generation:
   useClassNamesForArrayFields: true
   fixes:
     nameResolutionDec2023: true
+    nameResolutionFeb2025: false
     parameterOrderingFeb2024: true
     requestResponseComponentNamesFeb2024: true
     securityFeb2025: false
   auth:
     oAuth2ClientCredentialsEnabled: false
     oAuth2PasswordEnabled: false
 typescript:
-  version: 0.2.1
+  version: 0.3.0
   additionalDependencies:
     dependencies: {}
     devDependencies: {}

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,21 +1,21 @@
-speakeasyVersion: 1.490.0
+speakeasyVersion: 1.494.0
 sources:
     json-development:
         sourceNamespace: json-development
-        sourceRevisionDigest: sha256:2e0c21308626b21c71d084379fa94efbd8f2a9f460b9767db02ab81cf314ab3f
-        sourceBlobDigest: sha256:07b6df397e8f8c7e1e1ba33ef2aa72bd74f9c14abc9962bf0b25ca4e761143ff
+        sourceRevisionDigest: sha256:5b534f729df60d25ae9a868905689010f8c0985a8efaeb9b54bf783e4cf64580
+        sourceBlobDigest: sha256:3901a42e01b82ed5e37f76a1d5e38efd6c354a41d4a8e04b57cbde9f4649ed5f
         tags:
             - latest
-            - speakeasy-sdk-regen-1739439575
+            - speakeasy-sdk-regen-1739492253
             - "1.0"
 targets:
     my-first-target:
         source: json-development
         sourceNamespace: json-development
-        sourceRevisionDigest: sha256:2e0c21308626b21c71d084379fa94efbd8f2a9f460b9767db02ab81cf314ab3f
-        sourceBlobDigest: sha256:07b6df397e8f8c7e1e1ba33ef2aa72bd74f9c14abc9962bf0b25ca4e761143ff
+        sourceRevisionDigest: sha256:5b534f729df60d25ae9a868905689010f8c0985a8efaeb9b54bf783e4cf64580
+        sourceBlobDigest: sha256:3901a42e01b82ed5e37f76a1d5e38efd6c354a41d4a8e04b57cbde9f4649ed5f
         codeSamplesNamespace: code-samples-typescript
-        codeSamplesRevisionDigest: sha256:1bdbb60d60c4cdcb79ff769cc7bcdded3265112307e8d9d5e81804388d72afe1
+        codeSamplesRevisionDigest: sha256:0b78d306f2233cea5fc76344b40b2672232da2e23be91bd930799d216524c204
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

diff --git a/README.md b/README.md
@@ -560,10 +560,10 @@ In some rare cases, the SDK can fail to get a response from the server or even m
 
 You can override the default server globally by passing a server index to the `serverIdx: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
 
-| #   | Server                   |
-| --- | ------------------------ |
-| 0   | `https://api.novu.co`    |
-| 1   | `https://eu.api.novu.co` |
+| #   | Server                   | Description |
+| --- | ------------------------ | ----------- |
+| 0   | `https://api.novu.co`    |             |
+| 1   | `https://eu.api.novu.co` |             |
 
 #### Example
 

diff --git a/RELEASES.md b/RELEASES.md
@@ -88,4 +88,14 @@ Based on:
 ### Generated
 - [typescript v0.2.1] .
 ### Releases
-- [NPM v0.2.1] https://www.npmjs.com/package/@novu/api/v/0.2.1 - .
+- [NPM v0.2.1] https://www.npmjs.com/package/@novu/api/v/0.2.1 - .
+
+## 2025-02-19 00:17:17
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.494.0 (2.515.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.3.0] .
+### Releases
+- [NPM v0.3.0] https://www.npmjs.com/package/@novu/api/v/0.3.0 - .
diff --git a/docs/models/components/activitygraphstatesresponse.md b/docs/models/components/activitygraphstatesresponse.md
@@ -7,7 +7,7 @@ import { ActivityGraphStatesResponse } from "@novu/api/models/components";
 
 let value: ActivityGraphStatesResponse = {
   id: "<id>",
-  count: 4358.65,
+  count: 8919.24,
   templates: [
     "<value>",
   ],

diff --git a/docs/models/components/activitynotificationtemplateresponsedto.md b/docs/models/components/activitynotificationtemplateresponsedto.md
@@ -27,4 +27,5 @@ let value: ActivityNotificationTemplateResponseDto = {
 | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
 | `id`                                                                                     | *string*                                                                                 | :heavy_minus_sign:                                                                       | Unique identifier of the template                                                        |
 | `name`                                                                                   | *string*                                                                                 | :heavy_check_mark:                                                                       | Name of the template                                                                     |
+| `origin`                                                                                 | [components.WorkflowOriginEnum](../../models/components/workfloworiginenum.md)           | :heavy_minus_sign:                                                                       | Origin of the workflow                                                                   |
 | `triggers`                                                                               | [components.NotificationTriggerDto](../../models/components/notificationtriggerdto.md)[] | :heavy_check_mark:                                                                       | Triggers of the template                                                                 |
diff --git a/docs/models/components/activitystatsresponsedto.md b/docs/models/components/activitystatsresponsedto.md
@@ -6,8 +6,8 @@
 import { ActivityStatsResponseDto } from "@novu/api/models/components";
 
 let value: ActivityStatsResponseDto = {
-  weeklySent: 4314.18,
-  monthlySent: 8965.47,
+  weeklySent: 8965.47,
+  monthlySent: 3675.62,
 };
 ```
 

diff --git a/docs/models/components/channel.md b/docs/models/components/channel.md
@@ -7,7 +7,7 @@ The channel type for the integration, which defines how the integration communic
 ```typescript
 import { Channel } from "@novu/api/models/components";
 
-let value: Channel = "push";
+let value: Channel = "chat";
 ```
 
 ## Values

diff --git a/docs/models/components/channels.md b/docs/models/components/channels.md
@@ -5,7 +5,7 @@
 ```typescript
 import { Channels } from "@novu/api/models/components";
 
-let value: Channels = "email";
+let value: Channels = "sms";
 ```
 
 ## Values

diff --git a/docs/models/components/channelsettingsdto.md b/docs/models/components/channelsettingsdto.md
@@ -6,7 +6,7 @@
 import { ChannelSettingsDto } from "@novu/api/models/components";
 
 let value: ChannelSettingsDto = {
-  providerId: "msteams",
+  providerId: "fcm",
   credentials: {
     webhookUrl: "https://example.com/webhook",
     channel: "general",

diff --git a/docs/models/components/channelsettingsdtoproviderid.md b/docs/models/components/channelsettingsdtoproviderid.md
@@ -7,7 +7,7 @@ The provider identifier for the credentials
 ```typescript
 import { ChannelSettingsDtoProviderId } from "@novu/api/models/components";
 
-let value: ChannelSettingsDtoProviderId = "pushpad";
+let value: ChannelSettingsDtoProviderId = "msteams";
 ```
 
 ## Values

diff --git a/docs/models/components/channeltypeenum.md b/docs/models/components/channeltypeenum.md
@@ -7,7 +7,7 @@ Channel type through which the message is sent
 ```typescript
 import { ChannelTypeEnum } from "@novu/api/models/components";
 
-let value: ChannelTypeEnum = "chat";
+let value: ChannelTypeEnum = "sms";
 ```
 
 ## Values

diff --git a/docs/models/components/createintegrationrequestdto.md b/docs/models/components/createintegrationrequestdto.md
@@ -7,7 +7,7 @@ import { CreateIntegrationRequestDto } from "@novu/api/models/components";
 
 let value: CreateIntegrationRequestDto = {
   providerId: "<id>",
-  channel: "push",
+  channel: "chat",
 };
 ```
 

diff --git a/docs/models/components/createintegrationrequestdtochannel.md b/docs/models/components/createintegrationrequestdtochannel.md
@@ -7,7 +7,7 @@ The channel type for the integration
 ```typescript
 import { CreateIntegrationRequestDtoChannel } from "@novu/api/models/components";
 
-let value: CreateIntegrationRequestDtoChannel = "in_app";
+let value: CreateIntegrationRequestDtoChannel = "push";
 ```
 
 ## Values

diff --git a/docs/models/components/createsubscriberrequestdto.md b/docs/models/components/createsubscriberrequestdto.md
@@ -12,14 +12,14 @@ let value: CreateSubscriberRequestDto = {
 
 ## Fields
 
-| Field                                                                                                             | Type                                                                                                              | Required                                                                                                          | Description                                                                                                       |
-| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
-| `subscriberId`                                                                                                    | *string*                                                                                                          | :heavy_check_mark:                                                                                                | The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems |
-| `email`                                                                                                           | *string*                                                                                                          | :heavy_minus_sign:                                                                                                | The email address of the subscriber.                                                                              |
-| `firstName`                                                                                                       | *string*                                                                                                          | :heavy_minus_sign:                                                                                                | The first name of the subscriber.                                                                                 |
-| `lastName`                                                                                                        | *string*                                                                                                          | :heavy_minus_sign:                                                                                                | The last name of the subscriber.                                                                                  |
-| `phone`                                                                                                           | *string*                                                                                                          | :heavy_minus_sign:                                                                                                | The phone number of the subscriber.                                                                               |
-| `avatar`                                                                                                          | *string*                                                                                                          | :heavy_minus_sign:                                                                                                | An HTTP URL to the profile image of your subscriber.                                                              |
-| `locale`                                                                                                          | *string*                                                                                                          | :heavy_minus_sign:                                                                                                | The locale of the subscriber.                                                                                     |
-| `data`                                                                                                            | Record<string, *components.CreateSubscriberRequestDtoData*>                                                       | :heavy_minus_sign:                                                                                                | An optional payload object that can contain any properties.                                                       |
-| `channels`                                                                                                        | [components.SubscriberChannelDto](../../models/components/subscriberchanneldto.md)[]                              | :heavy_minus_sign:                                                                                                | An optional array of subscriber channels.                                                                         |
+| Field                                     | Type                                      | Required                                  | Description                               |
+| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
+| `subscriberId`                            | *string*                                  | :heavy_check_mark:                        | Unique identifier of the subscriber       |
+| `firstName`                               | *string*                                  | :heavy_minus_sign:                        | First name of the subscriber              |
+| `lastName`                                | *string*                                  | :heavy_minus_sign:                        | Last name of the subscriber               |
+| `email`                                   | *string*                                  | :heavy_minus_sign:                        | Email address of the subscriber           |
+| `phone`                                   | *string*                                  | :heavy_minus_sign:                        | Phone number of the subscriber            |
+| `avatar`                                  | *string*                                  | :heavy_minus_sign:                        | Avatar URL or identifier                  |
+| `timezone`                                | *string*                                  | :heavy_minus_sign:                        | Timezone of the subscriber                |
+| `locale`                                  | *string*                                  | :heavy_minus_sign:                        | Locale of the subscriber                  |
+| `data`                                    | Record<string, *any*>                     | :heavy_minus_sign:                        | Additional custom data for the subscriber |
diff --git a/docs/models/components/createsubscriberrequestdtodata.md b/docs/models/components/createsubscriberrequestdtodata.md
diff --git a/docs/models/components/integrationresponsedto.md b/docs/models/components/integrationresponsedto.md
@@ -11,7 +11,7 @@ let value: IntegrationResponseDto = {
   name: "<value>",
   identifier: "<value>",
   providerId: "<id>",
-  channel: "chat",
+  channel: "in_app",
   credentials: {},
   active: false,
   deleted: false,

diff --git a/docs/models/components/listsubscribersresponsedto.md b/docs/models/components/listsubscribersresponsedto.md
@@ -32,8 +32,8 @@ let value: ListSubscribersResponseDto = {
       organizationId: "<id>",
       environmentId: "<id>",
       deleted: false,
-      createdAt: "1734646828003",
-      updatedAt: "1739423392882",
+      createdAt: "1735131063107",
+      updatedAt: "1739907627986",
     },
   ],
   next: "<value>",

diff --git a/docs/models/components/messageresponsedto.md b/docs/models/components/messageresponsedto.md
@@ -37,10 +37,10 @@ let value: MessageResponseDto = {
     organizationId: "<id>",
     environmentId: "<id>",
     deleted: false,
-    createdAt: "1709617644175",
-    updatedAt: "1739370920929",
+    createdAt: "1710101879274",
+    updatedAt: "1739855156028",
   },
-  createdAt: "1708488144722",
+  createdAt: "1708972379821",
   content: "<value>",
   transactionId: "<id>",
   channel: "email",