@trycourier/courier 6.3.1 → 6.4.0

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

@@ -7,12 +7,20 @@ import * as Courier from "../../../index";
 export declare namespace Messages {
     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;
@@ -29,22 +37,7 @@ export declare class Messages {
      * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.messages.list({
-     *         archived: true,
-     *         cursor: "string",
-     *         event: "string",
-     *         list: "string",
-     *         messageId: "string",
-     *         notification: "string",
-     *         provider: "string",
-     *         recipient: "string",
-     *         status: "string",
-     *         tag: "string",
-     *         tags: "string",
-     *         tenant_id: "string",
-     *         enqueued_after: "string",
-     *         traceId: "string"
-     *     })
+     *     await client.messages.list()
      */
     list(request?: Courier.ListMessagesRequest, requestOptions?: Messages.RequestOptions): Promise<Courier.ListMessagesResponse>;
     /**
@@ -57,9 +50,9 @@ export declare class Messages {
      * @throws {@link Courier.MessageNotFoundError}
      *
      * @example
-     *     await courier.messages.get("string")
+     *     await client.messages.get("message_id")
      */
-    get(messageId: string, requestOptions?: Messages.RequestOptions): Promise<Courier.MessageDetails>;
+    get(messageId: string, requestOptions?: Messages.RequestOptions): Promise<Courier.MessageDetailsExtended>;
     /**
      * Cancel a message that is currently in the process of being delivered. A well-formatted API call to the cancel message API will return either `200` status code for a successful cancellation or `409` status code for an unsuccessful cancellation. Both cases will include the actual message record in the response body (see details below).
      *
@@ -67,7 +60,7 @@ export declare class Messages {
      * @param {Messages.IdempotentRequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.messages.cancel("string")
+     *     await client.messages.cancel("message_id")
      */
     cancel(messageId: string, requestOptions?: Messages.IdempotentRequestOptions): Promise<Courier.MessageDetails>;
     /**
@@ -81,9 +74,7 @@ export declare class Messages {
      * @throws {@link Courier.MessageNotFoundError}
      *
      * @example
-     *     await courier.messages.getHistory("string", {
-     *         type: "string"
-     *     })
+     *     await client.messages.getHistory("message_id")
      */
     getHistory(messageId: string, request?: Courier.GetMessageHistoryRequest, requestOptions?: Messages.RequestOptions): Promise<Courier.MessageHistoryResponse>;
     /**
@@ -94,7 +85,7 @@ export declare class Messages {
      * @throws {@link Courier.MessageNotFoundError}
      *
      * @example
-     *     await courier.messages.getContent("string")
+     *     await client.messages.getContent("message_id")
      */
     getContent(messageId: string, requestOptions?: Messages.RequestOptions): Promise<Courier.RenderOutputResponse>;
     /**
@@ -102,7 +93,7 @@ export declare class Messages {
      * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.messages.archive("string")
+     *     await client.messages.archive("request_id")
      */
     archive(requestId: string, requestOptions?: Messages.RequestOptions): Promise<void>;
     protected _getAuthorizationHeader(): Promise<string>;

package/api/resources/messages/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,26 +65,11 @@ class Messages {
      * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.messages.list({
-     *         archived: true,
-     *         cursor: "string",
-     *         event: "string",
-     *         list: "string",
-     *         messageId: "string",
-     *         notification: "string",
-     *         provider: "string",
-     *         recipient: "string",
-     *         status: "string",
-     *         tag: "string",
-     *         tags: "string",
-     *         tenant_id: "string",
-     *         enqueued_after: "string",
-     *         traceId: "string"
-     *     })
+     *     await client.messages.list()
      */
-    list(request = {}, requestOptions) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function* () {
+    list() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c;
             const { archived, cursor, event, list, messageId, notification, provider, recipient, status, tag, tags, tenant_id: tenantId, enqueued_after: enqueuedAfter, traceId, } = request;
             const _queryParams = {};
             if (archived != null) {
@@ -135,20 +130,15 @@ class Messages {
                 _queryParams["traceId"] = traceId;
             }
             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, "messages"),
+                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, "messages"),
                 method: "GET",
-                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",
                 queryParameters: _queryParams,
+                requestType: "json",
                 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;
@@ -166,7 +156,7 @@ class Messages {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /messages.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -184,25 +174,20 @@ class Messages {
      * @throws {@link Courier.MessageNotFoundError}
      *
      * @example
-     *     await courier.messages.get("string")
+     *     await client.messages.get("message_id")
      */
     get(messageId, 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, `messages/${encodeURIComponent(messageId)}`),
+                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, `messages/${encodeURIComponent(messageId)}`),
                 method: "GET",
-                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",
                 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;
@@ -227,7 +212,7 @@ class Messages {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /messages/{message_id}.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -242,27 +227,20 @@ class Messages {
      * @param {Messages.IdempotentRequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.messages.cancel("string")
+     *     await client.messages.cancel("message_id")
      */
     cancel(messageId, 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, `messages/${encodeURIComponent(messageId)}/cancel`),
+                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, `messages/${encodeURIComponent(messageId)}/cancel`),
                 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.0", "User-Agent": "@trycourier/courier/6.4.0", "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",
                 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;
@@ -280,7 +258,7 @@ class Messages {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling POST /messages/{message_id}/cancel.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -299,33 +277,26 @@ class Messages {
      * @throws {@link Courier.MessageNotFoundError}
      *
      * @example
-     *     await courier.messages.getHistory("string", {
-     *         type: "string"
-     *     })
+     *     await client.messages.getHistory("message_id")
      */
-    getHistory(messageId, request = {}, requestOptions) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function* () {
+    getHistory(messageId_1) {
+        return __awaiter(this, arguments, void 0, function* (messageId, request = {}, requestOptions) {
+            var _a, _b, _c;
             const { type: type_ } = request;
             const _queryParams = {};
             if (type_ != null) {
                 _queryParams["type"] = type_;
             }
             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, `messages/${encodeURIComponent(messageId)}/history`),
+                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, `messages/${encodeURIComponent(messageId)}/history`),
                 method: "GET",
-                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",
                 queryParameters: _queryParams,
+                requestType: "json",
                 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;
@@ -350,7 +321,7 @@ class Messages {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /messages/{message_id}/history.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -366,25 +337,20 @@ class Messages {
      * @throws {@link Courier.MessageNotFoundError}
      *
      * @example
-     *     await courier.messages.getContent("string")
+     *     await client.messages.getContent("message_id")
      */
     getContent(messageId, 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, `messages/${encodeURIComponent(messageId)}/output`),
+                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, `messages/${encodeURIComponent(messageId)}/output`),
                 method: "GET",
-                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",
                 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;
@@ -409,7 +375,7 @@ class Messages {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /messages/{message_id}/output.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -422,25 +388,20 @@ class Messages {
      * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.messages.archive("string")
+     *     await client.messages.archive("request_id")
      */
     archive(requestId, 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, `requests/${encodeURIComponent(requestId)}/archive`),
+                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, `requests/${encodeURIComponent(requestId)}/archive`),
                 method: "PUT",
-                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",
                 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;
@@ -458,7 +419,7 @@ class Messages {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling PUT /requests/{request_id}/archive.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -467,12 +428,12 @@ class Messages {
         });
     }
     _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/messages/client/requests/GetMessageHistoryRequest.d.ts

@@ -3,9 +3,7 @@
  */
 /**
  * @example
- *     {
- *         type: "string"
- *     }
+ *     {}
  */
 export interface GetMessageHistoryRequest {
     /**

package/api/resources/messages/client/requests/ListMessagesRequest.d.ts

@@ -3,22 +3,7 @@
  */
 /**
  * @example
- *     {
- *         archived: true,
- *         cursor: "string",
- *         event: "string",
- *         list: "string",
- *         messageId: "string",
- *         notification: "string",
- *         provider: "string",
- *         recipient: "string",
- *         status: "string",
- *         tag: "string",
- *         tags: "string",
- *         tenant_id: "string",
- *         enqueued_after: "string",
- *         traceId: "string"
- *     }
+ *     {}
  */
 export interface ListMessagesRequest {
     /**

package/api/resources/messages/types/MessageDetailsExtended.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Courier from "../../../index";
+export interface MessageDetailsExtended extends Courier.MessageDetails {
+    providers?: Record<string, any>[];
+}

package/api/resources/messages/types/MessageDetailsExtended.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/messages/types/MessageStatus.d.ts

@@ -1,25 +1,40 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type MessageStatus = 
+export type MessageStatus = 
+/**
+ * The message has been canceled such that it will not be delivered. */
+"CANCELED"
 /**
  * The recipient has clicked on any link in the message at least one time. */
-"CLICKED"
+ | "CLICKED"
+/**
+ * The message has been delayed and will be attempted for delivery at a later time. */
+ | "DELAYED"
 /**
  * The provider successfully delivered the message to the recipient. */
  | "DELIVERED"
+/**
+ * The message has been aggregated into a digest and will be sent according to digest rules. */
+ | "DIGESTED"
 /**
  * The request has been received to send a message, is waiting in the work queue. */
  | "ENQUEUED"
+/**
+ * The message was filtered out based on configured rules or preferences. */
+ | "FILTERED"
 /**
  * The recipient has opened the message at least one time. */
  | "OPENED"
 /**
- * The message has been canceled such that it will not be delivered. */
- | "CANCELED"
+ * The message has been successfully routed to a specific channel or provider. */
+ | "ROUTED"
 /**
  * The message has been accepted by the provider. */
  | "SENT"
+/**
+ * The message was sent with a mock key and Courier simulated the message lifecycle without sending to the downstream provider. */
+ | "SIMULATED"
 /**
  * The message was throttled by Courier. */
  | "THROTTLED"
@@ -33,12 +48,17 @@ export declare type MessageStatus =
  * The message could not be routed to any channel or provider. This can happen for multiple reasons: insufficient profile data, invalid notification setup, invalid integration configuration, etc. */
  | "UNROUTABLE";
 export declare const MessageStatus: {
+    readonly Canceled: "CANCELED";
     readonly Clicked: "CLICKED";
+    readonly Delayed: "DELAYED";
     readonly Delivered: "DELIVERED";
+    readonly Digested: "DIGESTED";
     readonly Enqueued: "ENQUEUED";
+    readonly Filtered: "FILTERED";
     readonly Opened: "OPENED";
-    readonly Canceled: "CANCELED";
+    readonly Routed: "ROUTED";
     readonly Sent: "SENT";
+    readonly Simulated: "SIMULATED";
     readonly Throttled: "THROTTLED";
     readonly Undeliverable: "UNDELIVERABLE";
     readonly Unmapped: "UNMAPPED";

package/api/resources/messages/types/MessageStatus.js

@@ -5,12 +5,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MessageStatus = void 0;
 exports.MessageStatus = {
+    Canceled: "CANCELED",
     Clicked: "CLICKED",
+    Delayed: "DELAYED",
     Delivered: "DELIVERED",
+    Digested: "DIGESTED",
     Enqueued: "ENQUEUED",
+    Filtered: "FILTERED",
     Opened: "OPENED",
-    Canceled: "CANCELED",
+    Routed: "ROUTED",
     Sent: "SENT",
+    Simulated: "SIMULATED",
     Throttled: "THROTTLED",
     Undeliverable: "UNDELIVERABLE",
     Unmapped: "UNMAPPED",

package/api/resources/messages/types/Reason.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type Reason = 
+export type Reason = 
 /**
  * The recipient did not receive the notification because of a condition that passed. */
 "FILTERED"

package/api/resources/messages/types/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./MessageStatus";
 export * from "./MessageDetails";
+export * from "./MessageDetailsExtended";
 export * from "./Reason";
 export * from "./ListMessagesResponse";
 export * from "./MessageHistoryResponse";

package/api/resources/messages/types/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./MessageStatus"), exports);
 __exportStar(require("./MessageDetails"), exports);
+__exportStar(require("./MessageDetailsExtended"), exports);
 __exportStar(require("./Reason"), exports);
 __exportStar(require("./ListMessagesResponse"), exports);
 __exportStar(require("./MessageHistoryResponse"), exports);