@trycourier/courier 6.1.0 → 6.1.2

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 "../../../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/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 "../../../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/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 "../../../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/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/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/dist/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;
 }

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

@@ -0,0 +1,31 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../../index";
+/**
+ * @example
+ *     {
+ *         action: "fetch-data",
+ *         merge_strategy: Courier.MergeAlgorithm.None,
+ *         webhook: {
+ *             body: {
+ *                 "foo": "bar"
+ *             },
+ *             params: {
+ *                 "hello": "world"
+ *             },
+ *             headers: {
+ *                 "content-type": "application/json"
+ *             },
+ *             method: Courier.AutomationFetchDataWebhookMethod.Post,
+ *             url: "https://bryan-at-courier.free.beeceptor.com"
+ *         }
+ *     }
+ */
+export interface AutomationFetchDataStep extends Courier.AutomationStep {
+    action: "fetch-data";
+    webhook: Courier.AutomationFetchDataWebhook;
+    merge_strategy: Courier.MergeAlgorithm;
+    idempotency_expiry?: string;
+    idempotency_key?: string;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../../index";
+export interface AutomationFetchDataWebhook {
+    body?: Record<string, any>;
+    headers?: Record<string, any>;
+    params?: Record<string, any>;
+    method: Courier.AutomationFetchDataWebhookMethod;
+    url: string;
+}

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type AutomationFetchDataWebhookMethod = "GET" | "POST";
+export declare const AutomationFetchDataWebhookMethod: {
+    readonly Get: "GET";
+    readonly Post: "POST";
+};

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

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AutomationFetchDataWebhookMethod = void 0;
+exports.AutomationFetchDataWebhookMethod = {
+    Get: "GET",
+    Post: "POST",
+};

package/dist/api/resources/automations/types/AutomationInvokeParams.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 AutomationInvokeParams {
     brand?: string;
     data?: Record<string, any>;

package/dist/api/resources/automations/types/AutomationInvokeStep.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 AutomationInvokeStep extends Courier.AutomationStep {
     action: "invoke";
     template: string;

package/dist/api/resources/automations/types/AutomationInvokeTemplateParams.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 AutomationInvokeTemplateParams extends Courier.AutomationInvokeParams {
     templateId: string;
 }

package/dist/api/resources/automations/types/AutomationRunContext.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 AutomationRunContext {
     brand?: string;
     data?: any;

package/dist/api/resources/automations/types/AutomationSendListStep.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 AutomationSendListStep extends Courier.AutomationStep {
     action: "send-list";
     brand?: string;

package/dist/api/resources/automations/types/AutomationSendStep.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 AutomationSendStep extends Courier.AutomationStep {
     action: "send";
     brand?: string;

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

@@ -1,5 +1,5 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
-export declare type AutomationStepOption = Courier.AutomationCancelStep | Courier.AutomationDelayStep | Courier.AutomationInvokeStep | Courier.AutomationSendStep | Courier.AutomationV2SendStep | Courier.AutomationSendListStep | Courier.AutomationUpdateProfileStep;
+import * as Courier from "../../../index";
+export declare type AutomationStepOption = Courier.AutomationAddToDigestStep | Courier.AutomationAddToBatchStep | Courier.AutomationThrottleStep | Courier.AutomationCancelStep | Courier.AutomationDelayStep | Courier.AutomationFetchDataStep | Courier.AutomationInvokeStep | Courier.AutomationSendStep | Courier.AutomationV2SendStep | Courier.AutomationSendListStep | Courier.AutomationUpdateProfileStep;

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface AutomationThrottleOnThrottle {
+    /** The node to go to if the request is throttled */
+    $node_id: string;
+}

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

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

package/dist/api/resources/automations/types/AutomationThrottleScope.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.AutomationThrottleScope = void 0;
+exports.AutomationThrottleScope = {
+    User: "user",
+    Global: "global",
+    Dynamic: "dynamic",
+};

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

@@ -0,0 +1,31 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../../index";
+/**
+ * @example
+ *     {
+ *         action: "throttle",
+ *         max_allowed: 1,
+ *         period: "PT5M",
+ *         scope: Courier.AutomationThrottleScope.Dynamic,
+ *         throttle_key: "refs.data.throttle_key",
+ *         should_alert: false,
+ *         on_throttle: {
+ *             $node_id: "on-throttle-node-ref"
+ *         }
+ *     }
+ */
+export interface AutomationThrottleStep extends Courier.AutomationStep {
+    action: "throttle";
+    /** Maximum number of allowed notifications in that timeframe */
+    max_allowed: number;
+    /** Defines the throttle period which corresponds to the max_allowed. Specified as an ISO 8601 duration, https://en.wikipedia.org/wiki/ISO_8601#Durations */
+    period: string;
+    scope: Courier.AutomationThrottleScope;
+    /** If using scope=dynamic, provide the reference (e.g., refs.data.throttle_key) to the how the throttle should be identified */
+    throttle_key?: string;
+    /** Value must be true */
+    should_alert: false;
+    on_throttle: Courier.AutomationThrottleOnThrottle;
+}

package/dist/api/resources/automations/types/AutomationThrottleStep.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/AutomationUpdateProfileStep.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 AutomationUpdateProfileStep {
     action: "update-profile";
     recipient_id: string;

package/dist/api/resources/automations/types/AutomationV2SendStep.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 AutomationV2SendStep extends Courier.AutomationStep {
     action: "send";
     message: Courier.Message;

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

@@ -1,13 +1,25 @@
-export * from "./AutomationStepAction";
+export * from "./AccessorType";
 export * from "./MergeAlgorithm";
 export * from "./AutomationRunContext";
 export * from "./AutomationStep";
+export * from "./AutomationAddToBatchScope";
+export * from "./AutomationAddToBatchStep";
+export * from "./AutomationAddToBatchMaxItemsType";
+export * from "./AutomationAddToBatchRetainType";
+export * from "./AutomationFetchDataWebhookMethod";
+export * from "./AutomationFetchDataWebhook";
+export * from "./AutomationThrottleScope";
+export * from "./AutomationThrottleOnThrottle";
+export * from "./AutomationAddToBatchRetain";
+export * from "./AutomationAddToDigestStep";
 export * from "./AutomationCancelStep";
 export * from "./AutomationDelayStep";
+export * from "./AutomationFetchDataStep";
 export * from "./AutomationInvokeStep";
 export * from "./AutomationSendStep";
 export * from "./AutomationV2SendStep";
 export * from "./AutomationSendListStep";
+export * from "./AutomationThrottleStep";
 export * from "./AutomationUpdateProfileStep";
 export * from "./AutomationStepOption";
 export * from "./Automation";

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

@@ -14,16 +14,28 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./AutomationStepAction"), exports);
+__exportStar(require("./AccessorType"), exports);
 __exportStar(require("./MergeAlgorithm"), exports);
 __exportStar(require("./AutomationRunContext"), exports);
 __exportStar(require("./AutomationStep"), exports);
+__exportStar(require("./AutomationAddToBatchScope"), exports);
+__exportStar(require("./AutomationAddToBatchStep"), exports);
+__exportStar(require("./AutomationAddToBatchMaxItemsType"), exports);
+__exportStar(require("./AutomationAddToBatchRetainType"), exports);
+__exportStar(require("./AutomationFetchDataWebhookMethod"), exports);
+__exportStar(require("./AutomationFetchDataWebhook"), exports);
+__exportStar(require("./AutomationThrottleScope"), exports);
+__exportStar(require("./AutomationThrottleOnThrottle"), exports);
+__exportStar(require("./AutomationAddToBatchRetain"), exports);
+__exportStar(require("./AutomationAddToDigestStep"), exports);
 __exportStar(require("./AutomationCancelStep"), exports);
 __exportStar(require("./AutomationDelayStep"), exports);
+__exportStar(require("./AutomationFetchDataStep"), exports);
 __exportStar(require("./AutomationInvokeStep"), exports);
 __exportStar(require("./AutomationSendStep"), exports);
 __exportStar(require("./AutomationV2SendStep"), exports);
 __exportStar(require("./AutomationSendListStep"), exports);
+__exportStar(require("./AutomationThrottleStep"), exports);
 __exportStar(require("./AutomationUpdateProfileStep"), exports);
 __exportStar(require("./AutomationStepOption"), exports);
 __exportStar(require("./Automation"), exports);

package/dist/api/resources/brands/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 Brands {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
@@ -16,33 +16,88 @@ export declare namespace Brands {
     }
     interface IdempotentRequestOptions extends RequestOptions {
         idempotencyKey?: string | undefined;
-        idempotencyExpiry?: number | undefined;
+        idempotencyExpiry?: string | undefined;
     }
 }
 export declare class Brands {
     protected readonly _options: Brands.Options;
     constructor(_options?: Brands.Options);
     /**
+     * @param {Courier.BrandParameters} request
+     * @param {Brands.IdempotentRequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
      * @throws {@link Courier.PaymentRequiredError}
      * @throws {@link Courier.AlreadyExistsError}
+     *
+     * @example
+     *     await courier.brands.create({
+     *         id: "string",
+     *         name: "string",
+     *         settings: {},
+     *         snippets: {}
+     *     })
      */
     create(request: Courier.BrandParameters, requestOptions?: Brands.IdempotentRequestOptions): Promise<Courier.Brand>;
     /**
      * Fetch a specific brand by brand ID.
+     *
+     * @param {string} brandId - A unique identifier associated with the brand you wish to retrieve.
+     * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.brands.get("string")
      */
     get(brandId: string, requestOptions?: Brands.RequestOptions): Promise<Courier.Brand>;
     /**
      * Get the list of brands.
+     *
+     * @param {Courier.ListBrandsRequest} request
+     * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.brands.list({
+     *         cursor: "string"
+     *     })
      */
     list(request?: Courier.ListBrandsRequest, requestOptions?: Brands.RequestOptions): Promise<Courier.BrandsResponse>;
     /**
      * Delete a brand by brand ID.
+     *
+     * @param {string} brandId - A unique identifier associated with the brand you wish to retrieve.
+     * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.ConflictError}
+     *
+     * @example
+     *     await courier.brands.delete("string")
      */
     delete(brandId: string, requestOptions?: Brands.RequestOptions): Promise<void>;
     /**
      * Replace an existing brand with the supplied values.
+     *
+     * @param {string} brandId - A unique identifier associated with the brand you wish to update.
+     * @param {Courier.BrandUpdateParameters} request
+     * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.brands.replace("string", {
+     *         name: "string",
+     *         settings: {
+     *             colors: {},
+     *             inapp: {
+     *                 "key": "value"
+     *             },
+     *             email: {}
+     *         },
+     *         snippets: {
+     *             items: [{
+     *                     format: "handlebars",
+     *                     name: "string",
+     *                     value: "string"
+     *                 }]
+     *         }
+     *     })
      */
     replace(brandId: string, request: Courier.BrandUpdateParameters, requestOptions?: Brands.RequestOptions): Promise<Courier.Brand>;
     protected _getAuthorizationHeader(): Promise<string>;