@trycourier/courier 6.4.0 → 6.4.2

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.
Files changed (133) hide show
  1. package/Client.d.ts +14 -48
  2. package/Client.js +20 -49
  3. package/README.md +113 -808
  4. package/api/client/requests/SendMessageRequest.d.ts +12 -47
  5. package/api/resources/audiences/client/Client.d.ts +10 -5
  6. package/api/resources/audiences/client/Client.js +45 -15
  7. package/api/resources/auditEvents/client/Client.d.ts +4 -2
  8. package/api/resources/auditEvents/client/Client.js +17 -5
  9. package/api/resources/authTokens/client/Client.d.ts +2 -1
  10. package/api/resources/authTokens/client/Client.js +8 -2
  11. package/api/resources/automations/client/Client.d.ts +4 -2
  12. package/api/resources/automations/client/Client.js +16 -4
  13. package/api/resources/brands/client/Client.d.ts +10 -5
  14. package/api/resources/brands/client/Client.js +45 -15
  15. package/api/resources/bulk/client/Client.d.ts +10 -5
  16. package/api/resources/bulk/client/Client.js +45 -15
  17. package/api/resources/commons/errors/AlreadyExistsError.d.ts +2 -1
  18. package/api/resources/commons/errors/AlreadyExistsError.js +2 -1
  19. package/api/resources/commons/errors/BadRequestError.d.ts +2 -1
  20. package/api/resources/commons/errors/BadRequestError.js +2 -1
  21. package/api/resources/commons/errors/ConflictError.d.ts +2 -1
  22. package/api/resources/commons/errors/ConflictError.js +2 -1
  23. package/api/resources/commons/errors/MessageNotFoundError.d.ts +2 -1
  24. package/api/resources/commons/errors/MessageNotFoundError.js +2 -1
  25. package/api/resources/commons/errors/NotFoundError.d.ts +2 -1
  26. package/api/resources/commons/errors/NotFoundError.js +2 -1
  27. package/api/resources/commons/errors/PaymentRequiredError.d.ts +2 -1
  28. package/api/resources/commons/errors/PaymentRequiredError.js +2 -1
  29. package/api/resources/inbound/client/Client.d.ts +2 -1
  30. package/api/resources/inbound/client/Client.js +10 -4
  31. package/api/resources/lists/client/Client.d.ts +20 -10
  32. package/api/resources/lists/client/Client.js +89 -29
  33. package/api/resources/messages/client/Client.d.ts +12 -6
  34. package/api/resources/messages/client/Client.js +56 -20
  35. package/api/resources/notifications/client/Client.d.ts +12 -6
  36. package/api/resources/notifications/client/Client.js +58 -13
  37. package/api/resources/profiles/client/Client.d.ts +16 -8
  38. package/api/resources/profiles/client/Client.js +75 -24
  39. package/api/resources/templates/client/Client.d.ts +2 -1
  40. package/api/resources/templates/client/Client.js +9 -3
  41. package/api/resources/tenants/client/Client.d.ts +14 -7
  42. package/api/resources/tenants/client/Client.js +61 -19
  43. package/api/resources/translations/client/Client.d.ts +4 -2
  44. package/api/resources/translations/client/Client.js +18 -6
  45. package/api/resources/users/resources/preferences/client/Client.d.ts +6 -3
  46. package/api/resources/users/resources/preferences/client/Client.js +38 -11
  47. package/api/resources/users/resources/tenants/client/Client.d.ts +10 -5
  48. package/api/resources/users/resources/tenants/client/Client.js +45 -12
  49. package/api/resources/users/resources/tokens/client/Client.d.ts +12 -6
  50. package/api/resources/users/resources/tokens/client/Client.js +53 -17
  51. package/core/fetcher/APIResponse.d.ts +10 -0
  52. package/core/fetcher/Fetcher.js +7 -0
  53. package/core/fetcher/Headers.d.ts +2 -0
  54. package/core/fetcher/Headers.js +84 -0
  55. package/core/fetcher/HttpResponsePromise.d.ts +58 -0
  56. package/core/fetcher/HttpResponsePromise.js +103 -0
  57. package/core/fetcher/RawResponse.d.ts +29 -0
  58. package/core/fetcher/RawResponse.js +44 -0
  59. package/core/fetcher/index.d.ts +3 -0
  60. package/core/fetcher/index.js +7 -1
  61. package/core/index.d.ts +1 -1
  62. package/core/index.js +1 -1
  63. package/dist/Client.d.ts +14 -48
  64. package/dist/Client.js +20 -49
  65. package/dist/api/client/requests/SendMessageRequest.d.ts +12 -47
  66. package/dist/api/resources/audiences/client/Client.d.ts +10 -5
  67. package/dist/api/resources/audiences/client/Client.js +45 -15
  68. package/dist/api/resources/auditEvents/client/Client.d.ts +4 -2
  69. package/dist/api/resources/auditEvents/client/Client.js +17 -5
  70. package/dist/api/resources/authTokens/client/Client.d.ts +2 -1
  71. package/dist/api/resources/authTokens/client/Client.js +8 -2
  72. package/dist/api/resources/automations/client/Client.d.ts +4 -2
  73. package/dist/api/resources/automations/client/Client.js +16 -4
  74. package/dist/api/resources/brands/client/Client.d.ts +10 -5
  75. package/dist/api/resources/brands/client/Client.js +45 -15
  76. package/dist/api/resources/bulk/client/Client.d.ts +10 -5
  77. package/dist/api/resources/bulk/client/Client.js +45 -15
  78. package/dist/api/resources/commons/errors/AlreadyExistsError.d.ts +2 -1
  79. package/dist/api/resources/commons/errors/AlreadyExistsError.js +2 -1
  80. package/dist/api/resources/commons/errors/BadRequestError.d.ts +2 -1
  81. package/dist/api/resources/commons/errors/BadRequestError.js +2 -1
  82. package/dist/api/resources/commons/errors/ConflictError.d.ts +2 -1
  83. package/dist/api/resources/commons/errors/ConflictError.js +2 -1
  84. package/dist/api/resources/commons/errors/MessageNotFoundError.d.ts +2 -1
  85. package/dist/api/resources/commons/errors/MessageNotFoundError.js +2 -1
  86. package/dist/api/resources/commons/errors/NotFoundError.d.ts +2 -1
  87. package/dist/api/resources/commons/errors/NotFoundError.js +2 -1
  88. package/dist/api/resources/commons/errors/PaymentRequiredError.d.ts +2 -1
  89. package/dist/api/resources/commons/errors/PaymentRequiredError.js +2 -1
  90. package/dist/api/resources/inbound/client/Client.d.ts +2 -1
  91. package/dist/api/resources/inbound/client/Client.js +10 -4
  92. package/dist/api/resources/lists/client/Client.d.ts +20 -10
  93. package/dist/api/resources/lists/client/Client.js +89 -29
  94. package/dist/api/resources/messages/client/Client.d.ts +12 -6
  95. package/dist/api/resources/messages/client/Client.js +56 -20
  96. package/dist/api/resources/notifications/client/Client.d.ts +12 -6
  97. package/dist/api/resources/notifications/client/Client.js +58 -13
  98. package/dist/api/resources/profiles/client/Client.d.ts +16 -8
  99. package/dist/api/resources/profiles/client/Client.js +75 -24
  100. package/dist/api/resources/templates/client/Client.d.ts +2 -1
  101. package/dist/api/resources/templates/client/Client.js +9 -3
  102. package/dist/api/resources/tenants/client/Client.d.ts +14 -7
  103. package/dist/api/resources/tenants/client/Client.js +61 -19
  104. package/dist/api/resources/translations/client/Client.d.ts +4 -2
  105. package/dist/api/resources/translations/client/Client.js +18 -6
  106. package/dist/api/resources/users/resources/preferences/client/Client.d.ts +6 -3
  107. package/dist/api/resources/users/resources/preferences/client/Client.js +38 -11
  108. package/dist/api/resources/users/resources/tenants/client/Client.d.ts +10 -5
  109. package/dist/api/resources/users/resources/tenants/client/Client.js +45 -12
  110. package/dist/api/resources/users/resources/tokens/client/Client.d.ts +12 -6
  111. package/dist/api/resources/users/resources/tokens/client/Client.js +53 -17
  112. package/dist/core/fetcher/APIResponse.d.ts +10 -0
  113. package/dist/core/fetcher/Fetcher.js +7 -0
  114. package/dist/core/fetcher/Headers.d.ts +2 -0
  115. package/dist/core/fetcher/Headers.js +84 -0
  116. package/dist/core/fetcher/HttpResponsePromise.d.ts +58 -0
  117. package/dist/core/fetcher/HttpResponsePromise.js +103 -0
  118. package/dist/core/fetcher/RawResponse.d.ts +29 -0
  119. package/dist/core/fetcher/RawResponse.js +44 -0
  120. package/dist/core/fetcher/index.d.ts +3 -0
  121. package/dist/core/fetcher/index.js +7 -1
  122. package/dist/core/index.d.ts +1 -1
  123. package/dist/core/index.js +1 -1
  124. package/dist/errors/CourierError.d.ts +4 -1
  125. package/dist/errors/CourierError.js +4 -7
  126. package/dist/version.d.ts +1 -1
  127. package/dist/version.js +1 -1
  128. package/errors/CourierError.d.ts +4 -1
  129. package/errors/CourierError.js +4 -7
  130. package/package.json +3 -2
  131. package/reference.md +12 -50
  132. package/version.d.ts +1 -1
  133. package/version.js +1 -1
package/Client.d.ts CHANGED
@@ -84,58 +84,24 @@ export declare class CourierClient {
84
84
  * @example
85
85
  * await client.send({
86
86
  * message: {
87
- * data: undefined,
88
- * brand_id: undefined,
89
- * channels: undefined,
90
- * context: undefined,
91
- * metadata: undefined,
92
- * preferences: undefined,
93
- * providers: undefined,
94
- * routing: undefined,
95
- * timeout: undefined,
96
- * delay: undefined,
97
- * expiry: undefined,
98
- * to: undefined,
87
+ * to: {
88
+ * email: "email@example.com"
89
+ * },
99
90
  * content: {
100
- * version: "version",
101
- * brand: undefined,
102
- * elements: [{
103
- * type: "text",
104
- * channels: undefined,
105
- * ref: undefined,
106
- * if: undefined,
107
- * loop: undefined,
108
- * content: "content",
109
- * align: "left",
110
- * text_style: undefined,
111
- * color: undefined,
112
- * bold: undefined,
113
- * italic: undefined,
114
- * strikethrough: undefined,
115
- * underline: undefined,
116
- * locales: undefined,
117
- * format: undefined
118
- * }, {
119
- * type: "text",
120
- * channels: undefined,
121
- * ref: undefined,
122
- * if: undefined,
123
- * loop: undefined,
124
- * content: "content",
125
- * align: "left",
126
- * text_style: undefined,
127
- * color: undefined,
128
- * bold: undefined,
129
- * italic: undefined,
130
- * strikethrough: undefined,
131
- * underline: undefined,
132
- * locales: undefined,
133
- * format: undefined
134
- * }]
91
+ * title: "Welcome!",
92
+ * body: "Thanks for signing up, {{name}}"
93
+ * },
94
+ * data: {
95
+ * "name": "Peter Parker"
96
+ * },
97
+ * routing: {
98
+ * method: "single",
99
+ * channels: ["email"]
135
100
  * }
136
101
  * }
137
102
  * })
138
103
  */
139
- send(request: Courier.SendMessageRequest, requestOptions?: CourierClient.IdempotentRequestOptions): Promise<Courier.SendMessageResponse>;
104
+ send(request: Courier.SendMessageRequest, requestOptions?: CourierClient.IdempotentRequestOptions): core.HttpResponsePromise<Courier.SendMessageResponse>;
105
+ private __send;
140
106
  protected _getAuthorizationHeader(): Promise<string>;
141
107
  }
package/Client.js CHANGED
@@ -141,65 +141,33 @@ class CourierClient {
141
141
  * @example
142
142
  * await client.send({
143
143
  * message: {
144
- * data: undefined,
145
- * brand_id: undefined,
146
- * channels: undefined,
147
- * context: undefined,
148
- * metadata: undefined,
149
- * preferences: undefined,
150
- * providers: undefined,
151
- * routing: undefined,
152
- * timeout: undefined,
153
- * delay: undefined,
154
- * expiry: undefined,
155
- * to: undefined,
144
+ * to: {
145
+ * email: "email@example.com"
146
+ * },
156
147
  * content: {
157
- * version: "version",
158
- * brand: undefined,
159
- * elements: [{
160
- * type: "text",
161
- * channels: undefined,
162
- * ref: undefined,
163
- * if: undefined,
164
- * loop: undefined,
165
- * content: "content",
166
- * align: "left",
167
- * text_style: undefined,
168
- * color: undefined,
169
- * bold: undefined,
170
- * italic: undefined,
171
- * strikethrough: undefined,
172
- * underline: undefined,
173
- * locales: undefined,
174
- * format: undefined
175
- * }, {
176
- * type: "text",
177
- * channels: undefined,
178
- * ref: undefined,
179
- * if: undefined,
180
- * loop: undefined,
181
- * content: "content",
182
- * align: "left",
183
- * text_style: undefined,
184
- * color: undefined,
185
- * bold: undefined,
186
- * italic: undefined,
187
- * strikethrough: undefined,
188
- * underline: undefined,
189
- * locales: undefined,
190
- * format: undefined
191
- * }]
148
+ * title: "Welcome!",
149
+ * body: "Thanks for signing up, {{name}}"
150
+ * },
151
+ * data: {
152
+ * "name": "Peter Parker"
153
+ * },
154
+ * routing: {
155
+ * method: "single",
156
+ * channels: ["email"]
192
157
  * }
193
158
  * }
194
159
  * })
195
160
  */
196
161
  send(request, requestOptions) {
162
+ return core.HttpResponsePromise.fromPromise(this.__send(request, requestOptions));
163
+ }
164
+ __send(request, requestOptions) {
197
165
  return __awaiter(this, void 0, void 0, function* () {
198
166
  var _a, _b, _c;
199
167
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
200
168
  url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CourierEnvironment.Production, "/send"),
201
169
  method: "POST",
202
- headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@trycourier/courier", "X-Fern-SDK-Version": "6.4.0", "User-Agent": "@trycourier/courier/6.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined, "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry : undefined }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
170
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@trycourier/courier", "X-Fern-SDK-Version": "6.4.2", "User-Agent": "@trycourier/courier/6.4.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined, "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry : undefined }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
203
171
  contentType: "application/json",
204
172
  requestType: "json",
205
173
  body: request,
@@ -208,12 +176,13 @@ class CourierClient {
208
176
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
209
177
  });
210
178
  if (_response.ok) {
211
- return _response.body;
179
+ return { data: _response.body, rawResponse: _response.rawResponse };
212
180
  }
213
181
  if (_response.error.reason === "status-code") {
214
182
  throw new errors.CourierError({
215
183
  statusCode: _response.error.statusCode,
216
184
  body: _response.error.body,
185
+ rawResponse: _response.rawResponse,
217
186
  });
218
187
  }
219
188
  switch (_response.error.reason) {
@@ -221,12 +190,14 @@ class CourierClient {
221
190
  throw new errors.CourierError({
222
191
  statusCode: _response.error.statusCode,
223
192
  body: _response.error.rawBody,
193
+ rawResponse: _response.rawResponse,
224
194
  });
225
195
  case "timeout":
226
196
  throw new errors.CourierTimeoutError("Timeout exceeded when calling POST /send.");
227
197
  case "unknown":
228
198
  throw new errors.CourierError({
229
199
  message: _response.error.errorMessage,
200
+ rawResponse: _response.rawResponse,
230
201
  });
231
202
  }
232
203
  });