ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.322.3

novuhq · Jun 30, 2024 · c01a079 · c01a079
1 parent feeb718
commit c01a079
Show file tree

Hide file tree

Showing 190 changed files with 9,986 additions and 892 deletions.
diff --git a/.eslintrc.js → .eslintrc.cjs b/.eslintrc.js → .eslintrc.cjs
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
@@ -1,20 +1,20 @@
 lockVersion: 2.0.0
 id: f50499c4-d106-4975-983f-ead3a386ec53
 management:
-  docChecksum: 843588d509aa4de3a4d846ef57647cfc
+  docChecksum: 1eadec3f5478d02504091b0e2b5b2ee0
   docVersion: "1.0"
-  speakeasyVersion: 1.308.1
-  generationVersion: 2.342.6
-  releaseVersion: 0.0.1-alpha.8
-  configChecksum: 44795b95ebeff18a9bac44fee44a664c
+  speakeasyVersion: 1.322.3
+  generationVersion: 2.354.2
+  releaseVersion: 0.0.1-alpha.9
+  configChecksum: 29fb899ef19d96629eaf20333f0647b0
   repoURL: https://github.com/novuhq/novu-node.git
   installationURL: https://github.com/novuhq/novu-node
   published: true
 features:
   typescript:
     additionalDependencies: 0.1.0
     constsAndDefaults: 0.1.5
-    core: 3.9.14
+    core: 3.10.2
     deprecations: 2.81.1
     examples: 2.81.4
     flattening: 2.81.1
@@ -61,7 +61,7 @@ generatedFiles:
   - src/sdk/status.ts
   - src/sdk/workflows.ts
   - src/sdk/sdk.ts
-  - .eslintrc.js
+  - .eslintrc.cjs
   - .npmignore
   - RUNTIMES.md
   - jsr.json
@@ -530,6 +530,7 @@ generatedFiles:
   - docs/models/operations/subscriberscontrollergetunseencountrequest.md
   - docs/models/operations/subscriberscontrollerupdatesubscriberonlineflagrequest.md
   - docs/models/operations/subscriberscontrollerlistsubscriberpreferencesrequest.md
+  - docs/models/operations/parameter.md
   - docs/models/operations/subscriberscontrollergetsubscriberpreferencebylevelrequest.md
   - docs/models/operations/subscriberscontrollerupdatesubscriberpreferencerequest.md
   - docs/models/operations/subscriberscontrollerupdatesubscriberglobalpreferencesrequest.md

diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -11,7 +11,7 @@ generation:
   auth:
     oAuth2ClientCredentialsEnabled: false
 typescript:
-  version: 0.0.1-alpha.8
+  version: 0.0.1-alpha.9
   additionalDependencies:
     dependencies: {}
     devDependencies: {}
@@ -36,3 +36,4 @@ typescript:
   packageName: '@novu/api'
   responseFormat: flat
   templateVersion: v2
+  useIndexModules: true
diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,20 +1,21 @@
-speakeasyVersion: 1.308.1
+speakeasyVersion: 1.322.3
 sources:
     json-development:
         sourceNamespace: json-development
-        sourceRevisionDigest: sha256:1bc7354bf3d77f5041f4a62ff46949898a6e56bfebddd50406db841adbe08f6e
-        sourceBlobDigest: sha256:aef7e5b403d20e17858ce338f35a9e6bb056e3ea3e7a98c3def0d89ecfeb95b3
+        sourceRevisionDigest: sha256:9aaa2cefb426a15cee5a49a925f699de098a471674151d8e4ff677c3c9ce0da3
+        sourceBlobDigest: sha256:be824c6647996617fb6fd7ea6b234c66f101d67d28a79402f53258bbd957c404
         tags:
             - latest
+            - main
 targets:
     my-first-target:
         source: json-development
         sourceNamespace: json-development
-        sourceRevisionDigest: sha256:1bc7354bf3d77f5041f4a62ff46949898a6e56bfebddd50406db841adbe08f6e
-        sourceBlobDigest: sha256:aef7e5b403d20e17858ce338f35a9e6bb056e3ea3e7a98c3def0d89ecfeb95b3
+        sourceRevisionDigest: sha256:9aaa2cefb426a15cee5a49a925f699de098a471674151d8e4ff677c3c9ce0da3
+        sourceBlobDigest: sha256:be824c6647996617fb6fd7ea6b234c66f101d67d28a79402f53258bbd957c404
         codeSamplesNamespace: code-samples-typescript
-        codeSamplesRevisionDigest: sha256:8bcf1a1d27d468c4289986ffc8eb9789bc81a6d0f5abcac77ddd6d8f5b43b832
-        outLocation: /Users/da/code/misc/novu-node
+        codeSamplesRevisionDigest: sha256:33324b9421a6105c75147afd9d70c354c7a6ad0f5e48327905d8171c613522a8
+        outLocation: /github/workspace/repo
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest
@@ -35,6 +36,6 @@ workflow:
                 npm:
                     token: $npm_token
             codeSamples:
-                output: sources/code-samples.json
+                output: sources/code-samples.yaml
                 registry:
                     location: registry.speakeasyapi.dev/novu/novu/code-samples-typescript
diff --git a/README.md b/README.md
@@ -15,10 +15,25 @@
 npm add @novu/api
 ```
 
+### PNPM
+
+```bash
+pnpm add @novu/api
+```
+
+### Bun
+
+```bash
+bun add @novu/api
+```
+
 ### Yarn
 
 ```bash
-yarn add @novu/api
+yarn add @novu/api zod
+
+# Note that Yarn does not install peer dependencies automatically. You will need
+# to install zod as shown above.
 ```
 <!-- End SDK Installation [installation] -->
 
@@ -35,7 +50,6 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 
 ```typescript
 import { Novu } from "@novu/api";
-import { TopicPayloadDtoType } from "@novu/api/models/components";
 
 const novu = new Novu({
     apiKey: "<YOUR_API_KEY_HERE>",
@@ -49,7 +63,7 @@ async function run() {
         to: [
             {
                 topicKey: "topic_key",
-                type: TopicPayloadDtoType.Topic,
+                type: "Topic",
             },
         ],
     });
@@ -292,8 +306,7 @@ Validation errors can also occur when either method arguments or data returned f
 
 ```typescript
 import { Novu } from "@novu/api";
-import { TopicPayloadDtoType } from "@novu/api/models/components";
-import * as errors from "@novu/api/models/errors";
+import { SDKValidationError } from "@novu/api/models/errors";
 
 const novu = new Novu({
     apiKey: "<YOUR_API_KEY_HERE>",
@@ -309,13 +322,13 @@ async function run() {
             to: [
                 {
                     topicKey: "topic_key",
-                    type: TopicPayloadDtoType.Topic,
+                    type: "Topic",
                 },
             ],
         });
     } catch (err) {
         switch (true) {
-            case err instanceof errors.SDKValidationError: {
+            case err instanceof SDKValidationError: {
                 // Validation errors can be pretty-printed
                 console.error(err.pretty());
                 // Raw value may also be inspected
@@ -351,7 +364,6 @@ You can override the default server globally by passing a server index to the `s
 
 ```typescript
 import { Novu } from "@novu/api";
-import { TopicPayloadDtoType } from "@novu/api/models/components";
 
 const novu = new Novu({
     serverIdx: 1,
@@ -366,7 +378,7 @@ async function run() {
         to: [
             {
                 topicKey: "topic_key",
-                type: TopicPayloadDtoType.Topic,
+                type: "Topic",
             },
         ],
     });
@@ -386,7 +398,6 @@ The default server can also be overridden globally by passing a URL to the `serv
 
 ```typescript
 import { Novu } from "@novu/api";
-import { TopicPayloadDtoType } from "@novu/api/models/components";
 
 const novu = new Novu({
     serverURL: "https://api.novu.co",
@@ -401,7 +412,7 @@ async function run() {
         to: [
             {
                 topicKey: "topic_key",
-                type: TopicPayloadDtoType.Topic,
+                type: "Topic",
             },
         ],
     });
@@ -478,7 +489,6 @@ This SDK supports the following security scheme globally:
 To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:
 ```typescript
 import { Novu } from "@novu/api";
-import { TopicPayloadDtoType } from "@novu/api/models/components";
 
 const novu = new Novu({
     apiKey: "<YOUR_API_KEY_HERE>",
@@ -492,7 +502,7 @@ async function run() {
         to: [
             {
                 topicKey: "topic_key",
-                type: TopicPayloadDtoType.Topic,
+                type: "Topic",
             },
         ],
     });
@@ -514,7 +524,6 @@ Some of the endpoints in this SDK support retries.  If you use the SDK without a
 To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
 ```typescript
 import { Novu } from "@novu/api";
-import { TopicPayloadDtoType } from "@novu/api/models/components";
 
 const novu = new Novu({
     apiKey: "<YOUR_API_KEY_HERE>",
@@ -529,7 +538,7 @@ async function run() {
             to: [
                 {
                     topicKey: "topic_key",
-                    type: TopicPayloadDtoType.Topic,
+                    type: "Topic",
                 },
             ],
         },
@@ -558,7 +567,6 @@ run();
 If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
 ```typescript
 import { Novu } from "@novu/api";
-import { TopicPayloadDtoType } from "@novu/api/models/components";
 
 const novu = new Novu({
     retryConfig: {
@@ -582,7 +590,7 @@ async function run() {
         to: [
             {
                 topicKey: "topic_key",
-                type: TopicPayloadDtoType.Topic,
+                type: "Topic",
             },
         ],
     });

diff --git a/RELEASES.md b/RELEASES.md
@@ -18,4 +18,14 @@ Based on:
 ### Generated
 - [typescript v0.0.1-alpha.6] .
 ### Releases
-- [NPM v0.0.1-alpha.6] https://www.npmjs.com/package/@novu/api/v/0.0.1-alpha.6 - .
+- [NPM v0.0.1-alpha.6] https://www.npmjs.com/package/@novu/api/v/0.0.1-alpha.6 - .
+
+## 2024-06-30 00:16:00
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.322.3 (2.354.2) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.0.1-alpha.9] .
+### Releases
+- [NPM v0.0.1-alpha.9] https://www.npmjs.com/package/@novu/api/v/0.0.1-alpha.9 - .
diff --git a/USAGE.md b/USAGE.md
@@ -3,7 +3,6 @@
 
 ```typescript
 import { Novu } from "@novu/api";
-import { TopicPayloadDtoType } from "@novu/api/models/components";
 
 const novu = new Novu({
     apiKey: "<YOUR_API_KEY_HERE>",
@@ -17,7 +16,7 @@ async function run() {
         to: [
             {
                 topicKey: "topic_key",
-                type: TopicPayloadDtoType.Topic,
+                type: "Topic",
             },
         ],
     });

diff --git a/docs/models/components/actor.md b/docs/models/components/actor.md
@@ -4,3 +4,18 @@ It is used to display the Avatar of the provided actor's subscriber id or actor
     If a new actor object is provided, we will create a new subscriber in our system
 
 
+
+## Supported Types
+
+### `string`
+
+```typescript
+const value: string = /* values here */
+```
+
+### `components.SubscriberPayloadDto`
+
+```typescript
+const value: components.SubscriberPayloadDto = /* values here */
+```
+
diff --git a/docs/models/components/content.md b/docs/models/components/content.md
@@ -1,2 +1,17 @@
 # Content
 
+
+## Supported Types
+
+### `components.EmailBlock`
+
+```typescript
+const value: components.EmailBlock = /* values here */
+```
+
+### `string`
+
+```typescript
+const value: string = /* values here */
+```
+
diff --git a/docs/models/components/feedidentifier.md b/docs/models/components/feedidentifier.md
@@ -2,3 +2,18 @@
 
 Optional feed identifier or array of feed identifiers
 
+
+## Supported Types
+
+### `string`
+
+```typescript
+const value: string = /* values here */
+```
+
+### `string[]`
+
+```typescript
+const value: string[] = /* values here */
+```
+
diff --git a/docs/models/components/messageactionresulttype.md b/docs/models/components/messageactionresulttype.md
@@ -6,5 +6,4 @@
 | Name        | Value       |
 | ----------- | ----------- |
 | `Primary`   | primary     |
-| `Secondary` | secondary   |
-| `Clicked`   | clicked     |
+| `Secondary` | secondary   |
diff --git a/docs/models/components/messagebuttontype.md b/docs/models/components/messagebuttontype.md
@@ -6,5 +6,4 @@
 | Name        | Value       |
 | ----------- | ----------- |
 | `Primary`   | primary     |
-| `Secondary` | secondary   |
-| `Clicked`   | clicked     |
+| `Secondary` | secondary   |
diff --git a/docs/models/components/messageid.md b/docs/models/components/messageid.md
@@ -1,2 +1,17 @@
 # MessageId
 
+
+## Supported Types
+
+### `string`
+
+```typescript
+const value: string = /* values here */
+```
+
+### `string[]`
+
+```typescript
+const value: string[] = /* values here */
+```
+