add error dto to 500

novuhq · Jan 14, 2025 · 0b9461b · 0b9461b
1 parent 0b84ddb
commit 0b9461b
Show file tree

Hide file tree

Showing 207 changed files with 4,297 additions and 682 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
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.183
+  version: 0.0.1-alpha.185
   additionalDependencies:
     dependencies: {}
     devDependencies: {}

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -2,19 +2,19 @@ speakeasyVersion: 1.468.5
 sources:
     json-development:
         sourceNamespace: json-development
-        sourceRevisionDigest: sha256:ad4851ee72553198704e4f3a6ed1859b1c2ef111172f86d34395f577afdd14da
-        sourceBlobDigest: sha256:98ff71d9656ecc1294937a13bff2ddc8e6f233d1c281875726dfc3f2c0301ce4
+        sourceRevisionDigest: sha256:539c43f93b977159045b3ad8ace48361c55c536e63be9a0e52037e113fd6dfad
+        sourceBlobDigest: sha256:14ab1e11a39c0b449a308b8f7299616fd083607b5dc75d5b47bfb9c58407835c
         tags:
             - latest
             - "1.0"
 targets:
     my-first-target:
         source: json-development
         sourceNamespace: json-development
-        sourceRevisionDigest: sha256:ad4851ee72553198704e4f3a6ed1859b1c2ef111172f86d34395f577afdd14da
-        sourceBlobDigest: sha256:98ff71d9656ecc1294937a13bff2ddc8e6f233d1c281875726dfc3f2c0301ce4
+        sourceRevisionDigest: sha256:539c43f93b977159045b3ad8ace48361c55c536e63be9a0e52037e113fd6dfad
+        sourceBlobDigest: sha256:14ab1e11a39c0b449a308b8f7299616fd083607b5dc75d5b47bfb9c58407835c
         codeSamplesNamespace: code-samples-typescript
-        codeSamplesRevisionDigest: sha256:e3490b0ae3b56c06736e527f74adefce5ed564fd59c86b2d2bc06430af58c696
+        codeSamplesRevisionDigest: sha256:74346be6f269180459e26becdb9c494a76faf0927aac0dfca36acef0aad5a580
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

diff --git a/README.md b/README.md
@@ -218,7 +218,7 @@ run();
 
 ### [admin](docs/sdks/admin/README.md)
 
-* [testingControllerIdempotency](docs/sdks/admin/README.md#testingcontrolleridempotency)
+* [testIdempotency](docs/sdks/admin/README.md#testidempotency)
 * [testingControllerIdempotencyGet](docs/sdks/admin/README.md#testingcontrolleridempotencyget)
 
 ### [integrations](docs/sdks/integrations/README.md)
@@ -334,7 +334,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 <summary>Available standalone functions</summary>
 
-- [`adminTestingControllerIdempotency`](docs/sdks/admin/README.md#testingcontrolleridempotency)
+- [`adminTestIdempotency`](docs/sdks/admin/README.md#testidempotency)
 - [`adminTestingControllerIdempotencyGet`](docs/sdks/admin/README.md#testingcontrolleridempotencyget)
 - [`cancel`](docs/sdks/novu/README.md#cancel) - Cancel triggered event
 - [`integrationsCreate`](docs/sdks/integrations/README.md#create) - Create integration
@@ -428,11 +428,11 @@ run();
 
 Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `trigger` method may throw the following errors:
 
-| Error Type                | Status Code             | Content Type     |
-| ------------------------- | ----------------------- | ---------------- |
-| errors.ErrorDto           | 400, 401, 404, 409, 500 | application/json |
-| errors.ValidationErrorDto | 422                     | application/json |
-| errors.SDKError           | 4XX, 5XX                | \*/\*            |
+| Error Type                | Status Code                  | Content Type     |
+| ------------------------- | ---------------------------- | ---------------- |
+| errors.ErrorDto           | 400, 401, 403, 404, 409, 500 | application/json |
+| errors.ValidationErrorDto | 422                          | application/json |
+| errors.SDKError           | 4XX, 5XX                     | \*/\*            |
 
 If the method throws an error and it is not captured by the known errors, it will default to throwing a `SDKError`.
 

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

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: 6994.79,
+  count: 8965.47,
   templates: [
     "<value>",
   ],

diff --git a/docs/models/components/activitynotificationexecutiondetailresponsedto.md b/docs/models/components/activitynotificationexecutiondetailresponsedto.md
@@ -7,12 +7,12 @@ import { ActivityNotificationExecutionDetailResponseDto } from "@novu/api/models
 
 let value: ActivityNotificationExecutionDetailResponseDto = {
   id: "<id>",
-  status: "ReadConfirmation",
+  status: "Failed",
   detail: "<value>",
   isRetry: false,
   isTest: false,
-  providerId: "novu-email",
-  source: "Payload",
+  providerId: "netcore",
+  source: "Internal",
 };
 ```
 

diff --git a/docs/models/components/activitynotificationjobresponsedto.md b/docs/models/components/activitynotificationjobresponsedto.md
@@ -7,16 +7,16 @@ import { ActivityNotificationJobResponseDto } from "@novu/api/models/components"
 
 let value: ActivityNotificationJobResponseDto = {
   id: "<id>",
-  type: "email",
+  type: "digest",
   executionDetails: [
     {
       id: "<id>",
-      status: "Pending",
+      status: "Failed",
       detail: "<value>",
       isRetry: false,
       isTest: false,
-      providerId: "mailgun",
-      source: "Webhook",
+      providerId: "generic-sms",
+      source: "Credentials",
     },
   ],
   step: {
@@ -26,7 +26,7 @@ let value: ActivityNotificationJobResponseDto = {
       {},
     ],
   },
-  providerId: "emailjs",
+  providerId: "braze",
   status: "<value>",
 };
 ```

diff --git a/docs/models/components/activitynotificationjobresponsedtotype.md b/docs/models/components/activitynotificationjobresponsedtotype.md
@@ -7,7 +7,7 @@ Type of the job
 ```typescript
 import { ActivityNotificationJobResponseDtoType } from "@novu/api/models/components";
 
-let value: ActivityNotificationJobResponseDtoType = "sms";
+let value: ActivityNotificationJobResponseDtoType = "custom";
 ```
 
 ## 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: 9527.49,
-  monthlySent: 4471.25,
+  weeklySent: 6532.01,
+  monthlySent: 6521.03,
 };
 ```
 

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_custom",
+  type: "none",
 };
 ```
 

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

diff --git a/docs/models/components/bulktriggereventdto.md b/docs/models/components/bulktriggereventdto.md
@@ -24,7 +24,8 @@ let value: BulkTriggerEventDto = {
         },
       },
       to: {
-        subscriberId: "<id>",
+        topicKey: "<value>",
+        type: "Topic",
       },
     },
   ],

diff --git a/docs/models/components/buttontypeenum.md b/docs/models/components/buttontypeenum.md
@@ -7,7 +7,7 @@ Type of button for the action result
 ```typescript
 import { ButtonTypeEnum } from "@novu/api/models/components";
 
-let value: ButtonTypeEnum = "secondary";
+let value: ButtonTypeEnum = "primary";
 ```
 
 ## Values

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 = "sms";
 ```
 
 ## Values

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: "sms",
+  type: "email",
   enabled: false,
 };
 ```

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 = "push";
+let value: Channels = "sms";
 ```
 
 ## Values

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

diff --git a/docs/models/components/channelsettingsproviderid.md b/docs/models/components/channelsettingsproviderid.md
@@ -7,7 +7,7 @@ The provider identifier for the credentials
 ```typescript
 import { ChannelSettingsProviderId } from "@novu/api/models/components";
 
-let value: ChannelSettingsProviderId = "getstream";
+let value: ChannelSettingsProviderId = "discord";
 ```
 
 ## 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 = "email";
+let value: ChannelTypeEnum = "sms";
 ```
 
 ## Values

diff --git a/docs/models/components/content.md b/docs/models/components/content.md
@@ -9,7 +9,7 @@ Content of the message, can be an email block or a string
 
 ```typescript
 const value: components.EmailBlock = {
-  type: "button",
+  type: "text",
   content: "<value>",
 };
 ```

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: "email",
+  channel: "push",
 };
 ```
 

diff --git a/docs/models/components/createsubscriberrequestdtodata.md b/docs/models/components/createsubscriberrequestdtodata.md
@@ -26,6 +26,6 @@ const value: boolean = false;
 ### `number`
 
 ```typescript
-const value: number = 2982.82;
+const value: number = 4535.43;
 ```
 
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 = 5232.48;
+const value: number = 2974.37;
 ```
 
diff --git a/docs/models/components/delayregularmetadataunit.md b/docs/models/components/delayregularmetadataunit.md
@@ -5,7 +5,7 @@
 ```typescript
 import { DelayRegularMetadataUnit } from "@novu/api/models/components";
 
-let value: DelayRegularMetadataUnit = "minutes";
+let value: DelayRegularMetadataUnit = "days";
 ```
 
 ## 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 = "seconds";
+let value: DigestTimedMetadataUnit = "minutes";
 ```
 
 ## Values

diff --git a/docs/models/components/emailblock.md b/docs/models/components/emailblock.md
@@ -6,7 +6,7 @@
 import { EmailBlock } from "@novu/api/models/components";
 
 let value: EmailBlock = {
-  type: "button",
+  type: "text",
   content: "<value>",
 };
 ```

diff --git a/docs/models/components/emailblockstyles.md b/docs/models/components/emailblockstyles.md
@@ -6,7 +6,7 @@
 import { EmailBlockStyles } from "@novu/api/models/components";
 
 let value: EmailBlockStyles = {
-  textAlign: "right",
+  textAlign: "center",
 };
 ```
 

diff --git a/docs/models/components/emailblocktypeenum.md b/docs/models/components/emailblocktypeenum.md
@@ -7,7 +7,7 @@ Type of the email block
 ```typescript
 import { EmailBlockTypeEnum } from "@novu/api/models/components";
 
-let value: EmailBlockTypeEnum = "text";
+let value: EmailBlockTypeEnum = "button";
 ```
 
 ## Values

diff --git a/docs/models/components/errordto.md b/docs/models/components/errordto.md
@@ -0,0 +1,30 @@
+# ErrorDto
+
+## Example Usage
+
+```typescript
+import { ErrorDto } from "@novu/api/models/components";
+
+let value: ErrorDto = {
+  statusCode: 404,
+  timestamp: "2024-12-12T13:00:00Z",
+  path: "/api/v1/resource",
+  message: "Resource not found.",
+  ctx: {
+    "workflowId": "some_wf_id",
+    "stepId": "some_wf_id",
+  },
+  errorId: "abc123",
+};
+```
+
+## Fields
+
+| Field                                                                                                                    | Type                                                                                                                     | Required                                                                                                                 | Description                                                                                                              | Example                                                                                                                  |
+| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
+| `statusCode`                                                                                                             | *number*                                                                                                                 | :heavy_check_mark:                                                                                                       | HTTP status code of the error response.                                                                                  | 404                                                                                                                      |
+| `timestamp`                                                                                                              | *string*                                                                                                                 | :heavy_check_mark:                                                                                                       | Timestamp of when the error occurred.                                                                                    | 2024-12-12T13:00:00Z                                                                                                     |
+| `path`                                                                                                                   | *string*                                                                                                                 | :heavy_check_mark:                                                                                                       | The path where the error occurred.                                                                                       | /api/v1/resource                                                                                                         |
+| `message`                                                                                                                | *string*                                                                                                                 | :heavy_check_mark:                                                                                                       | A detailed error message.                                                                                                | Resource not found.                                                                                                      |
+| `ctx`                                                                                                                    | Record<string, *any*>                                                                                                    | :heavy_minus_sign:                                                                                                       | Optional context object for additional error details.                                                                    | {<br/>"workflowId": "some_wf_id",<br/>"stepId": "some_wf_id"<br/>}                                                       |
+| `errorId`                                                                                                                | *string*                                                                                                                 | :heavy_minus_sign:                                                                                                       | Optional unique identifier for the error, useful for tracking using Sentry and <br/>      New Relic, only available for 500. | abc123                                                                                                                   |
diff --git a/docs/models/components/feedresponsedto.md b/docs/models/components/feedresponsedto.md
@@ -23,14 +23,14 @@ let value: FeedResponseDto = {
       updatedAt: new Date("2024-12-10T10:10:59.639Z"),
       actor: {
         data: null,
-        type: "system_custom",
+        type: "system_icon",
       },
       transactionId: "transaction_123456",
       templateIdentifier: "template_abcdef",
       providerId: "provider_xyz",
       content: "This is a test notification content.",
       subject: "Test Notification Subject",
-      channel: "email",
+      channel: "in_app",
       read: false,
       seen: true,
       deleted: false,

diff --git a/docs/models/components/fieldfilterpartdto.md b/docs/models/components/fieldfilterpartdto.md
@@ -8,7 +8,7 @@ import { FieldFilterPartDto } from "@novu/api/models/components";
 let value: FieldFilterPartDto = {
   field: "<value>",
   value: "<value>",
-  operator: "BETWEEN",
+  operator: "NOT_LIKE",
   on: "subscriber",
 };
 ```
-Original file line number
+Diff line change
@@ Expand Up / @@ -24,7 +24,8 @@ let value: BulkTriggerEventDto = { @@
             },
           },
           to: {
-            subscriberId: "<id>",
+            topicKey: "<value>",
+            type: "Topic",
           },
         },
       ],
@@ Expand Down @@