@trycourier/courier 6.3.1 → 6.4.1

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 (425) hide show
  1. package/Client.d.ts +49 -108
  2. package/Client.js +89 -148
  3. package/README.md +113 -808
  4. package/api/client/requests/SendMessageRequest.d.ts +8 -76
  5. package/api/resources/audiences/client/Client.d.ts +26 -21
  6. package/api/resources/audiences/client/Client.js +97 -90
  7. package/api/resources/audiences/client/requests/AudienceMembersListParams.d.ts +1 -3
  8. package/api/resources/audiences/client/requests/AudienceUpdateParams.d.ts +3 -7
  9. package/api/resources/audiences/client/requests/AudiencesListParams.d.ts +1 -3
  10. package/api/resources/audiences/types/ComparisonOperator.d.ts +1 -1
  11. package/api/resources/audiences/types/Filter.d.ts +1 -1
  12. package/api/resources/audiences/types/FilterConfig.d.ts +1 -1
  13. package/api/resources/audiences/types/LogicalOperator.d.ts +1 -1
  14. package/api/resources/audiences/types/Operator.d.ts +1 -1
  15. package/api/resources/auditEvents/client/Client.d.ts +14 -6
  16. package/api/resources/auditEvents/client/Client.js +48 -38
  17. package/api/resources/auditEvents/client/requests/ListAuditEventsRequest.d.ts +1 -3
  18. package/api/resources/authTokens/client/Client.d.ts +13 -4
  19. package/api/resources/authTokens/client/Client.js +35 -26
  20. package/api/resources/authTokens/client/requests/IssueTokenParams.d.ts +2 -2
  21. package/api/resources/automations/client/Client.d.ts +19 -15
  22. package/api/resources/automations/client/Client.js +52 -50
  23. package/api/resources/automations/types/AutomationAddToBatchMaxItemsType.d.ts +1 -1
  24. package/api/resources/automations/types/AutomationAddToBatchRetainType.d.ts +1 -1
  25. package/api/resources/automations/types/AutomationAddToBatchScope.d.ts +1 -1
  26. package/api/resources/automations/types/AutomationFetchDataWebhookMethod.d.ts +1 -1
  27. package/api/resources/automations/types/AutomationStepOption.d.ts +1 -1
  28. package/api/resources/automations/types/AutomationThrottleScope.d.ts +1 -1
  29. package/api/resources/automations/types/MergeAlgorithm.d.ts +1 -1
  30. package/api/resources/automations/types/Profile.d.ts +1 -1
  31. package/api/resources/brands/client/Client.d.ts +32 -63
  32. package/api/resources/brands/client/Client.js +103 -134
  33. package/api/resources/brands/client/requests/BrandUpdateParameters.d.ts +3 -26
  34. package/api/resources/brands/client/requests/ListBrandsRequest.d.ts +1 -3
  35. package/api/resources/bulk/client/Client.d.ts +40 -126
  36. package/api/resources/bulk/client/Client.js +111 -201
  37. package/api/resources/bulk/client/requests/BulkCreateJobParams.d.ts +6 -86
  38. package/api/resources/bulk/client/requests/BulkGetUsersParams.d.ts +1 -3
  39. package/api/resources/bulk/types/BulkJobStatus.d.ts +1 -1
  40. package/api/resources/bulk/types/BulkJobUserStatus.d.ts +1 -1
  41. package/api/resources/bulk/types/InboundBulkMessageV2.d.ts +3 -5
  42. package/api/resources/commons/errors/AlreadyExistsError.d.ts +2 -1
  43. package/api/resources/commons/errors/AlreadyExistsError.js +19 -8
  44. package/api/resources/commons/errors/BadRequestError.d.ts +2 -1
  45. package/api/resources/commons/errors/BadRequestError.js +19 -8
  46. package/api/resources/commons/errors/ConflictError.d.ts +2 -1
  47. package/api/resources/commons/errors/ConflictError.js +19 -8
  48. package/api/resources/commons/errors/MessageNotFoundError.d.ts +2 -1
  49. package/api/resources/commons/errors/MessageNotFoundError.js +19 -8
  50. package/api/resources/commons/errors/NotFoundError.d.ts +2 -1
  51. package/api/resources/commons/errors/NotFoundError.js +19 -8
  52. package/api/resources/commons/errors/PaymentRequiredError.d.ts +2 -1
  53. package/api/resources/commons/errors/PaymentRequiredError.js +19 -8
  54. package/api/resources/commons/types/ChannelClassification.d.ts +1 -1
  55. package/api/resources/commons/types/NotificationPreferences.d.ts +1 -1
  56. package/api/resources/commons/types/PreferenceStatus.d.ts +1 -1
  57. package/api/resources/inbound/client/Client.d.ts +11 -2
  58. package/api/resources/inbound/client/Client.js +35 -24
  59. package/api/resources/index.js +17 -7
  60. package/api/resources/lists/client/Client.d.ts +51 -44
  61. package/api/resources/lists/client/Client.js +181 -174
  62. package/api/resources/lists/client/requests/AddSubscribersToList.d.ts +5 -5
  63. package/api/resources/lists/client/requests/GetAllListsRequest.d.ts +1 -4
  64. package/api/resources/lists/client/requests/GetSubscriptionForListRequest.d.ts +1 -3
  65. package/api/resources/lists/client/requests/SubscribeUserToListRequest.d.ts +1 -4
  66. package/api/resources/lists/client/requests/SubscribeUsersToListRequest.d.ts +5 -5
  67. package/api/resources/messages/client/Client.d.ts +26 -29
  68. package/api/resources/messages/client/Client.js +111 -114
  69. package/api/resources/messages/client/requests/GetMessageHistoryRequest.d.ts +1 -3
  70. package/api/resources/messages/client/requests/ListMessagesRequest.d.ts +1 -16
  71. package/api/resources/messages/types/MessageDetailsExtended.d.ts +7 -0
  72. package/api/resources/messages/types/MessageDetailsExtended.js +5 -0
  73. package/api/resources/messages/types/MessageStatus.d.ts +25 -5
  74. package/api/resources/messages/types/MessageStatus.js +6 -1
  75. package/api/resources/messages/types/Reason.d.ts +1 -1
  76. package/api/resources/messages/types/index.d.ts +1 -0
  77. package/api/resources/messages/types/index.js +1 -0
  78. package/api/resources/notifications/client/Client.d.ts +32 -17
  79. package/api/resources/notifications/client/Client.js +119 -93
  80. package/api/resources/notifications/client/requests/NotificationListParams.d.ts +1 -4
  81. package/api/resources/notifications/client/requests/SubmissionChecksReplaceParams.d.ts +6 -2
  82. package/api/resources/notifications/types/BlockType.d.ts +1 -1
  83. package/api/resources/notifications/types/CheckStatus.d.ts +1 -1
  84. package/api/resources/notifications/types/MessageRoutingChannel.d.ts +1 -1
  85. package/api/resources/notifications/types/MessageRoutingMethod.d.ts +1 -1
  86. package/api/resources/notifications/types/NotificationContent.d.ts +1 -1
  87. package/api/resources/profiles/client/Client.d.ts +50 -30
  88. package/api/resources/profiles/client/Client.js +160 -139
  89. package/api/resources/profiles/client/requests/GetListSubscriptionsRequest.d.ts +1 -3
  90. package/api/resources/profiles/client/requests/MergeProfileRequest.d.ts +1 -1
  91. package/api/resources/profiles/client/requests/ReplaceProfileRequest.d.ts +1 -1
  92. package/api/resources/profiles/types/DeviceType.d.ts +1 -1
  93. package/api/resources/profiles/types/Discord.d.ts +1 -1
  94. package/api/resources/profiles/types/Expo.d.ts +1 -1
  95. package/api/resources/profiles/types/MsTeams.d.ts +1 -1
  96. package/api/resources/profiles/types/ProfileUpdateRequest.d.ts +8 -0
  97. package/api/resources/profiles/types/ProfileUpdateRequest.js +5 -0
  98. package/api/resources/profiles/types/Slack.d.ts +1 -1
  99. package/api/resources/profiles/types/SnoozeRuleType.d.ts +1 -1
  100. package/api/resources/profiles/types/UserProfileFirebaseToken.d.ts +1 -1
  101. package/api/resources/profiles/types/WebhookAuthMode.d.ts +1 -1
  102. package/api/resources/profiles/types/WebhookMethod.d.ts +1 -1
  103. package/api/resources/profiles/types/WebhookProfileType.d.ts +1 -1
  104. package/api/resources/profiles/types/index.d.ts +1 -0
  105. package/api/resources/profiles/types/index.js +1 -0
  106. package/api/resources/send/types/Attachment.d.ts +1 -1
  107. package/api/resources/send/types/ChannelSource.d.ts +1 -1
  108. package/api/resources/send/types/Content.d.ts +1 -1
  109. package/api/resources/send/types/Criteria.d.ts +1 -1
  110. package/api/resources/send/types/ElementalNode.d.ts +1 -1
  111. package/api/resources/send/types/ExpiresInType.d.ts +1 -1
  112. package/api/resources/send/types/IActionButtonStyle.d.ts +1 -1
  113. package/api/resources/send/types/IAlignment.d.ts +1 -1
  114. package/api/resources/send/types/IPreferences.d.ts +1 -1
  115. package/api/resources/send/types/InAppPlacement.d.ts +1 -1
  116. package/api/resources/send/types/Locales.d.ts +1 -1
  117. package/api/resources/send/types/Message.d.ts +1 -1
  118. package/api/resources/send/types/MessageChannels.d.ts +1 -1
  119. package/api/resources/send/types/MessageData.d.ts +1 -1
  120. package/api/resources/send/types/MessageProviders.d.ts +1 -1
  121. package/api/resources/send/types/MessageRecipient.d.ts +1 -1
  122. package/api/resources/send/types/Recipient.d.ts +1 -1
  123. package/api/resources/send/types/RecipientData.d.ts +1 -1
  124. package/api/resources/send/types/RoutingChannel.d.ts +1 -1
  125. package/api/resources/send/types/RoutingMethod.d.ts +1 -1
  126. package/api/resources/send/types/RuleType.d.ts +1 -1
  127. package/api/resources/send/types/TextAlign.d.ts +1 -1
  128. package/api/resources/send/types/TextStyle.d.ts +1 -1
  129. package/api/resources/templates/client/Client.d.ts +11 -4
  130. package/api/resources/templates/client/Client.js +34 -25
  131. package/api/resources/templates/client/requests/ListTemplatesRequest.d.ts +1 -3
  132. package/api/resources/templates/types/ChannelIdentifier.d.ts +1 -1
  133. package/api/resources/templates/types/RoutingStrategyMethod.d.ts +1 -1
  134. package/api/resources/tenants/client/Client.d.ts +37 -44
  135. package/api/resources/tenants/client/Client.js +130 -135
  136. package/api/resources/tenants/client/requests/ListTenantParams.d.ts +1 -5
  137. package/api/resources/tenants/client/requests/ListUsersForTenantParams.d.ts +1 -4
  138. package/api/resources/tenants/client/requests/TenantCreateOrReplaceParams.d.ts +6 -21
  139. package/api/resources/tenants/types/SubscriptionTopicStatus.d.ts +1 -1
  140. package/api/resources/tenants/types/TemplateProperty.d.ts +1 -1
  141. package/api/resources/translations/client/Client.d.ts +14 -4
  142. package/api/resources/translations/client/Client.js +49 -37
  143. package/api/resources/users/client/Client.d.ts +5 -7
  144. package/api/resources/users/resources/index.js +17 -7
  145. package/api/resources/users/resources/preferences/client/Client.d.ts +19 -12
  146. package/api/resources/users/resources/preferences/client/Client.js +77 -59
  147. package/api/resources/users/resources/preferences/client/requests/UserPreferencesParams.d.ts +1 -3
  148. package/api/resources/users/resources/preferences/client/requests/UserPreferencesTopicParams.d.ts +1 -3
  149. package/api/resources/users/resources/preferences/client/requests/UserPreferencesUpdateParams.d.ts +2 -2
  150. package/api/resources/users/resources/tenants/client/Client.d.ts +33 -26
  151. package/api/resources/users/resources/tenants/client/Client.js +104 -92
  152. package/api/resources/users/resources/tenants/client/requests/AddUserToMultipleTenantsParams.d.ts +9 -8
  153. package/api/resources/users/resources/tenants/client/requests/AddUserToSingleTenantsParams.d.ts +1 -5
  154. package/api/resources/users/resources/tenants/client/requests/ListTenantsForUserParams.d.ts +1 -4
  155. package/api/resources/users/resources/tokens/client/Client.d.ts +39 -35
  156. package/api/resources/users/resources/tokens/client/Client.js +121 -115
  157. package/api/resources/users/resources/tokens/types/ExpiryDate.d.ts +1 -1
  158. package/api/resources/users/resources/tokens/types/GetAllTokensResponse.d.ts +1 -1
  159. package/api/resources/users/resources/tokens/types/PatchOp.d.ts +1 -1
  160. package/api/resources/users/resources/tokens/types/ProviderKey.d.ts +1 -1
  161. package/api/resources/users/resources/tokens/types/TokenStatus.d.ts +1 -1
  162. package/core/auth/BearerToken.d.ts +1 -1
  163. package/core/fetcher/APIResponse.d.ts +11 -1
  164. package/core/fetcher/Fetcher.d.ts +7 -3
  165. package/core/fetcher/Fetcher.js +37 -135
  166. package/core/fetcher/Headers.d.ts +2 -0
  167. package/core/fetcher/Headers.js +84 -0
  168. package/core/fetcher/HttpResponsePromise.d.ts +58 -0
  169. package/core/fetcher/HttpResponsePromise.js +103 -0
  170. package/core/fetcher/RawResponse.d.ts +29 -0
  171. package/core/fetcher/RawResponse.js +44 -0
  172. package/core/fetcher/Supplier.d.ts +1 -1
  173. package/core/fetcher/createRequestUrl.d.ts +1 -0
  174. package/core/fetcher/createRequestUrl.js +12 -0
  175. package/core/fetcher/getFetchFn.d.ts +4 -0
  176. package/core/fetcher/getFetchFn.js +68 -0
  177. package/core/fetcher/getHeader.js +1 -2
  178. package/core/fetcher/getRequestBody.d.ts +7 -0
  179. package/core/fetcher/getRequestBody.js +23 -0
  180. package/core/fetcher/getResponseBody.d.ts +1 -0
  181. package/core/fetcher/getResponseBody.js +54 -0
  182. package/core/fetcher/index.d.ts +3 -0
  183. package/core/fetcher/index.js +7 -1
  184. package/core/fetcher/makeRequest.d.ts +1 -0
  185. package/core/fetcher/makeRequest.js +42 -0
  186. package/core/fetcher/requestWithRetries.d.ts +1 -0
  187. package/core/fetcher/requestWithRetries.js +40 -0
  188. package/core/fetcher/signals.d.ts +11 -0
  189. package/core/fetcher/signals.js +36 -0
  190. package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +30 -0
  191. package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +247 -0
  192. package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +21 -0
  193. package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +126 -0
  194. package/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +31 -0
  195. package/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +229 -0
  196. package/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +18 -0
  197. package/core/fetcher/stream-wrappers/chooseStreamWrapper.js +59 -0
  198. package/core/index.d.ts +1 -1
  199. package/core/index.js +1 -1
  200. package/core/json.d.ts +15 -0
  201. package/core/json.js +24 -0
  202. package/core/runtime/runtime.d.ts +2 -1
  203. package/core/runtime/runtime.js +57 -36
  204. package/dist/Client.d.ts +49 -108
  205. package/dist/Client.js +89 -148
  206. package/dist/api/client/requests/SendMessageRequest.d.ts +8 -76
  207. package/dist/api/resources/audiences/client/Client.d.ts +26 -21
  208. package/dist/api/resources/audiences/client/Client.js +97 -90
  209. package/dist/api/resources/audiences/client/requests/AudienceMembersListParams.d.ts +1 -3
  210. package/dist/api/resources/audiences/client/requests/AudienceUpdateParams.d.ts +3 -7
  211. package/dist/api/resources/audiences/client/requests/AudiencesListParams.d.ts +1 -3
  212. package/dist/api/resources/audiences/types/ComparisonOperator.d.ts +1 -1
  213. package/dist/api/resources/audiences/types/Filter.d.ts +1 -1
  214. package/dist/api/resources/audiences/types/FilterConfig.d.ts +1 -1
  215. package/dist/api/resources/audiences/types/LogicalOperator.d.ts +1 -1
  216. package/dist/api/resources/audiences/types/Operator.d.ts +1 -1
  217. package/dist/api/resources/auditEvents/client/Client.d.ts +14 -6
  218. package/dist/api/resources/auditEvents/client/Client.js +48 -38
  219. package/dist/api/resources/auditEvents/client/requests/ListAuditEventsRequest.d.ts +1 -3
  220. package/dist/api/resources/authTokens/client/Client.d.ts +13 -4
  221. package/dist/api/resources/authTokens/client/Client.js +35 -26
  222. package/dist/api/resources/authTokens/client/requests/IssueTokenParams.d.ts +2 -2
  223. package/dist/api/resources/automations/client/Client.d.ts +19 -15
  224. package/dist/api/resources/automations/client/Client.js +52 -50
  225. package/dist/api/resources/automations/types/AutomationAddToBatchMaxItemsType.d.ts +1 -1
  226. package/dist/api/resources/automations/types/AutomationAddToBatchRetainType.d.ts +1 -1
  227. package/dist/api/resources/automations/types/AutomationAddToBatchScope.d.ts +1 -1
  228. package/dist/api/resources/automations/types/AutomationFetchDataWebhookMethod.d.ts +1 -1
  229. package/dist/api/resources/automations/types/AutomationStepOption.d.ts +1 -1
  230. package/dist/api/resources/automations/types/AutomationThrottleScope.d.ts +1 -1
  231. package/dist/api/resources/automations/types/MergeAlgorithm.d.ts +1 -1
  232. package/dist/api/resources/automations/types/Profile.d.ts +1 -1
  233. package/dist/api/resources/brands/client/Client.d.ts +32 -63
  234. package/dist/api/resources/brands/client/Client.js +103 -134
  235. package/dist/api/resources/brands/client/requests/BrandUpdateParameters.d.ts +3 -26
  236. package/dist/api/resources/brands/client/requests/ListBrandsRequest.d.ts +1 -3
  237. package/dist/api/resources/bulk/client/Client.d.ts +40 -126
  238. package/dist/api/resources/bulk/client/Client.js +111 -201
  239. package/dist/api/resources/bulk/client/requests/BulkCreateJobParams.d.ts +6 -86
  240. package/dist/api/resources/bulk/client/requests/BulkGetUsersParams.d.ts +1 -3
  241. package/dist/api/resources/bulk/types/BulkJobStatus.d.ts +1 -1
  242. package/dist/api/resources/bulk/types/BulkJobUserStatus.d.ts +1 -1
  243. package/dist/api/resources/bulk/types/InboundBulkMessageV2.d.ts +3 -5
  244. package/dist/api/resources/commons/errors/AlreadyExistsError.d.ts +2 -1
  245. package/dist/api/resources/commons/errors/AlreadyExistsError.js +19 -8
  246. package/dist/api/resources/commons/errors/BadRequestError.d.ts +2 -1
  247. package/dist/api/resources/commons/errors/BadRequestError.js +19 -8
  248. package/dist/api/resources/commons/errors/ConflictError.d.ts +2 -1
  249. package/dist/api/resources/commons/errors/ConflictError.js +19 -8
  250. package/dist/api/resources/commons/errors/MessageNotFoundError.d.ts +2 -1
  251. package/dist/api/resources/commons/errors/MessageNotFoundError.js +19 -8
  252. package/dist/api/resources/commons/errors/NotFoundError.d.ts +2 -1
  253. package/dist/api/resources/commons/errors/NotFoundError.js +19 -8
  254. package/dist/api/resources/commons/errors/PaymentRequiredError.d.ts +2 -1
  255. package/dist/api/resources/commons/errors/PaymentRequiredError.js +19 -8
  256. package/dist/api/resources/commons/types/ChannelClassification.d.ts +1 -1
  257. package/dist/api/resources/commons/types/NotificationPreferences.d.ts +1 -1
  258. package/dist/api/resources/commons/types/PreferenceStatus.d.ts +1 -1
  259. package/dist/api/resources/inbound/client/Client.d.ts +11 -2
  260. package/dist/api/resources/inbound/client/Client.js +35 -24
  261. package/dist/api/resources/index.js +17 -7
  262. package/dist/api/resources/lists/client/Client.d.ts +51 -44
  263. package/dist/api/resources/lists/client/Client.js +181 -174
  264. package/dist/api/resources/lists/client/requests/AddSubscribersToList.d.ts +5 -5
  265. package/dist/api/resources/lists/client/requests/GetAllListsRequest.d.ts +1 -4
  266. package/dist/api/resources/lists/client/requests/GetSubscriptionForListRequest.d.ts +1 -3
  267. package/dist/api/resources/lists/client/requests/SubscribeUserToListRequest.d.ts +1 -4
  268. package/dist/api/resources/lists/client/requests/SubscribeUsersToListRequest.d.ts +5 -5
  269. package/dist/api/resources/messages/client/Client.d.ts +26 -29
  270. package/dist/api/resources/messages/client/Client.js +111 -114
  271. package/dist/api/resources/messages/client/requests/GetMessageHistoryRequest.d.ts +1 -3
  272. package/dist/api/resources/messages/client/requests/ListMessagesRequest.d.ts +1 -16
  273. package/dist/api/resources/messages/types/MessageDetailsExtended.d.ts +7 -0
  274. package/dist/api/resources/messages/types/MessageDetailsExtended.js +5 -0
  275. package/dist/api/resources/messages/types/MessageStatus.d.ts +25 -5
  276. package/dist/api/resources/messages/types/MessageStatus.js +6 -1
  277. package/dist/api/resources/messages/types/Reason.d.ts +1 -1
  278. package/dist/api/resources/messages/types/index.d.ts +1 -0
  279. package/dist/api/resources/messages/types/index.js +1 -0
  280. package/dist/api/resources/notifications/client/Client.d.ts +32 -17
  281. package/dist/api/resources/notifications/client/Client.js +119 -93
  282. package/dist/api/resources/notifications/client/requests/NotificationListParams.d.ts +1 -4
  283. package/dist/api/resources/notifications/client/requests/SubmissionChecksReplaceParams.d.ts +6 -2
  284. package/dist/api/resources/notifications/types/BlockType.d.ts +1 -1
  285. package/dist/api/resources/notifications/types/CheckStatus.d.ts +1 -1
  286. package/dist/api/resources/notifications/types/MessageRoutingChannel.d.ts +1 -1
  287. package/dist/api/resources/notifications/types/MessageRoutingMethod.d.ts +1 -1
  288. package/dist/api/resources/notifications/types/NotificationContent.d.ts +1 -1
  289. package/dist/api/resources/profiles/client/Client.d.ts +50 -30
  290. package/dist/api/resources/profiles/client/Client.js +160 -139
  291. package/dist/api/resources/profiles/client/requests/GetListSubscriptionsRequest.d.ts +1 -3
  292. package/dist/api/resources/profiles/client/requests/MergeProfileRequest.d.ts +1 -1
  293. package/dist/api/resources/profiles/client/requests/ReplaceProfileRequest.d.ts +1 -1
  294. package/dist/api/resources/profiles/types/DeviceType.d.ts +1 -1
  295. package/dist/api/resources/profiles/types/Discord.d.ts +1 -1
  296. package/dist/api/resources/profiles/types/Expo.d.ts +1 -1
  297. package/dist/api/resources/profiles/types/MsTeams.d.ts +1 -1
  298. package/dist/api/resources/profiles/types/ProfileUpdateRequest.d.ts +8 -0
  299. package/dist/api/resources/profiles/types/ProfileUpdateRequest.js +5 -0
  300. package/dist/api/resources/profiles/types/Slack.d.ts +1 -1
  301. package/dist/api/resources/profiles/types/SnoozeRuleType.d.ts +1 -1
  302. package/dist/api/resources/profiles/types/UserProfileFirebaseToken.d.ts +1 -1
  303. package/dist/api/resources/profiles/types/WebhookAuthMode.d.ts +1 -1
  304. package/dist/api/resources/profiles/types/WebhookMethod.d.ts +1 -1
  305. package/dist/api/resources/profiles/types/WebhookProfileType.d.ts +1 -1
  306. package/dist/api/resources/profiles/types/index.d.ts +1 -0
  307. package/dist/api/resources/profiles/types/index.js +1 -0
  308. package/dist/api/resources/send/types/Attachment.d.ts +1 -1
  309. package/dist/api/resources/send/types/ChannelSource.d.ts +1 -1
  310. package/dist/api/resources/send/types/Content.d.ts +1 -1
  311. package/dist/api/resources/send/types/Criteria.d.ts +1 -1
  312. package/dist/api/resources/send/types/ElementalNode.d.ts +1 -1
  313. package/dist/api/resources/send/types/ExpiresInType.d.ts +1 -1
  314. package/dist/api/resources/send/types/IActionButtonStyle.d.ts +1 -1
  315. package/dist/api/resources/send/types/IAlignment.d.ts +1 -1
  316. package/dist/api/resources/send/types/IPreferences.d.ts +1 -1
  317. package/dist/api/resources/send/types/InAppPlacement.d.ts +1 -1
  318. package/dist/api/resources/send/types/Locales.d.ts +1 -1
  319. package/dist/api/resources/send/types/Message.d.ts +1 -1
  320. package/dist/api/resources/send/types/MessageChannels.d.ts +1 -1
  321. package/dist/api/resources/send/types/MessageData.d.ts +1 -1
  322. package/dist/api/resources/send/types/MessageProviders.d.ts +1 -1
  323. package/dist/api/resources/send/types/MessageRecipient.d.ts +1 -1
  324. package/dist/api/resources/send/types/Recipient.d.ts +1 -1
  325. package/dist/api/resources/send/types/RecipientData.d.ts +1 -1
  326. package/dist/api/resources/send/types/RoutingChannel.d.ts +1 -1
  327. package/dist/api/resources/send/types/RoutingMethod.d.ts +1 -1
  328. package/dist/api/resources/send/types/RuleType.d.ts +1 -1
  329. package/dist/api/resources/send/types/TextAlign.d.ts +1 -1
  330. package/dist/api/resources/send/types/TextStyle.d.ts +1 -1
  331. package/dist/api/resources/templates/client/Client.d.ts +11 -4
  332. package/dist/api/resources/templates/client/Client.js +34 -25
  333. package/dist/api/resources/templates/client/requests/ListTemplatesRequest.d.ts +1 -3
  334. package/dist/api/resources/templates/types/ChannelIdentifier.d.ts +1 -1
  335. package/dist/api/resources/templates/types/RoutingStrategyMethod.d.ts +1 -1
  336. package/dist/api/resources/tenants/client/Client.d.ts +37 -44
  337. package/dist/api/resources/tenants/client/Client.js +130 -135
  338. package/dist/api/resources/tenants/client/requests/ListTenantParams.d.ts +1 -5
  339. package/dist/api/resources/tenants/client/requests/ListUsersForTenantParams.d.ts +1 -4
  340. package/dist/api/resources/tenants/client/requests/TenantCreateOrReplaceParams.d.ts +6 -21
  341. package/dist/api/resources/tenants/types/SubscriptionTopicStatus.d.ts +1 -1
  342. package/dist/api/resources/tenants/types/TemplateProperty.d.ts +1 -1
  343. package/dist/api/resources/translations/client/Client.d.ts +14 -4
  344. package/dist/api/resources/translations/client/Client.js +49 -37
  345. package/dist/api/resources/users/client/Client.d.ts +5 -7
  346. package/dist/api/resources/users/resources/index.js +17 -7
  347. package/dist/api/resources/users/resources/preferences/client/Client.d.ts +19 -12
  348. package/dist/api/resources/users/resources/preferences/client/Client.js +77 -59
  349. package/dist/api/resources/users/resources/preferences/client/requests/UserPreferencesParams.d.ts +1 -3
  350. package/dist/api/resources/users/resources/preferences/client/requests/UserPreferencesTopicParams.d.ts +1 -3
  351. package/dist/api/resources/users/resources/preferences/client/requests/UserPreferencesUpdateParams.d.ts +2 -2
  352. package/dist/api/resources/users/resources/tenants/client/Client.d.ts +33 -26
  353. package/dist/api/resources/users/resources/tenants/client/Client.js +104 -92
  354. package/dist/api/resources/users/resources/tenants/client/requests/AddUserToMultipleTenantsParams.d.ts +9 -8
  355. package/dist/api/resources/users/resources/tenants/client/requests/AddUserToSingleTenantsParams.d.ts +1 -5
  356. package/dist/api/resources/users/resources/tenants/client/requests/ListTenantsForUserParams.d.ts +1 -4
  357. package/dist/api/resources/users/resources/tokens/client/Client.d.ts +39 -35
  358. package/dist/api/resources/users/resources/tokens/client/Client.js +121 -115
  359. package/dist/api/resources/users/resources/tokens/types/ExpiryDate.d.ts +1 -1
  360. package/dist/api/resources/users/resources/tokens/types/GetAllTokensResponse.d.ts +1 -1
  361. package/dist/api/resources/users/resources/tokens/types/PatchOp.d.ts +1 -1
  362. package/dist/api/resources/users/resources/tokens/types/ProviderKey.d.ts +1 -1
  363. package/dist/api/resources/users/resources/tokens/types/TokenStatus.d.ts +1 -1
  364. package/dist/core/auth/BearerToken.d.ts +1 -1
  365. package/dist/core/fetcher/APIResponse.d.ts +11 -1
  366. package/dist/core/fetcher/Fetcher.d.ts +7 -3
  367. package/dist/core/fetcher/Fetcher.js +37 -135
  368. package/dist/core/fetcher/Headers.d.ts +2 -0
  369. package/dist/core/fetcher/Headers.js +84 -0
  370. package/dist/core/fetcher/HttpResponsePromise.d.ts +58 -0
  371. package/dist/core/fetcher/HttpResponsePromise.js +103 -0
  372. package/dist/core/fetcher/RawResponse.d.ts +29 -0
  373. package/dist/core/fetcher/RawResponse.js +44 -0
  374. package/dist/core/fetcher/Supplier.d.ts +1 -1
  375. package/dist/core/fetcher/createRequestUrl.d.ts +1 -0
  376. package/dist/core/fetcher/createRequestUrl.js +12 -0
  377. package/dist/core/fetcher/getFetchFn.d.ts +4 -0
  378. package/dist/core/fetcher/getFetchFn.js +68 -0
  379. package/dist/core/fetcher/getHeader.js +1 -2
  380. package/dist/core/fetcher/getRequestBody.d.ts +7 -0
  381. package/dist/core/fetcher/getRequestBody.js +23 -0
  382. package/dist/core/fetcher/getResponseBody.d.ts +1 -0
  383. package/dist/core/fetcher/getResponseBody.js +54 -0
  384. package/dist/core/fetcher/index.d.ts +3 -0
  385. package/dist/core/fetcher/index.js +7 -1
  386. package/dist/core/fetcher/makeRequest.d.ts +1 -0
  387. package/dist/core/fetcher/makeRequest.js +42 -0
  388. package/dist/core/fetcher/requestWithRetries.d.ts +1 -0
  389. package/dist/core/fetcher/requestWithRetries.js +40 -0
  390. package/dist/core/fetcher/signals.d.ts +11 -0
  391. package/dist/core/fetcher/signals.js +36 -0
  392. package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +30 -0
  393. package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +247 -0
  394. package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +21 -0
  395. package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +126 -0
  396. package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +31 -0
  397. package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +229 -0
  398. package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +18 -0
  399. package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.js +59 -0
  400. package/dist/core/index.d.ts +1 -1
  401. package/dist/core/index.js +1 -1
  402. package/dist/core/json.d.ts +15 -0
  403. package/dist/core/json.js +24 -0
  404. package/dist/core/runtime/runtime.d.ts +2 -1
  405. package/dist/core/runtime/runtime.js +57 -36
  406. package/dist/environments.d.ts +1 -1
  407. package/dist/errors/CourierError.d.ts +4 -1
  408. package/dist/errors/CourierError.js +6 -8
  409. package/dist/errors/CourierTimeoutError.d.ts +1 -1
  410. package/dist/errors/CourierTimeoutError.js +2 -2
  411. package/dist/index.js +17 -7
  412. package/dist/version.d.ts +1 -0
  413. package/dist/version.js +4 -0
  414. package/environments.d.ts +1 -1
  415. package/errors/CourierError.d.ts +4 -1
  416. package/errors/CourierError.js +6 -8
  417. package/errors/CourierTimeoutError.d.ts +1 -1
  418. package/errors/CourierTimeoutError.js +2 -2
  419. package/index.js +17 -7
  420. package/{jest.config.js → jest.config.mjs} +4 -1
  421. package/package.json +25 -15
  422. package/reference.md +5142 -0
  423. package/scripts/rename-to-esm-files.js +115 -0
  424. package/version.d.ts +1 -0
  425. 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) {
@@ -54,41 +64,38 @@ class AuditEvents {
54
64
  * @param {AuditEvents.RequestOptions} requestOptions - Request-specific configuration.
55
65
  *
56
66
  * @example
57
- * await courier.auditEvents.list({
58
- * cursor: "string"
59
- * })
67
+ * await client.auditEvents.list()
60
68
  */
61
69
  list(request = {}, requestOptions) {
62
- var _a, _b;
63
- return __awaiter(this, void 0, void 0, function* () {
70
+ return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
71
+ }
72
+ __list() {
73
+ return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
74
+ var _a, _b, _c;
64
75
  const { cursor } = request;
65
76
  const _queryParams = {};
66
77
  if (cursor != null) {
67
78
  _queryParams["cursor"] = cursor;
68
79
  }
69
80
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
70
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, "/audit-events"),
81
+ 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, "/audit-events"),
71
82
  method: "GET",
72
- headers: {
73
- Authorization: yield this._getAuthorizationHeader(),
74
- "X-Fern-Language": "JavaScript",
75
- "X-Fern-SDK-Name": "@trycourier/courier",
76
- "X-Fern-SDK-Version": "v6.3.1",
77
- "X-Fern-Runtime": core.RUNTIME.type,
78
- "X-Fern-Runtime-Version": core.RUNTIME.version,
79
- },
83
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@trycourier/courier", "X-Fern-SDK-Version": "6.4.1", "User-Agent": "@trycourier/courier/6.4.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
80
84
  contentType: "application/json",
81
85
  queryParameters: _queryParams,
86
+ requestType: "json",
82
87
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
83
88
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
89
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
84
90
  });
85
91
  if (_response.ok) {
86
- return _response.body;
92
+ return { data: _response.body, rawResponse: _response.rawResponse };
87
93
  }
88
94
  if (_response.error.reason === "status-code") {
89
95
  throw new errors.CourierError({
90
96
  statusCode: _response.error.statusCode,
91
97
  body: _response.error.body,
98
+ rawResponse: _response.rawResponse,
92
99
  });
93
100
  }
94
101
  switch (_response.error.reason) {
@@ -96,12 +103,14 @@ class AuditEvents {
96
103
  throw new errors.CourierError({
97
104
  statusCode: _response.error.statusCode,
98
105
  body: _response.error.rawBody,
106
+ rawResponse: _response.rawResponse,
99
107
  });
100
108
  case "timeout":
101
- throw new errors.CourierTimeoutError();
109
+ throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /audit-events.");
102
110
  case "unknown":
103
111
  throw new errors.CourierError({
104
112
  message: _response.error.errorMessage,
113
+ rawResponse: _response.rawResponse,
105
114
  });
106
115
  }
107
116
  });
@@ -113,33 +122,32 @@ class AuditEvents {
113
122
  * @param {AuditEvents.RequestOptions} requestOptions - Request-specific configuration.
114
123
  *
115
124
  * @example
116
- * await courier.auditEvents.get("string")
125
+ * await client.auditEvents.get("audit-event-id")
117
126
  */
118
127
  get(auditEventId, requestOptions) {
119
- var _a, _b;
128
+ return core.HttpResponsePromise.fromPromise(this.__get(auditEventId, requestOptions));
129
+ }
130
+ __get(auditEventId, requestOptions) {
120
131
  return __awaiter(this, void 0, void 0, function* () {
132
+ var _a, _b, _c;
121
133
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
122
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/audit-events/${encodeURIComponent(auditEventId)}`),
134
+ 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, `/audit-events/${encodeURIComponent(auditEventId)}`),
123
135
  method: "GET",
124
- headers: {
125
- Authorization: yield this._getAuthorizationHeader(),
126
- "X-Fern-Language": "JavaScript",
127
- "X-Fern-SDK-Name": "@trycourier/courier",
128
- "X-Fern-SDK-Version": "v6.3.1",
129
- "X-Fern-Runtime": core.RUNTIME.type,
130
- "X-Fern-Runtime-Version": core.RUNTIME.version,
131
- },
136
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@trycourier/courier", "X-Fern-SDK-Version": "6.4.1", "User-Agent": "@trycourier/courier/6.4.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
132
137
  contentType: "application/json",
138
+ requestType: "json",
133
139
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
134
140
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
141
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
135
142
  });
136
143
  if (_response.ok) {
137
- return _response.body;
144
+ return { data: _response.body, rawResponse: _response.rawResponse };
138
145
  }
139
146
  if (_response.error.reason === "status-code") {
140
147
  throw new errors.CourierError({
141
148
  statusCode: _response.error.statusCode,
142
149
  body: _response.error.body,
150
+ rawResponse: _response.rawResponse,
143
151
  });
144
152
  }
145
153
  switch (_response.error.reason) {
@@ -147,23 +155,25 @@ class AuditEvents {
147
155
  throw new errors.CourierError({
148
156
  statusCode: _response.error.statusCode,
149
157
  body: _response.error.rawBody,
158
+ rawResponse: _response.rawResponse,
150
159
  });
151
160
  case "timeout":
152
- throw new errors.CourierTimeoutError();
161
+ throw new errors.CourierTimeoutError("Timeout exceeded when calling GET /audit-events/{audit-event-id}.");
153
162
  case "unknown":
154
163
  throw new errors.CourierError({
155
164
  message: _response.error.errorMessage,
165
+ rawResponse: _response.rawResponse,
156
166
  });
157
167
  }
158
168
  });
159
169
  }
160
170
  _getAuthorizationHeader() {
161
- var _a;
162
171
  return __awaiter(this, void 0, void 0, function* () {
172
+ var _a;
163
173
  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"];
164
174
  if (bearer == null) {
165
175
  throw new errors.CourierError({
166
- message: "Please specify COURIER_AUTH_TOKEN when instantiating the client.",
176
+ message: "Please specify a bearer by either passing it in to the constructor or initializing a COURIER_AUTH_TOKEN environment variable",
167
177
  });
168
178
  }
169
179
  return `Bearer ${bearer}`;
@@ -3,9 +3,7 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {
7
- * cursor: "string"
8
- * }
6
+ * {}
9
7
  */
10
8
  export interface ListAuditEventsRequest {
11
9
  /**
@@ -7,12 +7,20 @@ import * as Courier from "../../../index";
7
7
  export declare namespace AuthTokens {
8
8
  interface Options {
9
9
  environment?: core.Supplier<environments.CourierEnvironment | string>;
10
+ /** Specify a custom URL to connect the client to. */
11
+ baseUrl?: core.Supplier<string>;
10
12
  authorizationToken?: core.Supplier<core.BearerToken | undefined>;
11
13
  fetcher?: core.FetchFunction;
12
14
  }
13
15
  interface RequestOptions {
16
+ /** The maximum time to wait for a response in seconds. */
14
17
  timeoutInSeconds?: number;
18
+ /** The number of times to retry the request. Defaults to 2. */
15
19
  maxRetries?: number;
20
+ /** A hook to abort the request. */
21
+ abortSignal?: AbortSignal;
22
+ /** Additional headers to include in the request. */
23
+ headers?: Record<string, string>;
16
24
  }
17
25
  interface IdempotentRequestOptions extends RequestOptions {
18
26
  idempotencyKey?: string | undefined;
@@ -29,11 +37,12 @@ export declare class AuthTokens {
29
37
  * @param {AuthTokens.IdempotentRequestOptions} requestOptions - Request-specific configuration.
30
38
  *
31
39
  * @example
32
- * await courier.authTokens.issueToken({
33
- * scope: "string",
34
- * expires_in: "string"
40
+ * await client.authTokens.issueToken({
41
+ * scope: "scope",
42
+ * expires_in: "expires_in"
35
43
  * })
36
44
  */
37
- issueToken(request: Courier.IssueTokenParams, requestOptions?: AuthTokens.IdempotentRequestOptions): Promise<Courier.IssueTokenResponse>;
45
+ issueToken(request: Courier.IssueTokenParams, requestOptions?: AuthTokens.IdempotentRequestOptions): core.HttpResponsePromise<Courier.IssueTokenResponse>;
46
+ private __issueToken;
38
47
  protected _getAuthorizationHeader(): Promise<string>;
39
48
  }
@@ -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) {
@@ -54,39 +64,36 @@ class AuthTokens {
54
64
  * @param {AuthTokens.IdempotentRequestOptions} requestOptions - Request-specific configuration.
55
65
  *
56
66
  * @example
57
- * await courier.authTokens.issueToken({
58
- * scope: "string",
59
- * expires_in: "string"
67
+ * await client.authTokens.issueToken({
68
+ * scope: "scope",
69
+ * expires_in: "expires_in"
60
70
  * })
61
71
  */
62
72
  issueToken(request, requestOptions) {
63
- var _a, _b;
73
+ return core.HttpResponsePromise.fromPromise(this.__issueToken(request, requestOptions));
74
+ }
75
+ __issueToken(request, requestOptions) {
64
76
  return __awaiter(this, void 0, void 0, function* () {
77
+ var _a, _b, _c;
65
78
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
66
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, "/auth/issue-token"),
79
+ 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, "/auth/issue-token"),
67
80
  method: "POST",
68
- headers: {
69
- Authorization: yield this._getAuthorizationHeader(),
70
- "X-Fern-Language": "JavaScript",
71
- "X-Fern-SDK-Name": "@trycourier/courier",
72
- "X-Fern-SDK-Version": "v6.3.1",
73
- "X-Fern-Runtime": core.RUNTIME.type,
74
- "X-Fern-Runtime-Version": core.RUNTIME.version,
75
- "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
76
- "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry : undefined,
77
- },
81
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@trycourier/courier", "X-Fern-SDK-Version": "6.4.1", "User-Agent": "@trycourier/courier/6.4.1", "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),
78
82
  contentType: "application/json",
83
+ requestType: "json",
79
84
  body: request,
80
85
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
81
86
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
87
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
82
88
  });
83
89
  if (_response.ok) {
84
- return _response.body;
90
+ return { data: _response.body, rawResponse: _response.rawResponse };
85
91
  }
86
92
  if (_response.error.reason === "status-code") {
87
93
  throw new errors.CourierError({
88
94
  statusCode: _response.error.statusCode,
89
95
  body: _response.error.body,
96
+ rawResponse: _response.rawResponse,
90
97
  });
91
98
  }
92
99
  switch (_response.error.reason) {
@@ -94,23 +101,25 @@ class AuthTokens {
94
101
  throw new errors.CourierError({
95
102
  statusCode: _response.error.statusCode,
96
103
  body: _response.error.rawBody,
104
+ rawResponse: _response.rawResponse,
97
105
  });
98
106
  case "timeout":
99
- throw new errors.CourierTimeoutError();
107
+ throw new errors.CourierTimeoutError("Timeout exceeded when calling POST /auth/issue-token.");
100
108
  case "unknown":
101
109
  throw new errors.CourierError({
102
110
  message: _response.error.errorMessage,
111
+ rawResponse: _response.rawResponse,
103
112
  });
104
113
  }
105
114
  });
106
115
  }
107
116
  _getAuthorizationHeader() {
108
- var _a;
109
117
  return __awaiter(this, void 0, void 0, function* () {
118
+ var _a;
110
119
  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"];
111
120
  if (bearer == null) {
112
121
  throw new errors.CourierError({
113
- message: "Please specify COURIER_AUTH_TOKEN when instantiating the client.",
122
+ message: "Please specify a bearer by either passing it in to the constructor or initializing a COURIER_AUTH_TOKEN environment variable",
114
123
  });
115
124
  }
116
125
  return `Bearer ${bearer}`;
@@ -4,8 +4,8 @@
4
4
  /**
5
5
  * @example
6
6
  * {
7
- * scope: "string",
8
- * expires_in: "string"
7
+ * scope: "scope",
8
+ * expires_in: "expires_in"
9
9
  * }
10
10
  */
11
11
  export interface IssueTokenParams {
@@ -7,12 +7,20 @@ import * as Courier from "../../../index";
7
7
  export declare namespace Automations {
8
8
  interface Options {
9
9
  environment?: core.Supplier<environments.CourierEnvironment | string>;
10
+ /** Specify a custom URL to connect the client to. */
11
+ baseUrl?: core.Supplier<string>;
10
12
  authorizationToken?: core.Supplier<core.BearerToken | undefined>;
11
13
  fetcher?: core.FetchFunction;
12
14
  }
13
15
  interface RequestOptions {
16
+ /** The maximum time to wait for a response in seconds. */
14
17
  timeoutInSeconds?: number;
18
+ /** The number of times to retry the request. Defaults to 2. */
15
19
  maxRetries?: number;
20
+ /** A hook to abort the request. */
21
+ abortSignal?: AbortSignal;
22
+ /** Additional headers to include in the request. */
23
+ headers?: Record<string, string>;
16
24
  }
17
25
  interface IdempotentRequestOptions extends RequestOptions {
18
26
  idempotencyKey?: string | undefined;
@@ -30,21 +38,16 @@ export declare class Automations {
30
38
  * @param {Automations.IdempotentRequestOptions} requestOptions - Request-specific configuration.
31
39
  *
32
40
  * @example
33
- * await courier.automations.invokeAutomationTemplate("string", {
34
- * brand: "string",
35
- * data: {
36
- * "string": {
37
- * "key": "value"
38
- * }
39
- * },
40
- * profile: {
41
- * "key": "value"
42
- * },
43
- * recipient: "string",
44
- * template: "string"
41
+ * await client.automations.invokeAutomationTemplate("templateId", {
42
+ * brand: undefined,
43
+ * data: undefined,
44
+ * profile: undefined,
45
+ * recipient: undefined,
46
+ * template: undefined
45
47
  * })
46
48
  */
47
- invokeAutomationTemplate(templateId: string, request: Courier.AutomationInvokeParams, requestOptions?: Automations.IdempotentRequestOptions): Promise<Courier.AutomationInvokeResponse>;
49
+ invokeAutomationTemplate(templateId: string, request: Courier.AutomationInvokeParams, requestOptions?: Automations.IdempotentRequestOptions): core.HttpResponsePromise<Courier.AutomationInvokeResponse>;
50
+ private __invokeAutomationTemplate;
48
51
  /**
49
52
  * Invoke an ad hoc automation run. This endpoint accepts a JSON payload with a series of automation steps. For information about what steps are available, checkout the ad hoc automation guide [here](https://www.courier.com/docs/automations/steps/).
50
53
  *
@@ -52,7 +55,7 @@ export declare class Automations {
52
55
  * @param {Automations.IdempotentRequestOptions} requestOptions - Request-specific configuration.
53
56
  *
54
57
  * @example
55
- * await courier.automations.invokeAdHocAutomation({
58
+ * await client.automations.invokeAdHocAutomation({
56
59
  * data: {
57
60
  * "name": "Foo"
58
61
  * },
@@ -72,6 +75,7 @@ export declare class Automations {
72
75
  * }
73
76
  * })
74
77
  */
75
- invokeAdHocAutomation(request: Courier.AutomationAdHocInvokeParams, requestOptions?: Automations.IdempotentRequestOptions): Promise<Courier.AutomationInvokeResponse>;
78
+ invokeAdHocAutomation(request: Courier.AutomationAdHocInvokeParams, requestOptions?: Automations.IdempotentRequestOptions): core.HttpResponsePromise<Courier.AutomationInvokeResponse>;
79
+ private __invokeAdHocAutomation;
76
80
  protected _getAuthorizationHeader(): Promise<string>;
77
81
  }
@@ -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,48 +65,39 @@ class Automations {
55
65
  * @param {Automations.IdempotentRequestOptions} requestOptions - Request-specific configuration.
56
66
  *
57
67
  * @example
58
- * await courier.automations.invokeAutomationTemplate("string", {
59
- * brand: "string",
60
- * data: {
61
- * "string": {
62
- * "key": "value"
63
- * }
64
- * },
65
- * profile: {
66
- * "key": "value"
67
- * },
68
- * recipient: "string",
69
- * template: "string"
68
+ * await client.automations.invokeAutomationTemplate("templateId", {
69
+ * brand: undefined,
70
+ * data: undefined,
71
+ * profile: undefined,
72
+ * recipient: undefined,
73
+ * template: undefined
70
74
  * })
71
75
  */
72
76
  invokeAutomationTemplate(templateId, request, requestOptions) {
73
- var _a, _b;
77
+ return core.HttpResponsePromise.fromPromise(this.__invokeAutomationTemplate(templateId, request, requestOptions));
78
+ }
79
+ __invokeAutomationTemplate(templateId, request, requestOptions) {
74
80
  return __awaiter(this, void 0, void 0, function* () {
81
+ var _a, _b, _c;
75
82
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
76
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/automations/${encodeURIComponent(templateId)}/invoke`),
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, `/automations/${encodeURIComponent(templateId)}/invoke`),
77
84
  method: "POST",
78
- headers: {
79
- Authorization: yield this._getAuthorizationHeader(),
80
- "X-Fern-Language": "JavaScript",
81
- "X-Fern-SDK-Name": "@trycourier/courier",
82
- "X-Fern-SDK-Version": "v6.3.1",
83
- "X-Fern-Runtime": core.RUNTIME.type,
84
- "X-Fern-Runtime-Version": core.RUNTIME.version,
85
- "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
86
- "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry : undefined,
87
- },
85
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@trycourier/courier", "X-Fern-SDK-Version": "6.4.1", "User-Agent": "@trycourier/courier/6.4.1", "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),
88
86
  contentType: "application/json",
87
+ requestType: "json",
89
88
  body: request,
90
89
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
91
90
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
91
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
92
92
  });
93
93
  if (_response.ok) {
94
- return _response.body;
94
+ return { data: _response.body, rawResponse: _response.rawResponse };
95
95
  }
96
96
  if (_response.error.reason === "status-code") {
97
97
  throw new errors.CourierError({
98
98
  statusCode: _response.error.statusCode,
99
99
  body: _response.error.body,
100
+ rawResponse: _response.rawResponse,
100
101
  });
101
102
  }
102
103
  switch (_response.error.reason) {
@@ -104,12 +105,14 @@ class Automations {
104
105
  throw new errors.CourierError({
105
106
  statusCode: _response.error.statusCode,
106
107
  body: _response.error.rawBody,
108
+ rawResponse: _response.rawResponse,
107
109
  });
108
110
  case "timeout":
109
- throw new errors.CourierTimeoutError();
111
+ throw new errors.CourierTimeoutError("Timeout exceeded when calling POST /automations/{templateId}/invoke.");
110
112
  case "unknown":
111
113
  throw new errors.CourierError({
112
114
  message: _response.error.errorMessage,
115
+ rawResponse: _response.rawResponse,
113
116
  });
114
117
  }
115
118
  });
@@ -121,7 +124,7 @@ class Automations {
121
124
  * @param {Automations.IdempotentRequestOptions} requestOptions - Request-specific configuration.
122
125
  *
123
126
  * @example
124
- * await courier.automations.invokeAdHocAutomation({
127
+ * await client.automations.invokeAdHocAutomation({
125
128
  * data: {
126
129
  * "name": "Foo"
127
130
  * },
@@ -142,33 +145,30 @@ class Automations {
142
145
  * })
143
146
  */
144
147
  invokeAdHocAutomation(request, requestOptions) {
145
- var _a, _b;
148
+ return core.HttpResponsePromise.fromPromise(this.__invokeAdHocAutomation(request, requestOptions));
149
+ }
150
+ __invokeAdHocAutomation(request, requestOptions) {
146
151
  return __awaiter(this, void 0, void 0, function* () {
152
+ var _a, _b, _c;
147
153
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
148
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, "/automations/invoke"),
154
+ 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, "/automations/invoke"),
149
155
  method: "POST",
150
- headers: {
151
- Authorization: yield this._getAuthorizationHeader(),
152
- "X-Fern-Language": "JavaScript",
153
- "X-Fern-SDK-Name": "@trycourier/courier",
154
- "X-Fern-SDK-Version": "v6.3.1",
155
- "X-Fern-Runtime": core.RUNTIME.type,
156
- "X-Fern-Runtime-Version": core.RUNTIME.version,
157
- "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
158
- "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry : undefined,
159
- },
156
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@trycourier/courier", "X-Fern-SDK-Version": "6.4.1", "User-Agent": "@trycourier/courier/6.4.1", "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),
160
157
  contentType: "application/json",
158
+ requestType: "json",
161
159
  body: request,
162
160
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
163
161
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
162
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
164
163
  });
165
164
  if (_response.ok) {
166
- return _response.body;
165
+ return { data: _response.body, rawResponse: _response.rawResponse };
167
166
  }
168
167
  if (_response.error.reason === "status-code") {
169
168
  throw new errors.CourierError({
170
169
  statusCode: _response.error.statusCode,
171
170
  body: _response.error.body,
171
+ rawResponse: _response.rawResponse,
172
172
  });
173
173
  }
174
174
  switch (_response.error.reason) {
@@ -176,23 +176,25 @@ class Automations {
176
176
  throw new errors.CourierError({
177
177
  statusCode: _response.error.statusCode,
178
178
  body: _response.error.rawBody,
179
+ rawResponse: _response.rawResponse,
179
180
  });
180
181
  case "timeout":
181
- throw new errors.CourierTimeoutError();
182
+ throw new errors.CourierTimeoutError("Timeout exceeded when calling POST /automations/invoke.");
182
183
  case "unknown":
183
184
  throw new errors.CourierError({
184
185
  message: _response.error.errorMessage,
186
+ rawResponse: _response.rawResponse,
185
187
  });
186
188
  }
187
189
  });
188
190
  }
189
191
  _getAuthorizationHeader() {
190
- var _a;
191
192
  return __awaiter(this, void 0, void 0, function* () {
193
+ var _a;
192
194
  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"];
193
195
  if (bearer == null) {
194
196
  throw new errors.CourierError({
195
- message: "Please specify COURIER_AUTH_TOKEN when instantiating the client.",
197
+ message: "Please specify a bearer by either passing it in to the constructor or initializing a COURIER_AUTH_TOKEN environment variable",
196
198
  });
197
199
  }
198
200
  return `Bearer ${bearer}`;
@@ -1,4 +1,4 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
- export declare type AutomationAddToBatchMaxItemsType = string | number;
4
+ export type AutomationAddToBatchMaxItemsType = string | number;
@@ -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 AutomationAddToBatchRetainType = "first" | "last" | "highest" | "lowest";
4
+ export type AutomationAddToBatchRetainType = "first" | "last" | "highest" | "lowest";
5
5
  export declare const AutomationAddToBatchRetainType: {
6
6
  readonly First: "first";
7
7
  readonly Last: "last";