@trycourier/courier 6.1.1 → 6.1.2

package/Client.d.ts

@@ -3,7 +3,7 @@
  */
 import * as environments from "./environments";
 import * as core from "./core";
-import * as Courier from "./api";
+import * as Courier from "./api/index";
 import { Audiences } from "./api/resources/audiences/client/Client";
 import { AuditEvents } from "./api/resources/auditEvents/client/Client";
 import { AuthTokens } from "./api/resources/authTokens/client/Client";
@@ -30,7 +30,7 @@ export declare namespace CourierClient {
     }
     interface IdempotentRequestOptions extends RequestOptions {
         idempotencyKey?: string | undefined;
-        idempotencyExpiry?: number | undefined;
+        idempotencyExpiry?: string | undefined;
     }
 }
 export declare class CourierClient {
@@ -38,6 +38,35 @@ export declare class CourierClient {
     constructor(_options?: CourierClient.Options);
     /**
      * Use the send API to send a message to one or more recipients.
+     *
+     * @param {Courier.SendMessageRequest} request
+     * @param {CourierClient.IdempotentRequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.send({
+     *         message: {
+     *             content: {},
+     *             data: {
+     *                 "string": {
+     *                     "key": "value"
+     *                 }
+     *             },
+     *             brand_id: "string",
+     *             channels: {
+     *                 "string": {}
+     *             },
+     *             context: {},
+     *             metadata: {},
+     *             providers: {
+     *                 "string": {}
+     *             },
+     *             routing: {},
+     *             timeout: {},
+     *             delay: {},
+     *             expiry: {},
+     *             to: {}
+     *         }
+     *     })
      */
     send(request: Courier.SendMessageRequest, requestOptions?: CourierClient.IdempotentRequestOptions): Promise<Courier.SendMessageResponse>;
     protected _audiences: Audiences | undefined;

package/Client.js

@@ -42,7 +42,7 @@ exports.CourierClient = void 0;
 const environments = __importStar(require("./environments"));
 const core = __importStar(require("./core"));
 const url_join_1 = __importDefault(require("url-join"));
-const errors = __importStar(require("./errors"));
+const errors = __importStar(require("./errors/index"));
 const Client_1 = require("./api/resources/audiences/client/Client");
 const Client_2 = require("./api/resources/auditEvents/client/Client");
 const Client_3 = require("./api/resources/authTokens/client/Client");
@@ -63,6 +63,35 @@ class CourierClient {
     }
     /**
      * Use the send API to send a message to one or more recipients.
+     *
+     * @param {Courier.SendMessageRequest} request
+     * @param {CourierClient.IdempotentRequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.send({
+     *         message: {
+     *             content: {},
+     *             data: {
+     *                 "string": {
+     *                     "key": "value"
+     *                 }
+     *             },
+     *             brand_id: "string",
+     *             channels: {
+     *                 "string": {}
+     *             },
+     *             context: {},
+     *             metadata: {},
+     *             providers: {
+     *                 "string": {}
+     *             },
+     *             routing: {},
+     *             timeout: {},
+     *             delay: {},
+     *             expiry: {},
+     *             to: {}
+     *         }
+     *     })
      */
     send(request, requestOptions) {
         var _a, _b;
@@ -74,11 +103,11 @@ class CourierClient {
                     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.2",
+                    "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",
                 body: request,
@@ -168,7 +197,7 @@ class CourierClient {
     _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/api/client/requests/SendMessageRequest.d.ts

@@ -1,7 +1,34 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../..";
+import * as Courier from "../../index";
+/**
+ * @example
+ *     {
+ *         message: {
+ *             content: {},
+ *             data: {
+ *                 "string": {
+ *                     "key": "value"
+ *                 }
+ *             },
+ *             brand_id: "string",
+ *             channels: {
+ *                 "string": {}
+ *             },
+ *             context: {},
+ *             metadata: {},
+ *             providers: {
+ *                 "string": {}
+ *             },
+ *             routing: {},
+ *             timeout: {},
+ *             delay: {},
+ *             expiry: {},
+ *             to: {}
+ *         }
+ *     }
+ */
 export interface SendMessageRequest {
     /** Defines the message to be delivered */
     message: Courier.Message;

package/api/client/requests/index.d.ts

@@ -1 +1 @@
-export { SendMessageRequest } from "./SendMessageRequest";
+export { type SendMessageRequest } from "./SendMessageRequest";

package/api/resources/audiences/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 Audiences {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
@@ -20,24 +20,70 @@ export declare class Audiences {
     constructor(_options?: Audiences.Options);
     /**
      * Returns the specified audience by id.
+     *
+     * @param {string} audienceId - A unique identifier representing the audience_id
+     * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.audiences.get("string")
      */
     get(audienceId: string, requestOptions?: Audiences.RequestOptions): Promise<Courier.Audience>;
     /**
      * Creates or updates audience.
+     *
+     * @param {string} audienceId - A unique identifier representing the audience id
+     * @param {Courier.AudienceUpdateParams} request
+     * @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
+     *         }
+     *     })
      */
     update(audienceId: string, request?: Courier.AudienceUpdateParams, requestOptions?: Audiences.RequestOptions): Promise<Courier.AudienceUpdateResponse>;
     /**
      * Deletes the specified audience.
+     *
+     * @param {string} audienceId - A unique identifier representing the audience id
+     * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.audiences.delete("string")
      */
     delete(audienceId: string, requestOptions?: Audiences.RequestOptions): Promise<void>;
     /**
      * Get list of members of an audience.
+     *
+     * @param {string} audienceId - A unique identifier representing the audience id
+     * @param {Courier.AudienceMembersListParams} request
+     * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
+     *
+     * @example
+     *     await courier.audiences.listMembers("string", {
+     *         cursor: "string"
+     *     })
      */
     listMembers(audienceId: string, request?: Courier.AudienceMembersListParams, requestOptions?: Audiences.RequestOptions): Promise<Courier.AudienceMemberListResponse>;
     /**
      * Get the audiences associated with the authorization token.
+     *
+     * @param {Courier.AudiencesListParams} request
+     * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
+     *
+     * @example
+     *     await courier.audiences.listAudiences({
+     *         cursor: "string"
+     *     })
      */
     listAudiences(request?: Courier.AudiencesListParams, requestOptions?: Audiences.RequestOptions): Promise<Courier.AudienceListResponse>;
     protected _getAuthorizationHeader(): Promise<string>;

package/api/resources/audiences/client/Client.js

@@ -41,27 +41,35 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Audiences = 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 Audiences {
     constructor(_options = {}) {
         this._options = _options;
     }
     /**
      * Returns the specified audience by id.
+     *
+     * @param {string} audienceId - A unique identifier representing the audience_id
+     * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.audiences.get("string")
      */
     get(audienceId, 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, `/audiences/${audienceId}`),
+                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)}`),
                 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.2",
+                    "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,
@@ -93,18 +101,35 @@ class Audiences {
     }
     /**
      * Creates or updates audience.
+     *
+     * @param {string} audienceId - A unique identifier representing the audience id
+     * @param {Courier.AudienceUpdateParams} request
+     * @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
+     *         }
+     *     })
      */
     update(audienceId, request = {}, 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, `/audiences/${audienceId}`),
+                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)}`),
                 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.2",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 body: request,
@@ -137,18 +162,26 @@ class Audiences {
     }
     /**
      * Deletes the specified audience.
+     *
+     * @param {string} audienceId - A unique identifier representing the audience id
+     * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.audiences.delete("string")
      */
     delete(audienceId, 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, `/audiences/${audienceId}`),
+                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)}`),
                 method: "DELETE",
                 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.2",
+                    "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,
@@ -180,7 +213,17 @@ class Audiences {
     }
     /**
      * Get list of members of an audience.
+     *
+     * @param {string} audienceId - A unique identifier representing the audience id
+     * @param {Courier.AudienceMembersListParams} request
+     * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
+     *
+     * @example
+     *     await courier.audiences.listMembers("string", {
+     *         cursor: "string"
+     *     })
      */
     listMembers(audienceId, request = {}, requestOptions) {
         var _a, _b;
@@ -191,13 +234,15 @@ class Audiences {
                 _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/${audienceId}/members`),
+                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`),
                 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.2",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -235,7 +280,16 @@ class Audiences {
     }
     /**
      * Get the audiences associated with the authorization token.
+     *
+     * @param {Courier.AudiencesListParams} request
+     * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
+     *
+     * @example
+     *     await courier.audiences.listAudiences({
+     *         cursor: "string"
+     *     })
      */
     listAudiences(request = {}, requestOptions) {
         var _a, _b;
@@ -252,7 +306,9 @@ class Audiences {
                     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.2",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -291,7 +347,7 @@ class Audiences {
     _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/api/resources/audiences/client/requests/AudienceMembersListParams.d.ts

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         cursor: "string"
+ *     }
+ */
 export interface AudienceMembersListParams {
     /**
      * A unique identifier that allows for fetching the next set of members

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

@@ -1,7 +1,19 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../../..";
+import * as Courier from "../../../../index";
+/**
+ * @example
+ *     {
+ *         name: "string",
+ *         description: "string",
+ *         filter: {
+ *             value: "string",
+ *             path: "string",
+ *             operator: Courier.ComparisonOperator.EndsWith
+ *         }
+ *     }
+ */
 export interface AudienceUpdateParams {
     /** The name of the audience */
     name?: string;

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

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         cursor: "string"
+ *     }
+ */
 export interface AudiencesListParams {
     /**
      * A unique identifier that allows for fetching the next set of audiences

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

@@ -1,3 +1,3 @@
-export { AudienceUpdateParams } from "./AudienceUpdateParams";
-export { AudienceMembersListParams } from "./AudienceMembersListParams";
-export { AudiencesListParams } from "./AudiencesListParams";
+export { type AudienceUpdateParams } from "./AudienceUpdateParams";
+export { type AudienceMembersListParams } from "./AudienceMembersListParams";
+export { type AudiencesListParams } from "./AudiencesListParams";

package/api/resources/audiences/types/Audience.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 Audience {
     /** A unique identifier representing the audience_id */
     id: string;

package/api/resources/audiences/types/AudienceListResponse.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 AudienceListResponse {
     items: Courier.Audience[];
     paging: Courier.Paging;

package/api/resources/audiences/types/AudienceMemberGetResponse.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 AudienceMemberGetResponse {
     audienceMember: Courier.AudienceMember;
 }

package/api/resources/audiences/types/AudienceMemberListResponse.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 AudienceMemberListResponse {
     items: Courier.AudienceMember[];
     paging: Courier.Paging;

package/api/resources/audiences/types/AudienceUpdateResponse.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 AudienceUpdateResponse {
     audience: Courier.Audience;
 }

package/api/resources/audiences/types/BaseFilterConfig.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 BaseFilterConfig {
     /** The operator to use for filtering */
     operator: Courier.Operator;

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

@@ -1,5 +1,5 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export declare type Filter = Courier.SingleFilterConfig | Courier.NestedFilterConfig;

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

@@ -1,5 +1,5 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export declare type FilterConfig = Courier.SingleFilterConfig | Courier.NestedFilterConfig;

package/api/resources/audiences/types/NestedFilterConfig.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";
 /**
  * The operator to use for filtering
  */

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

@@ -1,5 +1,5 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../..";
+import * as Courier from "../../../index";
 export declare type Operator = Courier.ComparisonOperator | Courier.LogicalOperator;

package/api/resources/audiences/types/SingleFilterConfig.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";
 /**
  * A single filter to use for filtering
  */

package/api/resources/auditEvents/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 AuditEvents {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
@@ -20,10 +20,24 @@ export declare class AuditEvents {
     constructor(_options?: AuditEvents.Options);
     /**
      * Fetch the list of audit events
+     *
+     * @param {Courier.ListAuditEventsRequest} request
+     * @param {AuditEvents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.auditEvents.list({
+     *         cursor: "string"
+     *     })
      */
     list(request?: Courier.ListAuditEventsRequest, requestOptions?: AuditEvents.RequestOptions): Promise<Courier.ListAuditEventsResponse>;
     /**
      * Fetch a specific audit event by ID.
+     *
+     * @param {string} auditEventId - A unique identifier associated with the audit event you wish to retrieve
+     * @param {AuditEvents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.auditEvents.get("string")
      */
     get(auditEventId: string, requestOptions?: AuditEvents.RequestOptions): Promise<Courier.AuditEvent>;
     protected _getAuthorizationHeader(): Promise<string>;