@trycourier/courier 2.4.0 → 3.0.0

package/CHANGELOG.md

@@ -5,6 +5,24 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## [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
@@ -159,7 +177,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.4.0...HEAD
+[unreleased]: https://github.com/trycourier/courier-node/compare/v3.0.0...HEAD
+[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

package/README.md

@@ -80,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>",

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

@@ -84,15 +84,66 @@ 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),

package/lib/lists/types.d.ts

@@ -6,6 +6,10 @@ export interface ICourierList {
     name: string;
     updated?: number;
 }
+export interface ICourierRecipientSubscriptionsResponse {
+    paging: ICourierPaging;
+    results: ICourierList[];
+}
 export interface ICourierListPutParams {
     name: string;
     preferences?: {

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 { ICourierRecipientSubscriptionsResponse } from "./lists/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 getRecipientSubscriptions: (options: ICourierClientConfiguration) => (params: ICourierProfileGetParameters) => Promise<ICourierList[]>;
+export declare const deleteProfile: (options: ICourierClientConfiguration) => (params: ICourierProfileDeleteParameters) => Promise<void>;
+export declare const getRecipientSubscriptions: (options: ICourierClientConfiguration) => (params: ICourierProfileGetParameters) => Promise<ICourierRecipientSubscriptionsResponse>;
 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,6 @@
 import { AxiosRequestConfig } from "axios";
 import { ICourierClientAutomations } from "./automations/types";
-import { ICourierClientLists, ICourierList } from "./lists/types";
+import { ICourierClientLists, ICourierList, ICourierRecipientSubscriptionsResponse } 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<{
@@ -79,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;
@@ -100,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;
@@ -158,8 +264,12 @@ 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>;
-    getRecipientSubscriptions: (params: ICourierProfileGetParameters) => Promise<ICourierList[]>;
+    deleteProfile: (params: ICourierProfileDeleteParameters) => Promise<void>;
+    getRecipientSubscriptions: (params: ICourierProfileGetParameters) => Promise<ICourierRecipientSubscriptionsResponse>;
     lists: ICourierClientLists;
     mergeProfile: (params: ICourierProfilePostParameters, config?: ICourierProfilePostConfig) => Promise<ICourierProfilePostResponse>;
     notifications: ICourierClientNotifications;

package/package.json

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