@trycourier/courier 2.6.0 → 3.1.0

package/CHANGELOG.md

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

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/client.js

@@ -84,6 +84,32 @@ 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;
@@ -115,6 +141,8 @@ exports.client = function (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),

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,9 +1,9 @@
-import { ICourierList } from "./lists/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 deleteProfile: (options: ICourierClientConfiguration) => (params: ICourierProfileDeleteParameters) => Promise<void>;
-export declare const getRecipientSubscriptions: (options: ICourierClientConfiguration) => (params: ICourierProfileGetParameters) => Promise<ICourierList[]>;
+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/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<{
@@ -101,25 +101,122 @@ 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";
+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;
@@ -182,10 +279,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>;
     deleteProfile: (params: ICourierProfileDeleteParameters) => Promise<void>;
-    getRecipientSubscriptions: (params: ICourierProfileGetParameters) => Promise<ICourierList[]>;
+    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.6.0",
+  "version": "3.1.0",
   "description": "A node.js module for communicating with the Courier REST API.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",