relaunch (#33)

novuhq · Dec 4, 2024 · d2ef592 · d2ef592
1 parent ff7f65b
commit d2ef592
Show file tree

Hide file tree

Showing 70 changed files with 265 additions and 227 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: a4c968a941c2a70a0b9dc69fc32824f6
+  docChecksum: c80170a573b597fb86409c24caaf5768
   docVersion: "1.0"
   speakeasyVersion: 1.451.1
   generationVersion: 2.470.1
-  releaseVersion: 0.0.1-alpha.49
-  configChecksum: cd5955a27ad9c6d63f20386dd1c0d1ae
+  releaseVersion: 0.0.1-alpha.51
+  configChecksum: ff1ed64ee49c5df31c8a02844f336ee5
   published: true
 features:
   typescript:
@@ -59,7 +59,6 @@ generatedFiles:
   - docs/models/components/channelpreferencetype.md
   - docs/models/components/channels.md
   - docs/models/components/channelsettings.md
-  - docs/models/components/channelsettingsproviderid.md
   - docs/models/components/content.md
   - docs/models/components/controls.md
   - docs/models/components/createintegrationrequestdto.md

diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -13,7 +13,7 @@ generation:
     oAuth2ClientCredentialsEnabled: false
     oAuth2PasswordEnabled: false
 typescript:
-  version: 0.0.1-alpha.49
+  version: 0.0.1-alpha.51
   additionalDependencies:
     dependencies: {}
     devDependencies: {}

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -2,19 +2,19 @@ speakeasyVersion: 1.451.1
 sources:
     json-development:
         sourceNamespace: json-development
-        sourceRevisionDigest: sha256:2a48dbb7b26846c65c91bcbbf6a00e2caae34bed35d6783113dbf8f9eafc6b26
-        sourceBlobDigest: sha256:8bf9ac8f56e9b783c1d587a0283d6b4c3bed24c6ee63b181831b3a3440e96425
+        sourceRevisionDigest: sha256:8f0009bb0f06e2d8e222d20dcad1c3d2f8ce41dcd3300740bb4314adcff38576
+        sourceBlobDigest: sha256:431b08ef9d3ec5aefc9282bb31272647c54513deae9a753b411420340f106d4b
         tags:
             - latest
             - "1.0"
 targets:
     my-first-target:
         source: json-development
         sourceNamespace: json-development
-        sourceRevisionDigest: sha256:2a48dbb7b26846c65c91bcbbf6a00e2caae34bed35d6783113dbf8f9eafc6b26
-        sourceBlobDigest: sha256:8bf9ac8f56e9b783c1d587a0283d6b4c3bed24c6ee63b181831b3a3440e96425
+        sourceRevisionDigest: sha256:8f0009bb0f06e2d8e222d20dcad1c3d2f8ce41dcd3300740bb4314adcff38576
+        sourceBlobDigest: sha256:431b08ef9d3ec5aefc9282bb31272647c54513deae9a753b411420340f106d4b
         codeSamplesNamespace: code-samples-typescript
-        codeSamplesRevisionDigest: sha256:615ee2362175484c0efe9e70554cef37f6c4602224846a2bc0a0893536a54b41
+        codeSamplesRevisionDigest: sha256:1ed7a6887524cc5469aa86bb6ce08a216f8190679ac47debb608e29640b8141b
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

diff --git a/docs/models/components/activitiesresponsedto.md b/docs/models/components/activitiesresponsedto.md
@@ -14,8 +14,8 @@ let value: ActivitiesResponseDto = {
       transactionId: "<id>",
     },
   ],
-  pageSize: 4686.51,
-  page: 9767.61,
+  pageSize: 9767.61,
+  page: 6048.46,
 };
 ```
 

diff --git a/docs/models/components/activitygraphstatesresponse.md b/docs/models/components/activitygraphstatesresponse.md
@@ -7,12 +7,12 @@ import { ActivityGraphStatesResponse } from "@novu/api/models/components";
 
 let value: ActivityGraphStatesResponse = {
   id: "<id>",
-  count: 1201.97,
+  count: 2961.40,
   templates: [
     "<value>",
   ],
   channels: [
-    "email",
+    "in_app",
   ],
 };
 ```

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

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: 7392.64,
-  monthlySent: 391.88,
+  weeklySent: 391.88,
+  monthlySent: 2828.07,
 };
 ```
 

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

diff --git a/docs/models/components/bulksubscribercreatedto.md b/docs/models/components/bulksubscribercreatedto.md
@@ -14,6 +14,6 @@ let value: BulkSubscriberCreateDto = {
 
 ## Fields
 
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `subscribers`      | *string*[]         | :heavy_check_mark: | N/A                |
+| Field                                          | Type                                           | Required                                       | Description                                    |
+| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
+| `subscribers`                                  | *string*[]                                     | :heavy_check_mark:                             | An array of subscribers to be created in bulk. |
diff --git a/docs/models/components/bulktriggereventdto.md b/docs/models/components/bulktriggereventdto.md
@@ -18,7 +18,8 @@ let value: BulkTriggerEventDto = {
       overrides: {},
       to: [
         {
-          subscriberId: "<id>",
+          topicKey: "<value>",
+          type: "Topic",
         },
       ],
     },

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

diff --git a/docs/models/components/channelcredentials.md b/docs/models/components/channelcredentials.md
@@ -6,7 +6,7 @@
 import { ChannelCredentials } from "@novu/api/models/components";
 
 let value: ChannelCredentials = {
-  webhookUrl: "https://remarkable-dream.net/",
+  webhookUrl: "https://finished-receptor.org",
 };
 ```
 

diff --git a/docs/models/components/channelcredentialsdto.md b/docs/models/components/channelcredentialsdto.md
@@ -10,7 +10,7 @@ let value: ChannelCredentialsDto = {};
 
 ## Fields
 
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `webhookUrl`       | *string*           | :heavy_minus_sign: | N/A                |
-| `deviceTokens`     | *string*[]         | :heavy_minus_sign: | N/A                |
+| Field                                                | Type                                                 | Required                                             | Description                                          |
+| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
+| `webhookUrl`                                         | *string*                                             | :heavy_minus_sign:                                   | The URL for the webhook associated with the channel. |
+| `deviceTokens`                                       | *string*[]                                           | :heavy_minus_sign:                                   | An array of device tokens for push notifications.    |
diff --git a/docs/models/components/channelpreference.md b/docs/models/components/channelpreference.md
@@ -6,7 +6,7 @@
 import { ChannelPreference } from "@novu/api/models/components";
 
 let value: ChannelPreference = {
-  type: "push",
+  type: "chat",
   enabled: false,
 };
 ```

diff --git a/docs/models/components/channelpreferencetype.md b/docs/models/components/channelpreferencetype.md
@@ -7,7 +7,7 @@ The type of channel that is enabled or not
 ```typescript
 import { ChannelPreferenceType } from "@novu/api/models/components";
 
-let value: ChannelPreferenceType = "sms";
+let value: ChannelPreferenceType = "push";
 ```
 
 ## 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 = "digest";
+let value: Channels = "trigger";
 ```
 
 ## Values

diff --git a/docs/models/components/channelsettings.md b/docs/models/components/channelsettings.md
@@ -6,19 +6,19 @@
 import { ChannelSettings } from "@novu/api/models/components";
 
 let value: ChannelSettings = {
-  providerId: "ryver",
+  providerId: "mattermost",
   credentials: {
-    webhookUrl: "https://outrageous-agreement.net/",
+    webhookUrl: "https://ajar-solvency.com",
   },
   integrationId: "<id>",
 };
 ```
 
 ## Fields
 
-| Field                                                                                        | Type                                                                                         | Required                                                                                     | Description                                                                                  |
-| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
-| `providerId`                                                                                 | [components.ChannelSettingsProviderId](../../models/components/channelsettingsproviderid.md) | :heavy_check_mark:                                                                           | The provider identifier for the credentials                                                  |
-| `integrationIdentifier`                                                                      | *string*                                                                                     | :heavy_minus_sign:                                                                           | The integration identifier                                                                   |
-| `credentials`                                                                                | [components.ChannelCredentials](../../models/components/channelcredentials.md)               | :heavy_check_mark:                                                                           | Credentials payload for the specified provider                                               |
-| `integrationId`                                                                              | *string*                                                                                     | :heavy_check_mark:                                                                           | Id of the integration that is used for this channel                                          |
+| Field                                                                          | Type                                                                           | Required                                                                       | Description                                                                    |
+| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
+| `providerId`                                                                   | [components.ProviderId](../../models/components/providerid.md)                 | :heavy_check_mark:                                                             | The provider identifier for the credentials                                    |
+| `integrationIdentifier`                                                        | *string*                                                                       | :heavy_minus_sign:                                                             | The integration identifier                                                     |
+| `credentials`                                                                  | [components.ChannelCredentials](../../models/components/channelcredentials.md) | :heavy_check_mark:                                                             | Credentials payload for the specified provider                                 |
+| `integrationId`                                                                | *string*                                                                       | :heavy_check_mark:                                                             | Id of the integration that is used for this channel                            |
diff --git a/docs/models/components/channelsettingsproviderid.md b/docs/models/components/channelsettingsproviderid.md
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: "in_app",
+  channel: "chat",
 };
 ```
 

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