add error dto to 500

novuhq · Jan 14, 2025 · cd42839 · cd42839
1 parent 91c0e4d
commit cd42839
Show file tree

Hide file tree

Showing 200 changed files with 7,288 additions and 3,152 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.190
+  version: 0.0.1-alpha.191
   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:d2d26f4f38aad2f864bfeca92dadbbecd76ae4be8e62a2b7cad8f007928a8c21
-        sourceBlobDigest: sha256:3b3b31a84ca2cf667720127456386b248528b50b47b8cd84f6a3265b4dd2cef7
+        sourceRevisionDigest: sha256:947d403c6210d4def348841542284055c75f9d523a1bebad3cc1b19379053050
+        sourceBlobDigest: sha256:b6cb003896457b33a9eff91cb1634e1141c85dabac04dfb4ff98a62fd208b3aa
         tags:
             - latest
             - "1.0"
 targets:
     my-first-target:
         source: json-development
         sourceNamespace: json-development
-        sourceRevisionDigest: sha256:d2d26f4f38aad2f864bfeca92dadbbecd76ae4be8e62a2b7cad8f007928a8c21
-        sourceBlobDigest: sha256:3b3b31a84ca2cf667720127456386b248528b50b47b8cd84f6a3265b4dd2cef7
+        sourceRevisionDigest: sha256:947d403c6210d4def348841542284055c75f9d523a1bebad3cc1b19379053050
+        sourceBlobDigest: sha256:b6cb003896457b33a9eff91cb1634e1141c85dabac04dfb4ff98a62fd208b3aa
         codeSamplesNamespace: code-samples-typescript
-        codeSamplesRevisionDigest: sha256:bd2b02bfed55239d2aa4ba80af1fd1432b99d1dd6b0be1cdd03cfa8ccd8ee6a8
+        codeSamplesRevisionDigest: sha256:bba06e78002f00eb8d0fa12916a790bfe23a0b1a8eef3b8c636980bb7146dd92
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

diff --git a/README.md b/README.md
@@ -428,11 +428,12 @@ 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, 403, 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, 405, 409, 413, 415, 500 | application/json |
+| errors.ErrorDto           | 414                                         | 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`.
 
@@ -482,6 +483,11 @@ async function run() {
         console.error(err);
         return;
       }
+      case (err instanceof ErrorDto): {
+        // Handle err.data$: ErrorDtoData
+        console.error(err);
+        return;
+      }
       case (err instanceof ValidationErrorDto): {
         // Handle err.data$: ValidationErrorDtoData
         console.error(err);

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

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: 6521.03,
+  count: 6994.79,
   templates: [
     "<value>",
   ],
   channels: [
-    "sms",
+    "email",
   ],
 };
 ```

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: "Warning",
+  status: "ReadConfirmation",
   detail: "<value>",
   isRetry: false,
   isTest: false,
-  providerId: "clicksend",
-  source: "Internal",
+  providerId: "novu-email",
+  source: "Payload",
 };
 ```
 

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: "push",
+  type: "email",
   executionDetails: [
     {
       id: "<id>",
-      status: "ReadConfirmation",
+      status: "Pending",
       detail: "<value>",
       isRetry: false,
       isTest: false,
-      providerId: "messagebird",
-      source: "Internal",
+      providerId: "mailgun",
+      source: "Webhook",
     },
   ],
   step: {
@@ -26,7 +26,7 @@ let value: ActivityNotificationJobResponseDto = {
       {},
     ],
   },
-  providerId: "generic-sms",
+  providerId: "emailjs",
   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 = "trigger";
+let value: ActivityNotificationJobResponseDtoType = "sms";
 ```
 
 ## 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: 5908.73,
-  monthlySent: 5743.25,
+  weeklySent: 9527.49,
+  monthlySent: 4471.25,
 };
 ```
 

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

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

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

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: "sms",
   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 = "chat";
+let value: Channels = "push";
 ```
 
 ## 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: "grafana-on-call",
+  providerId: "msteams",
   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 = "whatsapp-business";
+let value: ChannelSettingsProviderId = "getstream";
 ```
 
 ## 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 = "sms";
+let value: ChannelTypeEnum = "email";
 ```
 
 ## Values

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

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 = 691.67;
+const value: number = 2982.82;
 ```
 
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 = 8464.09;
+const value: number = 5232.48;
 ```
 
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 = "hours";
+let value: DelayRegularMetadataUnit = "minutes";
 ```
 
 ## Values

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

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 = "backoff";
+let value: DigestRegularMetadataType = "regular";
 ```
 
 ## Values

diff --git a/docs/models/components/digestregularmetadataunit.md b/docs/models/components/digestregularmetadataunit.md
@@ -5,7 +5,7 @@
 ```typescript
 import { DigestRegularMetadataUnit } from "@novu/api/models/components";
 
-let value: DigestRegularMetadataUnit = "minutes";
+let value: DigestRegularMetadataUnit = "weeks";
 ```
 
 ## 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 = "minutes";
+let value: DigestTimedMetadataUnit = "seconds";
 ```
 
 ## 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: "text",
+  type: "button",
   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: "left",
+  textAlign: "right",
 };
 ```
 

diff --git a/docs/models/components/errordto.md b/docs/models/components/errordto.md
diff --git a/docs/models/components/feedresponsedto.md b/docs/models/components/feedresponsedto.md
@@ -23,7 +23,7 @@ let value: FeedResponseDto = {
       updatedAt: new Date("2024-12-10T10:10:59.639Z"),
       actor: {
         data: null,
-        type: "none",
+        type: "system_custom",
       },
       transactionId: "transaction_123456",
       templateIdentifier: "template_abcdef",

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: "IN",
+  operator: "BETWEEN",
   on: "subscriber",
 };
 ```

diff --git a/docs/models/components/idempotencybodydto.md b/docs/models/components/idempotencybodydto.md
@@ -6,7 +6,7 @@
 import { IdempotencyBodyDto } from "@novu/api/models/components";
 
 let value: IdempotencyBodyDto = {
-  data: 3960.6,
+  data: 1832.8,
 };
 ```
-Original file line number
+Diff line change
@@ Expand Up / @@ -24,8 +24,7 @@ let value: BulkTriggerEventDto = { @@
             },
           },
           to: {
-            topicKey: "<value>",
-            type: "Topic",
+            subscriberId: "<id>",
           },
         },
       ],
@@ Expand Down @@