@trycourier/courier 6.3.1 → 6.4.1

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,72 +67,50 @@ 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 core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
+    }
+    __create(request, requestOptions) {
         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.1", "User-Agent": "@trycourier/courier/6.4.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 }, 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;
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 400:
-                        throw new Courier.BadRequestError(_response.error.body);
+                        throw new Courier.BadRequestError(_response.error.body, _response.rawResponse);
                     case 402:
-                        throw new Courier.PaymentRequiredError(_response.error.body);
+                        throw new Courier.PaymentRequiredError(_response.error.body, _response.rawResponse);
                     case 409:
-                        throw new Courier.AlreadyExistsError(_response.error.body);
+                        throw new Courier.AlreadyExistsError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.CourierError({
                             statusCode: _response.error.statusCode,
                             body: _response.error.body,
+                            rawResponse: _response.rawResponse,
                         });
                 }
             }
@@ -131,12 +119,14 @@ class Brands {
                     throw new errors.CourierError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
                     });
                 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,
+                        rawResponse: _response.rawResponse,
                     });
             }
         });
@@ -148,33 +138,32 @@ 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 core.HttpResponsePromise.fromPromise(this.__get(brandId, requestOptions));
+    }
+    __get(brandId, requestOptions) {
         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.1", "User-Agent": "@trycourier/courier/6.4.1", "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;
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
                 throw new errors.CourierError({
                     statusCode: _response.error.statusCode,
                     body: _response.error.body,
+                    rawResponse: _response.rawResponse,
                 });
             }
             switch (_response.error.reason) {
@@ -182,12 +171,14 @@ class Brands {
                     throw new errors.CourierError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
                     });
                 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,
+                        rawResponse: _response.rawResponse,
                     });
             }
         });
@@ -199,41 +190,38 @@ 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* () {
+        return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
+    }
+    __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.1", "User-Agent": "@trycourier/courier/6.4.1", "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;
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
                 throw new errors.CourierError({
                     statusCode: _response.error.statusCode,
                     body: _response.error.body,
+                    rawResponse: _response.rawResponse,
                 });
             }
             switch (_response.error.reason) {
@@ -241,12 +229,14 @@ class Brands {
                     throw new errors.CourierError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
                     });
                 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,
+                        rawResponse: _response.rawResponse,
                     });
             }
         });
@@ -260,37 +250,36 @@ 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 core.HttpResponsePromise.fromPromise(this.__delete(brandId, requestOptions));
+    }
+    __delete(brandId, requestOptions) {
         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.1", "User-Agent": "@trycourier/courier/6.4.1", "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;
+                return { data: undefined, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 409:
-                        throw new Courier.ConflictError(_response.error.body);
+                        throw new Courier.ConflictError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.CourierError({
                             statusCode: _response.error.statusCode,
                             body: _response.error.body,
+                            rawResponse: _response.rawResponse,
                         });
                 }
             }
@@ -299,12 +288,14 @@ class Brands {
                     throw new errors.CourierError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
                     });
                 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,
+                        rawResponse: _response.rawResponse,
                     });
             }
         });
@@ -317,61 +308,37 @@ 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 core.HttpResponsePromise.fromPromise(this.__replace(brandId, request, requestOptions));
+    }
+    __replace(brandId, request, requestOptions) {
         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.1", "User-Agent": "@trycourier/courier/6.4.1", "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;
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
                 throw new errors.CourierError({
                     statusCode: _response.error.statusCode,
                     body: _response.error.body,
+                    rawResponse: _response.rawResponse,
                 });
             }
             switch (_response.error.reason) {
@@ -379,23 +346,25 @@ class Brands {
                     throw new errors.CourierError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
                     });
                 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,
+                        rawResponse: _response.rawResponse,
                     });
             }
         });
     }
     _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 {
     /**