@trycourier/courier 6.3.1 → 6.4.0

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

@@ -7,12 +7,20 @@ import * as Courier from "../../../index";
 export declare namespace Audiences {
     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 Audiences {
@@ -25,7 +33,7 @@ export declare class Audiences {
      * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.audiences.get("string")
+     *     await client.audiences.get("audience_id")
      */
     get(audienceId: string, requestOptions?: Audiences.RequestOptions): Promise<Courier.Audience>;
     /**
@@ -36,14 +44,10 @@ export declare class Audiences {
      * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.audiences.update("string", {
-     *         name: "string",
-     *         description: "string",
-     *         filter: {
-     *             value: "string",
-     *             path: "string",
-     *             operator: Courier.ComparisonOperator.EndsWith
-     *         }
+     *     await client.audiences.update("audience_id", {
+     *         name: undefined,
+     *         description: undefined,
+     *         filter: undefined
      *     })
      */
     update(audienceId: string, request?: Courier.AudienceUpdateParams, requestOptions?: Audiences.RequestOptions): Promise<Courier.AudienceUpdateResponse>;
@@ -54,7 +58,7 @@ export declare class Audiences {
      * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.audiences.delete("string")
+     *     await client.audiences.delete("audience_id")
      */
     delete(audienceId: string, requestOptions?: Audiences.RequestOptions): Promise<void>;
     /**
@@ -67,9 +71,7 @@ export declare class Audiences {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.audiences.listMembers("string", {
-     *         cursor: "string"
-     *     })
+     *     await client.audiences.listMembers("audience_id")
      */
     listMembers(audienceId: string, request?: Courier.AudienceMembersListParams, requestOptions?: Audiences.RequestOptions): Promise<Courier.AudienceMemberListResponse>;
     /**
@@ -81,9 +83,7 @@ export declare class Audiences {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.audiences.listAudiences({
-     *         cursor: "string"
-     *     })
+     *     await client.audiences.listAudiences()
      */
     listAudiences(request?: Courier.AudiencesListParams, requestOptions?: Audiences.RequestOptions): Promise<Courier.AudienceListResponse>;
     protected _getAuthorizationHeader(): Promise<string>;

package/api/resources/audiences/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,25 +65,20 @@ class Audiences {
      * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.audiences.get("string")
+     *     await client.audiences.get("audience_id")
      */
     get(audienceId, 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, `/audiences/${encodeURIComponent(audienceId)}`),
+                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, `/audiences/${encodeURIComponent(audienceId)}`),
                 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;
@@ -91,7 +96,7 @@ class Audiences {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /audiences/{audience_id}.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -107,34 +112,25 @@ class Audiences {
      * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.audiences.update("string", {
-     *         name: "string",
-     *         description: "string",
-     *         filter: {
-     *             value: "string",
-     *             path: "string",
-     *             operator: Courier.ComparisonOperator.EndsWith
-     *         }
+     *     await client.audiences.update("audience_id", {
+     *         name: undefined,
+     *         description: undefined,
+     *         filter: undefined
      *     })
      */
-    update(audienceId, request = {}, requestOptions) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function* () {
+    update(audienceId_1) {
+        return __awaiter(this, arguments, void 0, function* (audienceId, request = {}, requestOptions) {
+            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, `/audiences/${encodeURIComponent(audienceId)}`),
+                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, `/audiences/${encodeURIComponent(audienceId)}`),
                 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",
                 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;
@@ -152,7 +148,7 @@ class Audiences {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling PUT /audiences/{audience_id}.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -167,25 +163,20 @@ class Audiences {
      * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.audiences.delete("string")
+     *     await client.audiences.delete("audience_id")
      */
     delete(audienceId, 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, `/audiences/${encodeURIComponent(audienceId)}`),
+                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, `/audiences/${encodeURIComponent(audienceId)}`),
                 method: "DELETE",
-                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;
@@ -203,7 +194,7 @@ class Audiences {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling DELETE /audiences/{audience_id}.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -221,33 +212,26 @@ class Audiences {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.audiences.listMembers("string", {
-     *         cursor: "string"
-     *     })
+     *     await client.audiences.listMembers("audience_id")
      */
-    listMembers(audienceId, request = {}, requestOptions) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function* () {
+    listMembers(audienceId_1) {
+        return __awaiter(this, arguments, void 0, function* (audienceId, request = {}, requestOptions) {
+            var _a, _b, _c;
             const { cursor } = request;
             const _queryParams = {};
             if (cursor != null) {
                 _queryParams["cursor"] = cursor;
             }
             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, `/audiences/${encodeURIComponent(audienceId)}/members`),
+                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, `/audiences/${encodeURIComponent(audienceId)}/members`),
                 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;
@@ -270,7 +254,7 @@ class Audiences {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /audiences/{audience_id}/members.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -287,33 +271,26 @@ class Audiences {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.audiences.listAudiences({
-     *         cursor: "string"
-     *     })
+     *     await client.audiences.listAudiences()
      */
-    listAudiences(request = {}, requestOptions) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function* () {
+    listAudiences() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c;
             const { cursor } = request;
             const _queryParams = {};
             if (cursor != null) {
                 _queryParams["cursor"] = cursor;
             }
             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, "/audiences"),
+                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, "/audiences"),
                 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;
@@ -336,7 +313,7 @@ class Audiences {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /audiences.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -345,12 +322,12 @@ class Audiences {
         });
     }
     _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/audiences/client/requests/AudienceMembersListParams.d.ts

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

package/api/resources/audiences/client/requests/AudienceUpdateParams.d.ts

@@ -5,13 +5,9 @@ import * as Courier from "../../../../index";
 /**
  * @example
  *     {
- *         name: "string",
- *         description: "string",
- *         filter: {
- *             value: "string",
- *             path: "string",
- *             operator: Courier.ComparisonOperator.EndsWith
- *         }
+ *         name: undefined,
+ *         description: undefined,
+ *         filter: undefined
  *     }
  */
 export interface AudienceUpdateParams {

package/api/resources/audiences/client/requests/AudiencesListParams.d.ts

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

package/api/resources/audiences/types/ComparisonOperator.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type ComparisonOperator = "ENDS_WITH" | "EQ" | "EXISTS" | "GT" | "GTE" | "INCLUDES" | "IS_AFTER" | "IS_BEFORE" | "LT" | "LTE" | "NEQ" | "OMIT" | "STARTS_WITH";
+export type ComparisonOperator = "ENDS_WITH" | "EQ" | "EXISTS" | "GT" | "GTE" | "INCLUDES" | "IS_AFTER" | "IS_BEFORE" | "LT" | "LTE" | "NEQ" | "OMIT" | "STARTS_WITH";
 export declare const ComparisonOperator: {
     readonly EndsWith: "ENDS_WITH";
     readonly Eq: "EQ";

package/api/resources/audiences/types/Filter.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 Filter = Courier.SingleFilterConfig | Courier.NestedFilterConfig;
+export type Filter = Courier.SingleFilterConfig | Courier.NestedFilterConfig;

package/api/resources/audiences/types/FilterConfig.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 FilterConfig = Courier.SingleFilterConfig | Courier.NestedFilterConfig;
+export type FilterConfig = Courier.SingleFilterConfig | Courier.NestedFilterConfig;

package/api/resources/audiences/types/LogicalOperator.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type LogicalOperator = "AND" | "OR";
+export type LogicalOperator = "AND" | "OR";
 export declare const LogicalOperator: {
     readonly And: "AND";
     readonly Or: "OR";

package/api/resources/audiences/types/Operator.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 Operator = Courier.ComparisonOperator | Courier.LogicalOperator;
+export type Operator = Courier.ComparisonOperator | Courier.LogicalOperator;

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

@@ -7,12 +7,20 @@ import * as Courier from "../../../index";
 export declare namespace AuditEvents {
     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 AuditEvents {
@@ -25,9 +33,7 @@ export declare class AuditEvents {
      * @param {AuditEvents.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.auditEvents.list({
-     *         cursor: "string"
-     *     })
+     *     await client.auditEvents.list()
      */
     list(request?: Courier.ListAuditEventsRequest, requestOptions?: AuditEvents.RequestOptions): Promise<Courier.ListAuditEventsResponse>;
     /**
@@ -37,7 +43,7 @@ export declare class AuditEvents {
      * @param {AuditEvents.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.auditEvents.get("string")
+     *     await client.auditEvents.get("audit-event-id")
      */
     get(auditEventId: string, requestOptions?: AuditEvents.RequestOptions): Promise<Courier.AuditEvent>;
     protected _getAuthorizationHeader(): Promise<string>;

package/api/resources/auditEvents/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) {
@@ -54,33 +64,26 @@ class AuditEvents {
      * @param {AuditEvents.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.auditEvents.list({
-     *         cursor: "string"
-     *     })
+     *     await client.auditEvents.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 { cursor } = request;
             const _queryParams = {};
             if (cursor != null) {
                 _queryParams["cursor"] = cursor;
             }
             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, "/audit-events"),
+                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, "/audit-events"),
                 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;
@@ -98,7 +101,7 @@ class AuditEvents {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /audit-events.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -113,25 +116,20 @@ class AuditEvents {
      * @param {AuditEvents.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.auditEvents.get("string")
+     *     await client.auditEvents.get("audit-event-id")
      */
     get(auditEventId, 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, `/audit-events/${encodeURIComponent(auditEventId)}`),
+                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, `/audit-events/${encodeURIComponent(auditEventId)}`),
                 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;
@@ -149,7 +147,7 @@ class AuditEvents {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /audit-events/{audit-event-id}.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -158,12 +156,12 @@ class AuditEvents {
         });
     }
     _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/auditEvents/client/requests/ListAuditEventsRequest.d.ts

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