@trycourier/courier 3.0.0 → 3.3.0

package/CHANGELOG.md

@@ -5,6 +5,22 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## [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`
@@ -177,7 +193,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## v1.0.1 - 2019-07-12
 
-[unreleased]: https://github.com/trycourier/courier-node/compare/v3.0.0...HEAD
+[unreleased]: https://github.com/trycourier/courier-node/compare/v3.3.0...HEAD
+[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

package/README.md

@@ -377,6 +377,45 @@ async function run() {
 
   // Example: Cancel notification submission
   await courier.notifications.cancelSubmission("notification1", "submission1");
+
+  // Bulk Processing
+  // Example: create a job
+  const response = await courier.bulk.createJob({
+    message: {
+      event: "RR4NDQ7NZ24A8TKPWVBEDGE15E9A",
+    },
+  });
+  console.log(response);
+
+  // Example: get a job
+  const response = await courier.bulk.getJob({
+    jobId: "1-61efe386-6ff57552409e311b7a1f371f",
+  });
+  console.log(response);
+
+  // Example: Ingest users in a job
+  const response = await courier.bulk.ingestUsers({
+    jobId: "1-61efe386-6ff57552409e311b7a1f371f",
+    users: [
+      {
+        profile: {
+          email: "tejas@courier.com",
+        },
+      },
+    ],
+  });
+  console.log(response);
+
+  // Example: Run a job
+  await courier.bulk.runJob({
+    jobId: "1-61efe386-6ff57552409e311b7a1f371f",
+  });
+
+  // Example: Get user details in a job
+  const response = await courier.bulk.getJobUsers({
+    jobId: "1-61efe386-6ff57552409e311b7a1f371f",
+  });
+  console.log(response);
 }
 
 run();

package/lib/bulk/index.d.ts

@@ -0,0 +1,3 @@
+import { ICourierClientConfiguration } from "../types";
+import { ICourierClientBulk } from "./types";
+export declare const bulk: (options: ICourierClientConfiguration) => ICourierClientBulk;

package/lib/bulk/index.js

@@ -0,0 +1,154 @@
+"use strict";
+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 };
+    }
+};
+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;
+        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 1:
+                    res = _a.sent();
+                    return [2 /*return*/, res.data];
+            }
+        });
+    }); };
+};
+var ingestUsers = function (options) {
+    return function (params, config) { return __awaiter(void 0, void 0, void 0, function () {
+        var axiosConfig, 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 1:
+                    res = _a.sent();
+                    return [2 /*return*/, res.data];
+            }
+        });
+    }); };
+};
+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 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+};
+var getJob = function (options) {
+    return function (params) { 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.get("/bulk/" + params.jobId)];
+                case 1:
+                    res = _a.sent();
+                    return [2 /*return*/, res.data];
+            }
+        });
+    }); };
+};
+var getJobUsers = function (options) {
+    return function (params) { 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.get("/bulk/" + params.jobId + "/users", {
+                        params: {
+                            cursor: params.cursor
+                        }
+                    })];
+                case 1:
+                    res = _a.sent();
+                    return [2 /*return*/, res.data];
+            }
+        });
+    }); };
+};
+exports.bulk = function (options) {
+    return {
+        createJob: createJob(options),
+        getJob: getJob(options),
+        getJobUsers: getJobUsers(options),
+        ingestUsers: ingestUsers(options),
+        runJob: runJob(options)
+    };
+};

package/lib/bulk/types.d.ts

@@ -0,0 +1,76 @@
+import { IRecipientPreferences } from "../preferences/types";
+export interface IInboundBulkMessage {
+    brand?: string;
+    data?: object;
+    event: string;
+    locale?: string;
+    override?: object;
+}
+export interface ICourierBulkConfig {
+    idempotencyKey?: string;
+    idempotencyExpiry?: number;
+}
+export interface ICourierBulkCreateJobParams {
+    message: IInboundBulkMessage;
+}
+export interface ICourierBulkCreateJobResponse {
+    jobId: string;
+}
+export interface IInboundBulkMessageUser {
+    preferences?: IRecipientPreferences;
+    profile?: object;
+    recipient?: string;
+    data?: object;
+}
+export declare type InboundBulkMessageUser = IInboundBulkMessageUser;
+export interface ICourierBulkIngestUsersParams {
+    jobId: string;
+    users: InboundBulkMessageUser[];
+}
+export interface ICourierBulkIngestError {
+    user: any;
+    error: any;
+}
+export interface ICourierBulkIngestUsersResponse {
+    total: number;
+    errors?: ICourierBulkIngestError[];
+}
+export interface ICourierBulkRunJobParams {
+    jobId: string;
+}
+export interface ICourierBulkGetJobParams {
+    jobId: string;
+}
+export declare type BulkJobStatus = "CREATED" | "PROCESSING" | "COMPLETED" | "ERROR";
+export declare type BulkJobUserStatus = "PENDING" | "ENQUEUED" | "ERROR";
+export interface ICourierBulkGetJobResponse {
+    job: {
+        definition: IInboundBulkMessage;
+        enqueued: number;
+        failures: number;
+        received: number;
+        status: BulkJobStatus;
+    };
+}
+export interface ICourierBulkGetJobUsersParams {
+    jobId: string;
+    cursor?: string;
+}
+export interface ICourierBulkMessageUserResponse extends InboundBulkMessageUser {
+    status: BulkJobUserStatus;
+    messageId?: string;
+}
+export interface ICourierBulkGetJobUsersResponse {
+    items: ICourierBulkMessageUserResponse[];
+    paging: {
+        cursor?: string;
+        more: boolean;
+    };
+}
+export interface ICourierClientBulk {
+    createJob: (params: ICourierBulkCreateJobParams, config?: ICourierBulkConfig) => Promise<ICourierBulkCreateJobResponse>;
+    ingestUsers: (params: ICourierBulkIngestUsersParams, config?: ICourierBulkConfig) => Promise<ICourierBulkIngestUsersResponse>;
+    runJob: (params: ICourierBulkRunJobParams, config?: ICourierBulkConfig) => Promise<void>;
+    getJob: (params: ICourierBulkGetJobParams) => Promise<ICourierBulkGetJobResponse>;
+    getJobUsers: (params: ICourierBulkGetJobUsersParams) => Promise<ICourierBulkGetJobUsersResponse>;
+}

package/lib/bulk/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/client.js

@@ -39,6 +39,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.client = void 0;
 var automations_1 = require("./automations");
 var brands_1 = require("./brands");
+var bulk_1 = require("./bulk");
 var lists_1 = require("./lists");
 var notifications_1 = require("./notifications");
 var preferences_1 = require("./preferences");
@@ -55,6 +56,10 @@ var send = function (options) {
                     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", {
                             brand: params.brand,
                             data: params.data,
@@ -116,13 +121,15 @@ var getMessages = function (options) {
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, options.httpClient.get("/messages", {
-                        cursor: params === null || params === void 0 ? void 0 : params.cursor,
-                        event: params === null || params === void 0 ? void 0 : params.eventId,
-                        list: params === null || params === void 0 ? void 0 : params.listId,
-                        messageId: params === null || params === void 0 ? void 0 : params.messageId,
-                        notification: params === null || params === void 0 ? void 0 : params.notificationId,
-                        recipient: params === null || params === void 0 ? void 0 : params.recipientId,
-                        status: params === null || params === void 0 ? void 0 : params.status
+                        params: {
+                            cursor: params === null || params === void 0 ? void 0 : params.cursor,
+                            event: params === null || params === void 0 ? void 0 : params.eventId,
+                            list: params === null || params === void 0 ? void 0 : params.listId,
+                            messageId: params === null || params === void 0 ? void 0 : params.messageId,
+                            notification: params === null || params === void 0 ? void 0 : params.notificationId,
+                            recipient: params === null || params === void 0 ? void 0 : params.recipientId,
+                            status: params === null || params === void 0 ? void 0 : params.status
+                        }
                     })];
                 case 1:
                     res = _a.sent();
@@ -135,6 +142,7 @@ exports.client = function (options) {
     return {
         addRecipientToLists: profile_1.addRecipientToLists(options),
         automations: automations_1.automations(options),
+        bulk: bulk_1.bulk(options),
         createBrand: brands_1.createBrand(options),
         deleteBrand: brands_1.deleteBrand(options),
         deleteProfile: profile_1.deleteProfile(options),

package/lib/lists/index.js

@@ -192,6 +192,10 @@ var send = function (options) {
                     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 1:
                     res = _a.sent();

package/lib/types.d.ts

@@ -1,5 +1,6 @@
 import { AxiosRequestConfig } from "axios";
 import { ICourierClientAutomations } from "./automations/types";
+import { ICourierClientBulk } from "./bulk/types";
 import { ICourierClientLists, ICourierList, ICourierRecipientSubscriptionsResponse } from "./lists/types";
 import { ICourierClientNotifications } from "./notifications/types";
 import { ICourierClientPreferences, IRecipientPreferences } from "./preferences/types";
@@ -31,6 +32,7 @@ export interface ICourierSendParameters {
 }
 export interface ICourierSendConfig {
     idempotencyKey?: string;
+    idempotencyExpiry?: number;
 }
 export interface ICourierSendResponse {
     messageId: string;
@@ -101,25 +103,40 @@ export interface ICourierMessagesGetResponse {
     }>;
 }
 export interface ICourierMessageGetResponse {
+    clicked?: number;
+    delivered?: number;
     enqueued?: number;
+    error?: string;
     event?: string;
     id: string;
+    idempotencyKey?: string;
+    listId?: string;
+    listMessageId?: string;
     notification?: string;
+    opened?: number;
     providers?: Array<{
         channel: {
-            name: string;
+            key?: string;
+            name?: string;
             template: string;
         };
+        clicked?: number;
+        delivered?: number;
+        error?: string;
         provider: string;
-        reference: {
-            "x-message-id": string;
+        reference?: {
+            [key: string]: string | number;
         };
         sent: number;
-        status: string;
+        status: MessageStatus;
     }>;
+    reason?: MessageStatusReason;
+    reasonCode?: MessageStatusReasonCode;
+    reasonDetails?: string;
     recipient: string;
+    runId?: string;
     sent?: number;
-    status: string;
+    status: MessageStatus;
 }
 export declare type MessageStatus = "CLICKED" | "DELIVERED" | "ENQUEUED" | "FILTERED" | "OPENED" | "SENT" | "SIMULATED" | "UNDELIVERABLE" | "UNMAPPED";
 export declare type MessageHistoryType = MessageStatus | "DELIVERING" | "FILTERED" | "MAPPED" | "PROFILE_LOADED" | "RENDERED";
@@ -257,6 +274,7 @@ export interface ICourierBrandGetAllResponse {
 export interface ICourierClient {
     addRecipientToLists: (params: ICourierProfileListsPostParameters) => Promise<ICourierProfilePostResponse>;
     automations: ICourierClientAutomations;
+    bulk: ICourierClientBulk;
     createBrand: (params: ICourierBrandParameters, config?: ICourierBrandPostConfig) => Promise<ICourierBrand>;
     deleteBrand: (brandId: string) => Promise<void>;
     getBrand: (brandId: string) => Promise<ICourierBrand>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trycourier/courier",
-  "version": "3.0.0",
+  "version": "3.3.0",
   "description": "A node.js module for communicating with the Courier REST API.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",