@trycourier/courier 6.2.1 → 6.2.3

package/api/resources/bulk/client/Client.d.ts

@@ -31,7 +31,76 @@ export declare class Bulk {
      * @example
      *     await courier.bulk.createJob({
      *         message: {
-     *             message: {},
+     *             message: {
+     *                 template: "string",
+     *                 data: {
+     *                     "string": {
+     *                         "key": "value"
+     *                     }
+     *                 },
+     *                 brand_id: "string",
+     *                 channels: {
+     *                     "string": {
+     *                         brand_id: undefined,
+     *                         providers: undefined,
+     *                         routing_method: undefined,
+     *                         if: undefined,
+     *                         timeouts: undefined,
+     *                         override: undefined,
+     *                         metadata: undefined
+     *                     }
+     *                 },
+     *                 context: {
+     *                     tenant_id: "string"
+     *                 },
+     *                 metadata: {
+     *                     event: "string",
+     *                     tags: [],
+     *                     utm: {
+     *                         source: undefined,
+     *                         medium: undefined,
+     *                         campaign: undefined,
+     *                         term: undefined,
+     *                         content: undefined
+     *                     },
+     *                     trace_id: "string"
+     *                 },
+     *                 preferences: {
+     *                     subscription_topic_id: "string"
+     *                 },
+     *                 providers: {
+     *                     "string": {
+     *                         override: undefined,
+     *                         if: undefined,
+     *                         timeouts: undefined,
+     *                         metadata: undefined
+     *                     }
+     *                 },
+     *                 routing: {
+     *                     method: Courier.RoutingMethod.All,
+     *                     channels: [{
+     *                             channel: "string",
+     *                             config: undefined,
+     *                             method: undefined,
+     *                             providers: undefined,
+     *                             if: undefined
+     *                         }]
+     *                 },
+     *                 timeout: {
+     *                     provider: {},
+     *                     channel: {},
+     *                     message: 1,
+     *                     escalation: 1,
+     *                     criteria: Courier.Criteria.NoEscalation
+     *                 },
+     *                 delay: {
+     *                     duration: 1
+     *                 },
+     *                 expiry: {
+     *                     expires_at: "string",
+     *                     expires_in: "string"
+     *                 }
+     *             },
      *             brand: "string",
      *             data: {
      *                 "string": {
@@ -61,7 +130,10 @@ export declare class Bulk {
      * @example
      *     await courier.bulk.ingestUsers("string", {
      *         users: [{
-     *                 preferences: {},
+     *                 preferences: {
+     *                     categories: {},
+     *                     notifications: {}
+     *                 },
      *                 profile: {
      *                     "key": "value"
      *                 },
@@ -69,7 +141,23 @@ export declare class Bulk {
      *                 data: {
      *                     "key": "value"
      *                 },
-     *                 to: {}
+     *                 to: {
+     *                     account_id: "string",
+     *                     context: {
+     *                         tenant_id: "string"
+     *                     },
+     *                     data: {},
+     *                     email: "string",
+     *                     locale: "string",
+     *                     user_id: "string",
+     *                     phone_number: "string",
+     *                     preferences: {
+     *                         categories: undefined,
+     *                         notifications: {},
+     *                         templateId: undefined
+     *                     },
+     *                     tenant_id: "string"
+     *                 }
      *             }]
      *     })
      */

package/api/resources/bulk/client/Client.js

@@ -57,7 +57,76 @@ class Bulk {
      * @example
      *     await courier.bulk.createJob({
      *         message: {
-     *             message: {},
+     *             message: {
+     *                 template: "string",
+     *                 data: {
+     *                     "string": {
+     *                         "key": "value"
+     *                     }
+     *                 },
+     *                 brand_id: "string",
+     *                 channels: {
+     *                     "string": {
+     *                         brand_id: undefined,
+     *                         providers: undefined,
+     *                         routing_method: undefined,
+     *                         if: undefined,
+     *                         timeouts: undefined,
+     *                         override: undefined,
+     *                         metadata: undefined
+     *                     }
+     *                 },
+     *                 context: {
+     *                     tenant_id: "string"
+     *                 },
+     *                 metadata: {
+     *                     event: "string",
+     *                     tags: [],
+     *                     utm: {
+     *                         source: undefined,
+     *                         medium: undefined,
+     *                         campaign: undefined,
+     *                         term: undefined,
+     *                         content: undefined
+     *                     },
+     *                     trace_id: "string"
+     *                 },
+     *                 preferences: {
+     *                     subscription_topic_id: "string"
+     *                 },
+     *                 providers: {
+     *                     "string": {
+     *                         override: undefined,
+     *                         if: undefined,
+     *                         timeouts: undefined,
+     *                         metadata: undefined
+     *                     }
+     *                 },
+     *                 routing: {
+     *                     method: Courier.RoutingMethod.All,
+     *                     channels: [{
+     *                             channel: "string",
+     *                             config: undefined,
+     *                             method: undefined,
+     *                             providers: undefined,
+     *                             if: undefined
+     *                         }]
+     *                 },
+     *                 timeout: {
+     *                     provider: {},
+     *                     channel: {},
+     *                     message: 1,
+     *                     escalation: 1,
+     *                     criteria: Courier.Criteria.NoEscalation
+     *                 },
+     *                 delay: {
+     *                     duration: 1
+     *                 },
+     *                 expiry: {
+     *                     expires_at: "string",
+     *                     expires_in: "string"
+     *                 }
+     *             },
      *             brand: "string",
      *             data: {
      *                 "string": {
@@ -86,7 +155,7 @@ class Bulk {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.2.1",
+                    "X-Fern-SDK-Version": "v6.2.3",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                     "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
@@ -136,7 +205,10 @@ class Bulk {
      * @example
      *     await courier.bulk.ingestUsers("string", {
      *         users: [{
-     *                 preferences: {},
+     *                 preferences: {
+     *                     categories: {},
+     *                     notifications: {}
+     *                 },
      *                 profile: {
      *                     "key": "value"
      *                 },
@@ -144,7 +216,23 @@ class Bulk {
      *                 data: {
      *                     "key": "value"
      *                 },
-     *                 to: {}
+     *                 to: {
+     *                     account_id: "string",
+     *                     context: {
+     *                         tenant_id: "string"
+     *                     },
+     *                     data: {},
+     *                     email: "string",
+     *                     locale: "string",
+     *                     user_id: "string",
+     *                     phone_number: "string",
+     *                     preferences: {
+     *                         categories: undefined,
+     *                         notifications: {},
+     *                         templateId: undefined
+     *                     },
+     *                     tenant_id: "string"
+     *                 }
      *             }]
      *     })
      */
@@ -158,7 +246,7 @@ class Bulk {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.2.1",
+                    "X-Fern-SDK-Version": "v6.2.3",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                     "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
@@ -214,7 +302,7 @@ class Bulk {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.2.1",
+                    "X-Fern-SDK-Version": "v6.2.3",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                     "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
@@ -274,7 +362,7 @@ class Bulk {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.2.1",
+                    "X-Fern-SDK-Version": "v6.2.3",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -332,7 +420,7 @@ class Bulk {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.2.1",
+                    "X-Fern-SDK-Version": "v6.2.3",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/api/resources/bulk/client/requests/BulkCreateJobParams.d.ts

@@ -6,7 +6,76 @@ import * as Courier from "../../../../index";
  * @example
  *     {
  *         message: {
- *             message: {},
+ *             message: {
+ *                 template: "string",
+ *                 data: {
+ *                     "string": {
+ *                         "key": "value"
+ *                     }
+ *                 },
+ *                 brand_id: "string",
+ *                 channels: {
+ *                     "string": {
+ *                         brand_id: undefined,
+ *                         providers: undefined,
+ *                         routing_method: undefined,
+ *                         if: undefined,
+ *                         timeouts: undefined,
+ *                         override: undefined,
+ *                         metadata: undefined
+ *                     }
+ *                 },
+ *                 context: {
+ *                     tenant_id: "string"
+ *                 },
+ *                 metadata: {
+ *                     event: "string",
+ *                     tags: [],
+ *                     utm: {
+ *                         source: undefined,
+ *                         medium: undefined,
+ *                         campaign: undefined,
+ *                         term: undefined,
+ *                         content: undefined
+ *                     },
+ *                     trace_id: "string"
+ *                 },
+ *                 preferences: {
+ *                     subscription_topic_id: "string"
+ *                 },
+ *                 providers: {
+ *                     "string": {
+ *                         override: undefined,
+ *                         if: undefined,
+ *                         timeouts: undefined,
+ *                         metadata: undefined
+ *                     }
+ *                 },
+ *                 routing: {
+ *                     method: Courier.RoutingMethod.All,
+ *                     channels: [{
+ *                             channel: "string",
+ *                             config: undefined,
+ *                             method: undefined,
+ *                             providers: undefined,
+ *                             if: undefined
+ *                         }]
+ *                 },
+ *                 timeout: {
+ *                     provider: {},
+ *                     channel: {},
+ *                     message: 1,
+ *                     escalation: 1,
+ *                     criteria: Courier.Criteria.NoEscalation
+ *                 },
+ *                 delay: {
+ *                     duration: 1
+ *                 },
+ *                 expiry: {
+ *                     expires_at: "string",
+ *                     expires_in: "string"
+ *                 }
+ *             },
  *             brand: "string",
  *             data: {
  *                 "string": {

package/api/resources/inbound/client/Client.js

@@ -78,7 +78,7 @@ class Inbound {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.2.1",
+                    "X-Fern-SDK-Version": "v6.2.3",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/api/resources/lists/client/Client.d.ts

@@ -60,30 +60,8 @@ export declare class Lists {
      *     await courier.lists.update("string", {
      *         name: "string",
      *         preferences: {
-     *             categories: {
-     *                 "string": {
-     *                     status: Courier.PreferenceStatus.OptedIn,
-     *                     rules: [{
-     *                             start: "string",
-     *                             until: "string"
-     *                         }],
-     *                     channel_preferences: [{
-     *                             channel: Courier.ChannelClassification.DirectMessage
-     *                         }]
-     *                 }
-     *             },
-     *             notifications: {
-     *                 "string": {
-     *                     status: Courier.PreferenceStatus.OptedIn,
-     *                     rules: [{
-     *                             start: "string",
-     *                             until: "string"
-     *                         }],
-     *                     channel_preferences: [{
-     *                             channel: Courier.ChannelClassification.DirectMessage
-     *                         }]
-     *                 }
-     *             }
+     *             categories: {},
+     *             notifications: {}
      *         }
      *     })
      */
@@ -137,30 +115,8 @@ export declare class Lists {
      *         recipients: [{
      *                 recipientId: "string",
      *                 preferences: {
-     *                     categories: {
-     *                         "string": {
-     *                             status: Courier.PreferenceStatus.OptedIn,
-     *                             rules: [{
-     *                                     start: "string",
-     *                                     until: "string"
-     *                                 }],
-     *                             channel_preferences: [{
-     *                                     channel: Courier.ChannelClassification.DirectMessage
-     *                                 }]
-     *                         }
-     *                     },
-     *                     notifications: {
-     *                         "string": {
-     *                             status: Courier.PreferenceStatus.OptedIn,
-     *                             rules: [{
-     *                                     start: "string",
-     *                                     until: "string"
-     *                                 }],
-     *                             channel_preferences: [{
-     *                                     channel: Courier.ChannelClassification.DirectMessage
-     *                                 }]
-     *                         }
-     *                     }
+     *                     categories: {},
+     *                     notifications: {}
      *                 }
      *             }]
      *     })
@@ -180,30 +136,8 @@ export declare class Lists {
      *         recipients: [{
      *                 recipientId: "string",
      *                 preferences: {
-     *                     categories: {
-     *                         "string": {
-     *                             status: Courier.PreferenceStatus.OptedIn,
-     *                             rules: [{
-     *                                     start: "string",
-     *                                     until: "string"
-     *                                 }],
-     *                             channel_preferences: [{
-     *                                     channel: Courier.ChannelClassification.DirectMessage
-     *                                 }]
-     *                         }
-     *                     },
-     *                     notifications: {
-     *                         "string": {
-     *                             status: Courier.PreferenceStatus.OptedIn,
-     *                             rules: [{
-     *                                     start: "string",
-     *                                     until: "string"
-     *                                 }],
-     *                             channel_preferences: [{
-     *                                     channel: Courier.ChannelClassification.DirectMessage
-     *                                 }]
-     *                         }
-     *                     }
+     *                     categories: {},
+     *                     notifications: {}
      *                 }
      *             }]
      *     })
@@ -220,30 +154,8 @@ export declare class Lists {
      * @example
      *     await courier.lists.subscribe("string", "string", {
      *         preferences: {
-     *             categories: {
-     *                 "string": {
-     *                     status: Courier.PreferenceStatus.OptedIn,
-     *                     rules: [{
-     *                             start: "string",
-     *                             until: "string"
-     *                         }],
-     *                     channel_preferences: [{
-     *                             channel: Courier.ChannelClassification.DirectMessage
-     *                         }]
-     *                 }
-     *             },
-     *             notifications: {
-     *                 "string": {
-     *                     status: Courier.PreferenceStatus.OptedIn,
-     *                     rules: [{
-     *                             start: "string",
-     *                             until: "string"
-     *                         }],
-     *                     channel_preferences: [{
-     *                             channel: Courier.ChannelClassification.DirectMessage
-     *                         }]
-     *                 }
-     *             }
+     *             categories: {},
+     *             notifications: {}
      *         }
      *     })
      */