@trycourier/courier 3.9.0 → 3.10.0

package/CHANGELOG.md

@@ -5,6 +5,9 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## [3.10.0] - 2022-03-20
+- adds support for messages timeout (`message.timeout`)
+
 ## [3.9.0] - 2022-03-17
 
 - adds support for bulk messaging API v2 support

package/README.md

@@ -160,6 +160,29 @@ const { requestId } = await courier.send({
     },
   },
 });
+
+// Example: send a basic message that expires after the specified timeout
+const { requestId } = await courier.send({
+  message: {
+    to: {
+      data: {
+        name: "Marty",
+      },
+      email: "marty_mcfly@email.com",
+    },
+    content: {
+      title: "Back to the Future",
+      body: "Oh my {{name}}, we need 1.21 Gigawatts!",
+    },
+    routing: {
+      method: "single",
+      channels: ["email"],
+    },
+    timeout: {
+      message: 3600000 // 1 hour in milliseconds
+    },
+  },
+});
 ```
 
 ## Environment Variables

package/lib/send/types.d.ts

@@ -236,13 +236,22 @@ export interface ElementalContentSugar {
     body?: string;
     title?: string;
 }
+export interface Timeout {
+    provider?: number;
+    channel?: number;
+    message?: number;
+    escalation?: number;
+    criteria?: "no-escalation" | "delivered" | "viewed" | "engaged";
+}
 export declare type Content = ElementalContentSugar | ElementalContent;
 export interface BaseMessage {
+    brand_id?: string;
     channels?: MessageChannels;
     data?: MessageData;
     metadata?: MessageMetadata;
     providers?: MessageProviders;
     routing?: Routing;
+    timeout?: Timeout;
     to: MessageRecipient;
 }
 interface TrackingOverride {

package/package.json

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