change handle different content types

novuhq · Dec 20, 2024 · de8f0bd · de8f0bd
1 parent 3f8d041
commit de8f0bd
Show file tree

Hide file tree

Showing 72 changed files with 861 additions and 667 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: 81ddd8b7fd43f246d1713a14a3302b37
+  docChecksum: cba710e135508061c084776b3a4a1ccf
   docVersion: "1.0"
   speakeasyVersion: 1.456.1
   generationVersion: 2.481.0
-  releaseVersion: 0.0.1-alpha.144
-  configChecksum: fea77918fed907cf0fb2e1dfae3181d9
+  releaseVersion: 0.0.1-alpha.145
+  configChecksum: 8eded2f4a278abe6b04a5ff8a5ec72a3
   published: true
 features:
   typescript:
@@ -59,9 +59,11 @@ generatedFiles:
   - docs/models/components/bulkcreatesubscriberresponsedto.md
   - docs/models/components/bulksubscribercreatedto.md
   - docs/models/components/bulktriggereventdto.md
+  - docs/models/components/buttontypeenum.md
   - docs/models/components/channel.md
   - docs/models/components/channelcredentials.md
   - docs/models/components/channelcredentialsdto.md
+  - docs/models/components/channelctatypeenum.md
   - docs/models/components/channelpreference.md
   - docs/models/components/channelpreferencetype.md
   - docs/models/components/channels.md
@@ -96,10 +98,9 @@ generatedFiles:
   - docs/models/components/digesttimedmetadataunit.md
   - docs/models/components/emailblock.md
   - docs/models/components/emailblockstyles.md
-  - docs/models/components/emailblocktype.md
+  - docs/models/components/emailblocktypeenum.md
   - docs/models/components/failedassignmentsdto.md
   - docs/models/components/failedoperationdto.md
-  - docs/models/components/feedid.md
   - docs/models/components/feedidentifier.md
   - docs/models/components/feedresponsedto.md
   - docs/models/components/filtertopicsresponsedto.md
@@ -115,20 +116,16 @@ generatedFiles:
   - docs/models/components/messageaction.md
   - docs/models/components/messageactionresult.md
   - docs/models/components/messageactionresultpayload.md
-  - docs/models/components/messageactionresulttype.md
-  - docs/models/components/messageactionstatus.md
+  - docs/models/components/messageactionstatusenum.md
   - docs/models/components/messagebutton.md
-  - docs/models/components/messagebuttontype.md
   - docs/models/components/messagecta.md
   - docs/models/components/messagectadata.md
-  - docs/models/components/messagectatype.md
   - docs/models/components/messageid.md
   - docs/models/components/messagemarkasrequestdto.md
   - docs/models/components/messageresponsedto.md
-  - docs/models/components/messageresponsedtochannel.md
   - docs/models/components/messageresponsedtooverrides.md
   - docs/models/components/messageresponsedtopayload.md
-  - docs/models/components/messageresponsedtostatus.md
+  - docs/models/components/messagestatusenum.md
   - docs/models/components/messagetemplate.md
   - docs/models/components/messagetemplatedto.md
   - docs/models/components/metadata.md
@@ -173,7 +170,7 @@ generatedFiles:
   - docs/models/components/tenant.md
   - docs/models/components/tenantpayloaddto.md
   - docs/models/components/tenantpayloaddtodata.md
-  - docs/models/components/textalign.md
+  - docs/models/components/textalignenum.md
   - docs/models/components/timedconfig.md
   - docs/models/components/tlsoptions.md
   - docs/models/components/to.md
@@ -401,8 +398,10 @@ generatedFiles:
   - src/models/components/bulkcreatesubscriberresponsedto.ts
   - src/models/components/bulksubscribercreatedto.ts
   - src/models/components/bulktriggereventdto.ts
+  - src/models/components/buttontypeenum.ts
   - src/models/components/channelcredentials.ts
   - src/models/components/channelcredentialsdto.ts
+  - src/models/components/channelctatypeenum.ts
   - src/models/components/channelpreference.ts
   - src/models/components/channelsettings.ts
   - src/models/components/channeltypeenum.ts
@@ -421,6 +420,7 @@ generatedFiles:
   - src/models/components/digesttimedmetadata.ts
   - src/models/components/emailblock.ts
   - src/models/components/emailblockstyles.ts
+  - src/models/components/emailblocktypeenum.ts
   - src/models/components/failedassignmentsdto.ts
   - src/models/components/failedoperationdto.ts
   - src/models/components/feedresponsedto.ts
@@ -433,11 +433,13 @@ generatedFiles:
   - src/models/components/markmessageactionasseendto.ts
   - src/models/components/messageaction.ts
   - src/models/components/messageactionresult.ts
+  - src/models/components/messageactionstatusenum.ts
   - src/models/components/messagebutton.ts
   - src/models/components/messagecta.ts
   - src/models/components/messagectadata.ts
   - src/models/components/messagemarkasrequestdto.ts
   - src/models/components/messageresponsedto.ts
+  - src/models/components/messagestatusenum.ts
   - src/models/components/messagetemplate.ts
   - src/models/components/messagetemplatedto.ts
   - src/models/components/notificationfeeditemdto.ts
@@ -463,6 +465,7 @@ generatedFiles:
   - src/models/components/subscriberresponsedto.ts
   - src/models/components/templateresponse.ts
   - src/models/components/tenantpayloaddto.ts
+  - src/models/components/textalignenum.ts
   - src/models/components/timedconfig.ts
   - src/models/components/topicdto.ts
   - src/models/components/topicpayloaddto.ts

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.144
+  version: 0.0.1-alpha.145
   additionalDependencies:
     dependencies: {}
     devDependencies: {}

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -2,19 +2,19 @@ speakeasyVersion: 1.456.1
 sources:
     json-development:
         sourceNamespace: json-development
-        sourceRevisionDigest: sha256:87a816d6d17cc1c1f9809149350c6a4d792f83791b5542b15b9d4a57d249cf11
-        sourceBlobDigest: sha256:8a67d281e8db84236430c1ff0b441ba4676fdf26ba5d81ff1b6ea78124e8c99d
+        sourceRevisionDigest: sha256:39323a9fbd97f54ee2abba3359e99315a9d41da2e7bc2bc4f081bde9236d9e13
+        sourceBlobDigest: sha256:a0b3c12b6ec20fd4262e16c47d0e1f8d33cdced865c0cd3bd075eb4f4a8a6fc8
         tags:
             - latest
             - "1.0"
 targets:
     my-first-target:
         source: json-development
         sourceNamespace: json-development
-        sourceRevisionDigest: sha256:87a816d6d17cc1c1f9809149350c6a4d792f83791b5542b15b9d4a57d249cf11
-        sourceBlobDigest: sha256:8a67d281e8db84236430c1ff0b441ba4676fdf26ba5d81ff1b6ea78124e8c99d
+        sourceRevisionDigest: sha256:39323a9fbd97f54ee2abba3359e99315a9d41da2e7bc2bc4f081bde9236d9e13
+        sourceBlobDigest: sha256:a0b3c12b6ec20fd4262e16c47d0e1f8d33cdced865c0cd3bd075eb4f4a8a6fc8
         codeSamplesNamespace: code-samples-typescript
-        codeSamplesRevisionDigest: sha256:fed9c24a39faf6532182b85d701222c6552aa9a88b88ffb450d95e9c7593f9cd
+        codeSamplesRevisionDigest: sha256:5c067edcfacb694404b916a8255dba9cf67acc66ca6f6e87dd856978dc8cec18
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

diff --git a/docs/models/components/actorfeeditemdto.md b/docs/models/components/actorfeeditemdto.md
@@ -7,7 +7,7 @@ import { ActorFeedItemDto } from "@novu/api/models/components";
 
 let value: ActorFeedItemDto = {
   data: null,
-  type: "system_icon",
+  type: "system_custom",
 };
 ```
 

diff --git a/docs/models/components/actortypeenum.md b/docs/models/components/actortypeenum.md
@@ -7,7 +7,7 @@ The type of the actor, indicating the role in the notification process.
 ```typescript
 import { ActorTypeEnum } from "@novu/api/models/components";
 
-let value: ActorTypeEnum = "system_custom";
+let value: ActorTypeEnum = "system_icon";
 ```
 
 ## Values

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 = "months";
+let value: BackoffUnit = "minutes";
 ```
 
 ## Values

diff --git a/docs/models/components/buttontypeenum.md b/docs/models/components/buttontypeenum.md
@@ -0,0 +1,17 @@
+# ButtonTypeEnum
+
+Type of button for the action result
+
+## Example Usage
+
+```typescript
+import { ButtonTypeEnum } from "@novu/api/models/components";
+
+let value: ButtonTypeEnum = "primary";
+```
+
+## Values
+
+```typescript
+"primary" | "secondary"
+```
diff --git a/docs/models/components/channelctatypeenum.md b/docs/models/components/channelctatypeenum.md
@@ -0,0 +1,17 @@
+# ChannelCTATypeEnum
+
+Type of call to action
+
+## Example Usage
+
+```typescript
+import { ChannelCTATypeEnum } from "@novu/api/models/components";
+
+let value: ChannelCTATypeEnum = "redirect";
+```
+
+## Values
+
+```typescript
+"redirect"
+```
diff --git a/docs/models/components/channeltypeenum.md b/docs/models/components/channeltypeenum.md
@@ -1,6 +1,6 @@
 # ChannelTypeEnum
 
-The channel through which the notification is sent.
+Channel type through which the message is sent
 
 ## Example Usage
 

diff --git a/docs/models/components/content.md b/docs/models/components/content.md
@@ -1,5 +1,7 @@
 # Content
 
+Content of the message, can be an email block or a string
+
 
 ## Supported Types
 

diff --git a/docs/models/components/digestregularmetadata.md b/docs/models/components/digestregularmetadata.md
@@ -6,7 +6,7 @@
 import { DigestRegularMetadata } from "@novu/api/models/components";
 
 let value: DigestRegularMetadata = {
-  type: "backoff",
+  type: "regular",
 };
 ```
 

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

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

diff --git a/docs/models/components/emailblock.md b/docs/models/components/emailblock.md
@@ -13,9 +13,9 @@ let value: EmailBlock = {
 
 ## Fields
 
-| Field                                                                      | Type                                                                       | Required                                                                   | Description                                                                |
-| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
-| `type`                                                                     | [components.EmailBlockType](../../models/components/emailblocktype.md)     | :heavy_check_mark:                                                         | N/A                                                                        |
-| `content`                                                                  | *string*                                                                   | :heavy_check_mark:                                                         | N/A                                                                        |
-| `url`                                                                      | *string*                                                                   | :heavy_minus_sign:                                                         | N/A                                                                        |
-| `styles`                                                                   | [components.EmailBlockStyles](../../models/components/emailblockstyles.md) | :heavy_minus_sign:                                                         | N/A                                                                        |
+| Field                                                                          | Type                                                                           | Required                                                                       | Description                                                                    |
+| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
+| `type`                                                                         | [components.EmailBlockTypeEnum](../../models/components/emailblocktypeenum.md) | :heavy_check_mark:                                                             | Type of the email block                                                        |
+| `content`                                                                      | *string*                                                                       | :heavy_check_mark:                                                             | Content of the email block                                                     |
+| `url`                                                                          | *string*                                                                       | :heavy_minus_sign:                                                             | URL associated with the email block, if any                                    |
+| `styles`                                                                       | [components.EmailBlockStyles](../../models/components/emailblockstyles.md)     | :heavy_minus_sign:                                                             | Styles applied to the email block                                              |
diff --git a/docs/models/components/emailblockstyles.md b/docs/models/components/emailblockstyles.md
@@ -6,12 +6,12 @@
 import { EmailBlockStyles } from "@novu/api/models/components";
 
 let value: EmailBlockStyles = {
-  textAlign: "center",
+  textAlign: "left",
 };
 ```
 
 ## Fields
 
-| Field                                                        | Type                                                         | Required                                                     | Description                                                  |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| `textAlign`                                                  | [components.TextAlign](../../models/components/textalign.md) | :heavy_check_mark:                                           | N/A                                                          |
+| Field                                                                | Type                                                                 | Required                                                             | Description                                                          |
+| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
+| `textAlign`                                                          | [components.TextAlignEnum](../../models/components/textalignenum.md) | :heavy_check_mark:                                                   | Text alignment for the email block                                   |
diff --git a/docs/models/components/emailblocktype.md b/docs/models/components/emailblocktype.md
diff --git a/docs/models/components/emailblocktypeenum.md b/docs/models/components/emailblocktypeenum.md
@@ -0,0 +1,17 @@
+# EmailBlockTypeEnum
+
+Type of the email block
+
+## Example Usage
+
+```typescript
+import { EmailBlockTypeEnum } from "@novu/api/models/components";
+
+let value: EmailBlockTypeEnum = "button";
+```
+
+## Values
+
+```typescript
+"button" | "text"
+```
diff --git a/docs/models/components/feedid.md b/docs/models/components/feedid.md
diff --git a/docs/models/components/markallmessageasrequestdto.md b/docs/models/components/markallmessageasrequestdto.md
@@ -6,7 +6,7 @@
 import { MarkAllMessageAsRequestDto } from "@novu/api/models/components";
 
 let value: MarkAllMessageAsRequestDto = {
-  markAs: "read",
+  markAs: "unread",
 };
 ```
 

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

diff --git a/docs/models/components/messageaction.md b/docs/models/components/messageaction.md
@@ -10,8 +10,8 @@ let value: MessageAction = {};
 
 ## Fields
 
-| Field                                                                            | Type                                                                             | Required                                                                         | Description                                                                      |
-| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
-| `status`                                                                         | [components.MessageActionStatus](../../models/components/messageactionstatus.md) | :heavy_minus_sign:                                                               | N/A                                                                              |
-| `buttons`                                                                        | [components.MessageButton](../../models/components/messagebutton.md)[]           | :heavy_minus_sign:                                                               | N/A                                                                              |
-| `result`                                                                         | [components.MessageActionResult](../../models/components/messageactionresult.md) | :heavy_minus_sign:                                                               | N/A                                                                              |
+| Field                                                                                    | Type                                                                                     | Required                                                                                 | Description                                                                              |
+| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
+| `status`                                                                                 | [components.MessageActionStatusEnum](../../models/components/messageactionstatusenum.md) | :heavy_minus_sign:                                                                       | Status of the message action                                                             |
+| `buttons`                                                                                | [components.MessageButton](../../models/components/messagebutton.md)[]                   | :heavy_minus_sign:                                                                       | List of buttons associated with the message action                                       |
+| `result`                                                                                 | [components.MessageActionResult](../../models/components/messageactionresult.md)         | :heavy_minus_sign:                                                                       | Result of the message action                                                             |