@trycourier/courier 6.1.0 → 6.1.1

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

@@ -61,7 +61,7 @@ class Tenants {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 body: request,
@@ -110,7 +110,7 @@ class Tenants {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -163,7 +163,7 @@ class Tenants {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -204,7 +204,7 @@ class Tenants {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -255,7 +255,7 @@ class Tenants {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,

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

@@ -62,7 +62,7 @@ class Translations {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -111,7 +111,7 @@ class Translations {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 body: request,

package/api/resources/users/resources/preferences/client/Client.d.ts

@@ -31,6 +31,15 @@ export declare class Preferences {
     /**
      * Update or Create user preferences for a specific subscription topic.
      * @throws {@link Courier.BadRequestError}
+     *
+     * @example
+     *     await courier.users.preferences.update("abc-123", "74Q4QGFBEX481DP6JRPMV751H4XT", {
+     *         topic: {
+     *             status: Courier.PreferenceStatus.OptedIn,
+     *             has_custom_routing: true,
+     *             custom_routing: [Courier.ChannelClassification.Inbox, Courier.ChannelClassification.Email]
+     *         }
+     *     })
      */
     update(userId: string, topicId: string, request: Courier.users.UserPreferencesUpdateParams, requestOptions?: Preferences.RequestOptions): Promise<Courier.users.UserPreferencesUpdateResponse>;
     protected _getAuthorizationHeader(): Promise<string>;

package/api/resources/users/resources/preferences/client/Client.js

@@ -62,7 +62,7 @@ class Preferences {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -111,7 +111,7 @@ class Preferences {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -149,6 +149,15 @@ class Preferences {
     /**
      * Update or Create user preferences for a specific subscription topic.
      * @throws {@link Courier.BadRequestError}
+     *
+     * @example
+     *     await courier.users.preferences.update("abc-123", "74Q4QGFBEX481DP6JRPMV751H4XT", {
+     *         topic: {
+     *             status: Courier.PreferenceStatus.OptedIn,
+     *             has_custom_routing: true,
+     *             custom_routing: [Courier.ChannelClassification.Inbox, Courier.ChannelClassification.Email]
+     *         }
+     *     })
      */
     update(userId, topicId, request, requestOptions) {
         var _a, _b;
@@ -160,7 +169,7 @@ class Preferences {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 body: request,

package/api/resources/users/resources/preferences/client/requests/UserPreferencesUpdateParams.d.ts

@@ -2,10 +2,16 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Courier from "../../../../../..";
+/**
+ * @example
+ *     {
+ *         topic: {
+ *             status: Courier.PreferenceStatus.OptedIn,
+ *             has_custom_routing: true,
+ *             custom_routing: [Courier.ChannelClassification.Inbox, Courier.ChannelClassification.Email]
+ *         }
+ *     }
+ */
 export interface UserPreferencesUpdateParams {
-    status: Courier.PreferenceStatus;
-    /** The Channels a user has chosen to receive notifications through for this topic */
-    custom_routing?: Courier.ChannelClassification[];
-    default_status: Courier.PreferenceStatus;
-    has_custom_routing?: boolean;
+    topic: Courier.users.TopicPreferenceUpdate;
 }

package/api/resources/users/resources/preferences/types/TopicPreferenceUpdate.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../../../..";
+export interface TopicPreferenceUpdate {
+    status: Courier.PreferenceStatus;
+    /** The Channels a user has chosen to receive notifications through for this topic */
+    custom_routing?: Courier.ChannelClassification[];
+    has_custom_routing?: boolean;
+}

package/api/resources/users/resources/preferences/types/TopicPreferenceUpdate.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/users/resources/preferences/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./UserPreferencesListResponse";
 export * from "./UserPreferencesGetResponse";
 export * from "./TopicPreference";
+export * from "./TopicPreferenceUpdate";
 export * from "./UserPreferencesUpdateResponse";

package/api/resources/users/resources/preferences/types/index.js

@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./UserPreferencesListResponse"), exports);
 __exportStar(require("./UserPreferencesGetResponse"), exports);
 __exportStar(require("./TopicPreference"), exports);
+__exportStar(require("./TopicPreferenceUpdate"), exports);
 __exportStar(require("./UserPreferencesUpdateResponse"), exports);

package/api/resources/users/resources/tenants/client/Client.js

@@ -64,7 +64,7 @@ class Tenants {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 body: request,
@@ -112,7 +112,7 @@ class Tenants {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 body: request,
@@ -156,7 +156,7 @@ class Tenants {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -199,7 +199,7 @@ class Tenants {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -250,7 +250,7 @@ class Tenants {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,

package/api/resources/users/resources/tokens/client/Client.js

@@ -62,7 +62,7 @@ class Tokens {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -111,7 +111,7 @@ class Tokens {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 body: request,
@@ -161,7 +161,7 @@ class Tokens {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 body: request,
@@ -211,7 +211,7 @@ class Tokens {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -260,7 +260,7 @@ class Tokens {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/dist/Client.js

@@ -74,7 +74,7 @@ class CourierClient {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                     "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
                     "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null
                         ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry.toString()

package/dist/api/resources/audiences/client/Client.js

@@ -61,7 +61,7 @@ class Audiences {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -104,7 +104,7 @@ class Audiences {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 body: request,
@@ -148,7 +148,7 @@ class Audiences {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -197,7 +197,7 @@ class Audiences {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -252,7 +252,7 @@ class Audiences {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,

package/dist/api/resources/auditEvents/client/Client.js

@@ -65,7 +65,7 @@ class AuditEvents {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -109,7 +109,7 @@ class AuditEvents {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/dist/api/resources/authTokens/client/Client.js

@@ -60,7 +60,7 @@ class AuthTokens {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                     "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
                     "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null
                         ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry.toString()

package/dist/api/resources/automations/client/Client.d.ts

@@ -28,6 +28,21 @@ export declare class Automations {
     invokeAutomationTemplate(templateId: string, request: Courier.AutomationInvokeParams, requestOptions?: Automations.IdempotentRequestOptions): Promise<Courier.AutomationInvokeResponse>;
     /**
      * Invoke an ad hoc automation run. This endpoint accepts a JSON payload with a series of automation steps. For information about what steps are available, checkout the ad hoc automation guide [here](https://www.courier.com/docs/automations/steps/).
+     *
+     * @example
+     *     await courier.automations.invokeAdHocAutomation({
+     *         data: {
+     *             "name": "Foo"
+     *         },
+     *         profile: {
+     *             "tenant_id": "abc-123"
+     *         },
+     *         recipient: "user-yes",
+     *         automation: {
+     *             cancelation_token: "delay-send--user-yes--abc-123",
+     *             steps: []
+     *         }
+     *     })
      */
     invokeAdHocAutomation(request: Courier.AutomationAdHocInvokeParams, requestOptions?: Automations.IdempotentRequestOptions): Promise<Courier.AutomationInvokeResponse>;
     protected _getAuthorizationHeader(): Promise<string>;

package/dist/api/resources/automations/client/Client.js

@@ -60,7 +60,7 @@ class Automations {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                     "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
                     "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null
                         ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry.toString()
@@ -97,6 +97,21 @@ class Automations {
     }
     /**
      * Invoke an ad hoc automation run. This endpoint accepts a JSON payload with a series of automation steps. For information about what steps are available, checkout the ad hoc automation guide [here](https://www.courier.com/docs/automations/steps/).
+     *
+     * @example
+     *     await courier.automations.invokeAdHocAutomation({
+     *         data: {
+     *             "name": "Foo"
+     *         },
+     *         profile: {
+     *             "tenant_id": "abc-123"
+     *         },
+     *         recipient: "user-yes",
+     *         automation: {
+     *             cancelation_token: "delay-send--user-yes--abc-123",
+     *             steps: []
+     *         }
+     *     })
      */
     invokeAdHocAutomation(request, requestOptions) {
         var _a, _b;
@@ -108,7 +123,7 @@ class Automations {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.0",
+                    "X-Fern-SDK-Version": "v6.1.1",
                     "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
                     "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null
                         ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry.toString()

package/dist/api/resources/automations/types/AccessorType.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface AccessorType {
+    $ref: string;
+}

package/dist/api/resources/automations/types/AccessorType.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/automations/types/AutomationAddToBatchMaxItemsType.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type AutomationAddToBatchMaxItemsType = string | number;

package/dist/api/resources/automations/types/AutomationAddToBatchMaxItemsType.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/automations/types/AutomationAddToBatchRetain.d.ts

@@ -0,0 +1,34 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+/**
+ * Defines what items should be retained and passed along to the next steps when the batch is released
+ *
+ * @example
+ *     {
+ *         type: Courier.AutomationAddToBatchRetainType.Highest,
+ *         count: 10,
+ *         sort_key: "refs.data.my_custom_scoring"
+ *     }
+ *
+ * @example
+ *     {
+ *         type: Courier.AutomationAddToBatchRetainType.Last,
+ *         count: 10
+ *     }
+ */
+export interface AutomationAddToBatchRetain {
+    /**
+     * Keep N number of notifications based on the type. First/Last N based on notification received.
+     * highest/lowest based on a scoring key providing in the data accessed by sort_key
+     */
+    type: Courier.AutomationAddToBatchRetainType;
+    /**
+     * The number of records to keep in batch. Default is 10 and only configurable by requesting from support.
+     * When configurable minimum is 2 and maximum is 100.
+     */
+    count: number;
+    /** Defines the data value data[sort_key] that is used to sort the stored items. Required when type is set to highest or lowest. */
+    sort_key?: string;
+}

package/dist/api/resources/automations/types/AutomationAddToBatchRetain.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/automations/types/AutomationAddToBatchRetainType.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type AutomationAddToBatchRetainType = "first" | "last" | "highest" | "lowest";
+export declare const AutomationAddToBatchRetainType: {
+    readonly First: "first";
+    readonly Last: "last";
+    readonly Highest: "highest";
+    readonly Lowest: "lowest";
+};

package/dist/api/resources/automations/types/AutomationAddToBatchRetainType.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AutomationAddToBatchRetainType = void 0;
+exports.AutomationAddToBatchRetainType = {
+    First: "first",
+    Last: "last",
+    Highest: "highest",
+    Lowest: "lowest",
+};

package/dist/api/resources/automations/types/AutomationAddToBatchScope.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type AutomationAddToBatchScope = "user" | "global" | "dynamic";
+export declare const AutomationAddToBatchScope: {
+    readonly User: "user";
+    readonly Global: "global";
+    readonly Dynamic: "dynamic";
+};

package/dist/api/resources/automations/types/AutomationAddToBatchScope.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AutomationAddToBatchScope = void 0;
+exports.AutomationAddToBatchScope = {
+    User: "user",
+    Global: "global",
+    Dynamic: "dynamic",
+};

package/dist/api/resources/automations/types/AutomationAddToBatchStep.d.ts

@@ -0,0 +1,39 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+/**
+ * @example
+ *     {
+ *         action: "add-to-batch",
+ *         wait_period: "PT5M",
+ *         max_wait_period: "PT1H",
+ *         retain: {
+ *             type: Courier.AutomationAddToBatchRetainType.Highest,
+ *             count: 10,
+ *             sort_key: "refs.data.my_custom_scoring"
+ *         },
+ *         scope: Courier.AutomationAddToBatchScope.User,
+ *         category_key: "refs.data.status"
+ *     }
+ */
+export interface AutomationAddToBatchStep extends Courier.AutomationStep {
+    action: "add-to-batch";
+    /** Defines the period of inactivity before the batch is released. Specified as an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) */
+    wait_period: string;
+    /** Defines the maximum wait time before the batch should be released. Must be less than wait period. Maximum of 60 days. Specified as an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) */
+    max_wait_period: string;
+    /** If specified, the batch will release as soon as this number is reached */
+    max_items?: Courier.AutomationAddToBatchMaxItemsType;
+    retain: Courier.AutomationAddToBatchRetain;
+    /**
+     * Determine the scope of the batching. If user, chosen in this order: recipient, profile.user_id, data.user_id, data.userId.
+     * If dynamic, then specify where the batch_key or a reference to the batch_key
+     */
+    scope?: Courier.AutomationAddToBatchScope;
+    /** If using scope=dynamic, provide the key or a reference (e.g., refs.data.batch_key) */
+    batch_key?: string;
+    batch_id?: string;
+    /** Defines the field of the data object the batch is set to when complete. Defaults to `batch` */
+    category_key?: string;
+}

package/dist/api/resources/automations/types/AutomationAddToBatchStep.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/automations/types/AutomationAddToDigestStep.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../..";
+/**
+ * @example
+ *     {
+ *         action: "add-to-digest",
+ *         subscription_topic_id: "RAJE97CMT04KDJJ88ZDS2TP1690S"
+ *     }
+ */
+export interface AutomationAddToDigestStep extends Courier.AutomationStep {
+    action: "add-to-digest";
+    /** The subscription topic that has digests enabled */
+    subscription_topic_id: string;
+}

package/dist/api/resources/automations/types/AutomationAddToDigestStep.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/automations/types/AutomationDelayStep.d.ts

@@ -4,5 +4,8 @@
 import * as Courier from "../../..";
 export interface AutomationDelayStep extends Courier.AutomationStep {
     action: "delay";
+    /** The [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) string for how long to delay for */
+    duration?: string;
+    /** The ISO 8601 timestamp for when the delay should end */
     until?: string;
 }