@trycourier/courier 3.0.0 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -5,6 +5,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
5
5
 
6
6
  ## [Unreleased][unreleased]
7
7
 
8
+ ## [v3.1.0] - 2021-11-16
9
+
10
+ - Expose additional type definitions for `getMessage`
11
+
8
12
  ## [v3.0.0] - 2021-11-02
9
13
 
10
14
  - fixes type definition for `getRecipientSubscriptions`
@@ -177,7 +181,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
177
181
 
178
182
  ## v1.0.1 - 2019-07-12
179
183
 
180
- [unreleased]: https://github.com/trycourier/courier-node/compare/v3.0.0...HEAD
184
+ [unreleased]: https://github.com/trycourier/courier-node/compare/v3.1.0...HEAD
185
+ [v3.1.0]: https://github.com/trycourier/courier-node/compare/v3.0.0...v3.1.0
181
186
  [v3.0.0]: https://github.com/trycourier/courier-node/compare/v2.8.0...v3.0.0
182
187
  [v2.8.0]: https://github.com/trycourier/courier-node/compare/v2.7.0...v2.8.0
183
188
  [v2.7.0]: https://github.com/trycourier/courier-node/compare/v2.6.0...v2.7.0
package/lib/types.d.ts CHANGED
@@ -101,25 +101,40 @@ export interface ICourierMessagesGetResponse {
101
101
  }>;
102
102
  }
103
103
  export interface ICourierMessageGetResponse {
104
+ clicked?: number;
105
+ delivered?: number;
104
106
  enqueued?: number;
107
+ error?: string;
105
108
  event?: string;
106
109
  id: string;
110
+ idempotencyKey?: string;
111
+ listId?: string;
112
+ listMessageId?: string;
107
113
  notification?: string;
114
+ opened?: number;
108
115
  providers?: Array<{
109
116
  channel: {
110
- name: string;
117
+ key?: string;
118
+ name?: string;
111
119
  template: string;
112
120
  };
121
+ clicked?: number;
122
+ delivered?: number;
123
+ error?: string;
113
124
  provider: string;
114
- reference: {
115
- "x-message-id": string;
125
+ reference?: {
126
+ [key: string]: string | number;
116
127
  };
117
128
  sent: number;
118
- status: string;
129
+ status: MessageStatus;
119
130
  }>;
131
+ reason?: MessageStatusReason;
132
+ reasonCode?: MessageStatusReasonCode;
133
+ reasonDetails?: string;
120
134
  recipient: string;
135
+ runId?: string;
121
136
  sent?: number;
122
- status: string;
137
+ status: MessageStatus;
123
138
  }
124
139
  export declare type MessageStatus = "CLICKED" | "DELIVERED" | "ENQUEUED" | "FILTERED" | "OPENED" | "SENT" | "SIMULATED" | "UNDELIVERABLE" | "UNMAPPED";
125
140
  export declare type MessageHistoryType = MessageStatus | "DELIVERING" | "FILTERED" | "MAPPED" | "PROFILE_LOADED" | "RENDERED";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@trycourier/courier",
3
- "version": "3.0.0",
3
+ "version": "3.1.0",
4
4
  "description": "A node.js module for communicating with the Courier REST API.",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",