@trycourier/courier 6.3.0 → 6.4.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.
Files changed (394) hide show
  1. package/Client.d.ts +84 -109
  2. package/Client.js +118 -148
  3. package/api/client/requests/SendMessageRequest.d.ts +45 -78
  4. package/api/resources/audiences/client/Client.d.ts +16 -16
  5. package/api/resources/audiences/client/Client.js +63 -86
  6. package/api/resources/audiences/client/requests/AudienceMembersListParams.d.ts +1 -3
  7. package/api/resources/audiences/client/requests/AudienceUpdateParams.d.ts +3 -7
  8. package/api/resources/audiences/client/requests/AudiencesListParams.d.ts +1 -3
  9. package/api/resources/audiences/types/ComparisonOperator.d.ts +1 -1
  10. package/api/resources/audiences/types/Filter.d.ts +1 -1
  11. package/api/resources/audiences/types/FilterConfig.d.ts +1 -1
  12. package/api/resources/audiences/types/LogicalOperator.d.ts +1 -1
  13. package/api/resources/audiences/types/Operator.d.ts +1 -1
  14. package/api/resources/auditEvents/client/Client.d.ts +10 -4
  15. package/api/resources/auditEvents/client/Client.js +35 -37
  16. package/api/resources/auditEvents/client/requests/ListAuditEventsRequest.d.ts +1 -3
  17. package/api/resources/authTokens/client/Client.d.ts +11 -3
  18. package/api/resources/authTokens/client/Client.js +28 -25
  19. package/api/resources/authTokens/client/requests/IssueTokenParams.d.ts +2 -2
  20. package/api/resources/automations/client/Client.d.ts +15 -13
  21. package/api/resources/automations/client/Client.js +38 -48
  22. package/api/resources/automations/types/AutomationAddToBatchMaxItemsType.d.ts +1 -1
  23. package/api/resources/automations/types/AutomationAddToBatchRetainType.d.ts +1 -1
  24. package/api/resources/automations/types/AutomationAddToBatchScope.d.ts +1 -1
  25. package/api/resources/automations/types/AutomationFetchDataWebhookMethod.d.ts +1 -1
  26. package/api/resources/automations/types/AutomationStepOption.d.ts +1 -1
  27. package/api/resources/automations/types/AutomationThrottleScope.d.ts +1 -1
  28. package/api/resources/automations/types/MergeAlgorithm.d.ts +1 -1
  29. package/api/resources/automations/types/Profile.d.ts +1 -1
  30. package/api/resources/brands/client/Client.d.ts +22 -58
  31. package/api/resources/brands/client/Client.js +65 -126
  32. package/api/resources/brands/client/requests/BrandUpdateParameters.d.ts +3 -26
  33. package/api/resources/brands/client/requests/ListBrandsRequest.d.ts +1 -3
  34. package/api/resources/bulk/client/Client.d.ts +32 -120
  35. package/api/resources/bulk/client/Client.js +80 -191
  36. package/api/resources/bulk/client/requests/BulkCreateJobParams.d.ts +6 -86
  37. package/api/resources/bulk/client/requests/BulkGetUsersParams.d.ts +13 -0
  38. package/api/resources/bulk/client/requests/BulkGetUsersParams.js +5 -0
  39. package/api/resources/bulk/client/requests/index.d.ts +1 -0
  40. package/api/resources/bulk/types/BulkJobStatus.d.ts +1 -1
  41. package/api/resources/bulk/types/BulkJobUserStatus.d.ts +1 -1
  42. package/api/resources/bulk/types/InboundBulkMessageV2.d.ts +3 -5
  43. package/api/resources/commons/errors/AlreadyExistsError.js +17 -7
  44. package/api/resources/commons/errors/BadRequestError.js +17 -7
  45. package/api/resources/commons/errors/ConflictError.js +17 -7
  46. package/api/resources/commons/errors/MessageNotFoundError.js +17 -7
  47. package/api/resources/commons/errors/NotFoundError.js +17 -7
  48. package/api/resources/commons/errors/PaymentRequiredError.js +17 -7
  49. package/api/resources/commons/types/ChannelClassification.d.ts +1 -1
  50. package/api/resources/commons/types/NotificationPreferences.d.ts +1 -1
  51. package/api/resources/commons/types/PreferenceStatus.d.ts +1 -1
  52. package/api/resources/inbound/client/Client.d.ts +9 -1
  53. package/api/resources/inbound/client/Client.js +26 -21
  54. package/api/resources/index.js +17 -7
  55. package/api/resources/lists/client/Client.d.ts +31 -34
  56. package/api/resources/lists/client/Client.js +108 -161
  57. package/api/resources/lists/client/requests/AddSubscribersToList.d.ts +5 -5
  58. package/api/resources/lists/client/requests/GetAllListsRequest.d.ts +1 -4
  59. package/api/resources/lists/client/requests/GetSubscriptionForListRequest.d.ts +1 -3
  60. package/api/resources/lists/client/requests/SubscribeUserToListRequest.d.ts +1 -4
  61. package/api/resources/lists/client/requests/SubscribeUsersToListRequest.d.ts +5 -5
  62. package/api/resources/messages/client/Client.d.ts +15 -24
  63. package/api/resources/messages/client/Client.js +65 -104
  64. package/api/resources/messages/client/requests/GetMessageHistoryRequest.d.ts +1 -3
  65. package/api/resources/messages/client/requests/ListMessagesRequest.d.ts +1 -16
  66. package/api/resources/messages/types/MessageDetailsExtended.d.ts +7 -0
  67. package/api/resources/messages/types/MessageDetailsExtended.js +5 -0
  68. package/api/resources/messages/types/MessageStatus.d.ts +25 -5
  69. package/api/resources/messages/types/MessageStatus.js +6 -1
  70. package/api/resources/messages/types/Reason.d.ts +1 -1
  71. package/api/resources/messages/types/index.d.ts +1 -0
  72. package/api/resources/messages/types/index.js +1 -0
  73. package/api/resources/notifications/client/Client.d.ts +20 -11
  74. package/api/resources/notifications/client/Client.js +69 -88
  75. package/api/resources/notifications/client/requests/NotificationListParams.d.ts +1 -4
  76. package/api/resources/notifications/client/requests/SubmissionChecksReplaceParams.d.ts +6 -2
  77. package/api/resources/notifications/types/BlockType.d.ts +1 -1
  78. package/api/resources/notifications/types/CheckStatus.d.ts +1 -1
  79. package/api/resources/notifications/types/MessageRoutingChannel.d.ts +1 -1
  80. package/api/resources/notifications/types/MessageRoutingMethod.d.ts +1 -1
  81. package/api/resources/notifications/types/NotificationContent.d.ts +1 -1
  82. package/api/resources/profiles/client/Client.d.ts +35 -23
  83. package/api/resources/profiles/client/Client.js +95 -125
  84. package/api/resources/profiles/client/requests/GetListSubscriptionsRequest.d.ts +1 -3
  85. package/api/resources/profiles/client/requests/MergeProfileRequest.d.ts +1 -1
  86. package/api/resources/profiles/client/requests/ReplaceProfileRequest.d.ts +1 -1
  87. package/api/resources/profiles/types/DeviceType.d.ts +1 -1
  88. package/api/resources/profiles/types/Discord.d.ts +1 -1
  89. package/api/resources/profiles/types/Expo.d.ts +1 -1
  90. package/api/resources/profiles/types/MsTeams.d.ts +1 -1
  91. package/api/resources/profiles/types/ProfileUpdateRequest.d.ts +8 -0
  92. package/api/resources/profiles/types/ProfileUpdateRequest.js +5 -0
  93. package/api/resources/profiles/types/Slack.d.ts +1 -1
  94. package/api/resources/profiles/types/SnoozeRuleType.d.ts +1 -1
  95. package/api/resources/profiles/types/UserProfileFirebaseToken.d.ts +1 -1
  96. package/api/resources/profiles/types/WebhookAuthMode.d.ts +1 -1
  97. package/api/resources/profiles/types/WebhookMethod.d.ts +1 -1
  98. package/api/resources/profiles/types/WebhookProfileType.d.ts +1 -1
  99. package/api/resources/profiles/types/index.d.ts +1 -0
  100. package/api/resources/profiles/types/index.js +1 -0
  101. package/api/resources/send/types/Attachment.d.ts +1 -1
  102. package/api/resources/send/types/ChannelSource.d.ts +1 -1
  103. package/api/resources/send/types/Content.d.ts +1 -1
  104. package/api/resources/send/types/Criteria.d.ts +1 -1
  105. package/api/resources/send/types/ElementalNode.d.ts +1 -1
  106. package/api/resources/send/types/ExpiresInType.d.ts +1 -1
  107. package/api/resources/send/types/IActionButtonStyle.d.ts +1 -1
  108. package/api/resources/send/types/IAlignment.d.ts +1 -1
  109. package/api/resources/send/types/IPreferences.d.ts +1 -1
  110. package/api/resources/send/types/InAppPlacement.d.ts +1 -1
  111. package/api/resources/send/types/Locales.d.ts +1 -1
  112. package/api/resources/send/types/Message.d.ts +1 -1
  113. package/api/resources/send/types/MessageChannels.d.ts +1 -1
  114. package/api/resources/send/types/MessageData.d.ts +1 -1
  115. package/api/resources/send/types/MessageProviders.d.ts +1 -1
  116. package/api/resources/send/types/MessageRecipient.d.ts +1 -1
  117. package/api/resources/send/types/Recipient.d.ts +1 -1
  118. package/api/resources/send/types/RecipientData.d.ts +1 -1
  119. package/api/resources/send/types/RoutingChannel.d.ts +1 -1
  120. package/api/resources/send/types/RoutingMethod.d.ts +1 -1
  121. package/api/resources/send/types/RuleType.d.ts +1 -1
  122. package/api/resources/send/types/TextAlign.d.ts +1 -1
  123. package/api/resources/send/types/TextStyle.d.ts +1 -1
  124. package/api/resources/templates/client/Client.d.ts +9 -3
  125. package/api/resources/templates/client/Client.js +28 -25
  126. package/api/resources/templates/client/requests/ListTemplatesRequest.d.ts +1 -3
  127. package/api/resources/templates/types/ChannelIdentifier.d.ts +1 -1
  128. package/api/resources/templates/types/RoutingStrategyMethod.d.ts +1 -1
  129. package/api/resources/tenants/client/Client.d.ts +23 -37
  130. package/api/resources/tenants/client/Client.js +80 -127
  131. package/api/resources/tenants/client/requests/ListTenantParams.d.ts +1 -5
  132. package/api/resources/tenants/client/requests/ListUsersForTenantParams.d.ts +1 -4
  133. package/api/resources/tenants/client/requests/TenantCreateOrReplaceParams.d.ts +6 -21
  134. package/api/resources/tenants/types/SubscriptionTopicStatus.d.ts +1 -1
  135. package/api/resources/tenants/types/TemplateProperty.d.ts +1 -1
  136. package/api/resources/translations/client/Client.d.ts +10 -2
  137. package/api/resources/translations/client/Client.js +33 -33
  138. package/api/resources/users/client/Client.d.ts +5 -7
  139. package/api/resources/users/resources/index.js +17 -7
  140. package/api/resources/users/resources/preferences/client/Client.d.ts +13 -9
  141. package/api/resources/users/resources/preferences/client/Client.js +46 -55
  142. package/api/resources/users/resources/preferences/client/requests/UserPreferencesParams.d.ts +1 -3
  143. package/api/resources/users/resources/preferences/client/requests/UserPreferencesTopicParams.d.ts +1 -3
  144. package/api/resources/users/resources/preferences/client/requests/UserPreferencesUpdateParams.d.ts +2 -2
  145. package/api/resources/users/resources/tenants/client/Client.d.ts +23 -21
  146. package/api/resources/users/resources/tenants/client/Client.js +68 -89
  147. package/api/resources/users/resources/tenants/client/requests/AddUserToMultipleTenantsParams.d.ts +9 -8
  148. package/api/resources/users/resources/tenants/client/requests/AddUserToSingleTenantsParams.d.ts +1 -5
  149. package/api/resources/users/resources/tenants/client/requests/ListTenantsForUserParams.d.ts +1 -4
  150. package/api/resources/users/resources/tokens/client/Client.d.ts +27 -29
  151. package/api/resources/users/resources/tokens/client/Client.js +74 -104
  152. package/api/resources/users/resources/tokens/types/ExpiryDate.d.ts +1 -1
  153. package/api/resources/users/resources/tokens/types/GetAllTokensResponse.d.ts +1 -1
  154. package/api/resources/users/resources/tokens/types/PatchOp.d.ts +1 -1
  155. package/api/resources/users/resources/tokens/types/ProviderKey.d.ts +1 -1
  156. package/api/resources/users/resources/tokens/types/TokenStatus.d.ts +1 -1
  157. package/core/auth/BearerToken.d.ts +1 -1
  158. package/core/fetcher/APIResponse.d.ts +1 -1
  159. package/core/fetcher/Fetcher.d.ts +7 -3
  160. package/core/fetcher/Fetcher.js +30 -135
  161. package/core/fetcher/Supplier.d.ts +1 -1
  162. package/core/fetcher/createRequestUrl.d.ts +1 -0
  163. package/core/fetcher/createRequestUrl.js +12 -0
  164. package/core/fetcher/getFetchFn.d.ts +4 -0
  165. package/core/fetcher/getFetchFn.js +68 -0
  166. package/core/fetcher/getHeader.js +1 -2
  167. package/core/fetcher/getRequestBody.d.ts +7 -0
  168. package/core/fetcher/getRequestBody.js +23 -0
  169. package/core/fetcher/getResponseBody.d.ts +1 -0
  170. package/core/fetcher/getResponseBody.js +54 -0
  171. package/core/fetcher/makeRequest.d.ts +1 -0
  172. package/core/fetcher/makeRequest.js +42 -0
  173. package/core/fetcher/requestWithRetries.d.ts +1 -0
  174. package/core/fetcher/requestWithRetries.js +40 -0
  175. package/core/fetcher/signals.d.ts +11 -0
  176. package/core/fetcher/signals.js +36 -0
  177. package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +30 -0
  178. package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +247 -0
  179. package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +21 -0
  180. package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +126 -0
  181. package/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +31 -0
  182. package/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +229 -0
  183. package/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +18 -0
  184. package/core/fetcher/stream-wrappers/chooseStreamWrapper.js +59 -0
  185. package/core/json.d.ts +15 -0
  186. package/core/json.js +24 -0
  187. package/core/runtime/runtime.d.ts +2 -1
  188. package/core/runtime/runtime.js +57 -36
  189. package/dist/Client.d.ts +84 -109
  190. package/dist/Client.js +118 -148
  191. package/dist/api/client/requests/SendMessageRequest.d.ts +45 -78
  192. package/dist/api/resources/audiences/client/Client.d.ts +16 -16
  193. package/dist/api/resources/audiences/client/Client.js +63 -86
  194. package/dist/api/resources/audiences/client/requests/AudienceMembersListParams.d.ts +1 -3
  195. package/dist/api/resources/audiences/client/requests/AudienceUpdateParams.d.ts +3 -7
  196. package/dist/api/resources/audiences/client/requests/AudiencesListParams.d.ts +1 -3
  197. package/dist/api/resources/audiences/types/ComparisonOperator.d.ts +1 -1
  198. package/dist/api/resources/audiences/types/Filter.d.ts +1 -1
  199. package/dist/api/resources/audiences/types/FilterConfig.d.ts +1 -1
  200. package/dist/api/resources/audiences/types/LogicalOperator.d.ts +1 -1
  201. package/dist/api/resources/audiences/types/Operator.d.ts +1 -1
  202. package/dist/api/resources/auditEvents/client/Client.d.ts +10 -4
  203. package/dist/api/resources/auditEvents/client/Client.js +35 -37
  204. package/dist/api/resources/auditEvents/client/requests/ListAuditEventsRequest.d.ts +1 -3
  205. package/dist/api/resources/authTokens/client/Client.d.ts +11 -3
  206. package/dist/api/resources/authTokens/client/Client.js +28 -25
  207. package/dist/api/resources/authTokens/client/requests/IssueTokenParams.d.ts +2 -2
  208. package/dist/api/resources/automations/client/Client.d.ts +15 -13
  209. package/dist/api/resources/automations/client/Client.js +38 -48
  210. package/dist/api/resources/automations/types/AutomationAddToBatchMaxItemsType.d.ts +1 -1
  211. package/dist/api/resources/automations/types/AutomationAddToBatchRetainType.d.ts +1 -1
  212. package/dist/api/resources/automations/types/AutomationAddToBatchScope.d.ts +1 -1
  213. package/dist/api/resources/automations/types/AutomationFetchDataWebhookMethod.d.ts +1 -1
  214. package/dist/api/resources/automations/types/AutomationStepOption.d.ts +1 -1
  215. package/dist/api/resources/automations/types/AutomationThrottleScope.d.ts +1 -1
  216. package/dist/api/resources/automations/types/MergeAlgorithm.d.ts +1 -1
  217. package/dist/api/resources/automations/types/Profile.d.ts +1 -1
  218. package/dist/api/resources/brands/client/Client.d.ts +22 -58
  219. package/dist/api/resources/brands/client/Client.js +65 -126
  220. package/dist/api/resources/brands/client/requests/BrandUpdateParameters.d.ts +3 -26
  221. package/dist/api/resources/brands/client/requests/ListBrandsRequest.d.ts +1 -3
  222. package/dist/api/resources/bulk/client/Client.d.ts +32 -120
  223. package/dist/api/resources/bulk/client/Client.js +80 -191
  224. package/dist/api/resources/bulk/client/requests/BulkCreateJobParams.d.ts +6 -86
  225. package/dist/api/resources/bulk/client/requests/BulkGetUsersParams.d.ts +13 -0
  226. package/dist/api/resources/bulk/client/requests/BulkGetUsersParams.js +5 -0
  227. package/dist/api/resources/bulk/client/requests/index.d.ts +1 -0
  228. package/dist/api/resources/bulk/types/BulkJobStatus.d.ts +1 -1
  229. package/dist/api/resources/bulk/types/BulkJobUserStatus.d.ts +1 -1
  230. package/dist/api/resources/bulk/types/InboundBulkMessageV2.d.ts +3 -5
  231. package/dist/api/resources/commons/errors/AlreadyExistsError.js +17 -7
  232. package/dist/api/resources/commons/errors/BadRequestError.js +17 -7
  233. package/dist/api/resources/commons/errors/ConflictError.js +17 -7
  234. package/dist/api/resources/commons/errors/MessageNotFoundError.js +17 -7
  235. package/dist/api/resources/commons/errors/NotFoundError.js +17 -7
  236. package/dist/api/resources/commons/errors/PaymentRequiredError.js +17 -7
  237. package/dist/api/resources/commons/types/ChannelClassification.d.ts +1 -1
  238. package/dist/api/resources/commons/types/NotificationPreferences.d.ts +1 -1
  239. package/dist/api/resources/commons/types/PreferenceStatus.d.ts +1 -1
  240. package/dist/api/resources/inbound/client/Client.d.ts +9 -1
  241. package/dist/api/resources/inbound/client/Client.js +26 -21
  242. package/dist/api/resources/index.js +17 -7
  243. package/dist/api/resources/lists/client/Client.d.ts +31 -34
  244. package/dist/api/resources/lists/client/Client.js +108 -161
  245. package/dist/api/resources/lists/client/requests/AddSubscribersToList.d.ts +5 -5
  246. package/dist/api/resources/lists/client/requests/GetAllListsRequest.d.ts +1 -4
  247. package/dist/api/resources/lists/client/requests/GetSubscriptionForListRequest.d.ts +1 -3
  248. package/dist/api/resources/lists/client/requests/SubscribeUserToListRequest.d.ts +1 -4
  249. package/dist/api/resources/lists/client/requests/SubscribeUsersToListRequest.d.ts +5 -5
  250. package/dist/api/resources/messages/client/Client.d.ts +15 -24
  251. package/dist/api/resources/messages/client/Client.js +65 -104
  252. package/dist/api/resources/messages/client/requests/GetMessageHistoryRequest.d.ts +1 -3
  253. package/dist/api/resources/messages/client/requests/ListMessagesRequest.d.ts +1 -16
  254. package/dist/api/resources/messages/types/MessageDetailsExtended.d.ts +7 -0
  255. package/dist/api/resources/messages/types/MessageDetailsExtended.js +5 -0
  256. package/dist/api/resources/messages/types/MessageStatus.d.ts +25 -5
  257. package/dist/api/resources/messages/types/MessageStatus.js +6 -1
  258. package/dist/api/resources/messages/types/Reason.d.ts +1 -1
  259. package/dist/api/resources/messages/types/index.d.ts +1 -0
  260. package/dist/api/resources/messages/types/index.js +1 -0
  261. package/dist/api/resources/notifications/client/Client.d.ts +20 -11
  262. package/dist/api/resources/notifications/client/Client.js +69 -88
  263. package/dist/api/resources/notifications/client/requests/NotificationListParams.d.ts +1 -4
  264. package/dist/api/resources/notifications/client/requests/SubmissionChecksReplaceParams.d.ts +6 -2
  265. package/dist/api/resources/notifications/types/BlockType.d.ts +1 -1
  266. package/dist/api/resources/notifications/types/CheckStatus.d.ts +1 -1
  267. package/dist/api/resources/notifications/types/MessageRoutingChannel.d.ts +1 -1
  268. package/dist/api/resources/notifications/types/MessageRoutingMethod.d.ts +1 -1
  269. package/dist/api/resources/notifications/types/NotificationContent.d.ts +1 -1
  270. package/dist/api/resources/profiles/client/Client.d.ts +35 -23
  271. package/dist/api/resources/profiles/client/Client.js +95 -125
  272. package/dist/api/resources/profiles/client/requests/GetListSubscriptionsRequest.d.ts +1 -3
  273. package/dist/api/resources/profiles/client/requests/MergeProfileRequest.d.ts +1 -1
  274. package/dist/api/resources/profiles/client/requests/ReplaceProfileRequest.d.ts +1 -1
  275. package/dist/api/resources/profiles/types/DeviceType.d.ts +1 -1
  276. package/dist/api/resources/profiles/types/Discord.d.ts +1 -1
  277. package/dist/api/resources/profiles/types/Expo.d.ts +1 -1
  278. package/dist/api/resources/profiles/types/MsTeams.d.ts +1 -1
  279. package/dist/api/resources/profiles/types/ProfileUpdateRequest.d.ts +8 -0
  280. package/dist/api/resources/profiles/types/ProfileUpdateRequest.js +5 -0
  281. package/dist/api/resources/profiles/types/Slack.d.ts +1 -1
  282. package/dist/api/resources/profiles/types/SnoozeRuleType.d.ts +1 -1
  283. package/dist/api/resources/profiles/types/UserProfileFirebaseToken.d.ts +1 -1
  284. package/dist/api/resources/profiles/types/WebhookAuthMode.d.ts +1 -1
  285. package/dist/api/resources/profiles/types/WebhookMethod.d.ts +1 -1
  286. package/dist/api/resources/profiles/types/WebhookProfileType.d.ts +1 -1
  287. package/dist/api/resources/profiles/types/index.d.ts +1 -0
  288. package/dist/api/resources/profiles/types/index.js +1 -0
  289. package/dist/api/resources/send/types/Attachment.d.ts +1 -1
  290. package/dist/api/resources/send/types/ChannelSource.d.ts +1 -1
  291. package/dist/api/resources/send/types/Content.d.ts +1 -1
  292. package/dist/api/resources/send/types/Criteria.d.ts +1 -1
  293. package/dist/api/resources/send/types/ElementalNode.d.ts +1 -1
  294. package/dist/api/resources/send/types/ExpiresInType.d.ts +1 -1
  295. package/dist/api/resources/send/types/IActionButtonStyle.d.ts +1 -1
  296. package/dist/api/resources/send/types/IAlignment.d.ts +1 -1
  297. package/dist/api/resources/send/types/IPreferences.d.ts +1 -1
  298. package/dist/api/resources/send/types/InAppPlacement.d.ts +1 -1
  299. package/dist/api/resources/send/types/Locales.d.ts +1 -1
  300. package/dist/api/resources/send/types/Message.d.ts +1 -1
  301. package/dist/api/resources/send/types/MessageChannels.d.ts +1 -1
  302. package/dist/api/resources/send/types/MessageData.d.ts +1 -1
  303. package/dist/api/resources/send/types/MessageProviders.d.ts +1 -1
  304. package/dist/api/resources/send/types/MessageRecipient.d.ts +1 -1
  305. package/dist/api/resources/send/types/Recipient.d.ts +1 -1
  306. package/dist/api/resources/send/types/RecipientData.d.ts +1 -1
  307. package/dist/api/resources/send/types/RoutingChannel.d.ts +1 -1
  308. package/dist/api/resources/send/types/RoutingMethod.d.ts +1 -1
  309. package/dist/api/resources/send/types/RuleType.d.ts +1 -1
  310. package/dist/api/resources/send/types/TextAlign.d.ts +1 -1
  311. package/dist/api/resources/send/types/TextStyle.d.ts +1 -1
  312. package/dist/api/resources/templates/client/Client.d.ts +9 -3
  313. package/dist/api/resources/templates/client/Client.js +28 -25
  314. package/dist/api/resources/templates/client/requests/ListTemplatesRequest.d.ts +1 -3
  315. package/dist/api/resources/templates/types/ChannelIdentifier.d.ts +1 -1
  316. package/dist/api/resources/templates/types/RoutingStrategyMethod.d.ts +1 -1
  317. package/dist/api/resources/tenants/client/Client.d.ts +23 -37
  318. package/dist/api/resources/tenants/client/Client.js +80 -127
  319. package/dist/api/resources/tenants/client/requests/ListTenantParams.d.ts +1 -5
  320. package/dist/api/resources/tenants/client/requests/ListUsersForTenantParams.d.ts +1 -4
  321. package/dist/api/resources/tenants/client/requests/TenantCreateOrReplaceParams.d.ts +6 -21
  322. package/dist/api/resources/tenants/types/SubscriptionTopicStatus.d.ts +1 -1
  323. package/dist/api/resources/tenants/types/TemplateProperty.d.ts +1 -1
  324. package/dist/api/resources/translations/client/Client.d.ts +10 -2
  325. package/dist/api/resources/translations/client/Client.js +33 -33
  326. package/dist/api/resources/users/client/Client.d.ts +5 -7
  327. package/dist/api/resources/users/resources/index.js +17 -7
  328. package/dist/api/resources/users/resources/preferences/client/Client.d.ts +13 -9
  329. package/dist/api/resources/users/resources/preferences/client/Client.js +46 -55
  330. package/dist/api/resources/users/resources/preferences/client/requests/UserPreferencesParams.d.ts +1 -3
  331. package/dist/api/resources/users/resources/preferences/client/requests/UserPreferencesTopicParams.d.ts +1 -3
  332. package/dist/api/resources/users/resources/preferences/client/requests/UserPreferencesUpdateParams.d.ts +2 -2
  333. package/dist/api/resources/users/resources/tenants/client/Client.d.ts +23 -21
  334. package/dist/api/resources/users/resources/tenants/client/Client.js +68 -89
  335. package/dist/api/resources/users/resources/tenants/client/requests/AddUserToMultipleTenantsParams.d.ts +9 -8
  336. package/dist/api/resources/users/resources/tenants/client/requests/AddUserToSingleTenantsParams.d.ts +1 -5
  337. package/dist/api/resources/users/resources/tenants/client/requests/ListTenantsForUserParams.d.ts +1 -4
  338. package/dist/api/resources/users/resources/tokens/client/Client.d.ts +27 -29
  339. package/dist/api/resources/users/resources/tokens/client/Client.js +74 -104
  340. package/dist/api/resources/users/resources/tokens/types/ExpiryDate.d.ts +1 -1
  341. package/dist/api/resources/users/resources/tokens/types/GetAllTokensResponse.d.ts +1 -1
  342. package/dist/api/resources/users/resources/tokens/types/PatchOp.d.ts +1 -1
  343. package/dist/api/resources/users/resources/tokens/types/ProviderKey.d.ts +1 -1
  344. package/dist/api/resources/users/resources/tokens/types/TokenStatus.d.ts +1 -1
  345. package/dist/core/auth/BearerToken.d.ts +1 -1
  346. package/dist/core/fetcher/APIResponse.d.ts +1 -1
  347. package/dist/core/fetcher/Fetcher.d.ts +7 -3
  348. package/dist/core/fetcher/Fetcher.js +30 -135
  349. package/dist/core/fetcher/Supplier.d.ts +1 -1
  350. package/dist/core/fetcher/createRequestUrl.d.ts +1 -0
  351. package/dist/core/fetcher/createRequestUrl.js +12 -0
  352. package/dist/core/fetcher/getFetchFn.d.ts +4 -0
  353. package/dist/core/fetcher/getFetchFn.js +68 -0
  354. package/dist/core/fetcher/getHeader.js +1 -2
  355. package/dist/core/fetcher/getRequestBody.d.ts +7 -0
  356. package/dist/core/fetcher/getRequestBody.js +23 -0
  357. package/dist/core/fetcher/getResponseBody.d.ts +1 -0
  358. package/dist/core/fetcher/getResponseBody.js +54 -0
  359. package/dist/core/fetcher/makeRequest.d.ts +1 -0
  360. package/dist/core/fetcher/makeRequest.js +42 -0
  361. package/dist/core/fetcher/requestWithRetries.d.ts +1 -0
  362. package/dist/core/fetcher/requestWithRetries.js +40 -0
  363. package/dist/core/fetcher/signals.d.ts +11 -0
  364. package/dist/core/fetcher/signals.js +36 -0
  365. package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +30 -0
  366. package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +247 -0
  367. package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +21 -0
  368. package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +126 -0
  369. package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +31 -0
  370. package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +229 -0
  371. package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +18 -0
  372. package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.js +59 -0
  373. package/dist/core/json.d.ts +15 -0
  374. package/dist/core/json.js +24 -0
  375. package/dist/core/runtime/runtime.d.ts +2 -1
  376. package/dist/core/runtime/runtime.js +57 -36
  377. package/dist/environments.d.ts +1 -1
  378. package/dist/errors/CourierError.js +2 -1
  379. package/dist/errors/CourierTimeoutError.d.ts +1 -1
  380. package/dist/errors/CourierTimeoutError.js +2 -2
  381. package/dist/index.js +17 -7
  382. package/dist/version.d.ts +1 -0
  383. package/dist/version.js +4 -0
  384. package/environments.d.ts +1 -1
  385. package/errors/CourierError.js +2 -1
  386. package/errors/CourierTimeoutError.d.ts +1 -1
  387. package/errors/CourierTimeoutError.js +2 -2
  388. package/index.js +17 -7
  389. package/{jest.config.js → jest.config.mjs} +4 -1
  390. package/package.json +23 -14
  391. package/reference.md +5180 -0
  392. package/scripts/rename-to-esm-files.js +115 -0
  393. package/version.d.ts +1 -0
  394. package/version.js +4 -0
@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
18
18
  }) : function(o, v) {
19
19
  o["default"] = v;
20
20
  });
21
- var __importStar = (this && this.__importStar) || function (mod) {
22
- if (mod && mod.__esModule) return mod;
23
- var result = {};
24
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
- __setModuleDefault(result, mod);
26
- return result;
27
- };
21
+ var __importStar = (this && this.__importStar) || (function () {
22
+ var ownKeys = function(o) {
23
+ ownKeys = Object.getOwnPropertyNames || function (o) {
24
+ var ar = [];
25
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
+ return ar;
27
+ };
28
+ return ownKeys(o);
29
+ };
30
+ return function (mod) {
31
+ if (mod && mod.__esModule) return mod;
32
+ var result = {};
33
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
+ __setModuleDefault(result, mod);
35
+ return result;
36
+ };
37
+ })();
28
38
  var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
29
39
  function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
30
40
  return new (P || (P = Promise))(function (resolve, reject) {
@@ -55,117 +65,30 @@ class Bulk {
55
65
  * @throws {@link Courier.BadRequestError}
56
66
  *
57
67
  * @example
58
- * await courier.bulk.createJob({
68
+ * await client.bulk.createJob({
59
69
  * 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
- * until: "string"
125
- * },
126
- * expiry: {
127
- * expires_at: "string",
128
- * expires_in: "string"
129
- * }
130
- * },
131
- * brand: "string",
132
- * data: {
133
- * "string": {
134
- * "key": "value"
135
- * }
136
- * },
137
- * event: "string",
138
- * locale: {
139
- * "string": {
140
- * "key": "value"
141
- * }
142
- * },
143
- * override: {
144
- * "key": "value"
145
- * }
70
+ * brand: undefined,
71
+ * data: undefined,
72
+ * event: undefined,
73
+ * locale: undefined,
74
+ * override: undefined,
75
+ * message: undefined
146
76
  * }
147
77
  * })
148
78
  */
149
79
  createJob(request, requestOptions) {
150
- var _a, _b;
151
80
  return __awaiter(this, void 0, void 0, function* () {
81
+ var _a, _b, _c;
152
82
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
153
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, "/bulk"),
83
+ 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, "/bulk"),
154
84
  method: "POST",
155
- headers: {
156
- Authorization: yield this._getAuthorizationHeader(),
157
- "X-Fern-Language": "JavaScript",
158
- "X-Fern-SDK-Name": "@trycourier/courier",
159
- "X-Fern-SDK-Version": "v6.3.0",
160
- "X-Fern-Runtime": core.RUNTIME.type,
161
- "X-Fern-Runtime-Version": core.RUNTIME.version,
162
- "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
163
- "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry : undefined,
164
- },
85
+ 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),
165
86
  contentType: "application/json",
87
+ requestType: "json",
166
88
  body: request,
167
89
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
168
90
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
91
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
169
92
  });
170
93
  if (_response.ok) {
171
94
  return _response.body;
@@ -188,7 +111,7 @@ class Bulk {
188
111
  body: _response.error.rawBody,
189
112
  });
190
113
  case "timeout":
191
- throw new errors.CourierTimeoutError();
114
+ throw new errors.CourierTimeoutError("Timeout exceeded when calling POST /bulk.");
192
115
  case "unknown":
193
116
  throw new errors.CourierError({
194
117
  message: _response.error.errorMessage,
@@ -204,59 +127,35 @@ class Bulk {
204
127
  * @param {Bulk.IdempotentRequestOptions} requestOptions - Request-specific configuration.
205
128
  *
206
129
  * @example
207
- * await courier.bulk.ingestUsers("string", {
130
+ * await client.bulk.ingestUsers("job_id", {
208
131
  * users: [{
209
- * preferences: {
210
- * categories: {},
211
- * notifications: {}
212
- * },
213
- * profile: {
214
- * "key": "value"
215
- * },
216
- * recipient: "string",
217
- * data: {
218
- * "key": "value"
219
- * },
220
- * to: {
221
- * account_id: "string",
222
- * context: {
223
- * tenant_id: "string"
224
- * },
225
- * data: {},
226
- * email: "string",
227
- * locale: "string",
228
- * user_id: "string",
229
- * phone_number: "string",
230
- * preferences: {
231
- * categories: undefined,
232
- * notifications: {},
233
- * templateId: undefined
234
- * },
235
- * tenant_id: "string"
236
- * }
132
+ * preferences: undefined,
133
+ * profile: undefined,
134
+ * recipient: undefined,
135
+ * data: undefined,
136
+ * to: undefined
137
+ * }, {
138
+ * preferences: undefined,
139
+ * profile: undefined,
140
+ * recipient: undefined,
141
+ * data: undefined,
142
+ * to: undefined
237
143
  * }]
238
144
  * })
239
145
  */
240
146
  ingestUsers(jobId, request, requestOptions) {
241
- var _a, _b;
242
147
  return __awaiter(this, void 0, void 0, function* () {
148
+ var _a, _b, _c;
243
149
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
244
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/bulk/${encodeURIComponent(jobId)}`),
150
+ 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, `/bulk/${encodeURIComponent(jobId)}`),
245
151
  method: "POST",
246
- headers: {
247
- Authorization: yield this._getAuthorizationHeader(),
248
- "X-Fern-Language": "JavaScript",
249
- "X-Fern-SDK-Name": "@trycourier/courier",
250
- "X-Fern-SDK-Version": "v6.3.0",
251
- "X-Fern-Runtime": core.RUNTIME.type,
252
- "X-Fern-Runtime-Version": core.RUNTIME.version,
253
- "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
254
- "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry : undefined,
255
- },
152
+ 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),
256
153
  contentType: "application/json",
154
+ requestType: "json",
257
155
  body: request,
258
156
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
259
157
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
158
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
260
159
  });
261
160
  if (_response.ok) {
262
161
  return;
@@ -274,7 +173,7 @@ class Bulk {
274
173
  body: _response.error.rawBody,
275
174
  });
276
175
  case "timeout":
277
- throw new errors.CourierTimeoutError();
176
+ throw new errors.CourierTimeoutError("Timeout exceeded when calling POST /bulk/{job_id}.");
278
177
  case "unknown":
279
178
  throw new errors.CourierError({
280
179
  message: _response.error.errorMessage,
@@ -291,27 +190,20 @@ class Bulk {
291
190
  * @throws {@link Courier.BadRequestError}
292
191
  *
293
192
  * @example
294
- * await courier.bulk.runJob("string")
193
+ * await client.bulk.runJob("job_id")
295
194
  */
296
195
  runJob(jobId, requestOptions) {
297
- var _a, _b;
298
196
  return __awaiter(this, void 0, void 0, function* () {
197
+ var _a, _b, _c;
299
198
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
300
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/bulk/${encodeURIComponent(jobId)}/run`),
199
+ 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, `/bulk/${encodeURIComponent(jobId)}/run`),
301
200
  method: "POST",
302
- headers: {
303
- Authorization: yield this._getAuthorizationHeader(),
304
- "X-Fern-Language": "JavaScript",
305
- "X-Fern-SDK-Name": "@trycourier/courier",
306
- "X-Fern-SDK-Version": "v6.3.0",
307
- "X-Fern-Runtime": core.RUNTIME.type,
308
- "X-Fern-Runtime-Version": core.RUNTIME.version,
309
- "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
310
- "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry : undefined,
311
- },
201
+ 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),
312
202
  contentType: "application/json",
203
+ requestType: "json",
313
204
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
314
205
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
206
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
315
207
  });
316
208
  if (_response.ok) {
317
209
  return;
@@ -334,7 +226,7 @@ class Bulk {
334
226
  body: _response.error.rawBody,
335
227
  });
336
228
  case "timeout":
337
- throw new errors.CourierTimeoutError();
229
+ throw new errors.CourierTimeoutError("Timeout exceeded when calling POST /bulk/{job_id}/run.");
338
230
  case "unknown":
339
231
  throw new errors.CourierError({
340
232
  message: _response.error.errorMessage,
@@ -351,25 +243,20 @@ class Bulk {
351
243
  * @throws {@link Courier.BadRequestError}
352
244
  *
353
245
  * @example
354
- * await courier.bulk.getJob("string")
246
+ * await client.bulk.getJob("job_id")
355
247
  */
356
248
  getJob(jobId, requestOptions) {
357
- var _a, _b;
358
249
  return __awaiter(this, void 0, void 0, function* () {
250
+ var _a, _b, _c;
359
251
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
360
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/bulk/${encodeURIComponent(jobId)}`),
252
+ 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, `/bulk/${encodeURIComponent(jobId)}`),
361
253
  method: "GET",
362
- headers: {
363
- Authorization: yield this._getAuthorizationHeader(),
364
- "X-Fern-Language": "JavaScript",
365
- "X-Fern-SDK-Name": "@trycourier/courier",
366
- "X-Fern-SDK-Version": "v6.3.0",
367
- "X-Fern-Runtime": core.RUNTIME.type,
368
- "X-Fern-Runtime-Version": core.RUNTIME.version,
369
- },
254
+ 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 }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
370
255
  contentType: "application/json",
256
+ requestType: "json",
371
257
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
372
258
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
259
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
373
260
  });
374
261
  if (_response.ok) {
375
262
  return _response.body;
@@ -392,7 +279,7 @@ class Bulk {
392
279
  body: _response.error.rawBody,
393
280
  });
394
281
  case "timeout":
395
- throw new errors.CourierTimeoutError();
282
+ throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /bulk/{job_id}.");
396
283
  case "unknown":
397
284
  throw new errors.CourierError({
398
285
  message: _response.error.errorMessage,
@@ -404,30 +291,32 @@ class Bulk {
404
291
  * Get Bulk Job Users
405
292
  *
406
293
  * @param {string} jobId - A unique identifier representing the bulk job
294
+ * @param {Courier.BulkGetUsersParams} request
407
295
  * @param {Bulk.RequestOptions} requestOptions - Request-specific configuration.
408
296
  *
409
297
  * @throws {@link Courier.BadRequestError}
410
298
  *
411
299
  * @example
412
- * await courier.bulk.getUsers("string")
300
+ * await client.bulk.getUsers("job_id")
413
301
  */
414
- getUsers(jobId, requestOptions) {
415
- var _a, _b;
416
- return __awaiter(this, void 0, void 0, function* () {
302
+ getUsers(jobId_1) {
303
+ return __awaiter(this, arguments, void 0, function* (jobId, request = {}, requestOptions) {
304
+ var _a, _b, _c;
305
+ const { cursor } = request;
306
+ const _queryParams = {};
307
+ if (cursor != null) {
308
+ _queryParams["cursor"] = cursor;
309
+ }
417
310
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
418
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/bulk/${encodeURIComponent(jobId)}/users`),
311
+ 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, `/bulk/${encodeURIComponent(jobId)}/users`),
419
312
  method: "GET",
420
- headers: {
421
- Authorization: yield this._getAuthorizationHeader(),
422
- "X-Fern-Language": "JavaScript",
423
- "X-Fern-SDK-Name": "@trycourier/courier",
424
- "X-Fern-SDK-Version": "v6.3.0",
425
- "X-Fern-Runtime": core.RUNTIME.type,
426
- "X-Fern-Runtime-Version": core.RUNTIME.version,
427
- },
313
+ 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 }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
428
314
  contentType: "application/json",
315
+ queryParameters: _queryParams,
316
+ requestType: "json",
429
317
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
430
318
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
319
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
431
320
  });
432
321
  if (_response.ok) {
433
322
  return _response.body;
@@ -450,7 +339,7 @@ class Bulk {
450
339
  body: _response.error.rawBody,
451
340
  });
452
341
  case "timeout":
453
- throw new errors.CourierTimeoutError();
342
+ throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /bulk/{job_id}/users.");
454
343
  case "unknown":
455
344
  throw new errors.CourierError({
456
345
  message: _response.error.errorMessage,
@@ -459,12 +348,12 @@ class Bulk {
459
348
  });
460
349
  }
461
350
  _getAuthorizationHeader() {
462
- var _a;
463
351
  return __awaiter(this, void 0, void 0, function* () {
352
+ var _a;
464
353
  const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["COURIER_AUTH_TOKEN"];
465
354
  if (bearer == null) {
466
355
  throw new errors.CourierError({
467
- message: "Please specify COURIER_AUTH_TOKEN when instantiating the client.",
356
+ message: "Please specify a bearer by either passing it in to the constructor or initializing a COURIER_AUTH_TOKEN environment variable",
468
357
  });
469
358
  }
470
359
  return `Bearer ${bearer}`;
@@ -6,92 +6,12 @@ import * as Courier from "../../../../index";
6
6
  * @example
7
7
  * {
8
8
  * 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
- * until: "string"
74
- * },
75
- * expiry: {
76
- * expires_at: "string",
77
- * expires_in: "string"
78
- * }
79
- * },
80
- * brand: "string",
81
- * data: {
82
- * "string": {
83
- * "key": "value"
84
- * }
85
- * },
86
- * event: "string",
87
- * locale: {
88
- * "string": {
89
- * "key": "value"
90
- * }
91
- * },
92
- * override: {
93
- * "key": "value"
94
- * }
9
+ * brand: undefined,
10
+ * data: undefined,
11
+ * event: undefined,
12
+ * locale: undefined,
13
+ * override: undefined,
14
+ * message: undefined
95
15
  * }
96
16
  * }
97
17
  */
@@ -0,0 +1,13 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * @example
6
+ * {}
7
+ */
8
+ export interface BulkGetUsersParams {
9
+ /**
10
+ * A unique identifier that allows for fetching the next set of users added to the bulk job
11
+ */
12
+ cursor?: string;
13
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1 +1,2 @@
1
1
  export { type BulkCreateJobParams } from "./BulkCreateJobParams";
2
+ export { type BulkGetUsersParams } from "./BulkGetUsersParams";
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
- export declare type BulkJobStatus = "CREATED" | "PROCESSING" | "COMPLETED" | "ERROR";
4
+ export type BulkJobStatus = "CREATED" | "PROCESSING" | "COMPLETED" | "ERROR";
5
5
  export declare const BulkJobStatus: {
6
6
  readonly Created: "CREATED";
7
7
  readonly Processing: "PROCESSING";
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
- export declare type BulkJobUserStatus = "PENDING" | "ENQUEUED" | "ERROR";
4
+ export type BulkJobUserStatus = "PENDING" | "ENQUEUED" | "ERROR";
5
5
  export declare const BulkJobUserStatus: {
6
6
  readonly Pending: "PENDING";
7
7
  readonly Enqueued: "ENQUEUED";
@@ -2,15 +2,13 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as Courier from "../../../index";
5
- export declare type InboundBulkMessageV2 =
5
+ export type InboundBulkMessageV2 =
6
6
  /**
7
7
  * Describes the content of the message in a way that will
8
- * work for email, push, chat, or any channel.
9
- * */
8
+ * work for email, push, chat, or any channel. */
10
9
  Courier.InboundBulkTemplateMessage
11
10
  /**
12
11
  * A template for a type of message that can be sent more than once.
13
12
  * For example, you might create an "Appointment Reminder" Notification or
14
- * “Reset Password” Notifications.
15
- * */
13
+ * “Reset Password” Notifications. */
16
14
  | Courier.InboundBulkContentMessage;
@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
18
18
  }) : function(o, v) {
19
19
  o["default"] = v;
20
20
  });
21
- var __importStar = (this && this.__importStar) || function (mod) {
22
- if (mod && mod.__esModule) return mod;
23
- var result = {};
24
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
- __setModuleDefault(result, mod);
26
- return result;
27
- };
21
+ var __importStar = (this && this.__importStar) || (function () {
22
+ var ownKeys = function(o) {
23
+ ownKeys = Object.getOwnPropertyNames || function (o) {
24
+ var ar = [];
25
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
+ return ar;
27
+ };
28
+ return ownKeys(o);
29
+ };
30
+ return function (mod) {
31
+ if (mod && mod.__esModule) return mod;
32
+ var result = {};
33
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
+ __setModuleDefault(result, mod);
35
+ return result;
36
+ };
37
+ })();
28
38
  Object.defineProperty(exports, "__esModule", { value: true });
29
39
  exports.AlreadyExistsError = void 0;
30
40
  const errors = __importStar(require("../../../../errors/index"));
@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
18
18
  }) : function(o, v) {
19
19
  o["default"] = v;
20
20
  });
21
- var __importStar = (this && this.__importStar) || function (mod) {
22
- if (mod && mod.__esModule) return mod;
23
- var result = {};
24
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
- __setModuleDefault(result, mod);
26
- return result;
27
- };
21
+ var __importStar = (this && this.__importStar) || (function () {
22
+ var ownKeys = function(o) {
23
+ ownKeys = Object.getOwnPropertyNames || function (o) {
24
+ var ar = [];
25
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
+ return ar;
27
+ };
28
+ return ownKeys(o);
29
+ };
30
+ return function (mod) {
31
+ if (mod && mod.__esModule) return mod;
32
+ var result = {};
33
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
+ __setModuleDefault(result, mod);
35
+ return result;
36
+ };
37
+ })();
28
38
  Object.defineProperty(exports, "__esModule", { value: true });
29
39
  exports.BadRequestError = void 0;
30
40
  const errors = __importStar(require("../../../../errors/index"));