change add error definition

novuhq · Dec 16, 2024 · 2ee411e · 2ee411e
1 parent 1eb36ac
commit 2ee411e
Show file tree

Hide file tree

Showing 35 changed files with 879 additions and 46 deletions.
diff --git a/docs/models/components/activitynotificationexecutiondetailresponsedto.md b/docs/models/components/activitynotificationexecutiondetailresponsedto.md
@@ -0,0 +1,32 @@
+# ActivityNotificationExecutionDetailResponseDto
+
+## Example Usage
+
+```typescript
+import { ActivityNotificationExecutionDetailResponseDto } from "@novu/api/models/components";
+
+let value: ActivityNotificationExecutionDetailResponseDto = {
+  id: "<id>",
+  jobId: "<id>",
+  status: "Pending",
+  detail: "<value>",
+  isRetry: false,
+  isTest: false,
+  providerId: 7392.64,
+  source: "Credentials",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                              | Type                                                                                                                                               | Required                                                                                                                                           | Description                                                                                                                                        |
+| -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id`                                                                                                                                               | *string*                                                                                                                                           | :heavy_check_mark:                                                                                                                                 | Unique identifier of the execution detail                                                                                                          |
+| `jobId`                                                                                                                                            | *string*                                                                                                                                           | :heavy_check_mark:                                                                                                                                 | Unique identifier of the job                                                                                                                       |
+| `status`                                                                                                                                           | [components.ActivityNotificationExecutionDetailResponseDtoStatus](../../models/components/activitynotificationexecutiondetailresponsedtostatus.md) | :heavy_check_mark:                                                                                                                                 | Status of the execution detail                                                                                                                     |
+| `detail`                                                                                                                                           | *string*                                                                                                                                           | :heavy_check_mark:                                                                                                                                 | Detailed information about the execution                                                                                                           |
+| `isRetry`                                                                                                                                          | *boolean*                                                                                                                                          | :heavy_check_mark:                                                                                                                                 | Whether the execution is a retry or not                                                                                                            |
+| `isTest`                                                                                                                                           | *boolean*                                                                                                                                          | :heavy_check_mark:                                                                                                                                 | Whether the execution is a test or not                                                                                                             |
+| `providerId`                                                                                                                                       | *number*                                                                                                                                           | :heavy_check_mark:                                                                                                                                 | Provider ID of the job                                                                                                                             |
+| `raw`                                                                                                                                              | *string*                                                                                                                                           | :heavy_minus_sign:                                                                                                                                 | Raw data of the execution                                                                                                                          |
+| `source`                                                                                                                                           | [components.Source](../../models/components/source.md)                                                                                             | :heavy_check_mark:                                                                                                                                 | Source of the execution detail                                                                                                                     |
diff --git a/docs/models/components/activitynotificationexecutiondetailresponsedtostatus.md b/docs/models/components/activitynotificationexecutiondetailresponsedtostatus.md
@@ -0,0 +1,17 @@
+# ActivityNotificationExecutionDetailResponseDtoStatus
+
+Status of the execution detail
+
+## Example Usage
+
+```typescript
+import { ActivityNotificationExecutionDetailResponseDtoStatus } from "@novu/api/models/components";
+
+let value: ActivityNotificationExecutionDetailResponseDtoStatus = "Failed";
+```
+
+## Values
+
+```typescript
+"Success" | "Warning" | "Failed" | "Pending" | "Queued" | "ReadConfirmation"
+```
diff --git a/docs/models/components/activitynotificationjobresponsedto.md b/docs/models/components/activitynotificationjobresponsedto.md
@@ -0,0 +1,44 @@
+# ActivityNotificationJobResponseDto
+
+## Example Usage
+
+```typescript
+import { ActivityNotificationJobResponseDto } from "@novu/api/models/components";
+
+let value: ActivityNotificationJobResponseDto = {
+  id: "<id>",
+  type: "<value>",
+  executionDetails: [
+    {
+      id: "<id>",
+      jobId: "<id>",
+      status: "Success",
+      detail: "<value>",
+      isRetry: false,
+      isTest: false,
+      providerId: 8379.45,
+      source: "Credentials",
+    },
+  ],
+  step: {
+    id: "<id>",
+    active: false,
+    filters: {},
+  },
+  providerId: 9764.59,
+  status: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                    | Type                                                                                                                                     | Required                                                                                                                                 | Description                                                                                                                              |
+| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| `id`                                                                                                                                     | *string*                                                                                                                                 | :heavy_check_mark:                                                                                                                       | Unique identifier of the job                                                                                                             |
+| `type`                                                                                                                                   | *string*                                                                                                                                 | :heavy_check_mark:                                                                                                                       | Type of the job                                                                                                                          |
+| `digest`                                                                                                                                 | [components.Digest](../../models/components/digest.md)                                                                                   | :heavy_minus_sign:                                                                                                                       | Optional digest for the job                                                                                                              |
+| `executionDetails`                                                                                                                       | [components.ActivityNotificationExecutionDetailResponseDto](../../models/components/activitynotificationexecutiondetailresponsedto.md)[] | :heavy_check_mark:                                                                                                                       | Execution details of the job                                                                                                             |
+| `step`                                                                                                                                   | [components.ActivityNotificationStepResponseDto](../../models/components/activitynotificationstepresponsedto.md)                         | :heavy_check_mark:                                                                                                                       | Step details of the job                                                                                                                  |
+| `payload`                                                                                                                                | [components.Payload](../../models/components/payload.md)                                                                                 | :heavy_minus_sign:                                                                                                                       | Optional payload for the job                                                                                                             |
+| `providerId`                                                                                                                             | *number*                                                                                                                                 | :heavy_check_mark:                                                                                                                       | Provider ID of the job                                                                                                                   |
+| `status`                                                                                                                                 | *string*                                                                                                                                 | :heavy_check_mark:                                                                                                                       | Status of the job                                                                                                                        |
diff --git a/docs/models/components/activitynotificationstepresponsedto.md b/docs/models/components/activitynotificationstepresponsedto.md
@@ -0,0 +1,22 @@
+# ActivityNotificationStepResponseDto
+
+## Example Usage
+
+```typescript
+import { ActivityNotificationStepResponseDto } from "@novu/api/models/components";
+
+let value: ActivityNotificationStepResponseDto = {
+  id: "<id>",
+  active: false,
+  filters: {},
+};
+```
+
+## Fields
+
+| Field                                                                          | Type                                                                           | Required                                                                       | Description                                                                    |
+| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
+| `id`                                                                           | *string*                                                                       | :heavy_check_mark:                                                             | Unique identifier of the step                                                  |
+| `active`                                                                       | *boolean*                                                                      | :heavy_check_mark:                                                             | Whether the step is active or not                                              |
+| `filters`                                                                      | [components.StepFilter](../../models/components/stepfilter.md)                 | :heavy_check_mark:                                                             | Filter criteria for the step                                                   |
+| `template`                                                                     | [components.MessageTemplateDto](../../models/components/messagetemplatedto.md) | :heavy_minus_sign:                                                             | Optional template for the step                                                 |
diff --git a/docs/models/components/bulktriggereventdto.md b/docs/models/components/bulktriggereventdto.md
@@ -25,7 +25,8 @@ let value: BulkTriggerEventDto = {
       },
       to: [
         {
-          subscriberId: "<id>",
+          topicKey: "<value>",
+          type: "Subscriber",
         },
       ],
     },

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 = "chat";
+let value: Channel = "in_app";
 ```
 
 ## Values

diff --git a/docs/models/components/channelpreferencetype.md b/docs/models/components/channelpreferencetype.md
@@ -0,0 +1,17 @@
+# ChannelPreferenceType
+
+The type of channel that is enabled or not
+
+## Example Usage
+
+```typescript
+import { ChannelPreferenceType } from "@novu/api/models/components";
+
+let value: ChannelPreferenceType = "push";
+```
+
+## Values
+
+```typescript
+"in_app" | "email" | "sms" | "chat" | "push"
+```
diff --git a/docs/models/components/data.md b/docs/models/components/data.md
@@ -26,6 +26,6 @@ const value: boolean = false;
 ### `number`
 
 ```typescript
-const value: number = 4663.11;
+const value: number = 6531.08;
 ```
 
diff --git a/docs/models/components/digest.md b/docs/models/components/digest.md
@@ -0,0 +1,16 @@
+# Digest
+
+Optional digest for the job
+
+## Example Usage
+
+```typescript
+import { Digest } from "@novu/api/models/components";
+
+let value: Digest = {};
+```
+
+## Fields
+
+| Field       | Type        | Required    | Description |
+| ----------- | ----------- | ----------- | ----------- |
diff --git a/docs/models/components/messageactionresultpayload.md b/docs/models/components/messageactionresultpayload.md
@@ -0,0 +1,14 @@
+# MessageActionResultPayload
+
+## Example Usage
+
+```typescript
+import { MessageActionResultPayload } from "@novu/api/models/components";
+
+let value: MessageActionResultPayload = {};
+```
+
+## Fields
+
+| Field       | Type        | Required    | Description |
+| ----------- | ----------- | ----------- | ----------- |
diff --git a/docs/models/components/messageactionresulttype.md b/docs/models/components/messageactionresulttype.md
@@ -5,7 +5,7 @@
 ```typescript
 import { MessageActionResultType } from "@novu/api/models/components";
 
-let value: MessageActionResultType = "secondary";
+let value: MessageActionResultType = "primary";
 ```
 
 ## Values

diff --git a/docs/models/components/messagemarkasrequestdto.md b/docs/models/components/messagemarkasrequestdto.md
@@ -9,7 +9,7 @@ let value: MessageMarkAsRequestDto = {
   messageId: [
     "<id>",
   ],
-  markAs: "unread",
+  markAs: "unseen",
 };
 ```
 

diff --git a/docs/models/components/messagetemplatedto.md b/docs/models/components/messagetemplatedto.md
@@ -0,0 +1,14 @@
+# MessageTemplateDto
+
+## Example Usage
+
+```typescript
+import { MessageTemplateDto } from "@novu/api/models/components";
+
+let value: MessageTemplateDto = {};
+```
+
+## Fields
+
+| Field       | Type        | Required    | Description |
+| ----------- | ----------- | ----------- | ----------- |
diff --git a/docs/models/components/source.md b/docs/models/components/source.md
@@ -0,0 +1,17 @@
+# Source
+
+Source of the execution detail
+
+## Example Usage
+
+```typescript
+import { Source } from "@novu/api/models/components";
+
+let value: Source = "Webhook";
+```
+
+## Values
+
+```typescript
+"Credentials" | "Internal" | "Payload" | "Webhook"
+```
diff --git a/docs/models/components/status.md b/docs/models/components/status.md
@@ -7,7 +7,7 @@ Status of the trigger
 ```typescript
 import { Status } from "@novu/api/models/components";
 
-let value: Status = "no_workflow_steps_defined";
+let value: Status = "no_workflow_active_steps_defined";
 ```
 
 ## Values

diff --git a/docs/models/components/subscriberchanneldto.md b/docs/models/components/subscriberchanneldto.md
@@ -6,7 +6,7 @@
 import { SubscriberChannelDto } from "@novu/api/models/components";
 
 let value: SubscriberChannelDto = {
-  providerId: "msteams",
+  providerId: "getstream",
   credentials: {},
 };
 ```

diff --git a/docs/models/components/to.md b/docs/models/components/to.md
@@ -10,7 +10,8 @@ The recipients list of people who will receive the notification.
 ```typescript
 const value: components.One[] = [
   {
-    subscriberId: "<id>",
+    topicKey: "<value>",
+    type: "Topic",
   },
 ];
 ```

diff --git a/docs/models/components/triggereventrequestdto.md b/docs/models/components/triggereventrequestdto.md
@@ -23,8 +23,7 @@ let value: TriggerEventRequestDto = {
   },
   to: [
     {
-      topicKey: "<value>",
-      type: "Subscriber",
+      subscriberId: "<id>",
     },
   ],
 };

diff --git a/docs/models/components/triggereventresponsedto.md b/docs/models/components/triggereventresponsedto.md
@@ -7,7 +7,7 @@ import { TriggerEventResponseDto } from "@novu/api/models/components";
 
 let value: TriggerEventResponseDto = {
   acknowledged: false,
-  status: "no_workflow_steps_defined",
+  status: "no_workflow_active_steps_defined",
 };
 ```
 

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

diff --git a/docs/models/operations/channel.md b/docs/models/operations/channel.md
@@ -7,7 +7,7 @@ The channel of the message to be deleted
 ```typescript
 import { Channel } from "@novu/api/models/operations";
 
-let value: Channel = "email";
+let value: Channel = "chat";
 ```
 
 ## Values
-Original file line number
+Diff line change
@@ Expand Up / @@ -25,7 +25,8 @@ let value: BulkTriggerEventDto = { @@
           },
           to: [
             {
-              subscriberId: "<id>",
+              topicKey: "<value>",
+              type: "Subscriber",
             },
           ],
         },
@@ Expand Down @@