@trycourier/courier 6.3.1 → 6.4.0

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

@@ -7,12 +7,20 @@ import * as Courier from "../../../index";
 export declare namespace Notifications {
     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 Notifications {
@@ -23,10 +31,7 @@ export declare class Notifications {
      * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.notifications.list({
-     *         cursor: "string",
-     *         notes: true
-     *     })
+     *     await client.notifications.list()
      */
     list(request?: Courier.NotificationListParams, requestOptions?: Notifications.RequestOptions): Promise<Courier.NotificationListResponse>;
     /**
@@ -34,7 +39,7 @@ export declare class Notifications {
      * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.notifications.getContent("string")
+     *     await client.notifications.getContent("id")
      */
     getContent(id: string, requestOptions?: Notifications.RequestOptions): Promise<Courier.NotificationGetContentResponse>;
     /**
@@ -42,7 +47,7 @@ export declare class Notifications {
      * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.notifications.getDraftContent("string")
+     *     await client.notifications.getDraftContent("id")
      */
     getDraftContent(id: string, requestOptions?: Notifications.RequestOptions): Promise<Courier.NotificationGetContentResponse>;
     /**
@@ -51,7 +56,7 @@ export declare class Notifications {
      * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.notifications.getSubmissionChecks("string", "string")
+     *     await client.notifications.getSubmissionChecks("id", "submissionId")
      */
     getSubmissionChecks(id: string, submissionId: string, requestOptions?: Notifications.RequestOptions): Promise<Courier.SubmissionChecksGetResponse>;
     /**
@@ -61,10 +66,14 @@ export declare class Notifications {
      * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.notifications.replaceSubmissionChecks("string", "string", {
+     *     await client.notifications.replaceSubmissionChecks("id", "submissionId", {
      *         checks: [{
-     *                 id: "string",
-     *                 status: Courier.CheckStatus.Resolved,
+     *                 id: "id",
+     *                 status: "RESOLVED",
+     *                 type: "custom"
+     *             }, {
+     *                 id: "id",
+     *                 status: "RESOLVED",
      *                 type: "custom"
      *             }]
      *     })
@@ -76,7 +85,7 @@ export declare class Notifications {
      * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.notifications.cancelSubmission("string", "string")
+     *     await client.notifications.cancelSubmission("id", "submissionId")
      */
     cancelSubmission(id: string, submissionId: string, requestOptions?: Notifications.RequestOptions): Promise<void>;
     protected _getAuthorizationHeader(): Promise<string>;

package/api/resources/notifications/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) {
@@ -52,14 +62,11 @@ class Notifications {
      * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.notifications.list({
-     *         cursor: "string",
-     *         notes: true
-     *     })
+     *     await client.notifications.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, notes } = request;
             const _queryParams = {};
             if (cursor != null) {
@@ -69,20 +76,15 @@ class Notifications {
                 _queryParams["notes"] = notes.toString();
             }
             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, "/notifications"),
+                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, "/notifications"),
                 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;
@@ -100,7 +102,7 @@ class Notifications {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /notifications.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -113,25 +115,20 @@ class Notifications {
      * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.notifications.getContent("string")
+     *     await client.notifications.getContent("id")
      */
     getContent(id, 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, `/notifications/${encodeURIComponent(id)}/content`),
+                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, `/notifications/${encodeURIComponent(id)}/content`),
                 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 +146,7 @@ class Notifications {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /notifications/{id}/content.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -162,25 +159,20 @@ class Notifications {
      * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.notifications.getDraftContent("string")
+     *     await client.notifications.getDraftContent("id")
      */
     getDraftContent(id, 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, `/notifications/${encodeURIComponent(id)}/draft/content`),
+                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, `/notifications/${encodeURIComponent(id)}/draft/content`),
                 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;
@@ -198,7 +190,7 @@ class Notifications {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /notifications/{id}/draft/content.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -212,25 +204,20 @@ class Notifications {
      * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.notifications.getSubmissionChecks("string", "string")
+     *     await client.notifications.getSubmissionChecks("id", "submissionId")
      */
     getSubmissionChecks(id, submissionId, 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, `/notifications/${encodeURIComponent(id)}/${encodeURIComponent(submissionId)}/checks`),
+                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, `/notifications/${encodeURIComponent(id)}/${encodeURIComponent(submissionId)}/checks`),
                 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;
@@ -248,7 +235,7 @@ class Notifications {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /notifications/{id}/{submissionId}/checks.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -263,32 +250,31 @@ class Notifications {
      * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.notifications.replaceSubmissionChecks("string", "string", {
+     *     await client.notifications.replaceSubmissionChecks("id", "submissionId", {
      *         checks: [{
-     *                 id: "string",
-     *                 status: Courier.CheckStatus.Resolved,
+     *                 id: "id",
+     *                 status: "RESOLVED",
+     *                 type: "custom"
+     *             }, {
+     *                 id: "id",
+     *                 status: "RESOLVED",
      *                 type: "custom"
      *             }]
      *     })
      */
     replaceSubmissionChecks(id, submissionId, request, requestOptions) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/notifications/${encodeURIComponent(id)}/${encodeURIComponent(submissionId)}/checks`),
+                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, `/notifications/${encodeURIComponent(id)}/${encodeURIComponent(submissionId)}/checks`),
                 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;
@@ -306,7 +292,7 @@ class Notifications {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling PUT /notifications/{id}/{submissionId}/checks.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -320,25 +306,20 @@ class Notifications {
      * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.notifications.cancelSubmission("string", "string")
+     *     await client.notifications.cancelSubmission("id", "submissionId")
      */
     cancelSubmission(id, submissionId, 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, `/notifications/${encodeURIComponent(id)}/${encodeURIComponent(submissionId)}/checks`),
+                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, `/notifications/${encodeURIComponent(id)}/${encodeURIComponent(submissionId)}/checks`),
                 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;
@@ -356,7 +337,7 @@ class Notifications {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling DELETE /notifications/{id}/{submissionId}/checks.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -365,12 +346,12 @@ class Notifications {
         });
     }
     _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/notifications/client/requests/NotificationListParams.d.ts

@@ -3,10 +3,7 @@
  */
 /**
  * @example
- *     {
- *         cursor: "string",
- *         notes: true
- *     }
+ *     {}
  */
 export interface NotificationListParams {
     cursor?: string;

package/api/resources/notifications/client/requests/SubmissionChecksReplaceParams.d.ts

@@ -6,8 +6,12 @@ import * as Courier from "../../../../index";
  * @example
  *     {
  *         checks: [{
- *                 id: "string",
- *                 status: Courier.CheckStatus.Resolved,
+ *                 id: "id",
+ *                 status: "RESOLVED",
+ *                 type: "custom"
+ *             }, {
+ *                 id: "id",
+ *                 status: "RESOLVED",
  *                 type: "custom"
  *             }]
  *     }

package/api/resources/notifications/types/BlockType.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type BlockType = "action" | "divider" | "image" | "jsonnet" | "list" | "markdown" | "quote" | "template" | "text";
+export type BlockType = "action" | "divider" | "image" | "jsonnet" | "list" | "markdown" | "quote" | "template" | "text";
 export declare const BlockType: {
     readonly Action: "action";
     readonly Divider: "divider";

package/api/resources/notifications/types/CheckStatus.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type CheckStatus = "RESOLVED" | "FAILED" | "PENDING";
+export type CheckStatus = "RESOLVED" | "FAILED" | "PENDING";
 export declare const CheckStatus: {
     readonly Resolved: "RESOLVED";
     readonly Failed: "FAILED";

package/api/resources/notifications/types/MessageRoutingChannel.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 MessageRoutingChannel = string | Courier.MessageRouting;
+export type MessageRoutingChannel = string | Courier.MessageRouting;

package/api/resources/notifications/types/MessageRoutingMethod.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type MessageRoutingMethod = "all" | "single";
+export type MessageRoutingMethod = "all" | "single";
 export declare const MessageRoutingMethod: {
     readonly All: "all";
     readonly Single: "single";

package/api/resources/notifications/types/NotificationContent.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 NotificationContent = string | Courier.NotificationContentHierarchy;
+export type NotificationContent = string | Courier.NotificationContentHierarchy;

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

@@ -7,12 +7,20 @@ import * as Courier from "../../../index";
 export declare namespace Profiles {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         authorizationToken?: core.Supplier<core.BearerToken | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
     interface IdempotentRequestOptions extends RequestOptions {
         idempotencyKey?: string | undefined;
@@ -31,7 +39,7 @@ export declare class Profiles {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.profiles.get("string")
+     *     await client.profiles.get("user_id")
      */
     get(userId: string, requestOptions?: Profiles.RequestOptions): Promise<Courier.ProfileGetResponse>;
     /**
@@ -44,9 +52,9 @@ export declare class Profiles {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.profiles.create("string", {
+     *     await client.profiles.create("user_id", {
      *         profile: {
-     *             "string": {
+     *             "profile": {
      *                 "key": "value"
      *             }
      *         }
@@ -66,9 +74,9 @@ export declare class Profiles {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.profiles.replace("string", {
+     *     await client.profiles.replace("user_id", {
      *         profile: {
-     *             "string": {
+     *             "profile": {
      *                 "key": "value"
      *             }
      *         }
@@ -77,17 +85,23 @@ export declare class Profiles {
     replace(userId: string, request: Courier.ReplaceProfileRequest, requestOptions?: Profiles.RequestOptions): Promise<Courier.ReplaceProfileResponse>;
     /**
      * @param {string} userId - A unique identifier representing the user associated with the requested profile.
-     * @param {Courier.UserProfilePatch[]} request
+     * @param {Courier.ProfileUpdateRequest} request
      * @param {Profiles.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.profiles.mergeProfile("string", [{
-     *             op: "string",
-     *             path: "string",
-     *             value: "string"
-     *         }])
+     *     await client.profiles.mergeProfile("user_id", {
+     *         patch: [{
+     *                 op: "op",
+     *                 path: "path",
+     *                 value: "value"
+     *             }, {
+     *                 op: "op",
+     *                 path: "path",
+     *                 value: "value"
+     *             }]
+     *     })
      */
-    mergeProfile(userId: string, request: Courier.UserProfilePatch[], requestOptions?: Profiles.RequestOptions): Promise<void>;
+    mergeProfile(userId: string, request: Courier.ProfileUpdateRequest, requestOptions?: Profiles.RequestOptions): Promise<void>;
     /**
      * Deletes the specified user profile.
      *
@@ -97,7 +111,7 @@ export declare class Profiles {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.profiles.delete("string")
+     *     await client.profiles.delete("user_id")
      */
     delete(userId: string, requestOptions?: Profiles.RequestOptions): Promise<void>;
     /**
@@ -110,9 +124,7 @@ export declare class Profiles {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.profiles.getListSubscriptions("string", {
-     *         cursor: "string"
-     *     })
+     *     await client.profiles.getListSubscriptions("user_id")
      */
     getListSubscriptions(userId: string, request?: Courier.GetListSubscriptionsRequest, requestOptions?: Profiles.RequestOptions): Promise<Courier.GetListSubscriptionsResponse>;
     /**
@@ -125,13 +137,13 @@ export declare class Profiles {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.profiles.subscribeToLists("string", {
+     *     await client.profiles.subscribeToLists("user_id", {
      *         lists: [{
-     *                 listId: "string",
-     *                 preferences: {
-     *                     categories: {},
-     *                     notifications: {}
-     *                 }
+     *                 listId: "listId",
+     *                 preferences: undefined
+     *             }, {
+     *                 listId: "listId",
+     *                 preferences: undefined
      *             }]
      *     })
      */
@@ -145,7 +157,7 @@ export declare class Profiles {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.profiles.deleteListSubscription("string")
+     *     await client.profiles.deleteListSubscription("user_id")
      */
     deleteListSubscription(userId: string, requestOptions?: Profiles.RequestOptions): Promise<Courier.DeleteListSubscriptionResponse>;
     protected _getAuthorizationHeader(): Promise<string>;