@trycourier/courier 6.1.1 → 6.1.3

package/dist/api/resources/lists/types/ListSubscriptionRecipient.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface ListSubscriptionRecipient {
     recipientId: string;
     created?: string;

package/dist/api/resources/lists/types/PutSubscriptionsRecipient.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface PutSubscriptionsRecipient {
     recipientId: string;
     preferences?: Courier.RecipientPreferences;

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

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export declare namespace Messages {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
@@ -16,7 +16,7 @@ export declare namespace Messages {
     }
     interface IdempotentRequestOptions extends RequestOptions {
         idempotencyKey?: string | undefined;
-        idempotencyExpiry?: number | undefined;
+        idempotencyExpiry?: string | undefined;
     }
 }
 export declare class Messages {
@@ -24,29 +24,86 @@ export declare class Messages {
     constructor(_options?: Messages.Options);
     /**
      * Fetch the statuses of messages you've previously sent.
+     *
+     * @param {Courier.ListMessagesRequest} request
+     * @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"
+     *     })
      */
     list(request?: Courier.ListMessagesRequest, requestOptions?: Messages.RequestOptions): Promise<Courier.ListMessagesResponse>;
     /**
      * Fetch the status of a message you've previously sent.
+     *
+     * @param {string} messageId - A unique identifier associated with the message you wish to retrieve (results from a send).
+     * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
      * @throws {@link Courier.MessageNotFoundError}
+     *
+     * @example
+     *     await courier.messages.get("string")
      */
     get(messageId: string, requestOptions?: Messages.RequestOptions): Promise<Courier.MessageDetails>;
     /**
      * 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).
+     *
+     * @param {string} messageId - A unique identifier representing the message ID
+     * @param {Messages.IdempotentRequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.messages.cancel("string")
      */
     cancel(messageId: string, requestOptions?: Messages.IdempotentRequestOptions): Promise<Courier.MessageDetails>;
     /**
      * Fetch the array of events of a message you've previously sent.
+     *
+     * @param {string} messageId - A unique identifier representing the message ID
+     * @param {Courier.GetMessageHistoryRequest} request
+     * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
      * @throws {@link Courier.MessageNotFoundError}
+     *
+     * @example
+     *     await courier.messages.getHistory("string", {
+     *         type: "string"
+     *     })
      */
     getHistory(messageId: string, request?: Courier.GetMessageHistoryRequest, requestOptions?: Messages.RequestOptions): Promise<Courier.MessageHistoryResponse>;
     /**
+     * @param {string} messageId - A unique identifier associated with the message you wish to retrieve (results from a send).
+     * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
      * @throws {@link Courier.MessageNotFoundError}
+     *
+     * @example
+     *     await courier.messages.getContent("string")
      */
     getContent(messageId: string, requestOptions?: Messages.RequestOptions): Promise<Courier.RenderOutputResponse>;
+    /**
+     * @param {string} requestId - A unique identifier representing the request ID
+     * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.messages.archive("string")
+     */
     archive(requestId: string, requestOptions?: Messages.RequestOptions): Promise<void>;
     protected _getAuthorizationHeader(): Promise<string>;
 }

package/dist/api/resources/messages/client/Client.js

@@ -41,20 +41,41 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Messages = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
-const Courier = __importStar(require("../../.."));
+const Courier = __importStar(require("../../../index"));
 const url_join_1 = __importDefault(require("url-join"));
-const errors = __importStar(require("../../../../errors"));
+const errors = __importStar(require("../../../../errors/index"));
 class Messages {
     constructor(_options = {}) {
         this._options = _options;
     }
     /**
      * Fetch the statuses of messages you've previously sent.
+     *
+     * @param {Courier.ListMessagesRequest} request
+     * @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"
+     *     })
      */
     list(request = {}, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
-            const { archived, cursor, event, list, message_id: messageId, messageId: messageId_, notification, provider, recipient, status, tag, tags, tenant_id: tenantId, enqueued_after: enqueuedAfter, trace_id: traceId, traceId: traceId_, } = request;
+            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) {
                 _queryParams["archived"] = archived.toString();
@@ -68,11 +89,8 @@ class Messages {
             if (list != null) {
                 _queryParams["list"] = list;
             }
-            if (messageId_ != null) {
-                _queryParams["message_id"] = messageId_;
-            }
-            if (messageId_ != null) {
-                _queryParams["messageId"] = messageId_;
+            if (messageId != null) {
+                _queryParams["messageId"] = messageId;
             }
             if (notification != null) {
                 _queryParams["notification"] = notification;
@@ -113,11 +131,8 @@ class Messages {
             if (enqueuedAfter != null) {
                 _queryParams["enqueued_after"] = enqueuedAfter;
             }
-            if (traceId_ != null) {
-                _queryParams["trace_id"] = traceId_;
-            }
-            if (traceId_ != null) {
-                _queryParams["traceId"] = traceId_;
+            if (traceId != null) {
+                _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"),
@@ -126,7 +141,9 @@ class Messages {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.1",
+                    "X-Fern-SDK-Version": "v6.1.3",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -159,20 +176,29 @@ class Messages {
     }
     /**
      * Fetch the status of a message you've previously sent.
+     *
+     * @param {string} messageId - A unique identifier associated with the message you wish to retrieve (results from a send).
+     * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
      * @throws {@link Courier.MessageNotFoundError}
+     *
+     * @example
+     *     await courier.messages.get("string")
      */
     get(messageId, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             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/${messageId}`),
+                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)}`),
                 method: "GET",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.1",
+                    "X-Fern-SDK-Version": "v6.1.3",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -211,22 +237,28 @@ class Messages {
     }
     /**
      * 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).
+     *
+     * @param {string} messageId - A unique identifier representing the message ID
+     * @param {Messages.IdempotentRequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.messages.cancel("string")
      */
     cancel(messageId, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             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/${messageId}/cancel`),
+                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`),
                 method: "POST",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.1",
+                    "X-Fern-SDK-Version": "v6.1.3",
+                    "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.toString()
-                        : undefined,
+                    "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry : undefined,
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -258,8 +290,18 @@ class Messages {
     }
     /**
      * Fetch the array of events of a message you've previously sent.
+     *
+     * @param {string} messageId - A unique identifier representing the message ID
+     * @param {Courier.GetMessageHistoryRequest} request
+     * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
      * @throws {@link Courier.MessageNotFoundError}
+     *
+     * @example
+     *     await courier.messages.getHistory("string", {
+     *         type: "string"
+     *     })
      */
     getHistory(messageId, request = {}, requestOptions) {
         var _a, _b;
@@ -270,13 +312,15 @@ class Messages {
                 _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/${messageId}/history`),
+                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`),
                 method: "GET",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.1",
+                    "X-Fern-SDK-Version": "v6.1.3",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -315,20 +359,28 @@ class Messages {
         });
     }
     /**
+     * @param {string} messageId - A unique identifier associated with the message you wish to retrieve (results from a send).
+     * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
      * @throws {@link Courier.MessageNotFoundError}
+     *
+     * @example
+     *     await courier.messages.getContent("string")
      */
     getContent(messageId, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             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/${messageId}/output`),
+                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`),
                 method: "GET",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.1",
+                    "X-Fern-SDK-Version": "v6.1.3",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -365,17 +417,26 @@ class Messages {
             }
         });
     }
+    /**
+     * @param {string} requestId - A unique identifier representing the request ID
+     * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.messages.archive("string")
+     */
     archive(requestId, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             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/${requestId}/archive`),
+                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`),
                 method: "PUT",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@trycourier/courier",
-                    "X-Fern-SDK-Version": "v6.1.1",
+                    "X-Fern-SDK-Version": "v6.1.3",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -408,7 +469,7 @@ class Messages {
     _getAuthorizationHeader() {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process.env["COURIER_AUTH_TOKEN"];
+            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.",

package/dist/api/resources/messages/client/requests/GetMessageHistoryRequest.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         type: "string"
+ *     }
+ */
 export interface GetMessageHistoryRequest {
     /**
      * A supported Message History type that will filter the events returned.

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

@@ -1,6 +1,25 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @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 {
     /**
      * A boolean value that indicates whether archived messages should be included in the response.
@@ -18,10 +37,6 @@ export interface ListMessagesRequest {
      * A unique identifier representing the list the message was sent to.
      */
     list?: string;
-    /**
-     * A unique identifier representing the message_id returned from either /send or /send/list.
-     */
-    message_id?: string;
     /**
      * A unique identifier representing the message_id returned from either /send or /send/list.
      */
@@ -58,10 +73,6 @@ export interface ListMessagesRequest {
      * The enqueued datetime of a message to filter out messages received before.
      */
     enqueued_after?: string;
-    /**
-     * The unique identifier used to trace the requests
-     */
-    trace_id?: string;
     /**
      * The unique identifier used to trace the requests
      */

package/dist/api/resources/messages/client/requests/index.d.ts

@@ -1,2 +1,2 @@
-export { ListMessagesRequest } from "./ListMessagesRequest";
-export { GetMessageHistoryRequest } from "./GetMessageHistoryRequest";
+export { type ListMessagesRequest } from "./ListMessagesRequest";
+export { type GetMessageHistoryRequest } from "./GetMessageHistoryRequest";

package/dist/api/resources/messages/types/ListMessagesResponse.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface ListMessagesResponse {
     /** Paging information for the result set. */
     paging: Courier.Paging;

package/dist/api/resources/messages/types/MessageDetails.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface MessageDetails {
     /** A unique identifier associated with the message you wish to retrieve (results from a send). */
     id: string;

package/dist/api/resources/messages/types/MessageHistoryResponse.d.ts

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

package/dist/api/resources/messages/types/RenderOutput.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface RenderOutput {
     /** The channel used for rendering the message. */
     channel: string;

package/dist/api/resources/messages/types/RenderOutputResponse.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface RenderOutputResponse {
     /** An array of render output of a previously sent message. */
     results: Courier.RenderOutput[];

package/dist/api/resources/messages/types/RenderedMessageContent.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export interface RenderedMessageContent {
     /** The html content of the rendered message. */
     html: string;

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

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export declare namespace Notifications {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
@@ -18,13 +18,125 @@ export declare namespace Notifications {
 export declare class Notifications {
     protected readonly _options: Notifications.Options;
     constructor(_options?: Notifications.Options);
+    /**
+     * @param {Courier.NotificationListParams} request
+     * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.notifications.list({
+     *         cursor: "string"
+     *     })
+     */
     list(request?: Courier.NotificationListParams, requestOptions?: Notifications.RequestOptions): Promise<Courier.NotificationListResponse>;
+    /**
+     * @param {string} id
+     * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.notifications.getContent("string")
+     */
     getContent(id: string, requestOptions?: Notifications.RequestOptions): Promise<Courier.NotificationGetContentResponse>;
+    /**
+     * @param {string} id
+     * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.notifications.getDraftContent("string")
+     */
     getDraftContent(id: string, requestOptions?: Notifications.RequestOptions): Promise<Courier.NotificationGetContentResponse>;
+    /**
+     * @param {string} id
+     * @param {Courier.NotificationUpdateVariationsParams} request
+     * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.notifications.updateVariations("string", {
+     *         blocks: [{
+     *                 alias: "string",
+     *                 context: "string",
+     *                 id: "string",
+     *                 type: Courier.BlockType.Action,
+     *                 content: "string",
+     *                 locales: {
+     *                     "string": "string"
+     *                 },
+     *                 checksum: "string"
+     *             }],
+     *         channels: [{
+     *                 id: "string",
+     *                 type: "string",
+     *                 content: {},
+     *                 locales: {
+     *                     "string": {}
+     *                 },
+     *                 checksum: "string"
+     *             }]
+     *     })
+     */
     updateVariations(id: string, request?: Courier.NotificationUpdateVariationsParams, requestOptions?: Notifications.RequestOptions): Promise<void>;
+    /**
+     * @param {string} id
+     * @param {Courier.NotificationDraftUpdateVariationsParams} request
+     * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.notifications.updateDraftVariations("string", {
+     *         blocks: [{
+     *                 alias: "string",
+     *                 context: "string",
+     *                 id: "string",
+     *                 type: Courier.BlockType.Action,
+     *                 content: "string",
+     *                 locales: {
+     *                     "string": "string"
+     *                 },
+     *                 checksum: "string"
+     *             }],
+     *         channels: [{
+     *                 id: "string",
+     *                 type: "string",
+     *                 content: {},
+     *                 locales: {
+     *                     "string": {}
+     *                 },
+     *                 checksum: "string"
+     *             }]
+     *     })
+     */
     updateDraftVariations(id: string, request?: Courier.NotificationDraftUpdateVariationsParams, requestOptions?: Notifications.RequestOptions): Promise<void>;
+    /**
+     * @param {string} id
+     * @param {string} submissionId
+     * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.notifications.getSubmissionChecks("string", "string")
+     */
     getSubmissionChecks(id: string, submissionId: string, requestOptions?: Notifications.RequestOptions): Promise<Courier.SubmissionChecksGetResponse>;
+    /**
+     * @param {string} id
+     * @param {string} submissionId
+     * @param {Courier.SubmissionChecksReplaceParams} request
+     * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.notifications.replaceSubmissionChecks("string", "string", {
+     *         checks: [{
+     *                 id: "string",
+     *                 status: Courier.CheckStatus.Resolved,
+     *                 type: "custom"
+     *             }]
+     *     })
+     */
     replaceSubmissionChecks(id: string, submissionId: string, request: Courier.SubmissionChecksReplaceParams, requestOptions?: Notifications.RequestOptions): Promise<Courier.SubmissionChecksReplaceResponse>;
+    /**
+     * @param {string} id
+     * @param {string} submissionId
+     * @param {Notifications.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.notifications.cancelSubmission("string", "string")
+     */
     cancelSubmission(id: string, submissionId: string, requestOptions?: Notifications.RequestOptions): Promise<void>;
     protected _getAuthorizationHeader(): Promise<string>;
 }