@trycourier/courier 6.1.0 → 6.1.2

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

@@ -42,13 +42,21 @@ exports.AuditEvents = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
 const url_join_1 = __importDefault(require("url-join"));
-const errors = __importStar(require("../../../../errors"));
+const errors = __importStar(require("../../../../errors/index"));
 class AuditEvents {
     constructor(_options = {}) {
         this._options = _options;
     }
     /**
      * Fetch the list of audit events
+     *
+     * @param {Courier.ListAuditEventsRequest} request
+     * @param {AuditEvents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.auditEvents.list({
+     *         cursor: "string"
+     *     })
      */
     list(request = {}, requestOptions) {
         var _a, _b;
@@ -65,7 +73,9 @@ 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.2",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -98,18 +108,26 @@ class AuditEvents {
     }
     /**
      * Fetch a specific audit event by ID.
+     *
+     * @param {string} auditEventId - A unique identifier associated with the audit event you wish to retrieve
+     * @param {AuditEvents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.auditEvents.get("string")
      */
     get(auditEventId, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/audit-events/${auditEventId}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/audit-events/${encodeURIComponent(auditEventId)}`),
                 method: "GET",
                 headers: {
                     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.2",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -142,7 +160,7 @@ class AuditEvents {
     _getAuthorizationHeader() {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process.env["COURIER_AUTH_TOKEN"];
+            const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["COURIER_AUTH_TOKEN"];
             if (bearer == null) {
                 throw new errors.CourierError({
                     message: "Please specify COURIER_AUTH_TOKEN when instantiating the client.",

package/api/resources/auditEvents/client/requests/ListAuditEventsRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         cursor: "string"
+ *     }
+ */
 export interface ListAuditEventsRequest {
     /**
      * A unique identifier that allows for fetching the next set of audit events.

package/api/resources/auditEvents/client/requests/index.d.ts

@@ -1 +1 @@
-export { ListAuditEventsRequest } from "./ListAuditEventsRequest";
+export { type ListAuditEventsRequest } from "./ListAuditEventsRequest";

package/api/resources/auditEvents/types/AuditEvent.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface AuditEvent {
     actor?: Courier.Actor;
     target?: Courier.Target;

package/api/resources/auditEvents/types/ListAuditEventsResponse.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface ListAuditEventsResponse {
     paging: Courier.Paging;
     results: Courier.AuditEvent[];

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

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export declare namespace AuthTokens {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
@@ -16,7 +16,7 @@ export declare namespace AuthTokens {
     }
     interface IdempotentRequestOptions extends RequestOptions {
         idempotencyKey?: string | undefined;
-        idempotencyExpiry?: number | undefined;
+        idempotencyExpiry?: string | undefined;
     }
 }
 export declare class AuthTokens {
@@ -24,6 +24,15 @@ export declare class AuthTokens {
     constructor(_options?: AuthTokens.Options);
     /**
      * Returns a new access token.
+     *
+     * @param {Courier.IssueTokenParams} request
+     * @param {AuthTokens.IdempotentRequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.authTokens.issueToken({
+     *         scope: "string",
+     *         expires_in: "string"
+     *     })
      */
     issueToken(request: Courier.IssueTokenParams, requestOptions?: AuthTokens.IdempotentRequestOptions): Promise<Courier.IssueTokenResponse>;
     protected _getAuthorizationHeader(): Promise<string>;

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

@@ -42,13 +42,22 @@ exports.AuthTokens = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
 const url_join_1 = __importDefault(require("url-join"));
-const errors = __importStar(require("../../../../errors"));
+const errors = __importStar(require("../../../../errors/index"));
 class AuthTokens {
     constructor(_options = {}) {
         this._options = _options;
     }
     /**
      * Returns a new access token.
+     *
+     * @param {Courier.IssueTokenParams} request
+     * @param {AuthTokens.IdempotentRequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.authTokens.issueToken({
+     *         scope: "string",
+     *         expires_in: "string"
+     *     })
      */
     issueToken(request, requestOptions) {
         var _a, _b;
@@ -60,11 +69,11 @@ 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.2",
+                    "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,
-                    "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null
-                        ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry.toString()
-                        : undefined,
+                    "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry : undefined,
                 },
                 contentType: "application/json",
                 body: request,
@@ -98,7 +107,7 @@ class AuthTokens {
     _getAuthorizationHeader() {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process.env["COURIER_AUTH_TOKEN"];
+            const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["COURIER_AUTH_TOKEN"];
             if (bearer == null) {
                 throw new errors.CourierError({
                     message: "Please specify COURIER_AUTH_TOKEN when instantiating the client.",

package/api/resources/authTokens/client/requests/IssueTokenParams.d.ts

@@ -1,6 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         scope: "string",
+ *         expires_in: "string"
+ *     }
+ */
 export interface IssueTokenParams {
     scope: string;
     expires_in: string;

package/api/resources/authTokens/client/requests/index.d.ts

@@ -1 +1 @@
-export { IssueTokenParams } from "./IssueTokenParams";
+export { type IssueTokenParams } from "./IssueTokenParams";

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

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export declare namespace Automations {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
@@ -16,7 +16,7 @@ export declare namespace Automations {
     }
     interface IdempotentRequestOptions extends RequestOptions {
         idempotencyKey?: string | undefined;
-        idempotencyExpiry?: number | undefined;
+        idempotencyExpiry?: string | undefined;
     }
 }
 export declare class Automations {
@@ -24,10 +24,53 @@ export declare class Automations {
     constructor(_options?: Automations.Options);
     /**
      * Invoke an automation run from an automation template.
+     *
+     * @param {string} templateId - A unique identifier representing the automation template to be invoked. This could be the Automation Template ID or the Automation Template Alias.
+     * @param {Courier.AutomationInvokeParams} request
+     * @param {Automations.IdempotentRequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.automations.invokeAutomationTemplate("string", {
+     *         brand: "string",
+     *         data: {
+     *             "string": {
+     *                 "key": "value"
+     *             }
+     *         },
+     *         profile: {
+     *             "key": "value"
+     *         },
+     *         recipient: "string",
+     *         template: "string"
+     *     })
      */
     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/).
+     *
+     * @param {Courier.AutomationAdHocInvokeParams} request
+     * @param {Automations.IdempotentRequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @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: [{
+     *                     action: "delay",
+     *                     until: "20240408T080910.123"
+     *                 }, {
+     *                     action: "send",
+     *                     template: "64TP5HKPFTM8VTK1Y75SJDQX9JK0"
+     *                 }]
+     *         }
+     *     })
      */
     invokeAdHocAutomation(request: Courier.AutomationAdHocInvokeParams, requestOptions?: Automations.IdempotentRequestOptions): Promise<Courier.AutomationInvokeResponse>;
     protected _getAuthorizationHeader(): Promise<string>;

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

@@ -42,29 +42,48 @@ exports.Automations = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
 const url_join_1 = __importDefault(require("url-join"));
-const errors = __importStar(require("../../../../errors"));
+const errors = __importStar(require("../../../../errors/index"));
 class Automations {
     constructor(_options = {}) {
         this._options = _options;
     }
     /**
      * Invoke an automation run from an automation template.
+     *
+     * @param {string} templateId - A unique identifier representing the automation template to be invoked. This could be the Automation Template ID or the Automation Template Alias.
+     * @param {Courier.AutomationInvokeParams} request
+     * @param {Automations.IdempotentRequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.automations.invokeAutomationTemplate("string", {
+     *         brand: "string",
+     *         data: {
+     *             "string": {
+     *                 "key": "value"
+     *             }
+     *         },
+     *         profile: {
+     *             "key": "value"
+     *         },
+     *         recipient: "string",
+     *         template: "string"
+     *     })
      */
     invokeAutomationTemplate(templateId, request, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/automations/${templateId}/invoke`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/automations/${encodeURIComponent(templateId)}/invoke`),
                 method: "POST",
                 headers: {
                     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.2",
+                    "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,
-                    "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null
-                        ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry.toString()
-                        : undefined,
+                    "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry : undefined,
                 },
                 contentType: "application/json",
                 body: request,
@@ -97,6 +116,30 @@ 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/).
+     *
+     * @param {Courier.AutomationAdHocInvokeParams} request
+     * @param {Automations.IdempotentRequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @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: [{
+     *                     action: "delay",
+     *                     until: "20240408T080910.123"
+     *                 }, {
+     *                     action: "send",
+     *                     template: "64TP5HKPFTM8VTK1Y75SJDQX9JK0"
+     *                 }]
+     *         }
+     *     })
      */
     invokeAdHocAutomation(request, requestOptions) {
         var _a, _b;
@@ -108,11 +151,11 @@ 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.2",
+                    "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,
-                    "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null
-                        ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry.toString()
-                        : undefined,
+                    "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry : undefined,
                 },
                 contentType: "application/json",
                 body: request,
@@ -146,7 +189,7 @@ class Automations {
     _getAuthorizationHeader() {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process.env["COURIER_AUTH_TOKEN"];
+            const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["COURIER_AUTH_TOKEN"];
             if (bearer == null) {
                 throw new errors.CourierError({
                     message: "Please specify COURIER_AUTH_TOKEN when instantiating the client.",

package/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/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/api/resources/automations/types/Automation.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface Automation {
     cancelation_token?: string;
     steps: Courier.AutomationStepOption[];

package/api/resources/automations/types/AutomationAdHocInvokeParams.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface AutomationAdHocInvokeParams extends Courier.AutomationInvokeParams {
     automation: Courier.Automation;
 }

package/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/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/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 "../../../index";
+/**
+ * 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/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/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/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/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/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/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 "../../../index";
+/**
+ * @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/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/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 "../../../index";
+/**
+ * @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/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/api/resources/automations/types/AutomationCancelStep.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface AutomationCancelStep extends Courier.AutomationStep {
     action: "cancel";
     cancelation_token?: string;

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

@@ -1,8 +1,11 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 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;
 }