@trycourier/courier 3.6.0 → 3.7.0

package/CHANGELOG.md

@@ -5,9 +5,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## [v3.7.0] - 2022-03-11
+
+- adds additional types for the tags property (`message.tags`)
+- adds support for searching message by tags
+
 ## [v3.6.0] - 2022-02-10
 
-- adds additional type's for the recipient property (`message.to`)
+- adds additional types for the recipient property (`message.to`)
 
 ## [v3.5.0] - 2022-02-10
 

package/lib/client.js

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

package/lib/send/types.d.ts

@@ -316,7 +316,10 @@ export interface RoutingStrategyProvider<T = Record<string, any>> {
     config?: T;
     if?: string;
 }
-export interface ContentMessageMetadata {
+export interface BaseMessageMetadata {
+    tags?: [string?, string?, string?, string?, string?, string?, string?, string?, string?];
+}
+export interface ContentMessageMetadata extends BaseMessageMetadata {
     event?: string;
 }
 export interface ContentMessage extends BaseMessage {
@@ -325,6 +328,7 @@ export interface ContentMessage extends BaseMessage {
 }
 export interface TemplateMessage extends BaseMessage {
     brand?: string;
+    metadata?: BaseMessageMetadata;
     template: string;
 }
 export declare type Message = ContentMessage | TemplateMessage;

package/lib/types.d.ts

@@ -96,6 +96,7 @@ export interface ICourierMessagesGetParameters {
     notificationId?: string;
     recipientId?: string;
     status?: string | string[];
+    tags?: string | string[];
 }
 export interface ICourierMessagesGetResponse {
     paging: ICourierPaging;
@@ -107,6 +108,7 @@ export interface ICourierMessagesGetResponse {
         recipient: string;
         sent?: number;
         status: string;
+        tags?: string[];
     }>;
 }
 export interface ICourierMessageGetResponse {

package/package.json

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