@trycourier/courier 2.3.0 → 2.8.0

package/CHANGELOG.md

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

package/README.md

@@ -1,8 +1,10 @@
-# `@trycourier/courier`
+[![Courier: Your Complete Communication Stack](https://marketing-assets-public.s3.us-west-1.amazonaws.com/github_nodejs.png)](https://courier.com)
 
 [![npm version](https://badge.fury.io/js/%40trycourier%2Fcourier.svg)](https://badge.fury.io/js/%40trycourier%2Fcourier)
 
-A node.js module for communicating with the Courier REST API.
+This is the official node.js module for sending notifications with node.js with the [Courier](https://courier.com) REST API.
+
+[Courier docs](https://docs.courier.com/docs) • [3 Different Ways To Send Emails With Node.js](https://www.courier.com/blog/how-to-send-emails-with-node-js?utm_campaign=General-Content-Distribution&utm_source=github&utm_medium=node-sdk)
 
 ## Installation (via [npm](https://www.npmjs.com/package/@trycourier/courier))
 
@@ -10,7 +12,11 @@ A node.js module for communicating with the Courier REST API.
 npm install @trycourier/courier
 ```
 
-## Usage
+## Requirements
+
+You will need to get a Courier API key to get started. You can sign up and create one for free at [courier.com](https://courier.com).
+
+## Getting Started
 
 ```javascript
 import { CourierClient } from "@trycourier/courier";
@@ -74,6 +80,18 @@ async function run() {
   const messageStatus = await courier.getMessage(messageId);
   console.log(messageStatus);
 
+  // Example: get a message history
+  const { results } = await courier.getMessageHistory(messageId);
+  console.log(results);
+
+  // Example: get a message output
+  const { results } = await courier.getMessageOutput(messageId);
+  console.log(results);
+
+  // Example: get all messages
+  const { paging, results } = await courier.getMessages();
+  console.log(results);
+
   // Example: replace a recipient's profile
   const { status: replaceStatus } = await courier.replaceProfile({
     recipientId: "<RECIPIENT_ID>",
@@ -235,6 +253,130 @@ async function run() {
     template: "TEMPLATE_NAME_OR_ID",
   });
   console.log(runId);
+
+  // Example: List notifications
+  const { paging, results } = await courier.notifications.list({});
+  console.log(results);
+
+  // Example: Get notification content
+  const { blocks, channels } = await courier.notifications.getContent(
+    "notification1"
+  );
+  console.log(blocks);
+  console.log(channels);
+
+  // Example: Get notification draft content
+  const { blocks, channels } = await courier.notifications.getDraftContent(
+    "notification1"
+  );
+  console.log(blocks);
+  console.log(channels);
+
+  // Example: Post notification variations
+  await courier.notifications.postVariations("notification1", {
+    blocks: [
+      {
+        id: "block_1d4c32e0-bca8-43f6-b5d5-8c043199bce6",
+        type: "text",
+        locales: {
+          fr_FR: "block fr 1",
+        },
+      },
+      {
+        id: "block_6d50a6e3-ecc3-4815-bf51-0202c6bf54e2",
+        type: "text",
+        locales: {
+          fr_FR: "block fr 2",
+        },
+      },
+    ],
+    channels: [
+      {
+        id: "channel_1ba46024-f156-4ed7-893b-cb1cdcfbd36e",
+        type: "email",
+        locales: {
+          fr_FR: {
+            subject: "French Subject",
+          },
+        },
+      },
+      {
+        id: "channel_2c2aad1c-30f0-4a55-8d8f-d213f32147bc",
+        type: "push",
+        locales: {
+          fr_FR: {
+            title: "French Title",
+          },
+        },
+      },
+    ],
+  });
+
+  // Example: Post notification draft variations
+  await courier.notifications.postDraftVariations("notification1", {
+    blocks: [
+      {
+        id: "block_1d4c32e0-bca8-43f6-b5d5-8c043199bce6",
+        type: "text",
+        locales: {
+          fr_FR: "block fr 1",
+        },
+      },
+      {
+        id: "block_6d50a6e3-ecc3-4815-bf51-0202c6bf54e2",
+        type: "text",
+        locales: {
+          fr_FR: "block fr 2",
+        },
+      },
+    ],
+    channels: [
+      {
+        id: "channel_1ba46024-f156-4ed7-893b-cb1cdcfbd36e",
+        type: "email",
+        locales: {
+          fr_FR: {
+            subject: "French Subject",
+          },
+        },
+      },
+      {
+        id: "channel_2c2aad1c-30f0-4a55-8d8f-d213f32147bc",
+        type: "push",
+        locales: {
+          fr_FR: {
+            title: "French Title",
+          },
+        },
+      },
+    ],
+  });
+
+  // Example: Get notification submission checks
+  const { checks } = await courier.notifications.getSubmissionChecks(
+    "notification1",
+    "submission1"
+  );
+  console.log(checks);
+
+  // Example: Put notification submission checks
+  const { checks } = await courier.notifications.putSubmissionChecks(
+    "notification1",
+    "submission1",
+    {
+      checks: [
+        {
+          id: "check1",
+          status: "RESOLVED",
+          type: "custom",
+        },
+      ],
+    }
+  );
+  console.log(checks);
+
+  // Example: Cancel notification submission
+  await courier.notifications.cancelSubmission("notification1", "submission1");
 }
 
 run();
@@ -242,7 +384,7 @@ run();
 
 ### 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.
+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.
 
 ```javascript
 import { CourierClient } from "@trycourier/courier";

package/lib/automations/index.js

@@ -38,18 +38,29 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.automations = void 0;
 var invokeAdHocAutomation = function (options) {
-    return function (params) { return __awaiter(void 0, void 0, void 0, function () {
-        var res;
+    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: 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
-                    })];
+                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 1:
                     res = _a.sent();
                     return [2 /*return*/, res.data];
@@ -58,17 +69,26 @@ var invokeAdHocAutomation = function (options) {
     }); };
 };
 var invokeAutomationTemplate = function (options) {
-    return function (params) { return __awaiter(void 0, void 0, void 0, function () {
-        var res;
+    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: 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
-                    })];
+                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 1:
                     res = _a.sent();
                     return [2 /*return*/, res.data];

package/lib/automations/types.d.ts

@@ -52,6 +52,10 @@ export interface ICourierAutomationInvokeParams {
 export interface ICourierAutomationAdHocInvokeParams extends ICourierAutomationInvokeParams {
     automation: IAutomation;
 }
+export interface ICourierAutomationConfig {
+    idempotencyKey?: string;
+    idempotencyExpiry?: number;
+}
 export interface ICourierAutomationInvokeTemplateParams extends ICourierAutomationInvokeParams {
     templateId: string;
 }
@@ -59,6 +63,6 @@ export interface ICourierAutomationInvokeResponse {
     runId: string;
 }
 export interface ICourierClientAutomations {
-    invokeAdHocAutomation: (params: ICourierAutomationAdHocInvokeParams) => Promise<ICourierAutomationInvokeResponse>;
-    invokeAutomationTemplate: (params: ICourierAutomationInvokeTemplateParams) => Promise<ICourierAutomationInvokeResponse>;
+    invokeAdHocAutomation: (params: ICourierAutomationAdHocInvokeParams, config?: ICourierAutomationConfig) => Promise<ICourierAutomationInvokeResponse>;
+    invokeAutomationTemplate: (params: ICourierAutomationInvokeTemplateParams, config?: ICourierAutomationConfig) => Promise<ICourierAutomationInvokeResponse>;
 }

package/lib/client.js

@@ -40,6 +40,7 @@ exports.client = void 0;
 var automations_1 = require("./automations");
 var brands_1 = require("./brands");
 var lists_1 = require("./lists");
+var notifications_1 = require("./notifications");
 var preferences_1 = require("./preferences");
 var profile_1 = require("./profile");
 var send = function (options) {
@@ -83,19 +84,71 @@ var getMessage = function (options) {
         });
     }); };
 };
+var getMessageHistory = function (options) {
+    return function (messageId) { 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("/messages/" + messageId + "/history")];
+                case 1:
+                    res = _a.sent();
+                    return [2 /*return*/, res.data];
+            }
+        });
+    }); };
+};
+var getMessageOutput = function (options) {
+    return function (messageId) { 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("/messages/" + messageId + "/output")];
+                case 1:
+                    res = _a.sent();
+                    return [2 /*return*/, res.data];
+            }
+        });
+    }); };
+};
+var getMessages = 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("/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
+                    })];
+                case 1:
+                    res = _a.sent();
+                    return [2 /*return*/, res.data];
+            }
+        });
+    }); };
+};
 exports.client = function (options) {
     return {
         addRecipientToLists: profile_1.addRecipientToLists(options),
         automations: automations_1.automations(options),
         createBrand: brands_1.createBrand(options),
         deleteBrand: brands_1.deleteBrand(options),
+        deleteProfile: profile_1.deleteProfile(options),
         getBrand: brands_1.getBrand(options),
         getBrands: brands_1.getBrands(options),
         getMessage: getMessage(options),
+        getMessageHistory: getMessageHistory(options),
+        getMessageOutput: getMessageOutput(options),
+        getMessages: getMessages(options),
         getProfile: profile_1.getProfile(options),
         getRecipientSubscriptions: profile_1.getRecipientSubscriptions(options),
         lists: lists_1.lists(options),
         mergeProfile: profile_1.mergeProfile(options),
+        notifications: notifications_1.notifications(options),
         preferences: preferences_1.preferences(options),
         removeRecipientFromAllLists: profile_1.removeRecipientFromAllLists(options),
         replaceBrand: brands_1.replaceBrand(options),

package/lib/lists/types.d.ts

@@ -55,7 +55,7 @@ export interface ICourierClientLists {
     getSubscriptions: (listId: string, params?: ICourierListGetSubscriptionsParams) => Promise<ICourierListGetSubscriptionsResponse>;
     list: (params?: ICourierListGetAllParams) => Promise<ICourierListGetAllResponse>;
     postSubscriptions: (listId: string, recipients: ICourierPutSubscriptionsRecipient[]) => Promise<void>;
-    put: (listId: string, parms: ICourierListPutParams) => Promise<void>;
+    put: (listId: string, params: ICourierListPutParams) => Promise<void>;
     putSubscriptions: (listId: string, recipients: ICourierPutSubscriptionsRecipient[]) => Promise<void>;
     restore: (listId: string) => Promise<void>;
     send: (params: ICourierSendListOrPatternParams, config?: ICourierSendConfig) => Promise<ICourierSendResponse>;

package/lib/notifications/index.d.ts

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

package/lib/notifications/index.js

@@ -0,0 +1,152 @@
+"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.notifications = void 0;
+var list = 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("/notifications", params)];
+                case 1:
+                    res = _a.sent();
+                    return [2 /*return*/, res.data];
+            }
+        });
+    }); };
+};
+var getContent = function (options) {
+    return function (id) { 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("/notifications/" + id + "/content")];
+                case 1:
+                    res = _a.sent();
+                    return [2 /*return*/, res.data];
+            }
+        });
+    }); };
+};
+var getDraftContent = function (options) {
+    return function (id) { 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("/notifications/" + id + "/draft/content")];
+                case 1:
+                    res = _a.sent();
+                    return [2 /*return*/, res.data];
+            }
+        });
+    }); };
+};
+var postVariations = function (options) {
+    return function (id, params) { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, options.httpClient.post("/notifications/" + id + "/variations", params)];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+};
+var postDraftVariations = function (options) {
+    return function (id, params) { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, options.httpClient.post("/notifications/" + id + "/draft/variations", params)];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+};
+var getSubmissionChecks = function (options) {
+    return function (id, submissionId) { 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("/notifications/" + id + "/" + submissionId + "/checks")];
+                case 1:
+                    res = _a.sent();
+                    return [2 /*return*/, res.data];
+            }
+        });
+    }); };
+};
+var putSubmissionChecks = function (options) {
+    return function (id, submissionId, 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.put("/notifications/" + id + "/" + submissionId + "/checks", params)];
+                case 1:
+                    res = _a.sent();
+                    return [2 /*return*/, res.data];
+            }
+        });
+    }); };
+};
+var cancelSubmission = function (options) {
+    return function (id, submissionId) { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, options.httpClient.delete("/notifications/" + id + "/" + submissionId + "/checks")];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+};
+exports.notifications = function (options) {
+    return {
+        cancelSubmission: cancelSubmission(options),
+        getContent: getContent(options),
+        getDraftContent: getDraftContent(options),
+        getSubmissionChecks: getSubmissionChecks(options),
+        list: list(options),
+        postDraftVariations: postDraftVariations(options),
+        postVariations: postVariations(options),
+        putSubmissionChecks: putSubmissionChecks(options)
+    };
+};

package/lib/notifications/types.d.ts

@@ -0,0 +1,83 @@
+import { ICourierPaging } from "../types";
+export interface ICourierNotificationListResponse {
+    paging: ICourierPaging;
+    results: Array<{
+        id: string;
+        title: string;
+    }>;
+}
+export interface ICourierNotificationListParams {
+    cursor?: string;
+}
+export declare type BlockType = "action" | "divider" | "image" | "jsonnet" | "list" | "markdown" | "quote" | "template" | "text";
+export interface ICourierNotificationBlock {
+    alias?: string;
+    context?: string;
+    id: string;
+    type: BlockType;
+    content?: string | {
+        parent?: string;
+        children?: string;
+    };
+    locales?: {
+        [locale: string]: string | {
+            parent?: string;
+            children?: string;
+        };
+    };
+    checksum?: string;
+}
+export interface ICourierNotificationChannel {
+    id: string;
+    type?: string;
+    content?: {
+        subject?: string;
+        title?: string;
+    };
+    locales?: {
+        [locale: string]: {
+            subject?: string;
+            title?: string;
+        };
+    };
+    checksum?: string;
+}
+export interface ICourierNotificationGetContentResponse {
+    blocks?: ICourierNotificationBlock[];
+    channels?: ICourierNotificationChannel[];
+    checksum?: string;
+}
+export interface ICourierNotificationPostVariationsParams {
+    blocks?: ICourierNotificationBlock[];
+    channels?: ICourierNotificationChannel[];
+}
+export interface ICourierNotificationPostDraftVariationsParams {
+    blocks?: ICourierNotificationBlock[];
+    channels?: ICourierNotificationChannel[];
+}
+export declare type CheckStatus = "RESOLVED" | "FAILED" | "PENDING";
+export interface ICheck {
+    id: string;
+    status: CheckStatus;
+    type: "custom";
+    updated: number;
+}
+export interface ICourierNotificationGetSubmissionChecksResponse {
+    checks: ICheck[];
+}
+export interface ICourierNotificationPutSubmissionChecksParams {
+    checks: Array<Omit<ICheck, "updated">>;
+}
+export interface ICourierNotificationPutSubmissionChecksResponse {
+    checks: ICheck[];
+}
+export interface ICourierClientNotifications {
+    list: (params: ICourierNotificationListParams) => Promise<ICourierNotificationListResponse>;
+    getContent: (id: string) => Promise<ICourierNotificationGetContentResponse>;
+    getDraftContent: (id: string) => Promise<ICourierNotificationGetContentResponse>;
+    postVariations: (id: string, params: ICourierNotificationPostVariationsParams) => Promise<void>;
+    postDraftVariations: (id: string, params: ICourierNotificationPostDraftVariationsParams) => Promise<void>;
+    getSubmissionChecks: (id: string, submissionId: string) => Promise<ICourierNotificationGetSubmissionChecksResponse>;
+    putSubmissionChecks: (id: string, submissionId: string, params: ICourierNotificationPutSubmissionChecksParams) => Promise<ICourierNotificationPutSubmissionChecksResponse>;
+    cancelSubmission: (id: string, submissionId: string) => Promise<void>;
+}

package/lib/notifications/types.js

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

package/lib/profile.d.ts

@@ -1,8 +1,9 @@
 import { ICourierList } from "./lists/types";
-import { ICourierClientConfiguration, ICourierProfileGetParameters, ICourierProfileGetResponse, ICourierProfileListsPostParameters, ICourierProfilePostConfig, ICourierProfilePostParameters, ICourierProfilePostResponse, ICourierProfilePutParameters, ICourierProfilePutResponse } from "./types";
+import { ICourierClientConfiguration, ICourierProfileDeleteParameters, ICourierProfileGetParameters, ICourierProfileGetResponse, ICourierProfileListsPostParameters, ICourierProfilePostConfig, ICourierProfilePostParameters, ICourierProfilePostResponse, ICourierProfilePutParameters, ICourierProfilePutResponse } from "./types";
 export declare const replaceProfile: (options: ICourierClientConfiguration) => (params: ICourierProfilePutParameters) => Promise<ICourierProfilePutResponse>;
 export declare const mergeProfile: (options: ICourierClientConfiguration) => (params: ICourierProfilePostParameters, config?: ICourierProfilePostConfig | undefined) => Promise<ICourierProfilePostResponse>;
 export declare const getProfile: (options: ICourierClientConfiguration) => (params: ICourierProfileGetParameters) => Promise<ICourierProfileGetResponse>;
+export declare const deleteProfile: (options: ICourierClientConfiguration) => (params: ICourierProfileDeleteParameters) => Promise<void>;
 export declare const getRecipientSubscriptions: (options: ICourierClientConfiguration) => (params: ICourierProfileGetParameters) => Promise<ICourierList[]>;
 export declare const addRecipientToLists: (options: ICourierClientConfiguration) => (params: ICourierProfileListsPostParameters) => Promise<ICourierProfilePostResponse>;
 export declare const removeRecipientFromAllLists: (options: ICourierClientConfiguration) => (params: ICourierProfileGetParameters) => Promise<ICourierProfilePostResponse>;

package/lib/profile.js

@@ -36,7 +36,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeRecipientFromAllLists = exports.addRecipientToLists = exports.getRecipientSubscriptions = exports.getProfile = exports.mergeProfile = exports.replaceProfile = void 0;
+exports.removeRecipientFromAllLists = exports.addRecipientToLists = exports.getRecipientSubscriptions = exports.deleteProfile = exports.getProfile = exports.mergeProfile = exports.replaceProfile = void 0;
 exports.replaceProfile = function (options) {
     return function (params) { return __awaiter(void 0, void 0, void 0, function () {
         var res;
@@ -87,6 +87,18 @@ exports.getProfile = function (options) {
         });
     }); };
 };
+exports.deleteProfile = function (options) {
+    return function (params) { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, options.httpClient.delete("/profiles/" + params.recipientId)];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+};
 exports.getRecipientSubscriptions = function (options) {
     return function (params) { return __awaiter(void 0, void 0, void 0, function () {
         var res;

package/lib/types.d.ts

@@ -1,6 +1,7 @@
 import { AxiosRequestConfig } from "axios";
 import { ICourierClientAutomations } from "./automations/types";
 import { ICourierClientLists, ICourierList } from "./lists/types";
+import { ICourierClientNotifications } from "./notifications/types";
 import { ICourierClientPreferences, IRecipientPreferences } from "./preferences/types";
 export declare type HttpMethodClient = <T>(url: string, body?: object, config?: AxiosRequestConfig) => Promise<{
     data: T;
@@ -78,6 +79,27 @@ export interface ICourierProfileGetParameters {
 export interface ICourierProfileGetResponse {
     profile: object;
 }
+export interface ICourierMessagesGetParameters {
+    cursor?: string;
+    eventId?: string;
+    listId?: string;
+    messageId?: string;
+    notificationId?: string;
+    recipientId?: string;
+    status?: string | string[];
+}
+export interface ICourierMessagesGetResponse {
+    paging: ICourierPaging;
+    results: Array<{
+        enqueued?: number;
+        event?: string;
+        id: string;
+        notification?: string;
+        recipient: string;
+        sent?: number;
+        status: string;
+    }>;
+}
 export interface ICourierMessageGetResponse {
     enqueued?: number;
     event?: string;
@@ -99,6 +121,91 @@ export interface ICourierMessageGetResponse {
     sent?: number;
     status: string;
 }
+export declare type MessageStatus = "CLICKED" | "DELIVERED" | "ENQUEUED" | "FILTERED" | "OPENED" | "SENT" | "SIMULATED" | "UNDELIVERABLE" | "UNMAPPED";
+export declare type MessageHistoryType = MessageStatus | "DELIVERING" | "FILTERED" | "MAPPED" | "PROFILE_LOADED" | "RENDERED";
+export declare type MessageStatusReason = "BOUNCED" | "FAILED" | "FILTERED" | "NO_CHANNELS" | "NO_PROVIDERS" | "OPT_IN_REQUIRED" | "PROVIDER_ERROR" | "UNPUBLISHED" | "UNSUBSCRIBED";
+export declare type MessageStatusReasonCode = "HARD" | "SOFT";
+export interface IMessageHistory<T extends MessageHistoryType> {
+    ts: number;
+    type: T;
+}
+export interface IEnqueuedMessageHistory extends IMessageHistory<"ENQUEUED"> {
+    data?: string | {
+        [key: string]: string;
+    };
+    event: string;
+    profile?: {
+        [key: string]: any;
+    };
+    override?: {
+        [key: string]: any;
+    };
+    recipient: string;
+}
+export interface IMappedMessageHistory extends IMessageHistory<"MAPPED"> {
+    event_id: string;
+    notification_id: string;
+}
+export interface IProfileLoadedMessageHistory extends IMessageHistory<"PROFILE_LOADED"> {
+    merged_profile?: {
+        [key: string]: any;
+    };
+    received_profile?: {
+        [key: string]: any;
+    };
+    stored_profile?: {
+        [key: string]: any;
+    };
+}
+export interface IRenderedMessageHistory extends IRoutedMessageHistory<"RENDERED"> {
+    output: {
+        [key: string]: string;
+    };
+}
+export interface IUndeliverableMessageHistory extends IMessageHistory<"UNDELIVERABLE">, Partial<Omit<IRoutedMessageHistory<"UNDELIVERABLE">, "ts" | "type">> {
+    reason: MessageStatusReason;
+    reasonCode?: MessageStatusReasonCode;
+}
+export declare type RoutedMessageHistoryTypes = Extract<MessageHistoryType, "CLICKED" | "DELIVERED" | "DELIVERING" | "OPENED" | "RENDERED" | "SENT" | "UNDELIVERABLE">;
+export interface IRoutedMessageHistory<T extends RoutedMessageHistoryTypes> extends IMessageHistory<T> {
+    channel: {
+        id: string;
+        label?: string;
+    };
+    integration: {
+        id: string;
+        provider: string;
+    };
+}
+export interface IDeliveredMessageHistory extends IRoutedMessageHistory<"DELIVERED"> {
+    reference: {
+        [key: string]: string;
+    };
+}
+export interface IProviderErrorMessageHistory extends IRoutedMessageHistory<"UNDELIVERABLE"> {
+    error_message: string;
+}
+export interface ICourierMessageGetHistoryResponse {
+    results: Array<IEnqueuedMessageHistory | IMappedMessageHistory | IProfileLoadedMessageHistory | IRenderedMessageHistory | IRoutedMessageHistory<RoutedMessageHistoryTypes> | IDeliveredMessageHistory | IProviderErrorMessageHistory | IUndeliverableMessageHistory>;
+}
+export interface IApiMessageOutputItem {
+    channel: string;
+    channel_id: string;
+    content: {
+        html?: string;
+        title?: string;
+        blocks?: any[];
+        body?: string;
+        subject?: string;
+        text?: string;
+    };
+}
+export interface ICourierMessageGetOutputResponse {
+    results: IApiMessageOutputItem[];
+}
+export interface ICourierProfileDeleteParameters {
+    recipientId: string;
+}
 interface ICourierBrandSettings {
     colors?: {
         primary: string;
@@ -157,10 +264,15 @@ export interface ICourierClient {
         cursor: string;
     }) => Promise<ICourierBrandGetAllResponse>;
     getMessage: (messageId: string) => Promise<ICourierMessageGetResponse>;
+    getMessageHistory: (messageId: string) => Promise<ICourierMessageGetHistoryResponse>;
+    getMessageOutput: (messageId: string) => Promise<ICourierMessageGetOutputResponse>;
+    getMessages: (params?: ICourierMessagesGetParameters) => Promise<ICourierMessagesGetResponse>;
     getProfile: (params: ICourierProfileGetParameters) => Promise<ICourierProfileGetResponse>;
+    deleteProfile: (params: ICourierProfileDeleteParameters) => Promise<void>;
     getRecipientSubscriptions: (params: ICourierProfileGetParameters) => Promise<ICourierList[]>;
     lists: ICourierClientLists;
     mergeProfile: (params: ICourierProfilePostParameters, config?: ICourierProfilePostConfig) => Promise<ICourierProfilePostResponse>;
+    notifications: ICourierClientNotifications;
     preferences: ICourierClientPreferences;
     removeRecipientFromAllLists: (params: ICourierProfileGetParameters) => Promise<ICourierProfilePostResponse>;
     replaceBrand: (params: ICourierBrandPutParameters) => Promise<ICourierBrand>;

package/package.json

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