@trycourier/courier 6.1.1 → 6.1.3

package/api/resources/brands/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 Brands {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
@@ -16,33 +16,88 @@ export declare namespace Brands {
     }
     interface IdempotentRequestOptions extends RequestOptions {
         idempotencyKey?: string | undefined;
-        idempotencyExpiry?: number | undefined;
+        idempotencyExpiry?: string | undefined;
     }
 }
 export declare class Brands {
     protected readonly _options: Brands.Options;
     constructor(_options?: Brands.Options);
     /**
+     * @param {Courier.BrandParameters} request
+     * @param {Brands.IdempotentRequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
      * @throws {@link Courier.PaymentRequiredError}
      * @throws {@link Courier.AlreadyExistsError}
+     *
+     * @example
+     *     await courier.brands.create({
+     *         id: "string",
+     *         name: "string",
+     *         settings: {},
+     *         snippets: {}
+     *     })
      */
     create(request: Courier.BrandParameters, requestOptions?: Brands.IdempotentRequestOptions): Promise<Courier.Brand>;
     /**
      * Fetch a specific brand by brand ID.
+     *
+     * @param {string} brandId - A unique identifier associated with the brand you wish to retrieve.
+     * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.brands.get("string")
      */
     get(brandId: string, requestOptions?: Brands.RequestOptions): Promise<Courier.Brand>;
     /**
      * Get the list of brands.
+     *
+     * @param {Courier.ListBrandsRequest} request
+     * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.brands.list({
+     *         cursor: "string"
+     *     })
      */
     list(request?: Courier.ListBrandsRequest, requestOptions?: Brands.RequestOptions): Promise<Courier.BrandsResponse>;
     /**
      * Delete a brand by brand ID.
+     *
+     * @param {string} brandId - A unique identifier associated with the brand you wish to retrieve.
+     * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.ConflictError}
+     *
+     * @example
+     *     await courier.brands.delete("string")
      */
     delete(brandId: string, requestOptions?: Brands.RequestOptions): Promise<void>;
     /**
      * Replace an existing brand with the supplied values.
+     *
+     * @param {string} brandId - A unique identifier associated with the brand you wish to update.
+     * @param {Courier.BrandUpdateParameters} request
+     * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.brands.replace("string", {
+     *         name: "string",
+     *         settings: {
+     *             colors: {},
+     *             inapp: {
+     *                 "key": "value"
+     *             },
+     *             email: {}
+     *         },
+     *         snippets: {
+     *             items: [{
+     *                     format: "handlebars",
+     *                     name: "string",
+     *                     value: "string"
+     *                 }]
+     *         }
+     *     })
      */
     replace(brandId: string, request: Courier.BrandUpdateParameters, requestOptions?: Brands.RequestOptions): Promise<Courier.Brand>;
     protected _getAuthorizationHeader(): Promise<string>;

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

@@ -41,17 +41,28 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Brands = 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 Brands {
     constructor(_options = {}) {
         this._options = _options;
     }
     /**
+     * @param {Courier.BrandParameters} request
+     * @param {Brands.IdempotentRequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
      * @throws {@link Courier.PaymentRequiredError}
      * @throws {@link Courier.AlreadyExistsError}
+     *
+     * @example
+     *     await courier.brands.create({
+     *         id: "string",
+     *         name: "string",
+     *         settings: {},
+     *         snippets: {}
+     *     })
      */
     create(request, requestOptions) {
         var _a, _b;
@@ -63,11 +74,11 @@ class Brands {
                     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",
                 body: request,
@@ -109,18 +120,26 @@ class Brands {
     }
     /**
      * Fetch a specific brand by brand ID.
+     *
+     * @param {string} brandId - A unique identifier associated with the brand you wish to retrieve.
+     * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.brands.get("string")
      */
     get(brandId, 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, `/brands/${brandId}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/brands/${encodeURIComponent(brandId)}`),
                 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,
@@ -152,6 +171,14 @@ class Brands {
     }
     /**
      * Get the list of brands.
+     *
+     * @param {Courier.ListBrandsRequest} request
+     * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.brands.list({
+     *         cursor: "string"
+     *     })
      */
     list(request = {}, requestOptions) {
         var _a, _b;
@@ -168,7 +195,9 @@ class Brands {
                     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,
@@ -201,19 +230,28 @@ class Brands {
     }
     /**
      * Delete a brand by brand ID.
+     *
+     * @param {string} brandId - A unique identifier associated with the brand you wish to retrieve.
+     * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.ConflictError}
+     *
+     * @example
+     *     await courier.brands.delete("string")
      */
     delete(brandId, 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, `/brands/${brandId}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/brands/${encodeURIComponent(brandId)}`),
                 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.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,
@@ -250,18 +288,43 @@ class Brands {
     }
     /**
      * Replace an existing brand with the supplied values.
+     *
+     * @param {string} brandId - A unique identifier associated with the brand you wish to update.
+     * @param {Courier.BrandUpdateParameters} request
+     * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.brands.replace("string", {
+     *         name: "string",
+     *         settings: {
+     *             colors: {},
+     *             inapp: {
+     *                 "key": "value"
+     *             },
+     *             email: {}
+     *         },
+     *         snippets: {
+     *             items: [{
+     *                     format: "handlebars",
+     *                     name: "string",
+     *                     value: "string"
+     *                 }]
+     *         }
+     *     })
      */
     replace(brandId, 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, `/brands/${brandId}`),
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/brands/${encodeURIComponent(brandId)}`),
                 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",
                 body: request,
@@ -295,7 +358,7 @@ class Brands {
     _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/brands/client/requests/BrandUpdateParameters.d.ts

@@ -1,7 +1,27 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Courier from "../../../..";
+import * as Courier from "../../../../index";
+/**
+ * @example
+ *     {
+ *         name: "string",
+ *         settings: {
+ *             colors: {},
+ *             inapp: {
+ *                 "key": "value"
+ *             },
+ *             email: {}
+ *         },
+ *         snippets: {
+ *             items: [{
+ *                     format: "handlebars",
+ *                     name: "string",
+ *                     value: "string"
+ *                 }]
+ *         }
+ *     }
+ */
 export interface BrandUpdateParameters {
     /** The name of the brand. */
     name: string;

package/api/resources/brands/client/requests/ListBrandsRequest.d.ts

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

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

@@ -1,2 +1,2 @@
-export { ListBrandsRequest } from "./ListBrandsRequest";
-export { BrandUpdateParameters } from "./BrandUpdateParameters";
+export { type ListBrandsRequest } from "./ListBrandsRequest";
+export { type BrandUpdateParameters } from "./BrandUpdateParameters";

package/api/resources/brands/types/Brand.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 Brand {
     /** The date/time of when the brand was created. Represented in milliseconds since Unix epoch. */
     created: number;

package/api/resources/brands/types/BrandGetAllResponse.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 BrandGetAllResponse {
     paging: Courier.Paging;
     results: Courier.Brand[];

package/api/resources/brands/types/BrandParameters.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 BrandParameters {
     id?: string;
     /** The name of the brand. */

package/api/resources/brands/types/BrandSettings.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 BrandSettings {
     colors?: Courier.BrandColors;
     inapp?: any;

package/api/resources/brands/types/BrandSnippets.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 BrandSnippets {
     items: Courier.BrandSnippet[];
 }

package/api/resources/brands/types/BrandsResponse.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 BrandsResponse {
     paging: Courier.Paging;
     results: Courier.Brand[];

package/api/resources/bulk/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 Bulk {
     interface Options {
         environment?: core.Supplier<environments.CourierEnvironment | string>;
@@ -16,33 +16,98 @@ export declare namespace Bulk {
     }
     interface IdempotentRequestOptions extends RequestOptions {
         idempotencyKey?: string | undefined;
-        idempotencyExpiry?: number | undefined;
+        idempotencyExpiry?: string | undefined;
     }
 }
 export declare class Bulk {
     protected readonly _options: Bulk.Options;
     constructor(_options?: Bulk.Options);
     /**
+     * @param {Courier.BulkCreateJobParams} request
+     * @param {Bulk.IdempotentRequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
+     *
+     * @example
+     *     await courier.bulk.createJob({
+     *         message: {
+     *             message: {},
+     *             brand: "string",
+     *             data: {
+     *                 "string": {
+     *                     "key": "value"
+     *                 }
+     *             },
+     *             event: "string",
+     *             locale: {
+     *                 "string": {
+     *                     "key": "value"
+     *                 }
+     *             },
+     *             override: {
+     *                 "key": "value"
+     *             }
+     *         }
+     *     })
      */
     createJob(request: Courier.BulkCreateJobParams, requestOptions?: Bulk.IdempotentRequestOptions): Promise<Courier.BulkCreateJobResponse>;
     /**
      * Ingest user data into a Bulk Job
+     *
+     * @param {string} jobId - A unique identifier representing the bulk job
+     * @param {Courier.BulkIngestUsersParams} request
+     * @param {Bulk.IdempotentRequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await courier.bulk.ingestUsers("string", {
+     *         users: [{
+     *                 preferences: {},
+     *                 profile: {
+     *                     "key": "value"
+     *                 },
+     *                 recipient: "string",
+     *                 data: {
+     *                     "key": "value"
+     *                 },
+     *                 to: {}
+     *             }]
+     *     })
      */
     ingestUsers(jobId: string, request: Courier.BulkIngestUsersParams, requestOptions?: Bulk.IdempotentRequestOptions): Promise<void>;
     /**
      * Run a bulk job
+     *
+     * @param {string} jobId - A unique identifier representing the bulk job
+     * @param {Bulk.IdempotentRequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
+     *
+     * @example
+     *     await courier.bulk.runJob("string")
      */
     runJob(jobId: string, requestOptions?: Bulk.IdempotentRequestOptions): Promise<void>;
     /**
      * Get a bulk job
+     *
+     * @param {string} jobId - A unique identifier representing the bulk job
+     * @param {Bulk.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
+     *
+     * @example
+     *     await courier.bulk.getJob("string")
      */
     getJob(jobId: string, requestOptions?: Bulk.RequestOptions): Promise<Courier.BulkGetJobResponse>;
     /**
      * Get Bulk Job Users
+     *
+     * @param {string} jobId - A unique identifier representing the bulk job
+     * @param {Bulk.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Courier.BadRequestError}
+     *
+     * @example
+     *     await courier.bulk.getUsers("string")
      */
     getUsers(jobId: string, requestOptions?: Bulk.RequestOptions): Promise<Courier.BulkGetJobUsersResponse>;
     protected _getAuthorizationHeader(): Promise<string>;