@trycourier/courier 2.7.0 → 2.8.0

package/CHANGELOG.md

@@ -5,6 +5,10 @@ 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
@@ -169,7 +173,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## v1.0.1 - 2019-07-12
 
-[unreleased]: https://github.com/trycourier/courier-node/compare/v2.7.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

package/README.md

@@ -84,6 +84,10 @@ async function run() {
   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);

package/lib/client.js

@@ -97,6 +97,19 @@ var getMessageHistory = function (options) {
         });
     }); };
 };
+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;
@@ -129,6 +142,7 @@ exports.client = function (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/types.d.ts

@@ -188,6 +188,21 @@ export interface IProviderErrorMessageHistory extends IRoutedMessageHistory<"UND
 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;
 }
@@ -250,6 +265,7 @@ export interface ICourierClient {
     }) => 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>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trycourier/courier",
-  "version": "2.7.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",