@trycourier/courier 3.7.0 → 3.10.0

package/CHANGELOG.md

@@ -5,9 +5,20 @@ 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
+
+## [3.8.0] - 2022-03-14
+
+- adds additional types for utm property (`message.metadata.utm`)
+
 ## [v3.7.0] - 2022-03-11
 
-- adds additional types for the tags property (`message.tags`)
+- adds additional types for the tags property (`message.metadata.tags`)
 - adds support for searching message by tags
 
 ## [v3.6.0] - 2022-02-10
@@ -210,7 +221,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## v1.0.1 - 2019-07-12
 
-[unreleased]: https://github.com/trycourier/courier-node/compare/v3.5.0...HEAD
+[unreleased]: https://github.com/trycourier/courier-node/compare/v3.9.0...HEAD
+[v3.9.0]: https://github.com/trycourier/courier-node/compare/v3.8.0...v3.9.0
+[v3.8.0]: https://github.com/trycourier/courier-node/compare/v3.7.0...v3.8.0
+[v3.7.0]: https://github.com/trycourier/courier-node/compare/v3.6.0...v3.7.0
+[v3.6.0]: https://github.com/trycourier/courier-node/compare/v3.5.0...v3.6.0
 [v3.5.0]: https://github.com/trycourier/courier-node/compare/v3.4.0...v3.5.0
 [v3.4.0]: https://github.com/trycourier/courier-node/compare/v3.3.0...v3.4.0
 [v3.3.0]: https://github.com/trycourier/courier-node/compare/v3.2.1...v3.3.0

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
@@ -497,7 +520,7 @@ async function run() {
   await courier.notifications.cancelSubmission("notification1", "submission1");
 
   // Bulk Processing
-  // Example: create a job
+  // Example: create a job (API v1 semantics)
   const response = await courier.bulk.createJob({
     message: {
       event: "RR4NDQ7NZ24A8TKPWVBEDGE15E9A",
@@ -505,13 +528,23 @@ async function run() {
   });
   console.log(response);
 
+  // Example: create a job (API v2 semantics)
+  const response = await courier.bulk.createJob({
+    message: {
+      message: {
+        template: "RR4NDQ7NZ24A8TKPWVBEDGE15E9A",
+      },
+    },
+  });
+  console.log(response);
+
   // Example: get a job
   const response = await courier.bulk.getJob({
     jobId: "1-61efe386-6ff57552409e311b7a1f371f",
   });
   console.log(response);
 
-  // Example: Ingest users in a job
+  // Example: Ingest users in a job (API v1 semantics)
   const response = await courier.bulk.ingestUsers({
     jobId: "1-61efe386-6ff57552409e311b7a1f371f",
     users: [
@@ -524,6 +557,19 @@ async function run() {
   });
   console.log(response);
 
+  // Example: Ingest users in a job (API v2 semantics)
+  const response = await courier.bulk.ingestUsers({
+    jobId: "1-61efe386-6ff57552409e311b7a1f371f",
+    users: [
+      {
+        to: {
+          email: "tejas@courier.com",
+        },
+      },
+    ],
+  });
+  console.log(response);
+
   // Example: Run a job
   await courier.bulk.runJob({
     jobId: "1-61efe386-6ff57552409e311b7a1f371f",

package/lib/bulk/types.d.ts

@@ -1,11 +1,17 @@
 import { IRecipientPreferences } from "../preferences/types";
-export interface IInboundBulkMessage {
+import { Message, UserRecipient } from "../send/types";
+interface IInboundBulkMessageApiV1 {
     brand?: string;
     data?: object;
     event: string;
     locale?: string;
     override?: object;
 }
+declare type InboundBulkMessageApiV2 = Omit<Message, "to">;
+export interface IInboundBulkMessage extends IInboundBulkMessageApiV1 {
+    message?: InboundBulkMessageApiV2;
+}
+export declare type InboundBulkMessage = IInboundBulkMessage;
 export interface ICourierBulkConfig {
     idempotencyKey?: string;
     idempotencyExpiry?: number;
@@ -21,6 +27,7 @@ export interface IInboundBulkMessageUser {
     profile?: object;
     recipient?: string;
     data?: object;
+    to?: UserRecipient;
 }
 export declare type InboundBulkMessageUser = IInboundBulkMessageUser;
 export interface ICourierBulkIngestUsersParams {
@@ -74,3 +81,4 @@ export interface ICourierClientBulk {
     getJob: (params: ICourierBulkGetJobParams) => Promise<ICourierBulkGetJobResponse>;
     getJobUsers: (params: ICourierBulkGetJobUsersParams) => Promise<ICourierBulkGetJobUsersResponse>;
 }
+export {};

package/lib/client.js

@@ -98,8 +98,8 @@ var getMessages = function (options) {
                             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,
-                            tags: params === null || params === void 0 ? void 0 : params.tags,
-                        },
+                            tags: params === null || params === void 0 ? void 0 : params.tags
+                        }
                     })];
                 case 1:
                     res = _a.sent();

package/lib/send/types.d.ts

@@ -236,13 +236,23 @@ 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 {
-    to: MessageRecipient;
-    data?: MessageData;
+    brand_id?: string;
     channels?: MessageChannels;
+    data?: MessageData;
+    metadata?: MessageMetadata;
     providers?: MessageProviders;
     routing?: Routing;
+    timeout?: Timeout;
+    to: MessageRecipient;
 }
 interface TrackingOverride {
     open: boolean;
@@ -316,19 +326,21 @@ export interface RoutingStrategyProvider<T = Record<string, any>> {
     config?: T;
     if?: string;
 }
-export interface BaseMessageMetadata {
-    tags?: [string?, string?, string?, string?, string?, string?, string?, string?, string?];
-}
-export interface ContentMessageMetadata extends BaseMessageMetadata {
+export interface MessageMetadata {
     event?: string;
+    tags?: string[];
+    utm?: {
+        source?: string;
+        medium?: string;
+        campaign?: string;
+        term?: string;
+        content?: string;
+    };
 }
 export interface ContentMessage extends BaseMessage {
     content: Content;
-    metadata?: ContentMessageMetadata;
 }
 export interface TemplateMessage extends BaseMessage {
-    brand?: string;
-    metadata?: BaseMessageMetadata;
     template: string;
 }
 export declare type Message = ContentMessage | TemplateMessage;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trycourier/courier",
-  "version": "3.7.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",
@@ -33,4 +33,4 @@
   "dependencies": {
     "axios": "^0.21.1"
   }
-}
+}