@trycourier/courier 3.16.0 → 4.0.1

package/README.md

@@ -672,6 +672,36 @@ async function run() {
 run();
 ```
 
+### Error Handling
+
+This package tries to use the native `fetch` client to make requests or falls back to a polyfill if the client doesn't exist in the environment it's running in.
+
+All network related promise rejections are not handled in any way. All successfully made requests that produce errors on the server side are resulting in promise rejections with custom `CourierHttpClientError` error type.
+
+`CourierHttpClientError` extends native `Error` interface with two extra properties:
+
+* `response`: this is the `fetch` response as is
+* `data`: this is the parsed body of the response
+
+```javascript
+// Error handling example
+import { CourierClient, CourierHttpClientError } from '@trycourier/courier';
+
+const courier = CourierClient();
+
+try {
+  await courier.send(/* ... */);
+} catch (error) {
+  if (error instanceof CourierHttpClientError) {
+    console.log("Failed to send with status code:", error.response.status);
+    console.log("The Courier response is:", error.data);
+    console.log("The error message is:", error.message);
+  } else {
+    console.log('There was a problem making that request. Make sure you are online.');
+  }
+}
+```
+
 ### Idempotency
 
 For `POST` methods, you can supply an `idempotencyKey` in the config parameter to ensure the idempotency of the API Call. We recommend that you use a `V4 UUID` for the key. Keys are eligible to be removed from the system after they're at least 24 hours old, and a new request is generated if a key is reused after the original has been removed. For more info, see [Idempotent Requests](https://docs.courier.com/reference/idempotent-requests) in the Courier documentation.

package/lib/audiences/index.js

@@ -91,7 +91,7 @@ var putAudience = function (options) {
         var response;
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0: return [4 /*yield*/, options.httpClient.get("/audiences/" + audience.id)];
+                case 0: return [4 /*yield*/, options.httpClient.put("/audiences/" + audience.id)];
                 case 1:
                     response = _a.sent();
                     return [2 /*return*/, response.data.audience];

package/lib/automations/index.js

@@ -39,28 +39,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.automations = void 0;
 var invokeAdHocAutomation = function (options) {
     return function (params, config) { return __awaiter(void 0, void 0, void 0, function () {
-        var axiosConfig, res;
+        var res;
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0:
-                    axiosConfig = {
-                        headers: {}
-                    };
-                    if (config && config.idempotencyKey) {
-                        axiosConfig.headers["Idempotency-Key"] = config.idempotencyKey;
-                    }
-                    if (config && config.idempotencyExpiry) {
-                        axiosConfig.headers["x-idempotency-expiration"] =
-                            config.idempotencyExpiry;
-                    }
-                    return [4 /*yield*/, options.httpClient.post("/automations/invoke", {
-                            automation: params.automation,
-                            brand: params.brand,
-                            data: params.data,
-                            profile: params.profile,
-                            recipient: params.recipient,
-                            template: params.template
-                        }, axiosConfig)];
+                case 0: return [4 /*yield*/, options.httpClient.post("/automations/invoke", {
+                        automation: params.automation,
+                        brand: params.brand,
+                        data: params.data,
+                        profile: params.profile,
+                        recipient: params.recipient,
+                        template: params.template
+                    }, {
+                        idempotencyExpiry: config === null || config === void 0 ? void 0 : config.idempotencyExpiry,
+                        idempotencyKey: config === null || config === void 0 ? void 0 : config.idempotencyKey
+                    })];
                 case 1:
                     res = _a.sent();
                     return [2 /*return*/, res.data];
@@ -70,25 +62,19 @@ var invokeAdHocAutomation = function (options) {
 };
 var invokeAutomationTemplate = function (options) {
     return function (params, config) { return __awaiter(void 0, void 0, void 0, function () {
-        var axiosConfig, res;
+        var res;
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0:
-                    axiosConfig = {
-                        headers: {}
-                    };
-                    if (config && config.idempotencyKey) {
-                        axiosConfig.headers["Idempotency-Key"] = config.idempotencyKey;
-                        axiosConfig.headers["x-idempotency-expiration"] =
-                            config.idempotencyExpiry;
-                    }
-                    return [4 /*yield*/, options.httpClient.post("/automations/" + params.templateId + "/invoke", {
-                            brand: params.brand,
-                            data: params.data,
-                            profile: params.profile,
-                            recipient: params.recipient,
-                            template: params.template
-                        }, axiosConfig)];
+                case 0: return [4 /*yield*/, options.httpClient.post("/automations/" + params.templateId + "/invoke", {
+                        brand: params.brand,
+                        data: params.data,
+                        profile: params.profile,
+                        recipient: params.recipient,
+                        template: params.template
+                    }, {
+                        idempotencyExpiry: config === null || config === void 0 ? void 0 : config.idempotencyExpiry,
+                        idempotencyKey: config === null || config === void 0 ? void 0 : config.idempotencyKey
+                    })];
                 case 1:
                     res = _a.sent();
                     return [2 /*return*/, res.data];

package/lib/brands.js

@@ -76,21 +76,13 @@ exports.getBrand = function (options) {
 };
 exports.createBrand = function (options) {
     return function (params, config) { return __awaiter(void 0, void 0, void 0, function () {
-        var axiosConfig, res;
+        var res;
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0:
-                    axiosConfig = {
-                        headers: {}
-                    };
-                    if (config && config.idempotencyKey) {
-                        axiosConfig.headers["Idempotency-Key"] = config.idempotencyKey;
-                    }
-                    if (config && config.idempotencyExpiry) {
-                        axiosConfig.headers["x-idempotency-expiration"] =
-                            config.idempotencyExpiry;
-                    }
-                    return [4 /*yield*/, options.httpClient.post("/brands", params, axiosConfig)];
+                case 0: return [4 /*yield*/, options.httpClient.post("/brands", params, {
+                        idempotencyExpiry: config === null || config === void 0 ? void 0 : config.idempotencyExpiry,
+                        idempotencyKey: config === null || config === void 0 ? void 0 : config.idempotencyKey
+                    })];
                 case 1:
                     res = _a.sent();
                     return [2 /*return*/, res.data];

package/lib/bulk/index.js

@@ -39,23 +39,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.bulk = void 0;
 var createJob = function (options) {
     return function (params, config) { return __awaiter(void 0, void 0, void 0, function () {
-        var axiosConfig, res;
+        var res;
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0:
-                    axiosConfig = {
-                        headers: {}
-                    };
-                    if (config && config.idempotencyKey) {
-                        axiosConfig.headers["Idempotency-Key"] = config.idempotencyKey;
-                    }
-                    if (config && config.idempotencyExpiry) {
-                        axiosConfig.headers["x-idempotency-expiration"] =
-                            config.idempotencyExpiry;
-                    }
-                    return [4 /*yield*/, options.httpClient.post("/bulk", {
-                            message: params.message
-                        }, axiosConfig)];
+                case 0: return [4 /*yield*/, options.httpClient.post("/bulk", {
+                        message: params.message
+                    }, {
+                        idempotencyExpiry: config === null || config === void 0 ? void 0 : config.idempotencyExpiry,
+                        idempotencyKey: config === null || config === void 0 ? void 0 : config.idempotencyKey
+                    })];
                 case 1:
                     res = _a.sent();
                     return [2 /*return*/, res.data];
@@ -65,23 +57,15 @@ var createJob = function (options) {
 };
 var ingestUsers = function (options) {
     return function (params, config) { return __awaiter(void 0, void 0, void 0, function () {
-        var axiosConfig, res;
+        var res;
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0:
-                    axiosConfig = {
-                        headers: {}
-                    };
-                    if (config && config.idempotencyKey) {
-                        axiosConfig.headers["Idempotency-Key"] = config.idempotencyKey;
-                    }
-                    if (config && config.idempotencyExpiry) {
-                        axiosConfig.headers["x-idempotency-expiration"] =
-                            config.idempotencyExpiry;
-                    }
-                    return [4 /*yield*/, options.httpClient.post("/bulk/" + params.jobId, {
-                            users: params.users
-                        }, axiosConfig)];
+                case 0: return [4 /*yield*/, options.httpClient.post("/bulk/" + params.jobId, {
+                        users: params.users
+                    }, {
+                        idempotencyExpiry: config === null || config === void 0 ? void 0 : config.idempotencyExpiry,
+                        idempotencyKey: config === null || config === void 0 ? void 0 : config.idempotencyKey
+                    })];
                 case 1:
                     res = _a.sent();
                     return [2 /*return*/, res.data];
@@ -91,21 +75,12 @@ var ingestUsers = function (options) {
 };
 var runJob = function (options) {
     return function (params, config) { return __awaiter(void 0, void 0, void 0, function () {
-        var axiosConfig;
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0:
-                    axiosConfig = {
-                        headers: {}
-                    };
-                    if (config && config.idempotencyKey) {
-                        axiosConfig.headers["Idempotency-Key"] = config.idempotencyKey;
-                    }
-                    if (config && config.idempotencyExpiry) {
-                        axiosConfig.headers["x-idempotency-expiration"] =
-                            config.idempotencyExpiry;
-                    }
-                    return [4 /*yield*/, options.httpClient.post("/bulk/" + params.jobId + "/run", {}, axiosConfig)];
+                case 0: return [4 /*yield*/, options.httpClient.post("/bulk/" + params.jobId + "/run", {}, {
+                        idempotencyExpiry: config === null || config === void 0 ? void 0 : config.idempotencyExpiry,
+                        idempotencyKey: config === null || config === void 0 ? void 0 : config.idempotencyKey
+                    })];
                 case 1:
                     _a.sent();
                     return [2 /*return*/];

package/lib/http-client.d.ts

@@ -0,0 +1,10 @@
+import { IHttpClient, IInitHttpClientOptions } from "./types";
+export declare class CourierHttpClientError extends Error {
+    response?: Response;
+    data?: any;
+    constructor(message: string, { response, data }: {
+        response?: Response;
+        data?: any;
+    });
+}
+export declare const initHttpClient: ({ baseUrl, version, authorizationToken }: IInitHttpClientOptions) => IHttpClient;

package/lib/http-client.js

@@ -0,0 +1,131 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initHttpClient = exports.CourierHttpClientError = void 0;
+var cross_fetch_1 = require("cross-fetch");
+var fetch = (_a = globalThis.fetch) !== null && _a !== void 0 ? _a : cross_fetch_1.default;
+var CourierHttpClientError = /** @class */ (function (_super) {
+    __extends(CourierHttpClientError, _super);
+    function CourierHttpClientError(message, _a) {
+        var response = _a.response, data = _a.data;
+        var _this = _super.call(this, message) || this;
+        Object.setPrototypeOf(_this, CourierHttpClientError.prototype);
+        _this.response = response;
+        _this.data = data;
+        return _this;
+    }
+    return CourierHttpClientError;
+}(Error));
+exports.CourierHttpClientError = CourierHttpClientError;
+exports.initHttpClient = function (_a) {
+    var baseUrl = _a.baseUrl, version = _a.version, authorizationToken = _a.authorizationToken;
+    var createHttpMethodClient = function (method) {
+        return function () {
+            var _a = [];
+            for (var _i = 0; _i < arguments.length; _i++) {
+                _a[_i] = arguments[_i];
+            }
+            var url = _a[0], body = _a[1], config = _a[2];
+            return __awaiter(void 0, void 0, void 0, function () {
+                var searchParams, searchQueryString, fullUrl, contentTypeHeader, idempotencyKeyHeader, idempotencyExpiryHeader, response, parseAsJson, data;
+                return __generator(this, function (_b) {
+                    switch (_b.label) {
+                        case 0:
+                            searchParams = String(new URLSearchParams(config === null || config === void 0 ? void 0 : config.params));
+                            searchQueryString = searchParams && "?" + searchParams;
+                            fullUrl = String(new URL("" + url + searchQueryString, baseUrl));
+                            contentTypeHeader = body == null ? null : { "Content-Type": "application/json" };
+                            idempotencyKeyHeader = (config === null || config === void 0 ? void 0 : config.idempotencyKey) ? { "Idempotency-Key": config.idempotencyKey }
+                                : null;
+                            idempotencyExpiryHeader = (config === null || config === void 0 ? void 0 : config.idempotencyExpiry) == null
+                                ? null
+                                : { "x-idempotency-expiration": String(config.idempotencyExpiry) };
+                            return [4 /*yield*/, fetch(fullUrl, {
+                                    body: body != null ? JSON.stringify(body) : undefined,
+                                    headers: __assign(__assign(__assign({ Authorization: "Bearer " + authorizationToken, "User-Agent": "courier-node/" + version }, contentTypeHeader), idempotencyKeyHeader), idempotencyExpiryHeader),
+                                    method: method
+                                })];
+                        case 1:
+                            response = _b.sent();
+                            parseAsJson = response.headers.get("content-length") !== "0" &&
+                                response.headers.get("content-type") === "application/json";
+                            return [4 /*yield*/, (parseAsJson ? response.json() : response.text())];
+                        case 2:
+                            data = _b.sent();
+                            if (!response.ok) {
+                                throw new CourierHttpClientError(data.message || "An unexpected error has occurred", { response: response, data: data });
+                            }
+                            return [2 /*return*/, { data: data }];
+                    }
+                });
+            });
+        };
+    };
+    return {
+        delete: createHttpMethodClient("delete"),
+        get: function (url, config) { return createHttpMethodClient("get")(url, undefined, config); },
+        patch: createHttpMethodClient("patch"),
+        post: createHttpMethodClient("post"),
+        put: createHttpMethodClient("put")
+    };
+};

package/lib/index.d.ts

@@ -1,3 +1,4 @@
 import { ICourierClientOptions } from "./types";
 export { ICourierClient } from "./types";
+export { CourierHttpClientError } from "./http-client";
 export declare const CourierClient: (options?: ICourierClientOptions) => import("./types").ICourierClient;

package/lib/index.js

@@ -1,30 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CourierClient = void 0;
-var axios_1 = require("axios");
 var client_1 = require("./client");
+var http_client_1 = require("./http-client");
+var http_client_2 = require("./http-client");
+Object.defineProperty(exports, "CourierHttpClientError", { enumerable: true, get: function () { return http_client_2.CourierHttpClientError; } });
 // cannot be `import` as it's not under TS root dir
 // tslint:disable-next-line:no-var-requires
 var version = require("../package.json").version;
 var DEFAULTS = {
     BASE_URL: "https://api.courier.com"
 };
+var getEnvVariable = function (name) { var _a, _b; return (_b = (_a = globalThis === null || globalThis === void 0 ? void 0 : globalThis.process) === null || _a === void 0 ? void 0 : _a.env) === null || _b === void 0 ? void 0 : _b[name]; };
 exports.CourierClient = function (options) {
     if (options === void 0) { options = {}; }
-    var authorizationToken = options.authorizationToken || process.env.COURIER_AUTH_TOKEN;
+    var authorizationToken = options.authorizationToken || getEnvVariable("COURIER_AUTH_TOKEN");
     if (!authorizationToken) {
         throw new Error("Courier Auth Token is required.");
     }
-    var baseURL = options.baseUrl || process.env.COURIER_BASE_URL || DEFAULTS.BASE_URL;
-    var axiosInstance = axios_1.default.create({
-        baseURL: baseURL,
-        headers: {
-            Authorization: "Bearer " + authorizationToken,
-            "User-Agent": "courier-node/" + version
-        }
+    var baseUrl = options.baseUrl || getEnvVariable("COURIER_BASE_URL") || DEFAULTS.BASE_URL;
+    var httpClient = http_client_1.initHttpClient({
+        authorizationToken: authorizationToken,
+        baseUrl: baseUrl,
+        version: version
     });
     var courier = client_1.client({
-        httpClient: axiosInstance
+        httpClient: httpClient
     });
     return courier;
 };

package/lib/lists/index.js

@@ -182,21 +182,13 @@ var findByRecipientId = function (options) {
 };
 var send = function (options) {
     return function (params, config) { return __awaiter(void 0, void 0, void 0, function () {
-        var axiosConfig, res;
+        var res;
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0:
-                    axiosConfig = {
-                        headers: {}
-                    };
-                    if (config && config.idempotencyKey) {
-                        axiosConfig.headers["Idempotency-Key"] = config.idempotencyKey;
-                    }
-                    if (config && config.idempotencyExpiry) {
-                        axiosConfig.headers["x-idempotency-expiration"] =
-                            config.idempotencyExpiry;
-                    }
-                    return [4 /*yield*/, options.httpClient.post("/send/list", params, axiosConfig)];
+                case 0: return [4 /*yield*/, options.httpClient.post("/send/list", params, {
+                        idempotencyExpiry: config === null || config === void 0 ? void 0 : config.idempotencyExpiry,
+                        idempotencyKey: config === null || config === void 0 ? void 0 : config.idempotencyKey
+                    })];
                 case 1:
                     res = _a.sent();
                     return [2 /*return*/, res.data];

package/lib/profile.js

@@ -54,23 +54,15 @@ exports.replaceProfile = function (options) {
 };
 exports.mergeProfile = function (options) {
     return function (params, config) { return __awaiter(void 0, void 0, void 0, function () {
-        var axiosConfig, res;
+        var res;
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0:
-                    axiosConfig = {
-                        headers: {}
-                    };
-                    if (config && config.idempotencyKey) {
-                        axiosConfig.headers["Idempotency-Key"] = config.idempotencyKey;
-                    }
-                    if (config && config.idempotencyExpiry) {
-                        axiosConfig.headers["x-idempotency-expiration"] =
-                            config.idempotencyExpiry;
-                    }
-                    return [4 /*yield*/, options.httpClient.post("/profiles/" + params.recipientId, {
-                            profile: params.profile
-                        }, axiosConfig)];
+                case 0: return [4 /*yield*/, options.httpClient.post("/profiles/" + params.recipientId, {
+                        profile: params.profile
+                    }, {
+                        idempotencyExpiry: config === null || config === void 0 ? void 0 : config.idempotencyExpiry,
+                        idempotencyKey: config === null || config === void 0 ? void 0 : config.idempotencyKey
+                    })];
                 case 1:
                     res = _a.sent();
                     return [2 /*return*/, res.data];

package/lib/send/index.js

@@ -37,7 +37,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.send = void 0;
-var sendCall = function (options, config, params) { return __awaiter(void 0, void 0, void 0, function () {
+var sendCall = function (options, params, config) { return __awaiter(void 0, void 0, void 0, function () {
     var res;
     return __generator(this, function (_a) {
         switch (_a.label) {
@@ -49,20 +49,26 @@ var sendCall = function (options, config, params) { return __awaiter(void 0, voi
                     preferences: params.preferences,
                     profile: params.profile,
                     recipient: params.recipientId
-                }, config)];
+                }, {
+                    idempotencyExpiry: config === null || config === void 0 ? void 0 : config.idempotencyExpiry,
+                    idempotencyKey: config === null || config === void 0 ? void 0 : config.idempotencyKey
+                })];
             case 1:
                 res = _a.sent();
                 return [2 /*return*/, res.data];
         }
     });
 }); };
-var sendMessageCall = function (options, config, params) { return __awaiter(void 0, void 0, void 0, function () {
+var sendMessageCall = function (options, params, config) { return __awaiter(void 0, void 0, void 0, function () {
     var res;
     return __generator(this, function (_a) {
         switch (_a.label) {
             case 0: return [4 /*yield*/, options.httpClient.post("/send", {
                     message: params.message
-                }, config)];
+                }, {
+                    idempotencyExpiry: config === null || config === void 0 ? void 0 : config.idempotencyExpiry,
+                    idempotencyKey: config === null || config === void 0 ? void 0 : config.idempotencyKey
+                })];
             case 1:
                 res = _a.sent();
                 return [2 /*return*/, res.data];
@@ -71,26 +77,16 @@ var sendMessageCall = function (options, config, params) { return __awaiter(void
 }); };
 exports.send = function (options) {
     return function (params, config) { return __awaiter(void 0, void 0, void 0, function () {
-        var axiosConfig, v2Response, v1Response;
+        var v2Response, v1Response;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
-                    axiosConfig = {
-                        headers: {}
-                    };
-                    if (config && config.idempotencyKey) {
-                        axiosConfig.headers["Idempotency-Key"] = config.idempotencyKey;
-                    }
-                    if (config && config.idempotencyExpiry) {
-                        axiosConfig.headers["x-idempotency-expiration"] =
-                            config.idempotencyExpiry;
-                    }
                     if (!params.message) return [3 /*break*/, 2];
-                    return [4 /*yield*/, sendMessageCall(options, axiosConfig, params)];
+                    return [4 /*yield*/, sendMessageCall(options, params, config)];
                 case 1:
                     v2Response = _a.sent();
                     return [2 /*return*/, v2Response];
-                case 2: return [4 /*yield*/, sendCall(options, axiosConfig, params)];
+                case 2: return [4 /*yield*/, sendCall(options, params, config)];
                 case 3:
                     v1Response = _a.sent();
                     return [2 /*return*/, v1Response];

package/lib/types.d.ts

@@ -1,4 +1,3 @@
-import { AxiosRequestConfig } from "axios";
 import { ICourierClientAudiences } from "./audiences/types";
 import { auditEvents } from "./audit-events";
 import { ICourierClientAutomations } from "./automations/types";
@@ -8,7 +7,16 @@ import { ICourierClientNotifications } from "./notifications/types";
 import { ICourierClientPreferences, IRecipientPreferences } from "./preferences/types";
 import { Message } from "./send/types";
 import { tokenManagement } from "./token-management";
-export declare type HttpMethodClient = <T>(url: string, body?: object, config?: AxiosRequestConfig) => Promise<{
+export interface IInitHttpClientOptions {
+    baseUrl: string;
+    version: string;
+    authorizationToken: string;
+}
+export declare type HttpMethodClient = <T>(url: string, body?: object, config?: {
+    params?: Record<string, string>;
+    idempotencyKey?: string;
+    idempotencyExpiry?: number;
+}) => Promise<{
     data: T;
 }>;
 export interface IHttpClient {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trycourier/courier",
-  "version": "3.16.0",
+  "version": "4.0.1",
   "description": "A node.js module for communicating with the Courier REST API.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -14,8 +14,8 @@
   "devDependencies": {
     "@types/jest": "^24.0.15",
     "@types/node": "^12.6.2",
-    "axios-mock-adapter": "^1.17.0",
     "jest": "^24.8.0",
+    "jest-fetch-mock": "^3.0.3",
     "prettier": "^1.18.2",
     "ts-jest": "^24.0.2",
     "tslint": "^5.18.0",
@@ -31,6 +31,6 @@
     "prepublishOnly": "yarn lint && yarn test"
   },
   "dependencies": {
-    "axios": "^0.21.1"
+    "cross-fetch": "^3.1.5"
   }
 }

package/CHANGELOG.md

@@ -1,296 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-This project adheres to [Semantic Versioning](http://semver.org/).
-
-## [Unreleased][unreleased]
-
-## [3.16.0]
-
-- adds support for idempotency expiry to be passed in profiles and brands POST
-
-## [3.15.0]
-
-- adds support for audit events
-
-## [3.14.0]
-
-- adds support for token management
-
-## [3.13.1] - 2022-06-03
-
-- adds provider and channel timeout
-
-## [3.12.0] - 2022-03-31
-
-- adds support for message trace id (`message.metadata.trace_id`)
-
-## [3.11.0] - 2022-03-23
-
-- adds support for `audiences`
-
-## [3.10.1] - 2022-03-20
-
-- adds support for messages timeout (`message.timeout`)
-
-## [3.10.0] - 2020-03-24
-
-- adds support for messages brand_id (`message.brand_id`)
-
-## [3.9.0] - 2022-03-17
-
-- adds support for bulk messaging API v2 support
-
-## [3.8.0] - 2022-03-14
-
-- adds additional types for utm property (`message.metadata.utm`)
-
-## [v3.7.0] - 2022-03-11
-
-- adds additional types for the tags property (`message.metadata.tags`)
-- adds support for searching message by tags
-
-## [v3.6.0] - 2022-02-10
-
-- adds additional types for the recipient property (`message.to`)
-
-## [v3.5.0] - 2022-02-10
-
-- adds type for unroutable status
-
-## [v3.4.0] - 2022-01-25
-
-- adds support for the send message object in the request body of a `/send` call
-
-## [v3.3.0] - 2022-01-25
-
-- adds support for bulk processing endpoints
-
-## [v3.2.1] - 2022-01-13
-
-- Fixes `getMessages` query params
-
-## [v3.2.0] - 2021-11-18
-
-- adds idempotency expiration support for send and send list endpoints
-
-## [v3.1.0] - 2021-11-16
-
-- Expose additional type definitions for `getMessage`
-
-## [v3.0.0] - 2021-11-02
-
-- fixes type definition for `getRecipientSubscriptions`
-
-## [v2.8.0] - 2021-10-29
-
-- adds GET /messages/{messageId}/output API
-
-## [v2.7.0] - 2021-10-21
-
-- adds GET /messages/{messageId}/history API
-
-## [v2.6.0] - 2021-10-07
-
-- Add support for DELETE /profiles/{recipient_id} (#58)
-- adds GET /messages API
-- adds idempotencyKey support in automations client
-
-## [v2.4.0] - 2021-08-23
-
-- adds notifications API
-- type fix `put` method of `ICourierClientLists`
-
-## [v2.3.0] - 2021-04-28
-
-- adds support for update-profile step via `client.automations.invokeAdHocAutomation({...})`
-
-## [v2.2.0] - 2021-04-07
-
-- adds automations API
-
-## [v2.1.0] - 2021-03-15
-
-- adds support to add more recipients to a list subscription (#40)
-- adds support to delete all the lists subscriptions for a recipient (#39)
-- adds support to add recipient to multiple lists (#38)
-- updates preference interface to accept new preference options (#37)
-
-## [v2.0.0] - 2021-03-03
-
-- supports adding subscription preferences (#35)
-
-## [v1.7.3] - 2021-03-03
-
-### Added
-
-- ICourierClient exported as a type [#33](https://github.com/trycourier/courier-node/pull/33)
-
-## [v1.7.2] - 2021-02-16
-
-### Fixed
-
-- Update PUT list subscription request params with appropriate type [#32](https://github.com/trycourier/courier-node/pull/32)
-
-## [v1.7.1] - 2021-02-01
-
-### Fixed
-
-- Fix the notification(s) typo [#28](https://github.com/trycourier/courier-node/pull/28)
-
-## [v1.7.0] - 2021-01-25
-
-### Added
-
-- Support for [Preferences API]() by @helenamerk and @aydrian
-  - `GET /preferences` via `client.preferences.list()`
-  - `GET /preferences/{recipient_id}` via `client.preferences.get(recipientId)`
-  - `PUT /preferences/{recipient_id}` via `client.preferences.put(recipientId, {...})`
-
-## [v1.6.2] - 2021-01-19
-
-### Fixed
-
-- Bumped [axios](https://www.npmjs.com/package/axios) to version 0.21.1
-- Updated types for Send to List Parameters by @rileylnapier
-
-## [v1.6.1] - 2020-09-23
-
-### Fixed
-
-- Fixed return types for `PUT` methods that return 204
-- Fixed param types for `client.lists.send()`
-- Fixed return type for `client.lists.findByRecipientId()`
-- Fixed param types for `client.lists.put()`
-
-## [v1.6.0] - 2020-09-22
-
-### Added
-
-- Support for `idempotencyKey` for `POST` methods by @aydrian & @rileylnapier
-- Support for [Lists API](https://docs.courier.com/reference/lists-api) by @aydrian
-  - `POST /send/list` via `client.lists.send(params, config)`
-  - `GET /profiles/{recipient_id}/lists` via `client.lists.findByRecipientId(recipientId, params)`
-  - `GET /lists` via `client.lists.list(params)`
-  - `GET /lists/{list_id}` via `client.lists.get(listId)`
-  - `PUT /lists/{list_id}` via `client.lists.put(listId, {...})`
-  - `DELETE /lists/{list_id}` via `client.lists.delete(listId)`
-  - `PUT /lists/{list_id}/restore` via `client.lists.restore(listId)`
-  - `GET /lists/{list_id}/subscriptions` via `client.lists.getSubscriptions(listId)`
-  - `PUT /lists/{list_id}/subscriptions` via `client.lists.putSubscriptions(listId, [recipientId], config)`
-  - `PUT /lists/{list_id}/subscriptions/{recipient_id}` via `client.lists.subscribe(listId, recipientId)`
-  - `DELETE /lists/{list_id}/subscriptions/{recipient_id}` via `client.lists.unsubscribe(listId, recipientId)`
-
-### Changed
-
-- Default `base_url` is now `api.courier.com`
-
-## [v1.5.0] - 2020-07-08
-
-### Added
-
-- Support for [Brands API](https://docs.courier.com/reference/brands-api) by @aydrian
-  - `GET /brands` via `client.getBrands(params)`
-  - `GET /brands/:brand_id` via `client.getBrand(brandId)`
-  - `POST /brands` via `client.createBrand({…})`
-  - `PUT /brands/:brand_id` via `client.replaceBrand({…})`
-  - `DELETE /brands/:brand_id` via `client.deleteBrand(brandId)`
-- Support for specifying notification brand during [send](https://docs.courier.com/reference/send-api#sendmessage) by @aydrian
-
-## [v1.4.0] - 2020-06-29
-
-### Added
-
-- Support `GET /messages/:messageId` via `client.getMessage(messageId)` @rileylnapier
-
-## [v1.3.0] - 2020-03-10
-
-### Added
-
-- Support credential storage using `COURIER_AUTH_TOKEN` environment variable by @aydrian
-- Support setting base url using `COURIER_BASE_URL` environment variable by @aydrian
-- Support preferences and override in send method by @aydrian
-- Create GitHub Issue and Pull Request templates by @rileylnapier
-
-### Changed
-
-- Updated user agent string to match new standard by @aydrian
-
-## [v1.2.1] - 2019-12-30
-
-### Fixed
-
-- Convert package.json import to a require by @@scarney81
-
-## [v1.2.0] - 2019-12-20
-
-## Added
-
-- Custom user agent string by @aydrian
-
-## [v1.1.6] - 2019-07-12
-
-## [v1.1.5] - 2019-07-12
-
-## [v1.1.4] - 2019-07-12
-
-## [v1.1.3] - 2019-07-12
-
-## [v1.1.2] - 2019-07-12
-
-## [v1.1.1] - 2019-07-12
-
-## [v1.1.0] - 2019-07-12
-
-## [v1.0.4] - 2019-07-12
-
-## [v1.0.3] - 2019-07-12
-
-## [v1.0.2] - 2019-07-12
-
-## v1.0.1 - 2019-07-12
-
-[unreleased]: https://github.com/trycourier/courier-node/compare/v3.11.0...HEAD
-[v3.11.0]: https://github.com/trycourier/courier-node/compare/v3.10.0...v3.11.0
-[v3.10.0]: https://github.com/trycourier/courier-node/compare/v3.9.0...v3.10.0
-[v3.9.0]: https://github.com/trycourier/courier-node/compare/v3.8.0...v3.9.0
-[v3.8.0]: https://github.com/trycourier/courier-node/compare/v3.7.0...v3.8.0
-[v3.7.0]: https://github.com/trycourier/courier-node/compare/v3.6.0...v3.7.0
-[v3.6.0]: https://github.com/trycourier/courier-node/compare/v3.5.0...v3.6.0
-[v3.5.0]: https://github.com/trycourier/courier-node/compare/v3.4.0...v3.5.0
-[v3.4.0]: https://github.com/trycourier/courier-node/compare/v3.3.0...v3.4.0
-[v3.3.0]: https://github.com/trycourier/courier-node/compare/v3.2.1...v3.3.0
-[v3.2.1]: https://github.com/trycourier/courier-node/compare/v3.2.0...v3.2.1
-[v3.2.0]: https://github.com/trycourier/courier-node/compare/v3.1.0...v3.2.0
-[v3.1.0]: https://github.com/trycourier/courier-node/compare/v3.0.0...v3.1.0
-[v3.0.0]: https://github.com/trycourier/courier-node/compare/v2.8.0...v3.0.0
-[v2.8.0]: https://github.com/trycourier/courier-node/compare/v2.7.0...v2.8.0
-[v2.7.0]: https://github.com/trycourier/courier-node/compare/v2.6.0...v2.7.0
-[v2.6.0]: https://github.com/trycourier/courier-node/compare/v2.4.0...v2.6.0
-[v2.4.0]: https://github.com/trycourier/courier-node/compare/v2.3.0...v2.4.0
-[v2.3.0]: https://github.com/trycourier/courier-node/compare/v2.2.0...v2.3.0
-[v2.2.0]: https://github.com/trycourier/courier-node/compare/v2.1.0...v2.2.0
-[v2.1.0]: https://github.com/trycourier/courier-node/compare/v2.0.0...v2.1.0
-[v2.0.0]: https://github.com/trycourier/courier-node/compare/v1.7.3...v2.0.0
-[v1.7.3]: https://github.com/trycourier/courier-node/compare/v1.7.2...v1.7.3
-[v1.7.2]: https://github.com/trycourier/courier-node/compare/v1.7.1...v1.7.2
-[v1.7.1]: https://github.com/trycourier/courier-node/compare/v1.7.0...v1.7.1
-[v1.7.0]: https://github.com/trycourier/courier-node/compare/v1.6.2...v1.7.0
-[v1.6.2]: https://github.com/trycourier/courier-node/compare/v1.6.1...v1.6.2
-[v1.6.1]: https://github.com/trycourier/courier-node/compare/v1.6.0...v1.6.1
-[v1.6.0]: https://github.com/trycourier/courier-node/compare/v1.5.0...v1.6.0
-[v1.5.0]: https://github.com/trycourier/courier-node/compare/v1.4.0...v1.5.0
-[v1.4.0]: https://github.com/trycourier/courier-node/compare/v1.3.0...v1.4.0
-[v1.3.0]: https://github.com/trycourier/courier-node/compare/v1.2.1...v1.3.0
-[v1.2.1]: https://github.com/trycourier/courier-node/compare/v1.2.0...v1.2.1
-[v1.2.0]: https://github.com/trycourier/courier-node/compare/v1.1.6...v1.2.0
-[v1.1.6]: https://github.com/trycourier/courier-node/compare/v1.1.5...v1.1.6
-[v1.1.5]: https://github.com/trycourier/courier-node/compare/v1.1.4...v1.1.5
-[v1.1.4]: https://github.com/trycourier/courier-node/compare/v1.1.3...v1.1.4
-[v1.1.3]: https://github.com/trycourier/courier-node/compare/v1.1.2...v1.1.3
-[v1.1.2]: https://github.com/trycourier/courier-node/compare/v1.1.1...v1.1.2
-[v1.1.1]: https://github.com/trycourier/courier-node/compare/v1.1.0...v1.1.1
-[v1.1.0]: https://github.com/trycourier/courier-node/compare/v1.0.4...v1.1.0
-[v1.0.4]: https://github.com/trycourier/courier-node/compare/v1.0.3...v1.0.4
-[v1.0.3]: https://github.com/trycourier/courier-node/compare/v1.0.2...v1.0.3
-[v1.0.2]: https://github.com/trycourier/courier-node/compare/v1.0.1...v1.0.2