@trycourier/courier 3.7.0 → 3.8.0

package/CHANGELOG.md

@@ -5,9 +5,13 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## [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

package/lib/send/types.d.ts

@@ -238,11 +238,12 @@ export interface ElementalContentSugar {
 }
 export declare type Content = ElementalContentSugar | ElementalContent;
 export interface BaseMessage {
-    to: MessageRecipient;
-    data?: MessageData;
     channels?: MessageChannels;
+    data?: MessageData;
+    metadata?: MessageMetadata;
     providers?: MessageProviders;
     routing?: Routing;
+    to: MessageRecipient;
 }
 interface TrackingOverride {
     open: boolean;
@@ -316,19 +317,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.8.0",
   "description": "A node.js module for communicating with the Courier REST API.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",