@trycourier/courier 6.2.1 → 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 (147) hide show
  1. package/Client.d.ts +71 -10
  2. package/Client.js +72 -11
  3. package/api/client/requests/SendMessageRequest.d.ts +71 -10
  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.d.ts +2 -1
  22. package/api/resources/notifications/client/Client.js +12 -8
  23. package/api/resources/notifications/client/requests/NotificationListParams.d.ts +6 -1
  24. package/api/resources/notifications/types/Notification.d.ts +1 -0
  25. package/api/resources/profiles/client/Client.d.ts +7 -1
  26. package/api/resources/profiles/client/Client.js +14 -8
  27. package/api/resources/profiles/types/Pagerduty.d.ts +9 -0
  28. package/api/resources/profiles/types/UserProfile.d.ts +1 -1
  29. package/api/resources/profiles/types/UserProfileFirebaseToken.d.ts +4 -0
  30. package/api/resources/profiles/types/WebhookAuthMode.d.ts +9 -0
  31. package/api/resources/profiles/types/WebhookAuthMode.js +11 -0
  32. package/api/resources/profiles/types/WebhookAuthentication.d.ts +14 -0
  33. package/api/resources/profiles/types/WebhookAuthentication.js +5 -0
  34. package/api/resources/profiles/types/WebhookMethod.d.ts +8 -0
  35. package/api/resources/profiles/types/WebhookMethod.js +10 -0
  36. package/api/resources/profiles/types/WebhookProfile.d.ts +16 -0
  37. package/api/resources/profiles/types/WebhookProfile.js +5 -0
  38. package/api/resources/profiles/types/WebhookProfileType.d.ts +8 -0
  39. package/api/resources/profiles/types/WebhookProfileType.js +10 -0
  40. package/api/resources/profiles/types/index.d.ts +7 -0
  41. package/api/resources/profiles/types/index.js +7 -0
  42. package/api/resources/send/types/BaseMessage.d.ts +1 -0
  43. package/api/resources/send/types/Channel.d.ts +1 -1
  44. package/api/resources/send/types/MessagePreferences.d.ts +7 -0
  45. package/api/resources/send/types/MessagePreferences.js +5 -0
  46. package/api/resources/send/types/PagerdutyRecipient.d.ts +7 -0
  47. package/api/resources/send/types/PagerdutyRecipient.js +5 -0
  48. package/api/resources/send/types/Recipient.d.ts +1 -1
  49. package/api/resources/send/types/WebhookRecipient.d.ts +7 -0
  50. package/api/resources/send/types/WebhookRecipient.js +5 -0
  51. package/api/resources/send/types/index.d.ts +3 -2
  52. package/api/resources/send/types/index.js +3 -2
  53. package/api/resources/templates/client/Client.js +1 -1
  54. package/api/resources/tenants/client/Client.d.ts +6 -1
  55. package/api/resources/tenants/client/Client.js +13 -8
  56. package/api/resources/tenants/client/requests/TenantCreateOrReplaceParams.d.ts +6 -1
  57. package/api/resources/translations/client/Client.js +2 -2
  58. package/api/resources/users/resources/preferences/client/Client.d.ts +10 -4
  59. package/api/resources/users/resources/preferences/client/Client.js +43 -8
  60. package/api/resources/users/resources/preferences/client/requests/UserPreferencesParams.d.ts +15 -0
  61. package/api/resources/users/resources/preferences/client/requests/UserPreferencesParams.js +5 -0
  62. package/api/resources/users/resources/preferences/client/requests/UserPreferencesTopicParams.d.ts +15 -0
  63. package/api/resources/users/resources/preferences/client/requests/UserPreferencesTopicParams.js +5 -0
  64. package/api/resources/users/resources/preferences/client/requests/UserPreferencesUpdateParams.d.ts +4 -0
  65. package/api/resources/users/resources/preferences/client/requests/index.d.ts +2 -0
  66. package/api/resources/users/resources/tenants/client/Client.js +5 -5
  67. package/api/resources/users/resources/tokens/client/Client.d.ts +5 -1
  68. package/api/resources/users/resources/tokens/client/Client.js +11 -7
  69. package/dist/Client.d.ts +71 -10
  70. package/dist/Client.js +72 -11
  71. package/dist/api/client/requests/SendMessageRequest.d.ts +71 -10
  72. package/dist/api/resources/audiences/client/Client.js +5 -5
  73. package/dist/api/resources/auditEvents/client/Client.js +2 -2
  74. package/dist/api/resources/authTokens/client/Client.js +1 -1
  75. package/dist/api/resources/automations/client/Client.js +2 -2
  76. package/dist/api/resources/brands/client/Client.d.ts +38 -4
  77. package/dist/api/resources/brands/client/Client.js +43 -9
  78. package/dist/api/resources/brands/client/requests/BrandUpdateParameters.d.ts +13 -2
  79. package/dist/api/resources/bulk/client/Client.d.ts +91 -3
  80. package/dist/api/resources/bulk/client/Client.js +96 -8
  81. package/dist/api/resources/bulk/client/requests/BulkCreateJobParams.d.ts +70 -1
  82. package/dist/api/resources/inbound/client/Client.js +1 -1
  83. package/dist/api/resources/lists/client/Client.d.ts +8 -96
  84. package/dist/api/resources/lists/client/Client.js +18 -106
  85. package/dist/api/resources/lists/client/requests/AddSubscribersToList.d.ts +2 -24
  86. package/dist/api/resources/lists/client/requests/SubscribeUserToListRequest.d.ts +2 -24
  87. package/dist/api/resources/lists/client/requests/SubscribeUsersToListRequest.d.ts +2 -24
  88. package/dist/api/resources/messages/client/Client.js +6 -6
  89. package/dist/api/resources/notifications/client/Client.d.ts +2 -1
  90. package/dist/api/resources/notifications/client/Client.js +12 -8
  91. package/dist/api/resources/notifications/client/requests/NotificationListParams.d.ts +6 -1
  92. package/dist/api/resources/notifications/types/Notification.d.ts +1 -0
  93. package/dist/api/resources/profiles/client/Client.d.ts +7 -1
  94. package/dist/api/resources/profiles/client/Client.js +14 -8
  95. package/dist/api/resources/profiles/types/Pagerduty.d.ts +9 -0
  96. package/dist/api/resources/profiles/types/Pagerduty.js +5 -0
  97. package/dist/api/resources/profiles/types/UserProfile.d.ts +1 -1
  98. package/dist/api/resources/profiles/types/UserProfileFirebaseToken.d.ts +4 -0
  99. package/dist/api/resources/profiles/types/UserProfileFirebaseToken.js +5 -0
  100. package/dist/api/resources/profiles/types/WebhookAuthMode.d.ts +9 -0
  101. package/dist/api/resources/profiles/types/WebhookAuthMode.js +11 -0
  102. package/dist/api/resources/profiles/types/WebhookAuthentication.d.ts +14 -0
  103. package/dist/api/resources/profiles/types/WebhookAuthentication.js +5 -0
  104. package/dist/api/resources/profiles/types/WebhookMethod.d.ts +8 -0
  105. package/dist/api/resources/profiles/types/WebhookMethod.js +10 -0
  106. package/dist/api/resources/profiles/types/WebhookProfile.d.ts +16 -0
  107. package/dist/api/resources/profiles/types/WebhookProfile.js +5 -0
  108. package/dist/api/resources/profiles/types/WebhookProfileType.d.ts +8 -0
  109. package/dist/api/resources/profiles/types/WebhookProfileType.js +10 -0
  110. package/dist/api/resources/profiles/types/index.d.ts +7 -0
  111. package/dist/api/resources/profiles/types/index.js +7 -0
  112. package/dist/api/resources/send/types/BaseMessage.d.ts +1 -0
  113. package/dist/api/resources/send/types/Channel.d.ts +1 -1
  114. package/dist/api/resources/send/types/MessagePreferences.d.ts +7 -0
  115. package/dist/api/resources/send/types/MessagePreferences.js +5 -0
  116. package/dist/api/resources/send/types/PagerdutyRecipient.d.ts +7 -0
  117. package/dist/api/resources/send/types/PagerdutyRecipient.js +5 -0
  118. package/dist/api/resources/send/types/Recipient.d.ts +1 -1
  119. package/dist/api/resources/send/types/WebhookRecipient.d.ts +7 -0
  120. package/dist/api/resources/send/types/WebhookRecipient.js +5 -0
  121. package/dist/api/resources/send/types/index.d.ts +3 -2
  122. package/dist/api/resources/send/types/index.js +3 -2
  123. package/dist/api/resources/templates/client/Client.js +1 -1
  124. package/dist/api/resources/tenants/client/Client.d.ts +6 -1
  125. package/dist/api/resources/tenants/client/Client.js +13 -8
  126. package/dist/api/resources/tenants/client/requests/TenantCreateOrReplaceParams.d.ts +6 -1
  127. package/dist/api/resources/translations/client/Client.js +2 -2
  128. package/dist/api/resources/users/resources/preferences/client/Client.d.ts +10 -4
  129. package/dist/api/resources/users/resources/preferences/client/Client.js +43 -8
  130. package/dist/api/resources/users/resources/preferences/client/requests/UserPreferencesParams.d.ts +15 -0
  131. package/dist/api/resources/users/resources/preferences/client/requests/UserPreferencesParams.js +5 -0
  132. package/dist/api/resources/users/resources/preferences/client/requests/UserPreferencesTopicParams.d.ts +15 -0
  133. package/dist/api/resources/users/resources/preferences/client/requests/UserPreferencesTopicParams.js +5 -0
  134. package/dist/api/resources/users/resources/preferences/client/requests/UserPreferencesUpdateParams.d.ts +4 -0
  135. package/dist/api/resources/users/resources/preferences/client/requests/index.d.ts +2 -0
  136. package/dist/api/resources/users/resources/tenants/client/Client.js +5 -5
  137. package/dist/api/resources/users/resources/tokens/client/Client.d.ts +5 -1
  138. package/dist/api/resources/users/resources/tokens/client/Client.js +11 -7
  139. package/package.json +1 -1
  140. package/api/resources/send/types/MessageChannelEmailOverride.d.ts +0 -16
  141. package/api/resources/send/types/Override.d.ts +0 -8
  142. package/api/resources/send/types/Override.js +0 -10
  143. package/dist/api/resources/send/types/MessageChannelEmailOverride.d.ts +0 -16
  144. package/dist/api/resources/send/types/Override.d.ts +0 -8
  145. package/dist/api/resources/send/types/Override.js +0 -10
  146. /package/api/resources/{send/types/MessageChannelEmailOverride.js → profiles/types/Pagerduty.js} +0 -0
  147. /package/{dist/api/resources/send/types/MessageChannelEmailOverride.js → api/resources/profiles/types/UserProfileFirebaseToken.js} +0 -0
@@ -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.1",
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.1",
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.1",
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.1",
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.1",
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.1",
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.1",
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.1",
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.1",
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.1",
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.1",
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
  },
@@ -60,30 +60,8 @@ export declare class Lists {
60
60
  * await courier.lists.update("string", {
61
61
  * name: "string",
62
62
  * preferences: {
63
- * categories: {
64
- * "string": {
65
- * status: Courier.PreferenceStatus.OptedIn,
66
- * rules: [{
67
- * start: "string",
68
- * until: "string"
69
- * }],
70
- * channel_preferences: [{
71
- * channel: Courier.ChannelClassification.DirectMessage
72
- * }]
73
- * }
74
- * },
75
- * notifications: {
76
- * "string": {
77
- * status: Courier.PreferenceStatus.OptedIn,
78
- * rules: [{
79
- * start: "string",
80
- * until: "string"
81
- * }],
82
- * channel_preferences: [{
83
- * channel: Courier.ChannelClassification.DirectMessage
84
- * }]
85
- * }
86
- * }
63
+ * categories: {},
64
+ * notifications: {}
87
65
  * }
88
66
  * })
89
67
  */
@@ -137,30 +115,8 @@ export declare class Lists {
137
115
  * recipients: [{
138
116
  * recipientId: "string",
139
117
  * preferences: {
140
- * categories: {
141
- * "string": {
142
- * status: Courier.PreferenceStatus.OptedIn,
143
- * rules: [{
144
- * start: "string",
145
- * until: "string"
146
- * }],
147
- * channel_preferences: [{
148
- * channel: Courier.ChannelClassification.DirectMessage
149
- * }]
150
- * }
151
- * },
152
- * notifications: {
153
- * "string": {
154
- * status: Courier.PreferenceStatus.OptedIn,
155
- * rules: [{
156
- * start: "string",
157
- * until: "string"
158
- * }],
159
- * channel_preferences: [{
160
- * channel: Courier.ChannelClassification.DirectMessage
161
- * }]
162
- * }
163
- * }
118
+ * categories: {},
119
+ * notifications: {}
164
120
  * }
165
121
  * }]
166
122
  * })
@@ -180,30 +136,8 @@ export declare class Lists {
180
136
  * recipients: [{
181
137
  * recipientId: "string",
182
138
  * preferences: {
183
- * categories: {
184
- * "string": {
185
- * status: Courier.PreferenceStatus.OptedIn,
186
- * rules: [{
187
- * start: "string",
188
- * until: "string"
189
- * }],
190
- * channel_preferences: [{
191
- * channel: Courier.ChannelClassification.DirectMessage
192
- * }]
193
- * }
194
- * },
195
- * notifications: {
196
- * "string": {
197
- * status: Courier.PreferenceStatus.OptedIn,
198
- * rules: [{
199
- * start: "string",
200
- * until: "string"
201
- * }],
202
- * channel_preferences: [{
203
- * channel: Courier.ChannelClassification.DirectMessage
204
- * }]
205
- * }
206
- * }
139
+ * categories: {},
140
+ * notifications: {}
207
141
  * }
208
142
  * }]
209
143
  * })
@@ -220,30 +154,8 @@ export declare class Lists {
220
154
  * @example
221
155
  * await courier.lists.subscribe("string", "string", {
222
156
  * preferences: {
223
- * categories: {
224
- * "string": {
225
- * status: Courier.PreferenceStatus.OptedIn,
226
- * rules: [{
227
- * start: "string",
228
- * until: "string"
229
- * }],
230
- * channel_preferences: [{
231
- * channel: Courier.ChannelClassification.DirectMessage
232
- * }]
233
- * }
234
- * },
235
- * notifications: {
236
- * "string": {
237
- * status: Courier.PreferenceStatus.OptedIn,
238
- * rules: [{
239
- * start: "string",
240
- * until: "string"
241
- * }],
242
- * channel_preferences: [{
243
- * channel: Courier.ChannelClassification.DirectMessage
244
- * }]
245
- * }
246
- * }
157
+ * categories: {},
158
+ * notifications: {}
247
159
  * }
248
160
  * })
249
161
  */