@trycourier/courier 6.3.1 → 6.4.1

package/api/resources/bulk/types/InboundBulkMessageV2.d.ts

@@ -2,15 +2,13 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Courier from "../../../index";
-export declare type InboundBulkMessageV2 = 
+export type InboundBulkMessageV2 = 
 /**
  * Describes the content of the message in a way that will
- * work for email, push, chat, or any channel.
- *  */
+ * work for email, push, chat, or any channel. */
 Courier.InboundBulkTemplateMessage
 /**
  * A template for a type of message that can be sent more than once.
  * For example, you might create an "Appointment Reminder" Notification or
- * “Reset Password” Notifications.
- *  */
+ * “Reset Password” Notifications. */
  | Courier.InboundBulkContentMessage;

package/api/resources/commons/errors/AlreadyExistsError.d.ts

@@ -3,6 +3,7 @@
  */
 import * as errors from "../../../../errors/index";
 import * as Courier from "../../../index";
+import * as core from "../../../../core";
 export declare class AlreadyExistsError extends errors.CourierError {
-    constructor(body: Courier.AlreadyExists);
+    constructor(body: Courier.AlreadyExists, rawResponse?: core.RawResponse);
 }

package/api/resources/commons/errors/AlreadyExistsError.js

@@ -18,22 +18,33 @@ 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.AlreadyExistsError = void 0;
 const errors = __importStar(require("../../../../errors/index"));
 class AlreadyExistsError extends errors.CourierError {
-    constructor(body) {
+    constructor(body, rawResponse) {
         super({
             message: "AlreadyExistsError",
             statusCode: 409,
             body: body,
+            rawResponse: rawResponse,
         });
         Object.setPrototypeOf(this, AlreadyExistsError.prototype);
     }

package/api/resources/commons/errors/BadRequestError.d.ts

@@ -3,6 +3,7 @@
  */
 import * as errors from "../../../../errors/index";
 import * as Courier from "../../../index";
+import * as core from "../../../../core";
 export declare class BadRequestError extends errors.CourierError {
-    constructor(body: Courier.BadRequest);
+    constructor(body: Courier.BadRequest, rawResponse?: core.RawResponse);
 }

package/api/resources/commons/errors/BadRequestError.js

@@ -18,22 +18,33 @@ 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.BadRequestError = void 0;
 const errors = __importStar(require("../../../../errors/index"));
 class BadRequestError extends errors.CourierError {
-    constructor(body) {
+    constructor(body, rawResponse) {
         super({
             message: "BadRequestError",
             statusCode: 400,
             body: body,
+            rawResponse: rawResponse,
         });
         Object.setPrototypeOf(this, BadRequestError.prototype);
     }

package/api/resources/commons/errors/ConflictError.d.ts

@@ -3,6 +3,7 @@
  */
 import * as errors from "../../../../errors/index";
 import * as Courier from "../../../index";
+import * as core from "../../../../core";
 export declare class ConflictError extends errors.CourierError {
-    constructor(body: Courier.Conflict);
+    constructor(body: Courier.Conflict, rawResponse?: core.RawResponse);
 }

package/api/resources/commons/errors/ConflictError.js

@@ -18,22 +18,33 @@ 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"));
 class ConflictError extends errors.CourierError {
-    constructor(body) {
+    constructor(body, rawResponse) {
         super({
             message: "ConflictError",
             statusCode: 409,
             body: body,
+            rawResponse: rawResponse,
         });
         Object.setPrototypeOf(this, ConflictError.prototype);
     }

package/api/resources/commons/errors/MessageNotFoundError.d.ts

@@ -3,6 +3,7 @@
  */
 import * as errors from "../../../../errors/index";
 import * as Courier from "../../../index";
+import * as core from "../../../../core";
 export declare class MessageNotFoundError extends errors.CourierError {
-    constructor(body: Courier.MessageNotFound);
+    constructor(body: Courier.MessageNotFound, rawResponse?: core.RawResponse);
 }

package/api/resources/commons/errors/MessageNotFoundError.js

@@ -18,22 +18,33 @@ 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"));
 class MessageNotFoundError extends errors.CourierError {
-    constructor(body) {
+    constructor(body, rawResponse) {
         super({
             message: "MessageNotFoundError",
             statusCode: 404,
             body: body,
+            rawResponse: rawResponse,
         });
         Object.setPrototypeOf(this, MessageNotFoundError.prototype);
     }

package/api/resources/commons/errors/NotFoundError.d.ts

@@ -3,6 +3,7 @@
  */
 import * as errors from "../../../../errors/index";
 import * as Courier from "../../../index";
+import * as core from "../../../../core";
 export declare class NotFoundError extends errors.CourierError {
-    constructor(body: Courier.NotFound);
+    constructor(body: Courier.NotFound, rawResponse?: core.RawResponse);
 }

package/api/resources/commons/errors/NotFoundError.js

@@ -18,22 +18,33 @@ 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"));
 class NotFoundError extends errors.CourierError {
-    constructor(body) {
+    constructor(body, rawResponse) {
         super({
             message: "NotFoundError",
             statusCode: 404,
             body: body,
+            rawResponse: rawResponse,
         });
         Object.setPrototypeOf(this, NotFoundError.prototype);
     }

package/api/resources/commons/errors/PaymentRequiredError.d.ts

@@ -3,6 +3,7 @@
  */
 import * as errors from "../../../../errors/index";
 import * as Courier from "../../../index";
+import * as core from "../../../../core";
 export declare class PaymentRequiredError extends errors.CourierError {
-    constructor(body: Courier.PaymentRequired);
+    constructor(body: Courier.PaymentRequired, rawResponse?: core.RawResponse);
 }

package/api/resources/commons/errors/PaymentRequiredError.js

@@ -18,22 +18,33 @@ 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"));
 class PaymentRequiredError extends errors.CourierError {
-    constructor(body) {
+    constructor(body, rawResponse) {
         super({
             message: "PaymentRequiredError",
             statusCode: 402,
             body: body,
+            rawResponse: rawResponse,
         });
         Object.setPrototypeOf(this, PaymentRequiredError.prototype);
     }

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",
@@ -38,6 +46,7 @@ export declare class Inbound {
      *         }
      *     })
      */
-    track(request: Courier.InboundTrackEvent, requestOptions?: Inbound.RequestOptions): Promise<Courier.TrackAcceptedResponse>;
+    track(request: Courier.InboundTrackEvent, requestOptions?: Inbound.RequestOptions): core.HttpResponsePromise<Courier.TrackAcceptedResponse>;
+    private __track;
     protected _getAuthorizationHeader(): Promise<string>;
 }

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,37 +79,36 @@ class Inbound {
      *     })
      */
     track(request, requestOptions) {
-        var _a, _b;
+        return core.HttpResponsePromise.fromPromise(this.__track(request, requestOptions));
+    }
+    __track(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, "/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.1", "User-Agent": "@trycourier/courier/6.4.1", "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;
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 400:
-                        throw new Courier.BadRequestError(_response.error.body);
+                        throw new Courier.BadRequestError(_response.error.body, _response.rawResponse);
                     case 409:
-                        throw new Courier.ConflictError(_response.error.body);
+                        throw new Courier.ConflictError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.CourierError({
                             statusCode: _response.error.statusCode,
                             body: _response.error.body,
+                            rawResponse: _response.rawResponse,
                         });
                 }
             }
@@ -108,23 +117,25 @@ class Inbound {
                     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 /inbound/courier.");
                 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/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);
 };