@trycourier/courier 6.2.2 → 6.2.3

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 (79) hide show
  1. package/Client.d.ts +71 -11
  2. package/Client.js +72 -12
  3. package/api/client/requests/SendMessageRequest.d.ts +71 -11
  4. package/api/resources/audiences/client/Client.js +5 -5
  5. package/api/resources/auditEvents/client/Client.js +2 -2
  6. package/api/resources/authTokens/client/Client.js +1 -1
  7. package/api/resources/automations/client/Client.js +2 -2
  8. package/api/resources/brands/client/Client.d.ts +38 -4
  9. package/api/resources/brands/client/Client.js +43 -9
  10. package/api/resources/brands/client/requests/BrandUpdateParameters.d.ts +13 -2
  11. package/api/resources/bulk/client/Client.d.ts +91 -3
  12. package/api/resources/bulk/client/Client.js +96 -8
  13. package/api/resources/bulk/client/requests/BulkCreateJobParams.d.ts +70 -1
  14. package/api/resources/inbound/client/Client.js +1 -1
  15. package/api/resources/lists/client/Client.d.ts +8 -96
  16. package/api/resources/lists/client/Client.js +18 -106
  17. package/api/resources/lists/client/requests/AddSubscribersToList.d.ts +2 -24
  18. package/api/resources/lists/client/requests/SubscribeUserToListRequest.d.ts +2 -24
  19. package/api/resources/lists/client/requests/SubscribeUsersToListRequest.d.ts +2 -24
  20. package/api/resources/messages/client/Client.js +6 -6
  21. package/api/resources/notifications/client/Client.js +6 -6
  22. package/api/resources/profiles/client/Client.d.ts +7 -1
  23. package/api/resources/profiles/client/Client.js +14 -8
  24. package/api/resources/templates/client/Client.js +1 -1
  25. package/api/resources/tenants/client/Client.d.ts +6 -1
  26. package/api/resources/tenants/client/Client.js +13 -8
  27. package/api/resources/tenants/client/requests/TenantCreateOrReplaceParams.d.ts +6 -1
  28. package/api/resources/translations/client/Client.js +2 -2
  29. package/api/resources/users/resources/preferences/client/Client.d.ts +10 -4
  30. package/api/resources/users/resources/preferences/client/Client.js +43 -8
  31. package/api/resources/users/resources/preferences/client/requests/UserPreferencesParams.d.ts +15 -0
  32. package/api/resources/users/resources/preferences/client/requests/UserPreferencesParams.js +5 -0
  33. package/api/resources/users/resources/preferences/client/requests/UserPreferencesTopicParams.d.ts +15 -0
  34. package/api/resources/users/resources/preferences/client/requests/UserPreferencesTopicParams.js +5 -0
  35. package/api/resources/users/resources/preferences/client/requests/UserPreferencesUpdateParams.d.ts +4 -0
  36. package/api/resources/users/resources/preferences/client/requests/index.d.ts +2 -0
  37. package/api/resources/users/resources/tenants/client/Client.js +5 -5
  38. package/api/resources/users/resources/tokens/client/Client.d.ts +5 -1
  39. package/api/resources/users/resources/tokens/client/Client.js +11 -7
  40. package/dist/Client.d.ts +71 -11
  41. package/dist/Client.js +72 -12
  42. package/dist/api/client/requests/SendMessageRequest.d.ts +71 -11
  43. package/dist/api/resources/audiences/client/Client.js +5 -5
  44. package/dist/api/resources/auditEvents/client/Client.js +2 -2
  45. package/dist/api/resources/authTokens/client/Client.js +1 -1
  46. package/dist/api/resources/automations/client/Client.js +2 -2
  47. package/dist/api/resources/brands/client/Client.d.ts +38 -4
  48. package/dist/api/resources/brands/client/Client.js +43 -9
  49. package/dist/api/resources/brands/client/requests/BrandUpdateParameters.d.ts +13 -2
  50. package/dist/api/resources/bulk/client/Client.d.ts +91 -3
  51. package/dist/api/resources/bulk/client/Client.js +96 -8
  52. package/dist/api/resources/bulk/client/requests/BulkCreateJobParams.d.ts +70 -1
  53. package/dist/api/resources/inbound/client/Client.js +1 -1
  54. package/dist/api/resources/lists/client/Client.d.ts +8 -96
  55. package/dist/api/resources/lists/client/Client.js +18 -106
  56. package/dist/api/resources/lists/client/requests/AddSubscribersToList.d.ts +2 -24
  57. package/dist/api/resources/lists/client/requests/SubscribeUserToListRequest.d.ts +2 -24
  58. package/dist/api/resources/lists/client/requests/SubscribeUsersToListRequest.d.ts +2 -24
  59. package/dist/api/resources/messages/client/Client.js +6 -6
  60. package/dist/api/resources/notifications/client/Client.js +6 -6
  61. package/dist/api/resources/profiles/client/Client.d.ts +7 -1
  62. package/dist/api/resources/profiles/client/Client.js +14 -8
  63. package/dist/api/resources/templates/client/Client.js +1 -1
  64. package/dist/api/resources/tenants/client/Client.d.ts +6 -1
  65. package/dist/api/resources/tenants/client/Client.js +13 -8
  66. package/dist/api/resources/tenants/client/requests/TenantCreateOrReplaceParams.d.ts +6 -1
  67. package/dist/api/resources/translations/client/Client.js +2 -2
  68. package/dist/api/resources/users/resources/preferences/client/Client.d.ts +10 -4
  69. package/dist/api/resources/users/resources/preferences/client/Client.js +43 -8
  70. package/dist/api/resources/users/resources/preferences/client/requests/UserPreferencesParams.d.ts +15 -0
  71. package/dist/api/resources/users/resources/preferences/client/requests/UserPreferencesParams.js +5 -0
  72. package/dist/api/resources/users/resources/preferences/client/requests/UserPreferencesTopicParams.d.ts +15 -0
  73. package/dist/api/resources/users/resources/preferences/client/requests/UserPreferencesTopicParams.js +5 -0
  74. package/dist/api/resources/users/resources/preferences/client/requests/UserPreferencesUpdateParams.d.ts +4 -0
  75. package/dist/api/resources/users/resources/preferences/client/requests/index.d.ts +2 -0
  76. package/dist/api/resources/users/resources/tenants/client/Client.js +5 -5
  77. package/dist/api/resources/users/resources/tokens/client/Client.d.ts +5 -1
  78. package/dist/api/resources/users/resources/tokens/client/Client.js +11 -7
  79. package/package.json +1 -1
@@ -67,7 +67,7 @@ class Audiences {
67
67
  Authorization: yield this._getAuthorizationHeader(),
68
68
  "X-Fern-Language": "JavaScript",
69
69
  "X-Fern-SDK-Name": "@trycourier/courier",
70
- "X-Fern-SDK-Version": "v6.2.2",
70
+ "X-Fern-SDK-Version": "v6.2.3",
71
71
  "X-Fern-Runtime": core.RUNTIME.type,
72
72
  "X-Fern-Runtime-Version": core.RUNTIME.version,
73
73
  },
@@ -127,7 +127,7 @@ class Audiences {
127
127
  Authorization: yield this._getAuthorizationHeader(),
128
128
  "X-Fern-Language": "JavaScript",
129
129
  "X-Fern-SDK-Name": "@trycourier/courier",
130
- "X-Fern-SDK-Version": "v6.2.2",
130
+ "X-Fern-SDK-Version": "v6.2.3",
131
131
  "X-Fern-Runtime": core.RUNTIME.type,
132
132
  "X-Fern-Runtime-Version": core.RUNTIME.version,
133
133
  },
@@ -179,7 +179,7 @@ class Audiences {
179
179
  Authorization: yield this._getAuthorizationHeader(),
180
180
  "X-Fern-Language": "JavaScript",
181
181
  "X-Fern-SDK-Name": "@trycourier/courier",
182
- "X-Fern-SDK-Version": "v6.2.2",
182
+ "X-Fern-SDK-Version": "v6.2.3",
183
183
  "X-Fern-Runtime": core.RUNTIME.type,
184
184
  "X-Fern-Runtime-Version": core.RUNTIME.version,
185
185
  },
@@ -240,7 +240,7 @@ class Audiences {
240
240
  Authorization: yield this._getAuthorizationHeader(),
241
241
  "X-Fern-Language": "JavaScript",
242
242
  "X-Fern-SDK-Name": "@trycourier/courier",
243
- "X-Fern-SDK-Version": "v6.2.2",
243
+ "X-Fern-SDK-Version": "v6.2.3",
244
244
  "X-Fern-Runtime": core.RUNTIME.type,
245
245
  "X-Fern-Runtime-Version": core.RUNTIME.version,
246
246
  },
@@ -306,7 +306,7 @@ class Audiences {
306
306
  Authorization: yield this._getAuthorizationHeader(),
307
307
  "X-Fern-Language": "JavaScript",
308
308
  "X-Fern-SDK-Name": "@trycourier/courier",
309
- "X-Fern-SDK-Version": "v6.2.2",
309
+ "X-Fern-SDK-Version": "v6.2.3",
310
310
  "X-Fern-Runtime": core.RUNTIME.type,
311
311
  "X-Fern-Runtime-Version": core.RUNTIME.version,
312
312
  },
@@ -73,7 +73,7 @@ class AuditEvents {
73
73
  Authorization: yield this._getAuthorizationHeader(),
74
74
  "X-Fern-Language": "JavaScript",
75
75
  "X-Fern-SDK-Name": "@trycourier/courier",
76
- "X-Fern-SDK-Version": "v6.2.2",
76
+ "X-Fern-SDK-Version": "v6.2.3",
77
77
  "X-Fern-Runtime": core.RUNTIME.type,
78
78
  "X-Fern-Runtime-Version": core.RUNTIME.version,
79
79
  },
@@ -125,7 +125,7 @@ class AuditEvents {
125
125
  Authorization: yield this._getAuthorizationHeader(),
126
126
  "X-Fern-Language": "JavaScript",
127
127
  "X-Fern-SDK-Name": "@trycourier/courier",
128
- "X-Fern-SDK-Version": "v6.2.2",
128
+ "X-Fern-SDK-Version": "v6.2.3",
129
129
  "X-Fern-Runtime": core.RUNTIME.type,
130
130
  "X-Fern-Runtime-Version": core.RUNTIME.version,
131
131
  },
@@ -69,7 +69,7 @@ class AuthTokens {
69
69
  Authorization: yield this._getAuthorizationHeader(),
70
70
  "X-Fern-Language": "JavaScript",
71
71
  "X-Fern-SDK-Name": "@trycourier/courier",
72
- "X-Fern-SDK-Version": "v6.2.2",
72
+ "X-Fern-SDK-Version": "v6.2.3",
73
73
  "X-Fern-Runtime": core.RUNTIME.type,
74
74
  "X-Fern-Runtime-Version": core.RUNTIME.version,
75
75
  "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
@@ -79,7 +79,7 @@ class Automations {
79
79
  Authorization: yield this._getAuthorizationHeader(),
80
80
  "X-Fern-Language": "JavaScript",
81
81
  "X-Fern-SDK-Name": "@trycourier/courier",
82
- "X-Fern-SDK-Version": "v6.2.2",
82
+ "X-Fern-SDK-Version": "v6.2.3",
83
83
  "X-Fern-Runtime": core.RUNTIME.type,
84
84
  "X-Fern-Runtime-Version": core.RUNTIME.version,
85
85
  "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
@@ -151,7 +151,7 @@ class Automations {
151
151
  Authorization: yield this._getAuthorizationHeader(),
152
152
  "X-Fern-Language": "JavaScript",
153
153
  "X-Fern-SDK-Name": "@trycourier/courier",
154
- "X-Fern-SDK-Version": "v6.2.2",
154
+ "X-Fern-SDK-Version": "v6.2.3",
155
155
  "X-Fern-Runtime": core.RUNTIME.type,
156
156
  "X-Fern-Runtime-Version": core.RUNTIME.version,
157
157
  "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
@@ -34,8 +34,31 @@ export declare class Brands {
34
34
  * await courier.brands.create({
35
35
  * id: "string",
36
36
  * name: "string",
37
- * settings: {},
38
- * snippets: {}
37
+ * settings: {
38
+ * colors: {
39
+ * primary: "string",
40
+ * secondary: "string",
41
+ * tertiary: "string"
42
+ * },
43
+ * inapp: {
44
+ * "key": "value"
45
+ * },
46
+ * email: {
47
+ * footer: {
48
+ * "key": "value"
49
+ * },
50
+ * header: {
51
+ * "key": "value"
52
+ * }
53
+ * }
54
+ * },
55
+ * snippets: {
56
+ * items: [{
57
+ * format: "handlebars",
58
+ * name: "string",
59
+ * value: "string"
60
+ * }]
61
+ * }
39
62
  * })
40
63
  */
41
64
  create(request: Courier.BrandParameters, requestOptions?: Brands.IdempotentRequestOptions): Promise<Courier.Brand>;
@@ -84,11 +107,22 @@ export declare class Brands {
84
107
  * await courier.brands.replace("string", {
85
108
  * name: "string",
86
109
  * settings: {
87
- * colors: {},
110
+ * colors: {
111
+ * primary: "string",
112
+ * secondary: "string",
113
+ * tertiary: "string"
114
+ * },
88
115
  * inapp: {
89
116
  * "key": "value"
90
117
  * },
91
- * email: {}
118
+ * email: {
119
+ * footer: {
120
+ * "key": "value"
121
+ * },
122
+ * header: {
123
+ * "key": "value"
124
+ * }
125
+ * }
92
126
  * },
93
127
  * snippets: {
94
128
  * items: [{
@@ -60,8 +60,31 @@ class Brands {
60
60
  * await courier.brands.create({
61
61
  * id: "string",
62
62
  * name: "string",
63
- * settings: {},
64
- * snippets: {}
63
+ * settings: {
64
+ * colors: {
65
+ * primary: "string",
66
+ * secondary: "string",
67
+ * tertiary: "string"
68
+ * },
69
+ * inapp: {
70
+ * "key": "value"
71
+ * },
72
+ * email: {
73
+ * footer: {
74
+ * "key": "value"
75
+ * },
76
+ * header: {
77
+ * "key": "value"
78
+ * }
79
+ * }
80
+ * },
81
+ * snippets: {
82
+ * items: [{
83
+ * format: "handlebars",
84
+ * name: "string",
85
+ * value: "string"
86
+ * }]
87
+ * }
65
88
  * })
66
89
  */
67
90
  create(request, requestOptions) {
@@ -74,7 +97,7 @@ class Brands {
74
97
  Authorization: yield this._getAuthorizationHeader(),
75
98
  "X-Fern-Language": "JavaScript",
76
99
  "X-Fern-SDK-Name": "@trycourier/courier",
77
- "X-Fern-SDK-Version": "v6.2.2",
100
+ "X-Fern-SDK-Version": "v6.2.3",
78
101
  "X-Fern-Runtime": core.RUNTIME.type,
79
102
  "X-Fern-Runtime-Version": core.RUNTIME.version,
80
103
  "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
@@ -137,7 +160,7 @@ class Brands {
137
160
  Authorization: yield this._getAuthorizationHeader(),
138
161
  "X-Fern-Language": "JavaScript",
139
162
  "X-Fern-SDK-Name": "@trycourier/courier",
140
- "X-Fern-SDK-Version": "v6.2.2",
163
+ "X-Fern-SDK-Version": "v6.2.3",
141
164
  "X-Fern-Runtime": core.RUNTIME.type,
142
165
  "X-Fern-Runtime-Version": core.RUNTIME.version,
143
166
  },
@@ -195,7 +218,7 @@ class Brands {
195
218
  Authorization: yield this._getAuthorizationHeader(),
196
219
  "X-Fern-Language": "JavaScript",
197
220
  "X-Fern-SDK-Name": "@trycourier/courier",
198
- "X-Fern-SDK-Version": "v6.2.2",
221
+ "X-Fern-SDK-Version": "v6.2.3",
199
222
  "X-Fern-Runtime": core.RUNTIME.type,
200
223
  "X-Fern-Runtime-Version": core.RUNTIME.version,
201
224
  },
@@ -249,7 +272,7 @@ class Brands {
249
272
  Authorization: yield this._getAuthorizationHeader(),
250
273
  "X-Fern-Language": "JavaScript",
251
274
  "X-Fern-SDK-Name": "@trycourier/courier",
252
- "X-Fern-SDK-Version": "v6.2.2",
275
+ "X-Fern-SDK-Version": "v6.2.3",
253
276
  "X-Fern-Runtime": core.RUNTIME.type,
254
277
  "X-Fern-Runtime-Version": core.RUNTIME.version,
255
278
  },
@@ -297,11 +320,22 @@ class Brands {
297
320
  * await courier.brands.replace("string", {
298
321
  * name: "string",
299
322
  * settings: {
300
- * colors: {},
323
+ * colors: {
324
+ * primary: "string",
325
+ * secondary: "string",
326
+ * tertiary: "string"
327
+ * },
301
328
  * inapp: {
302
329
  * "key": "value"
303
330
  * },
304
- * email: {}
331
+ * email: {
332
+ * footer: {
333
+ * "key": "value"
334
+ * },
335
+ * header: {
336
+ * "key": "value"
337
+ * }
338
+ * }
305
339
  * },
306
340
  * snippets: {
307
341
  * items: [{
@@ -322,7 +356,7 @@ class Brands {
322
356
  Authorization: yield this._getAuthorizationHeader(),
323
357
  "X-Fern-Language": "JavaScript",
324
358
  "X-Fern-SDK-Name": "@trycourier/courier",
325
- "X-Fern-SDK-Version": "v6.2.2",
359
+ "X-Fern-SDK-Version": "v6.2.3",
326
360
  "X-Fern-Runtime": core.RUNTIME.type,
327
361
  "X-Fern-Runtime-Version": core.RUNTIME.version,
328
362
  },
@@ -7,11 +7,22 @@ import * as Courier from "../../../../index";
7
7
  * {
8
8
  * name: "string",
9
9
  * settings: {
10
- * colors: {},
10
+ * colors: {
11
+ * primary: "string",
12
+ * secondary: "string",
13
+ * tertiary: "string"
14
+ * },
11
15
  * inapp: {
12
16
  * "key": "value"
13
17
  * },
14
- * email: {}
18
+ * email: {
19
+ * footer: {
20
+ * "key": "value"
21
+ * },
22
+ * header: {
23
+ * "key": "value"
24
+ * }
25
+ * }
15
26
  * },
16
27
  * snippets: {
17
28
  * items: [{
@@ -31,7 +31,76 @@ export declare class Bulk {
31
31
  * @example
32
32
  * await courier.bulk.createJob({
33
33
  * message: {
34
- * message: {},
34
+ * message: {
35
+ * template: "string",
36
+ * data: {
37
+ * "string": {
38
+ * "key": "value"
39
+ * }
40
+ * },
41
+ * brand_id: "string",
42
+ * channels: {
43
+ * "string": {
44
+ * brand_id: undefined,
45
+ * providers: undefined,
46
+ * routing_method: undefined,
47
+ * if: undefined,
48
+ * timeouts: undefined,
49
+ * override: undefined,
50
+ * metadata: undefined
51
+ * }
52
+ * },
53
+ * context: {
54
+ * tenant_id: "string"
55
+ * },
56
+ * metadata: {
57
+ * event: "string",
58
+ * tags: [],
59
+ * utm: {
60
+ * source: undefined,
61
+ * medium: undefined,
62
+ * campaign: undefined,
63
+ * term: undefined,
64
+ * content: undefined
65
+ * },
66
+ * trace_id: "string"
67
+ * },
68
+ * preferences: {
69
+ * subscription_topic_id: "string"
70
+ * },
71
+ * providers: {
72
+ * "string": {
73
+ * override: undefined,
74
+ * if: undefined,
75
+ * timeouts: undefined,
76
+ * metadata: undefined
77
+ * }
78
+ * },
79
+ * routing: {
80
+ * method: Courier.RoutingMethod.All,
81
+ * channels: [{
82
+ * channel: "string",
83
+ * config: undefined,
84
+ * method: undefined,
85
+ * providers: undefined,
86
+ * if: undefined
87
+ * }]
88
+ * },
89
+ * timeout: {
90
+ * provider: {},
91
+ * channel: {},
92
+ * message: 1,
93
+ * escalation: 1,
94
+ * criteria: Courier.Criteria.NoEscalation
95
+ * },
96
+ * delay: {
97
+ * duration: 1
98
+ * },
99
+ * expiry: {
100
+ * expires_at: "string",
101
+ * expires_in: "string"
102
+ * }
103
+ * },
35
104
  * brand: "string",
36
105
  * data: {
37
106
  * "string": {
@@ -61,7 +130,10 @@ export declare class Bulk {
61
130
  * @example
62
131
  * await courier.bulk.ingestUsers("string", {
63
132
  * users: [{
64
- * preferences: {},
133
+ * preferences: {
134
+ * categories: {},
135
+ * notifications: {}
136
+ * },
65
137
  * profile: {
66
138
  * "key": "value"
67
139
  * },
@@ -69,7 +141,23 @@ export declare class Bulk {
69
141
  * data: {
70
142
  * "key": "value"
71
143
  * },
72
- * to: {}
144
+ * to: {
145
+ * account_id: "string",
146
+ * context: {
147
+ * tenant_id: "string"
148
+ * },
149
+ * data: {},
150
+ * email: "string",
151
+ * locale: "string",
152
+ * user_id: "string",
153
+ * phone_number: "string",
154
+ * preferences: {
155
+ * categories: undefined,
156
+ * notifications: {},
157
+ * templateId: undefined
158
+ * },
159
+ * tenant_id: "string"
160
+ * }
73
161
  * }]
74
162
  * })
75
163
  */
@@ -57,7 +57,76 @@ class Bulk {
57
57
  * @example
58
58
  * await courier.bulk.createJob({
59
59
  * message: {
60
- * message: {},
60
+ * message: {
61
+ * template: "string",
62
+ * data: {
63
+ * "string": {
64
+ * "key": "value"
65
+ * }
66
+ * },
67
+ * brand_id: "string",
68
+ * channels: {
69
+ * "string": {
70
+ * brand_id: undefined,
71
+ * providers: undefined,
72
+ * routing_method: undefined,
73
+ * if: undefined,
74
+ * timeouts: undefined,
75
+ * override: undefined,
76
+ * metadata: undefined
77
+ * }
78
+ * },
79
+ * context: {
80
+ * tenant_id: "string"
81
+ * },
82
+ * metadata: {
83
+ * event: "string",
84
+ * tags: [],
85
+ * utm: {
86
+ * source: undefined,
87
+ * medium: undefined,
88
+ * campaign: undefined,
89
+ * term: undefined,
90
+ * content: undefined
91
+ * },
92
+ * trace_id: "string"
93
+ * },
94
+ * preferences: {
95
+ * subscription_topic_id: "string"
96
+ * },
97
+ * providers: {
98
+ * "string": {
99
+ * override: undefined,
100
+ * if: undefined,
101
+ * timeouts: undefined,
102
+ * metadata: undefined
103
+ * }
104
+ * },
105
+ * routing: {
106
+ * method: Courier.RoutingMethod.All,
107
+ * channels: [{
108
+ * channel: "string",
109
+ * config: undefined,
110
+ * method: undefined,
111
+ * providers: undefined,
112
+ * if: undefined
113
+ * }]
114
+ * },
115
+ * timeout: {
116
+ * provider: {},
117
+ * channel: {},
118
+ * message: 1,
119
+ * escalation: 1,
120
+ * criteria: Courier.Criteria.NoEscalation
121
+ * },
122
+ * delay: {
123
+ * duration: 1
124
+ * },
125
+ * expiry: {
126
+ * expires_at: "string",
127
+ * expires_in: "string"
128
+ * }
129
+ * },
61
130
  * brand: "string",
62
131
  * data: {
63
132
  * "string": {
@@ -86,7 +155,7 @@ class Bulk {
86
155
  Authorization: yield this._getAuthorizationHeader(),
87
156
  "X-Fern-Language": "JavaScript",
88
157
  "X-Fern-SDK-Name": "@trycourier/courier",
89
- "X-Fern-SDK-Version": "v6.2.2",
158
+ "X-Fern-SDK-Version": "v6.2.3",
90
159
  "X-Fern-Runtime": core.RUNTIME.type,
91
160
  "X-Fern-Runtime-Version": core.RUNTIME.version,
92
161
  "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
@@ -136,7 +205,10 @@ class Bulk {
136
205
  * @example
137
206
  * await courier.bulk.ingestUsers("string", {
138
207
  * users: [{
139
- * preferences: {},
208
+ * preferences: {
209
+ * categories: {},
210
+ * notifications: {}
211
+ * },
140
212
  * profile: {
141
213
  * "key": "value"
142
214
  * },
@@ -144,7 +216,23 @@ class Bulk {
144
216
  * data: {
145
217
  * "key": "value"
146
218
  * },
147
- * to: {}
219
+ * to: {
220
+ * account_id: "string",
221
+ * context: {
222
+ * tenant_id: "string"
223
+ * },
224
+ * data: {},
225
+ * email: "string",
226
+ * locale: "string",
227
+ * user_id: "string",
228
+ * phone_number: "string",
229
+ * preferences: {
230
+ * categories: undefined,
231
+ * notifications: {},
232
+ * templateId: undefined
233
+ * },
234
+ * tenant_id: "string"
235
+ * }
148
236
  * }]
149
237
  * })
150
238
  */
@@ -158,7 +246,7 @@ class Bulk {
158
246
  Authorization: yield this._getAuthorizationHeader(),
159
247
  "X-Fern-Language": "JavaScript",
160
248
  "X-Fern-SDK-Name": "@trycourier/courier",
161
- "X-Fern-SDK-Version": "v6.2.2",
249
+ "X-Fern-SDK-Version": "v6.2.3",
162
250
  "X-Fern-Runtime": core.RUNTIME.type,
163
251
  "X-Fern-Runtime-Version": core.RUNTIME.version,
164
252
  "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
@@ -214,7 +302,7 @@ class Bulk {
214
302
  Authorization: yield this._getAuthorizationHeader(),
215
303
  "X-Fern-Language": "JavaScript",
216
304
  "X-Fern-SDK-Name": "@trycourier/courier",
217
- "X-Fern-SDK-Version": "v6.2.2",
305
+ "X-Fern-SDK-Version": "v6.2.3",
218
306
  "X-Fern-Runtime": core.RUNTIME.type,
219
307
  "X-Fern-Runtime-Version": core.RUNTIME.version,
220
308
  "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
@@ -274,7 +362,7 @@ class Bulk {
274
362
  Authorization: yield this._getAuthorizationHeader(),
275
363
  "X-Fern-Language": "JavaScript",
276
364
  "X-Fern-SDK-Name": "@trycourier/courier",
277
- "X-Fern-SDK-Version": "v6.2.2",
365
+ "X-Fern-SDK-Version": "v6.2.3",
278
366
  "X-Fern-Runtime": core.RUNTIME.type,
279
367
  "X-Fern-Runtime-Version": core.RUNTIME.version,
280
368
  },
@@ -332,7 +420,7 @@ class Bulk {
332
420
  Authorization: yield this._getAuthorizationHeader(),
333
421
  "X-Fern-Language": "JavaScript",
334
422
  "X-Fern-SDK-Name": "@trycourier/courier",
335
- "X-Fern-SDK-Version": "v6.2.2",
423
+ "X-Fern-SDK-Version": "v6.2.3",
336
424
  "X-Fern-Runtime": core.RUNTIME.type,
337
425
  "X-Fern-Runtime-Version": core.RUNTIME.version,
338
426
  },
@@ -6,7 +6,76 @@ import * as Courier from "../../../../index";
6
6
  * @example
7
7
  * {
8
8
  * message: {
9
- * message: {},
9
+ * message: {
10
+ * template: "string",
11
+ * data: {
12
+ * "string": {
13
+ * "key": "value"
14
+ * }
15
+ * },
16
+ * brand_id: "string",
17
+ * channels: {
18
+ * "string": {
19
+ * brand_id: undefined,
20
+ * providers: undefined,
21
+ * routing_method: undefined,
22
+ * if: undefined,
23
+ * timeouts: undefined,
24
+ * override: undefined,
25
+ * metadata: undefined
26
+ * }
27
+ * },
28
+ * context: {
29
+ * tenant_id: "string"
30
+ * },
31
+ * metadata: {
32
+ * event: "string",
33
+ * tags: [],
34
+ * utm: {
35
+ * source: undefined,
36
+ * medium: undefined,
37
+ * campaign: undefined,
38
+ * term: undefined,
39
+ * content: undefined
40
+ * },
41
+ * trace_id: "string"
42
+ * },
43
+ * preferences: {
44
+ * subscription_topic_id: "string"
45
+ * },
46
+ * providers: {
47
+ * "string": {
48
+ * override: undefined,
49
+ * if: undefined,
50
+ * timeouts: undefined,
51
+ * metadata: undefined
52
+ * }
53
+ * },
54
+ * routing: {
55
+ * method: Courier.RoutingMethod.All,
56
+ * channels: [{
57
+ * channel: "string",
58
+ * config: undefined,
59
+ * method: undefined,
60
+ * providers: undefined,
61
+ * if: undefined
62
+ * }]
63
+ * },
64
+ * timeout: {
65
+ * provider: {},
66
+ * channel: {},
67
+ * message: 1,
68
+ * escalation: 1,
69
+ * criteria: Courier.Criteria.NoEscalation
70
+ * },
71
+ * delay: {
72
+ * duration: 1
73
+ * },
74
+ * expiry: {
75
+ * expires_at: "string",
76
+ * expires_in: "string"
77
+ * }
78
+ * },
10
79
  * brand: "string",
11
80
  * data: {
12
81
  * "string": {
@@ -78,7 +78,7 @@ class Inbound {
78
78
  Authorization: yield this._getAuthorizationHeader(),
79
79
  "X-Fern-Language": "JavaScript",
80
80
  "X-Fern-SDK-Name": "@trycourier/courier",
81
- "X-Fern-SDK-Version": "v6.2.2",
81
+ "X-Fern-SDK-Version": "v6.2.3",
82
82
  "X-Fern-Runtime": core.RUNTIME.type,
83
83
  "X-Fern-Runtime-Version": core.RUNTIME.version,
84
84
  },