@trycourier/courier 6.3.1 → 6.4.1

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

@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -55,48 +65,39 @@ class Automations {
      * @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"
+     *     await client.automations.invokeAutomationTemplate("templateId", {
+     *         brand: undefined,
+     *         data: undefined,
+     *         profile: undefined,
+     *         recipient: undefined,
+     *         template: undefined
      *     })
      */
     invokeAutomationTemplate(templateId, request, requestOptions) {
-        var _a, _b;
+        return core.HttpResponsePromise.fromPromise(this.__invokeAutomationTemplate(templateId, request, requestOptions));
+    }
+    __invokeAutomationTemplate(templateId, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             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/${encodeURIComponent(templateId)}/invoke`),
+                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : 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.3.1",
-                    "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 : undefined,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@trycourier/courier", "X-Fern-SDK-Version": "6.4.1", "User-Agent": "@trycourier/courier/6.4.1", "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 : undefined }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
+                requestType: "json",
                 body: request,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return _response.body;
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
                 throw new errors.CourierError({
                     statusCode: _response.error.statusCode,
                     body: _response.error.body,
+                    rawResponse: _response.rawResponse,
                 });
             }
             switch (_response.error.reason) {
@@ -104,12 +105,14 @@ class Automations {
                     throw new errors.CourierError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling POST /automations/{templateId}/invoke.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
                     });
             }
         });
@@ -121,7 +124,7 @@ class Automations {
      * @param {Automations.IdempotentRequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.automations.invokeAdHocAutomation({
+     *     await client.automations.invokeAdHocAutomation({
      *         data: {
      *             "name": "Foo"
      *         },
@@ -142,33 +145,30 @@ class Automations {
      *     })
      */
     invokeAdHocAutomation(request, requestOptions) {
-        var _a, _b;
+        return core.HttpResponsePromise.fromPromise(this.__invokeAdHocAutomation(request, requestOptions));
+    }
+    __invokeAdHocAutomation(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             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/invoke"),
+                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CourierEnvironment.Production, "/automations/invoke"),
                 method: "POST",
-                headers: {
-                    Authorization: yield this._getAuthorizationHeader(),
-                    "X-Fern-Language": "JavaScript",
-                    "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.3.1",
-                    "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 : undefined,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@trycourier/courier", "X-Fern-SDK-Version": "6.4.1", "User-Agent": "@trycourier/courier/6.4.1", "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 : undefined }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
+                requestType: "json",
                 body: request,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return _response.body;
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
                 throw new errors.CourierError({
                     statusCode: _response.error.statusCode,
                     body: _response.error.body,
+                    rawResponse: _response.rawResponse,
                 });
             }
             switch (_response.error.reason) {
@@ -176,23 +176,25 @@ class Automations {
                     throw new errors.CourierError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling POST /automations/invoke.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
                     });
             }
         });
     }
     _getAuthorizationHeader() {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             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.",
+                    message: "Please specify a bearer by either passing it in to the constructor or initializing a COURIER_AUTH_TOKEN environment variable",
                 });
             }
             return `Bearer ${bearer}`;

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

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

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

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

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

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

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

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

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

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 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;
+export 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/api/resources/automations/types/AutomationThrottleScope.d.ts

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

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type MergeAlgorithm = "replace" | "none" | "overwrite" | "soft-merge";
+export type MergeAlgorithm = "replace" | "none" | "overwrite" | "soft-merge";
 export declare const MergeAlgorithm: {
     readonly Replace: "replace";
     readonly None: "none";

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

@@ -1,4 +1,4 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type Profile = any;
+export type Profile = any;

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

@@ -7,12 +7,20 @@ import * as Courier from "../../../index";
 export declare namespace Brands {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         authorizationToken?: core.Supplier<core.BearerToken | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
     interface IdempotentRequestOptions extends RequestOptions {
         idempotencyKey?: string | undefined;
@@ -31,37 +39,19 @@ export declare class Brands {
      * @throws {@link Courier.AlreadyExistsError}
      *
      * @example
-     *     await courier.brands.create({
-     *         id: "string",
-     *         name: "string",
+     *     await client.brands.create({
+     *         id: undefined,
+     *         name: "name",
      *         settings: {
-     *             colors: {
-     *                 primary: "string",
-     *                 secondary: "string",
-     *                 tertiary: "string"
-     *             },
-     *             inapp: {
-     *                 "key": "value"
-     *             },
-     *             email: {
-     *                 footer: {
-     *                     "key": "value"
-     *                 },
-     *                 header: {
-     *                     "key": "value"
-     *                 }
-     *             }
+     *             colors: undefined,
+     *             inapp: undefined,
+     *             email: undefined
      *         },
-     *         snippets: {
-     *             items: [{
-     *                     format: "handlebars",
-     *                     name: "string",
-     *                     value: "string"
-     *                 }]
-     *         }
+     *         snippets: undefined
      *     })
      */
-    create(request: Courier.BrandParameters, requestOptions?: Brands.IdempotentRequestOptions): Promise<Courier.Brand>;
+    create(request: Courier.BrandParameters, requestOptions?: Brands.IdempotentRequestOptions): core.HttpResponsePromise<Courier.Brand>;
+    private __create;
     /**
      * Fetch a specific brand by brand ID.
      *
@@ -69,9 +59,10 @@ export declare class Brands {
      * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.brands.get("string")
+     *     await client.brands.get("brand_id")
      */
-    get(brandId: string, requestOptions?: Brands.RequestOptions): Promise<Courier.Brand>;
+    get(brandId: string, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Courier.Brand>;
+    private __get;
     /**
      * Get the list of brands.
      *
@@ -79,11 +70,10 @@ export declare class Brands {
      * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.brands.list({
-     *         cursor: "string"
-     *     })
+     *     await client.brands.list()
      */
-    list(request?: Courier.ListBrandsRequest, requestOptions?: Brands.RequestOptions): Promise<Courier.BrandsResponse>;
+    list(request?: Courier.ListBrandsRequest, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Courier.BrandsResponse>;
+    private __list;
     /**
      * Delete a brand by brand ID.
      *
@@ -93,9 +83,10 @@ export declare class Brands {
      * @throws {@link Courier.ConflictError}
      *
      * @example
-     *     await courier.brands.delete("string")
+     *     await client.brands.delete("brand_id")
      */
-    delete(brandId: string, requestOptions?: Brands.RequestOptions): Promise<void>;
+    delete(brandId: string, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<void>;
+    private __delete;
     /**
      * Replace an existing brand with the supplied values.
      *
@@ -104,35 +95,13 @@ export declare class Brands {
      * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.brands.replace("string", {
-     *         name: "string",
-     *         settings: {
-     *             colors: {
-     *                 primary: "string",
-     *                 secondary: "string",
-     *                 tertiary: "string"
-     *             },
-     *             inapp: {
-     *                 "key": "value"
-     *             },
-     *             email: {
-     *                 footer: {
-     *                     "key": "value"
-     *                 },
-     *                 header: {
-     *                     "key": "value"
-     *                 }
-     *             }
-     *         },
-     *         snippets: {
-     *             items: [{
-     *                     format: "handlebars",
-     *                     name: "string",
-     *                     value: "string"
-     *                 }]
-     *         }
+     *     await client.brands.replace("brand_id", {
+     *         name: "name",
+     *         settings: undefined,
+     *         snippets: undefined
      *     })
      */
-    replace(brandId: string, request: Courier.BrandUpdateParameters, requestOptions?: Brands.RequestOptions): Promise<Courier.Brand>;
+    replace(brandId: string, request: Courier.BrandUpdateParameters, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Courier.Brand>;
+    private __replace;
     protected _getAuthorizationHeader(): Promise<string>;
 }