@trycourier/courier 6.3.1 → 6.4.0

package/api/resources/brands/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) {
@@ -57,56 +67,30 @@ class Brands {
      * @throws {@link Courier.AlreadyExistsError}
      *
      * @example
-     *     await courier.brands.create({
-     *         id: "string",
-     *         name: "string",
+     *     await client.brands.create({
+     *         id: undefined,
+     *         name: "name",
      *         settings: {
-     *             colors: {
-     *                 primary: "string",
-     *                 secondary: "string",
-     *                 tertiary: "string"
-     *             },
-     *             inapp: {
-     *                 "key": "value"
-     *             },
-     *             email: {
-     *                 footer: {
-     *                     "key": "value"
-     *                 },
-     *                 header: {
-     *                     "key": "value"
-     *                 }
-     *             }
+     *             colors: undefined,
+     *             inapp: undefined,
+     *             email: undefined
      *         },
-     *         snippets: {
-     *             items: [{
-     *                     format: "handlebars",
-     *                     name: "string",
-     *                     value: "string"
-     *                 }]
-     *         }
+     *         snippets: undefined
      *     })
      */
     create(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, "/brands"),
+                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, "/brands"),
                 method: "POST",
-                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,
-                    "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 : undefined,
-                },
+                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, "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 : undefined }, 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;
@@ -133,7 +117,7 @@ class Brands {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling POST /brands.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -148,25 +132,20 @@ class Brands {
      * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.brands.get("string")
+     *     await client.brands.get("brand_id")
      */
     get(brandId, 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, `/brands/${encodeURIComponent(brandId)}`),
+                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, `/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.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;
@@ -184,7 +163,7 @@ class Brands {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /brands/{brand_id}.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -199,33 +178,26 @@ class Brands {
      * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.brands.list({
-     *         cursor: "string"
-     *     })
+     *     await client.brands.list()
      */
-    list(request = {}, requestOptions) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function* () {
+    list() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c;
             const { cursor } = request;
             const _queryParams = {};
             if (cursor != null) {
                 _queryParams["cursor"] = cursor;
             }
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, "/brands"),
+                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, "/brands"),
                 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;
@@ -243,7 +215,7 @@ class Brands {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /brands.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -260,25 +232,20 @@ class Brands {
      * @throws {@link Courier.ConflictError}
      *
      * @example
-     *     await courier.brands.delete("string")
+     *     await client.brands.delete("brand_id")
      */
     delete(brandId, 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, `/brands/${encodeURIComponent(brandId)}`),
+                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, `/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.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;
@@ -301,7 +268,7 @@ class Brands {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling DELETE /brands/{brand_id}.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -317,53 +284,25 @@ class Brands {
      * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.brands.replace("string", {
-     *         name: "string",
-     *         settings: {
-     *             colors: {
-     *                 primary: "string",
-     *                 secondary: "string",
-     *                 tertiary: "string"
-     *             },
-     *             inapp: {
-     *                 "key": "value"
-     *             },
-     *             email: {
-     *                 footer: {
-     *                     "key": "value"
-     *                 },
-     *                 header: {
-     *                     "key": "value"
-     *                 }
-     *             }
-     *         },
-     *         snippets: {
-     *             items: [{
-     *                     format: "handlebars",
-     *                     name: "string",
-     *                     value: "string"
-     *                 }]
-     *         }
+     *     await client.brands.replace("brand_id", {
+     *         name: "name",
+     *         settings: undefined,
+     *         snippets: undefined
      *     })
      */
     replace(brandId, 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, `/brands/${encodeURIComponent(brandId)}`),
+                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, `/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.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;
@@ -381,7 +320,7 @@ class Brands {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CourierTimeoutError();
+                    throw new errors.CourierTimeoutError("Timeout exceeded when calling PUT /brands/{brand_id}.");
                 case "unknown":
                     throw new errors.CourierError({
                         message: _response.error.errorMessage,
@@ -390,12 +329,12 @@ class Brands {
         });
     }
     _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/brands/client/requests/BrandUpdateParameters.d.ts

@@ -5,32 +5,9 @@ import * as Courier from "../../../../index";
 /**
  * @example
  *     {
- *         name: "string",
- *         settings: {
- *             colors: {
- *                 primary: "string",
- *                 secondary: "string",
- *                 tertiary: "string"
- *             },
- *             inapp: {
- *                 "key": "value"
- *             },
- *             email: {
- *                 footer: {
- *                     "key": "value"
- *                 },
- *                 header: {
- *                     "key": "value"
- *                 }
- *             }
- *         },
- *         snippets: {
- *             items: [{
- *                     format: "handlebars",
- *                     name: "string",
- *                     value: "string"
- *                 }]
- *         }
+ *         name: "name",
+ *         settings: undefined,
+ *         snippets: undefined
  *     }
  */
 export interface BrandUpdateParameters {

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

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

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

@@ -7,12 +7,20 @@ import * as Courier from "../../../index";
 export declare namespace Bulk {
     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;
@@ -29,94 +37,14 @@ export declare class Bulk {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.bulk.createJob({
+     *     await client.bulk.createJob({
      *         message: {
-     *             message: {
-     *                 template: "string",
-     *                 data: {
-     *                     "string": {
-     *                         "key": "value"
-     *                     }
-     *                 },
-     *                 brand_id: "string",
-     *                 channels: {
-     *                     "string": {
-     *                         brand_id: undefined,
-     *                         providers: undefined,
-     *                         routing_method: undefined,
-     *                         if: undefined,
-     *                         timeouts: undefined,
-     *                         override: undefined,
-     *                         metadata: undefined
-     *                     }
-     *                 },
-     *                 context: {
-     *                     tenant_id: "string"
-     *                 },
-     *                 metadata: {
-     *                     event: "string",
-     *                     tags: [],
-     *                     utm: {
-     *                         source: undefined,
-     *                         medium: undefined,
-     *                         campaign: undefined,
-     *                         term: undefined,
-     *                         content: undefined
-     *                     },
-     *                     trace_id: "string"
-     *                 },
-     *                 preferences: {
-     *                     subscription_topic_id: "string"
-     *                 },
-     *                 providers: {
-     *                     "string": {
-     *                         override: undefined,
-     *                         if: undefined,
-     *                         timeouts: undefined,
-     *                         metadata: undefined
-     *                     }
-     *                 },
-     *                 routing: {
-     *                     method: Courier.RoutingMethod.All,
-     *                     channels: [{
-     *                             channel: "string",
-     *                             config: undefined,
-     *                             method: undefined,
-     *                             providers: undefined,
-     *                             if: undefined
-     *                         }]
-     *                 },
-     *                 timeout: {
-     *                     provider: {},
-     *                     channel: {},
-     *                     message: 1,
-     *                     escalation: 1,
-     *                     criteria: Courier.Criteria.NoEscalation
-     *                 },
-     *                 delay: {
-     *                     duration: 1,
-     *                     until: "string"
-     *                 },
-     *                 expiry: {
-     *                     expires_at: "string",
-     *                     expires_in: "string"
-     *                 }
-     *             },
-     *             brand: "string",
-     *             data: {
-     *                 "string": {
-     *                     "key": "value"
-     *                 }
-     *             },
-     *             event: "string",
-     *             locale: {
-     *                 "string": {
-     *                     "key": "value"
-     *                 }
-     *             },
-     *             override: {
-     *                 "key": "value"
-     *             }
+     *             brand: undefined,
+     *             data: undefined,
+     *             event: undefined,
+     *             locale: undefined,
+     *             override: undefined,
+     *             message: undefined
      *         }
      *     })
      */
@@ -129,36 +57,19 @@ export declare class Bulk {
      * @param {Bulk.IdempotentRequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await courier.bulk.ingestUsers("string", {
+     *     await client.bulk.ingestUsers("job_id", {
      *         users: [{
-     *                 preferences: {
-     *                     categories: {},
-     *                     notifications: {}
-     *                 },
-     *                 profile: {
-     *                     "key": "value"
-     *                 },
-     *                 recipient: "string",
-     *                 data: {
-     *                     "key": "value"
-     *                 },
-     *                 to: {
-     *                     account_id: "string",
-     *                     context: {
-     *                         tenant_id: "string"
-     *                     },
-     *                     data: {},
-     *                     email: "string",
-     *                     locale: "string",
-     *                     user_id: "string",
-     *                     phone_number: "string",
-     *                     preferences: {
-     *                         categories: undefined,
-     *                         notifications: {},
-     *                         templateId: undefined
-     *                     },
-     *                     tenant_id: "string"
-     *                 }
+     *                 preferences: undefined,
+     *                 profile: undefined,
+     *                 recipient: undefined,
+     *                 data: undefined,
+     *                 to: undefined
+     *             }, {
+     *                 preferences: undefined,
+     *                 profile: undefined,
+     *                 recipient: undefined,
+     *                 data: undefined,
+     *                 to: undefined
      *             }]
      *     })
      */
@@ -172,7 +83,7 @@ export declare class Bulk {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.bulk.runJob("string")
+     *     await client.bulk.runJob("job_id")
      */
     runJob(jobId: string, requestOptions?: Bulk.IdempotentRequestOptions): Promise<void>;
     /**
@@ -184,7 +95,7 @@ export declare class Bulk {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.bulk.getJob("string")
+     *     await client.bulk.getJob("job_id")
      */
     getJob(jobId: string, requestOptions?: Bulk.RequestOptions): Promise<Courier.BulkGetJobResponse>;
     /**
@@ -197,9 +108,7 @@ export declare class Bulk {
      * @throws {@link Courier.BadRequestError}
      *
      * @example
-     *     await courier.bulk.getUsers("string", {
-     *         cursor: "string"
-     *     })
+     *     await client.bulk.getUsers("job_id")
      */
     getUsers(jobId: string, request?: Courier.BulkGetUsersParams, requestOptions?: Bulk.RequestOptions): Promise<Courier.BulkGetJobUsersResponse>;
     protected _getAuthorizationHeader(): Promise<string>;