@trycourier/courier 6.3.1 → 6.4.0

package/api/resources/commons/errors/ConflictError.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;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConflictError = void 0;
 const errors = __importStar(require("../../../../errors/index"));

package/api/resources/commons/errors/MessageNotFoundError.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;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MessageNotFoundError = void 0;
 const errors = __importStar(require("../../../../errors/index"));

package/api/resources/commons/errors/NotFoundError.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;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NotFoundError = void 0;
 const errors = __importStar(require("../../../../errors/index"));

package/api/resources/commons/errors/PaymentRequiredError.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;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PaymentRequiredError = void 0;
 const errors = __importStar(require("../../../../errors/index"));

package/api/resources/commons/types/ChannelClassification.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type ChannelClassification = "direct_message" | "email" | "push" | "sms" | "webhook" | "inbox";
+export type ChannelClassification = "direct_message" | "email" | "push" | "sms" | "webhook" | "inbox";
 export declare const ChannelClassification: {
     readonly DirectMessage: "direct_message";
     readonly Email: "email";

package/api/resources/commons/types/NotificationPreferences.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 NotificationPreferences = Record<string, Courier.NotificationPreferenceDetails>;
+export type NotificationPreferences = Record<string, Courier.NotificationPreferenceDetails>;

package/api/resources/commons/types/PreferenceStatus.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type PreferenceStatus = "OPTED_IN" | "OPTED_OUT" | "REQUIRED";
+export type PreferenceStatus = "OPTED_IN" | "OPTED_OUT" | "REQUIRED";
 export declare const PreferenceStatus: {
     readonly OptedIn: "OPTED_IN";
     readonly OptedOut: "OPTED_OUT";

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

@@ -7,12 +7,20 @@ import * as Courier from "../../../index";
 export declare namespace Inbound {
     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>;
     }
 }
 export declare class Inbound {
@@ -26,7 +34,7 @@ export declare class Inbound {
      * @throws {@link Courier.ConflictError}
      *
      * @example
-     *     await courier.inbound.track({
+     *     await client.inbound.track({
      *         event: "New Order Placed",
      *         messageId: "4c62c457-b329-4bea-9bfc-17bba86c393f",
      *         userId: "1234",

package/api/resources/inbound/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) {
@@ -56,7 +66,7 @@ class Inbound {
      * @throws {@link Courier.ConflictError}
      *
      * @example
-     *     await courier.inbound.track({
+     *     await client.inbound.track({
      *         event: "New Order Placed",
      *         messageId: "4c62c457-b329-4bea-9bfc-17bba86c393f",
      *         userId: "1234",
@@ -69,23 +79,18 @@ class Inbound {
      *     })
      */
     track(request, requestOptions) {
-        var _a, _b;
         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, "/inbound/courier"),
+                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, "/inbound/courier"),
                 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,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@trycourier/courier", "X-Fern-SDK-Version": "6.4.0", "User-Agent": "@trycourier/courier/6.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, 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;
@@ -110,7 +115,7 @@ class Inbound {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling POST /inbound/courier.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -119,12 +124,12 @@ class Inbound {
         });
     }
     _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/index.js

@@ -15,13 +15,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 __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);
 };

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

@@ -7,12 +7,20 @@ import * as Courier from "../../../index";
 export declare namespace Lists {
     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,10 +39,7 @@ export declare class Lists {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.lists.list({
-     *         cursor: "string",
-     *         pattern: "string"
-     *     })
+     *     await client.lists.list()
      */
     list(request?: Courier.GetAllListsRequest, requestOptions?: Lists.RequestOptions): Promise<Courier.ListGetAllResponse>;
     /**
@@ -46,7 +51,7 @@ export declare class Lists {
      * @throws {@link Courier.NotFoundError}
      *
      * @example
-     *     await courier.lists.get("string")
+     *     await client.lists.get("list_id")
      */
     get(listId: string, requestOptions?: Lists.RequestOptions): Promise<Courier.List>;
     /**
@@ -57,12 +62,9 @@ export declare class Lists {
      * @param {Lists.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.lists.update("string", {
-     *         name: "string",
-     *         preferences: {
-     *             categories: {},
-     *             notifications: {}
-     *         }
+     *     await client.lists.update("list_id", {
+     *         name: "name",
+     *         preferences: undefined
      *     })
      */
     update(listId: string, request: Courier.ListPutParams, requestOptions?: Lists.RequestOptions): Promise<Courier.List>;
@@ -73,7 +75,7 @@ export declare class Lists {
      * @param {Lists.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.lists.delete("string")
+     *     await client.lists.delete("list_id")
      */
     delete(listId: string, requestOptions?: Lists.RequestOptions): Promise<void>;
     /**
@@ -83,7 +85,7 @@ export declare class Lists {
      * @param {Lists.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.lists.restore("string")
+     *     await client.lists.restore("list_id")
      */
     restore(listId: string, requestOptions?: Lists.RequestOptions): Promise<void>;
     /**
@@ -96,9 +98,7 @@ export declare class Lists {
      * @throws {@link Courier.NotFoundError}
      *
      * @example
-     *     await courier.lists.getSubscribers("string", {
-     *         cursor: "string"
-     *     })
+     *     await client.lists.getSubscribers("list_id")
      */
     getSubscribers(listId: string, request?: Courier.GetSubscriptionForListRequest, requestOptions?: Lists.RequestOptions): Promise<Courier.ListGetSubscriptionsResponse>;
     /**
@@ -111,13 +111,13 @@ export declare class Lists {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.lists.updateSubscribers("string", {
+     *     await client.lists.updateSubscribers("list_id", {
      *         recipients: [{
-     *                 recipientId: "string",
-     *                 preferences: {
-     *                     categories: {},
-     *                     notifications: {}
-     *                 }
+     *                 recipientId: "recipientId",
+     *                 preferences: undefined
+     *             }, {
+     *                 recipientId: "recipientId",
+     *                 preferences: undefined
      *             }]
      *     })
      */
@@ -132,13 +132,13 @@ export declare class Lists {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.lists.addSubscribers("string", {
+     *     await client.lists.addSubscribers("list_id", {
      *         recipients: [{
-     *                 recipientId: "string",
-     *                 preferences: {
-     *                     categories: {},
-     *                     notifications: {}
-     *                 }
+     *                 recipientId: "recipientId",
+     *                 preferences: undefined
+     *             }, {
+     *                 recipientId: "recipientId",
+     *                 preferences: undefined
      *             }]
      *     })
      */
@@ -152,11 +152,8 @@ export declare class Lists {
      * @param {Lists.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.lists.subscribe("string", "string", {
-     *         preferences: {
-     *             categories: {},
-     *             notifications: {}
-     *         }
+     *     await client.lists.subscribe("list_id", "user_id", {
+     *         preferences: undefined
      *     })
      */
     subscribe(listId: string, userId: string, request?: Courier.SubscribeUserToListRequest, requestOptions?: Lists.RequestOptions): Promise<void>;
@@ -170,7 +167,7 @@ export declare class Lists {
      * @throws {@link Courier.NotFoundError}
      *
      * @example
-     *     await courier.lists.unsubscribe("string", "string")
+     *     await client.lists.unsubscribe("list_id", "user_id")
      */
     unsubscribe(listId: string, userId: string, requestOptions?: Lists.RequestOptions): Promise<void>;
     protected _getAuthorizationHeader(): Promise<string>;