@trycourier/courier 6.1.0 → 6.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (642) hide show
  1. package/Client.d.ts +31 -2
  2. package/Client.js +35 -6
  3. package/README.md +5 -5
  4. package/api/client/requests/SendMessageRequest.d.ts +28 -1
  5. package/api/client/requests/index.d.ts +1 -1
  6. package/api/resources/audiences/client/Client.d.ts +47 -1
  7. package/api/resources/audiences/client/Client.js +68 -12
  8. package/api/resources/audiences/client/requests/AudienceMembersListParams.d.ts +6 -0
  9. package/api/resources/audiences/client/requests/AudienceUpdateParams.d.ts +13 -1
  10. package/api/resources/audiences/client/requests/AudiencesListParams.d.ts +6 -0
  11. package/api/resources/audiences/client/requests/index.d.ts +3 -3
  12. package/api/resources/audiences/types/Audience.d.ts +1 -1
  13. package/api/resources/audiences/types/AudienceListResponse.d.ts +1 -1
  14. package/api/resources/audiences/types/AudienceMemberGetResponse.d.ts +1 -1
  15. package/api/resources/audiences/types/AudienceMemberListResponse.d.ts +1 -1
  16. package/api/resources/audiences/types/AudienceUpdateResponse.d.ts +1 -1
  17. package/api/resources/audiences/types/BaseFilterConfig.d.ts +1 -1
  18. package/api/resources/audiences/types/Filter.d.ts +1 -1
  19. package/api/resources/audiences/types/FilterConfig.d.ts +1 -1
  20. package/api/resources/audiences/types/NestedFilterConfig.d.ts +1 -1
  21. package/api/resources/audiences/types/Operator.d.ts +1 -1
  22. package/api/resources/audiences/types/SingleFilterConfig.d.ts +1 -1
  23. package/api/resources/auditEvents/client/Client.d.ts +15 -1
  24. package/api/resources/auditEvents/client/Client.js +23 -5
  25. package/api/resources/auditEvents/client/requests/ListAuditEventsRequest.d.ts +6 -0
  26. package/api/resources/auditEvents/client/requests/index.d.ts +1 -1
  27. package/api/resources/auditEvents/types/AuditEvent.d.ts +1 -1
  28. package/api/resources/auditEvents/types/ListAuditEventsResponse.d.ts +1 -1
  29. package/api/resources/authTokens/client/Client.d.ts +11 -2
  30. package/api/resources/authTokens/client/Client.js +15 -6
  31. package/api/resources/authTokens/client/requests/IssueTokenParams.d.ts +7 -0
  32. package/api/resources/authTokens/client/requests/index.d.ts +1 -1
  33. package/api/resources/automations/client/Client.d.ts +45 -2
  34. package/api/resources/automations/client/Client.js +54 -11
  35. package/api/resources/automations/types/AccessorType.d.ts +6 -0
  36. package/api/resources/automations/types/AccessorType.js +5 -0
  37. package/api/resources/automations/types/Automation.d.ts +1 -1
  38. package/api/resources/automations/types/AutomationAdHocInvokeParams.d.ts +1 -1
  39. package/api/resources/automations/types/AutomationAddToBatchMaxItemsType.d.ts +4 -0
  40. package/api/resources/automations/types/AutomationAddToBatchMaxItemsType.js +5 -0
  41. package/api/resources/automations/types/AutomationAddToBatchRetain.d.ts +34 -0
  42. package/api/resources/automations/types/AutomationAddToBatchRetain.js +5 -0
  43. package/api/resources/automations/types/AutomationAddToBatchRetainType.d.ts +10 -0
  44. package/api/resources/automations/types/AutomationAddToBatchRetainType.js +12 -0
  45. package/api/resources/automations/types/AutomationAddToBatchScope.d.ts +9 -0
  46. package/api/resources/automations/types/AutomationAddToBatchScope.js +11 -0
  47. package/api/resources/automations/types/AutomationAddToBatchStep.d.ts +39 -0
  48. package/api/resources/automations/types/AutomationAddToBatchStep.js +5 -0
  49. package/api/resources/automations/types/AutomationAddToDigestStep.d.ts +16 -0
  50. package/api/resources/automations/types/AutomationAddToDigestStep.js +5 -0
  51. package/api/resources/automations/types/AutomationCancelStep.d.ts +1 -1
  52. package/api/resources/automations/types/AutomationDelayStep.d.ts +4 -1
  53. package/api/resources/automations/types/AutomationFetchDataStep.d.ts +31 -0
  54. package/api/resources/automations/types/AutomationFetchDataStep.js +5 -0
  55. package/api/resources/automations/types/AutomationFetchDataWebhook.d.ts +11 -0
  56. package/api/resources/automations/types/AutomationFetchDataWebhook.js +5 -0
  57. package/api/resources/automations/types/AutomationFetchDataWebhookMethod.d.ts +8 -0
  58. package/api/resources/automations/types/AutomationFetchDataWebhookMethod.js +10 -0
  59. package/api/resources/automations/types/AutomationInvokeParams.d.ts +1 -1
  60. package/api/resources/automations/types/AutomationInvokeStep.d.ts +1 -1
  61. package/api/resources/automations/types/AutomationInvokeTemplateParams.d.ts +1 -1
  62. package/api/resources/automations/types/AutomationRunContext.d.ts +1 -1
  63. package/api/resources/automations/types/AutomationSendListStep.d.ts +1 -1
  64. package/api/resources/automations/types/AutomationSendStep.d.ts +1 -1
  65. package/api/resources/automations/types/AutomationStepOption.d.ts +2 -2
  66. package/api/resources/automations/types/AutomationThrottleOnThrottle.d.ts +7 -0
  67. package/api/resources/automations/types/AutomationThrottleOnThrottle.js +5 -0
  68. package/api/resources/automations/types/AutomationThrottleScope.d.ts +9 -0
  69. package/api/resources/automations/types/AutomationThrottleScope.js +11 -0
  70. package/api/resources/automations/types/AutomationThrottleStep.d.ts +31 -0
  71. package/api/resources/automations/types/AutomationThrottleStep.js +5 -0
  72. package/api/resources/automations/types/AutomationUpdateProfileStep.d.ts +1 -1
  73. package/api/resources/automations/types/AutomationV2SendStep.d.ts +1 -1
  74. package/api/resources/automations/types/index.d.ts +13 -1
  75. package/api/resources/automations/types/index.js +13 -1
  76. package/api/resources/brands/client/Client.d.ts +57 -2
  77. package/api/resources/brands/client/Client.js +77 -14
  78. package/api/resources/brands/client/requests/BrandUpdateParameters.d.ts +21 -1
  79. package/api/resources/brands/client/requests/ListBrandsRequest.d.ts +6 -0
  80. package/api/resources/brands/client/requests/index.d.ts +2 -2
  81. package/api/resources/brands/types/Brand.d.ts +1 -1
  82. package/api/resources/brands/types/BrandGetAllResponse.d.ts +1 -1
  83. package/api/resources/brands/types/BrandParameters.d.ts +1 -1
  84. package/api/resources/brands/types/BrandSettings.d.ts +1 -1
  85. package/api/resources/brands/types/BrandSnippets.d.ts +1 -1
  86. package/api/resources/brands/types/BrandsResponse.d.ts +1 -1
  87. package/api/resources/bulk/client/Client.d.ts +67 -2
  88. package/api/resources/bulk/client/Client.js +90 -21
  89. package/api/resources/bulk/client/requests/BulkCreateJobParams.d.ts +24 -1
  90. package/api/resources/bulk/client/requests/index.d.ts +1 -1
  91. package/api/resources/bulk/types/BulkGetJobResponse.d.ts +1 -1
  92. package/api/resources/bulk/types/BulkGetJobUsersResponse.d.ts +1 -1
  93. package/api/resources/bulk/types/BulkIngestUsersParams.d.ts +1 -1
  94. package/api/resources/bulk/types/BulkIngestUsersResponse.d.ts +1 -1
  95. package/api/resources/bulk/types/BulkMessageUserResponse.d.ts +1 -1
  96. package/api/resources/bulk/types/InboundBulkContentMessage.d.ts +1 -1
  97. package/api/resources/bulk/types/InboundBulkMessage.d.ts +1 -1
  98. package/api/resources/bulk/types/InboundBulkMessageUser.d.ts +1 -1
  99. package/api/resources/bulk/types/InboundBulkMessageV2.d.ts +1 -1
  100. package/api/resources/bulk/types/InboundBulkTemplateMessage.d.ts +1 -1
  101. package/api/resources/bulk/types/JobDetails.d.ts +1 -1
  102. package/api/resources/commons/errors/AlreadyExistsError.d.ts +2 -2
  103. package/api/resources/commons/errors/AlreadyExistsError.js +1 -1
  104. package/api/resources/commons/errors/BadRequestError.d.ts +2 -2
  105. package/api/resources/commons/errors/BadRequestError.js +1 -1
  106. package/api/resources/commons/errors/ConflictError.d.ts +2 -2
  107. package/api/resources/commons/errors/ConflictError.js +1 -1
  108. package/api/resources/commons/errors/MessageNotFoundError.d.ts +2 -2
  109. package/api/resources/commons/errors/MessageNotFoundError.js +1 -1
  110. package/api/resources/commons/errors/NotFoundError.d.ts +2 -2
  111. package/api/resources/commons/errors/NotFoundError.js +1 -1
  112. package/api/resources/commons/errors/PaymentRequiredError.d.ts +2 -2
  113. package/api/resources/commons/errors/PaymentRequiredError.js +1 -1
  114. package/api/resources/commons/types/AlreadyExists.d.ts +1 -1
  115. package/api/resources/commons/types/BadRequest.d.ts +1 -1
  116. package/api/resources/commons/types/ChannelPreference.d.ts +1 -1
  117. package/api/resources/commons/types/Conflict.d.ts +1 -1
  118. package/api/resources/commons/types/MessageNotFound.d.ts +1 -1
  119. package/api/resources/commons/types/NotFound.d.ts +1 -1
  120. package/api/resources/commons/types/NotificationPreferenceDetails.d.ts +1 -1
  121. package/api/resources/commons/types/NotificationPreferences.d.ts +1 -1
  122. package/api/resources/commons/types/PaymentRequired.d.ts +1 -1
  123. package/api/resources/commons/types/RecipientPreferences.d.ts +1 -1
  124. package/api/resources/commons/types/UserTenantAssociation.d.ts +4 -3
  125. package/api/resources/lists/client/Client.d.ts +197 -4
  126. package/api/resources/lists/client/Client.js +236 -25
  127. package/api/resources/lists/client/requests/AddSubscribersToList.d.ts +41 -0
  128. package/api/resources/lists/client/requests/AddSubscribersToList.js +5 -0
  129. package/api/resources/lists/client/requests/GetAllListsRequest.d.ts +7 -0
  130. package/api/resources/lists/client/requests/GetSubscriptionForListRequest.d.ts +6 -0
  131. package/api/resources/lists/client/requests/SubscribeUserToListRequest.d.ts +32 -1
  132. package/api/resources/lists/client/requests/SubscribeUsersToListRequest.d.ts +41 -0
  133. package/api/resources/lists/client/requests/SubscribeUsersToListRequest.js +5 -0
  134. package/api/resources/lists/client/requests/index.d.ts +5 -3
  135. package/api/resources/lists/types/ListGetAllResponse.d.ts +1 -1
  136. package/api/resources/lists/types/ListGetSubscriptionsResponse.d.ts +1 -1
  137. package/api/resources/lists/types/ListPutParams.d.ts +1 -1
  138. package/api/resources/lists/types/ListSubscriptionRecipient.d.ts +1 -1
  139. package/api/resources/lists/types/PutSubscriptionsRecipient.d.ts +1 -1
  140. package/api/resources/messages/client/Client.d.ts +59 -2
  141. package/api/resources/messages/client/Client.js +110 -19
  142. package/api/resources/messages/client/requests/GetMessageHistoryRequest.d.ts +6 -0
  143. package/api/resources/messages/client/requests/ListMessagesRequest.d.ts +34 -3
  144. package/api/resources/messages/client/requests/index.d.ts +2 -2
  145. package/api/resources/messages/types/ListMessagesResponse.d.ts +1 -1
  146. package/api/resources/messages/types/MessageDetails.d.ts +1 -1
  147. package/api/resources/messages/types/MessageHistoryResponse.d.ts +1 -2
  148. package/api/resources/messages/types/MessageStatus.d.ts +4 -0
  149. package/api/resources/messages/types/MessageStatus.js +1 -0
  150. package/api/resources/messages/types/RenderOutput.d.ts +1 -1
  151. package/api/resources/messages/types/RenderOutputResponse.d.ts +1 -1
  152. package/api/resources/messages/types/RenderedMessageContent.d.ts +1 -1
  153. package/api/resources/notifications/client/Client.d.ts +113 -1
  154. package/api/resources/notifications/client/Client.js +145 -17
  155. package/api/resources/notifications/client/requests/NotificationDraftUpdateVariationsParams.d.ts +26 -1
  156. package/api/resources/notifications/client/requests/NotificationListParams.d.ts +6 -0
  157. package/api/resources/notifications/client/requests/NotificationUpdateVariationsParams.d.ts +26 -1
  158. package/api/resources/notifications/client/requests/SubmissionChecksReplaceParams.d.ts +11 -1
  159. package/api/resources/notifications/client/requests/index.d.ts +4 -4
  160. package/api/resources/notifications/types/BaseCheck.d.ts +1 -1
  161. package/api/resources/notifications/types/Check.d.ts +1 -1
  162. package/api/resources/notifications/types/MessageRouting.d.ts +1 -1
  163. package/api/resources/notifications/types/MessageRoutingChannel.d.ts +1 -1
  164. package/api/resources/notifications/types/Notification.d.ts +5 -1
  165. package/api/resources/notifications/types/NotificationBlock.d.ts +1 -1
  166. package/api/resources/notifications/types/NotificationChannel.d.ts +1 -1
  167. package/api/resources/notifications/types/NotificationContent.d.ts +1 -1
  168. package/api/resources/notifications/types/NotificationGetContentResponse.d.ts +1 -1
  169. package/api/resources/notifications/types/NotificationListResponse.d.ts +1 -1
  170. package/api/resources/notifications/types/NotificationTag.d.ts +7 -0
  171. package/api/resources/notifications/types/NotificationTag.js +5 -0
  172. package/api/resources/notifications/types/NotificationTagData.d.ts +7 -0
  173. package/api/resources/notifications/types/NotificationTagData.js +5 -0
  174. package/api/resources/notifications/types/SubmissionChecksGetResponse.d.ts +1 -1
  175. package/api/resources/notifications/types/SubmissionChecksReplaceResponse.d.ts +1 -1
  176. package/api/resources/notifications/types/index.d.ts +2 -0
  177. package/api/resources/notifications/types/index.js +2 -0
  178. package/api/resources/profiles/client/Client.d.ts +71 -2
  179. package/api/resources/profiles/client/Client.js +102 -23
  180. package/api/resources/profiles/client/requests/GetListSubscriptionsRequest.d.ts +6 -0
  181. package/api/resources/profiles/client/requests/MergeProfileRequest.d.ts +10 -0
  182. package/api/resources/profiles/client/requests/ReplaceProfileRequest.d.ts +10 -0
  183. package/api/resources/profiles/client/requests/index.d.ts +3 -3
  184. package/api/resources/profiles/types/AirshipProfile.d.ts +1 -1
  185. package/api/resources/profiles/types/Discord.d.ts +1 -1
  186. package/api/resources/profiles/types/Expo.d.ts +1 -1
  187. package/api/resources/profiles/types/GetListSubscriptionsList.d.ts +1 -1
  188. package/api/resources/profiles/types/GetListSubscriptionsResponse.d.ts +1 -1
  189. package/api/resources/profiles/types/Intercom.d.ts +1 -1
  190. package/api/resources/profiles/types/MsTeams.d.ts +1 -1
  191. package/api/resources/profiles/types/MultipleTokens.d.ts +1 -1
  192. package/api/resources/profiles/types/ProfileGetResponse.d.ts +1 -1
  193. package/api/resources/profiles/types/SendToMsTeamsChannelId.d.ts +1 -1
  194. package/api/resources/profiles/types/SendToMsTeamsChannelName.d.ts +1 -1
  195. package/api/resources/profiles/types/SendToMsTeamsConversationId.d.ts +1 -1
  196. package/api/resources/profiles/types/SendToMsTeamsEmail.d.ts +1 -1
  197. package/api/resources/profiles/types/SendToMsTeamsUserId.d.ts +1 -1
  198. package/api/resources/profiles/types/SendToSlackChannel.d.ts +1 -1
  199. package/api/resources/profiles/types/SendToSlackEmail.d.ts +1 -1
  200. package/api/resources/profiles/types/SendToSlackUserId.d.ts +1 -1
  201. package/api/resources/profiles/types/Slack.d.ts +1 -1
  202. package/api/resources/profiles/types/SnoozeRule.d.ts +1 -1
  203. package/api/resources/profiles/types/SubscribeToListsRequest.d.ts +1 -1
  204. package/api/resources/profiles/types/SubscribeToListsRequestListObject.d.ts +1 -1
  205. package/api/resources/profiles/types/UserProfile.d.ts +1 -1
  206. package/api/resources/send/types/AudienceRecipient.d.ts +1 -1
  207. package/api/resources/send/types/BaseMessage.d.ts +1 -1
  208. package/api/resources/send/types/BaseMessageSendTo.d.ts +8 -0
  209. package/api/resources/send/types/BaseMessageSendTo.js +5 -0
  210. package/api/resources/send/types/BrandSettingsEmail.d.ts +1 -1
  211. package/api/resources/send/types/BrandSettingsInApp.d.ts +1 -1
  212. package/api/resources/send/types/BrandSettingsSocialPresence.d.ts +1 -1
  213. package/api/resources/send/types/BrandTemplateOverride.d.ts +1 -1
  214. package/api/resources/send/types/Channel.d.ts +1 -1
  215. package/api/resources/send/types/ChannelMetadata.d.ts +1 -1
  216. package/api/resources/send/types/Content.d.ts +1 -1
  217. package/api/resources/send/types/ContentMessage.d.ts +2 -4
  218. package/api/resources/send/types/ElementalActionNode.d.ts +1 -1
  219. package/api/resources/send/types/ElementalChannelNode.d.ts +1 -1
  220. package/api/resources/send/types/ElementalContent.d.ts +1 -1
  221. package/api/resources/send/types/ElementalDividerNode.d.ts +1 -1
  222. package/api/resources/send/types/ElementalGroupNode.d.ts +1 -1
  223. package/api/resources/send/types/ElementalImageNode.d.ts +1 -1
  224. package/api/resources/send/types/ElementalMetaNode.d.ts +1 -1
  225. package/api/resources/send/types/ElementalNode.d.ts +1 -1
  226. package/api/resources/send/types/ElementalQuoteNode.d.ts +1 -1
  227. package/api/resources/send/types/ElementalTextNode.d.ts +1 -1
  228. package/api/resources/send/types/EmailHeader.d.ts +1 -1
  229. package/api/resources/send/types/Expiry.d.ts +1 -1
  230. package/api/resources/send/types/IPreferences.d.ts +1 -1
  231. package/api/resources/send/types/IProfilePreferences.d.ts +1 -1
  232. package/api/resources/send/types/ListPatternRecipient.d.ts +1 -1
  233. package/api/resources/send/types/ListRecipient.d.ts +1 -1
  234. package/api/resources/send/types/Locales.d.ts +1 -1
  235. package/api/resources/send/types/Message.d.ts +1 -1
  236. package/api/resources/send/types/MessageChannelEmailOverride.d.ts +1 -1
  237. package/api/resources/send/types/MessageChannels.d.ts +1 -1
  238. package/api/resources/send/types/MessageMetadata.d.ts +1 -1
  239. package/api/resources/send/types/MessageProviders.d.ts +1 -1
  240. package/api/resources/send/types/MessageProvidersType.d.ts +1 -1
  241. package/api/resources/send/types/MessageRecipient.d.ts +1 -1
  242. package/api/resources/send/types/Metadata.d.ts +1 -1
  243. package/api/resources/send/types/MsTeamsRecipient.d.ts +1 -1
  244. package/api/resources/send/types/Preference.d.ts +1 -1
  245. package/api/resources/send/types/Recipient.d.ts +2 -2
  246. package/api/resources/send/types/RecipientData.d.ts +4 -0
  247. package/api/resources/send/types/RecipientData.js +5 -0
  248. package/api/resources/send/types/Routing.d.ts +1 -1
  249. package/api/resources/send/types/RoutingChannel.d.ts +1 -1
  250. package/api/resources/send/types/RoutingStrategyChannel.d.ts +1 -1
  251. package/api/resources/send/types/RoutingStrategyProvider.d.ts +1 -1
  252. package/api/resources/send/types/SlackRecipient.d.ts +1 -1
  253. package/api/resources/send/types/TemplateMessage.d.ts +2 -4
  254. package/api/resources/send/types/Timeout.d.ts +1 -1
  255. package/api/resources/send/types/UserRecipient.d.ts +1 -1
  256. package/api/resources/send/types/index.d.ts +2 -0
  257. package/api/resources/send/types/index.js +2 -0
  258. package/api/resources/templates/client/Client.d.ts +9 -1
  259. package/api/resources/templates/client/Client.js +13 -3
  260. package/api/resources/templates/client/requests/ListTemplatesRequest.d.ts +6 -0
  261. package/api/resources/templates/client/requests/index.d.ts +1 -1
  262. package/api/resources/templates/types/ListTemplatesResponse.d.ts +1 -1
  263. package/api/resources/templates/types/NotificationTemplates.d.ts +1 -1
  264. package/api/resources/templates/types/RoutingStrategy.d.ts +1 -1
  265. package/api/resources/templates/types/Tag.d.ts +1 -1
  266. package/api/resources/tenants/client/Client.d.ts +82 -1
  267. package/api/resources/tenants/client/Client.js +190 -13
  268. package/api/resources/tenants/client/requests/ListTenantParams.d.ts +13 -1
  269. package/api/resources/tenants/client/requests/ListUsersForTenantParams.d.ts +7 -0
  270. package/api/resources/tenants/client/requests/TenantCreateOrReplaceParams.d.ts +23 -2
  271. package/api/resources/tenants/client/requests/index.d.ts +3 -3
  272. package/api/resources/tenants/types/DefaultPreferences.d.ts +2 -2
  273. package/api/resources/tenants/types/ListUsersForTenantResponse.d.ts +1 -1
  274. package/api/resources/tenants/types/SubscriptionTopic.d.ts +2 -3
  275. package/api/resources/tenants/types/SubscriptionTopicNew.d.ts +11 -0
  276. package/api/resources/tenants/types/SubscriptionTopicNew.js +5 -0
  277. package/api/resources/tenants/types/TemplateProperty.d.ts +3 -0
  278. package/api/resources/tenants/types/Tenant.d.ts +2 -2
  279. package/api/resources/tenants/types/TenantListResponse.d.ts +1 -1
  280. package/api/resources/tenants/types/index.d.ts +1 -0
  281. package/api/resources/tenants/types/index.js +1 -0
  282. package/api/resources/translations/client/Client.d.ts +17 -0
  283. package/api/resources/translations/client/Client.js +28 -7
  284. package/api/resources/users/resources/preferences/client/Client.d.ts +31 -1
  285. package/api/resources/users/resources/preferences/client/Client.js +45 -9
  286. package/api/resources/users/resources/preferences/client/requests/UserPreferencesUpdateParams.d.ts +12 -6
  287. package/api/resources/users/resources/preferences/client/requests/index.d.ts +1 -1
  288. package/api/resources/users/resources/preferences/types/TopicPreference.d.ts +1 -1
  289. package/api/resources/users/resources/preferences/types/TopicPreferenceUpdate.d.ts +10 -0
  290. package/api/resources/users/resources/preferences/types/TopicPreferenceUpdate.js +5 -0
  291. package/api/resources/users/resources/preferences/types/UserPreferencesGetResponse.d.ts +1 -1
  292. package/api/resources/users/resources/preferences/types/UserPreferencesListResponse.d.ts +1 -1
  293. package/api/resources/users/resources/preferences/types/index.d.ts +1 -0
  294. package/api/resources/users/resources/preferences/types/index.js +1 -0
  295. package/api/resources/users/resources/tenants/client/Client.d.ts +57 -2
  296. package/api/resources/users/resources/tenants/client/Client.js +78 -13
  297. package/api/resources/users/resources/tenants/client/requests/AddUserToMultipleTenantsParams.d.ts +16 -1
  298. package/api/resources/users/resources/tenants/client/requests/AddUserToSingleTenantsParams.d.ts +11 -2
  299. package/api/resources/users/resources/tenants/client/requests/ListTenantsForUserParams.d.ts +7 -0
  300. package/api/resources/users/resources/tenants/client/requests/index.d.ts +3 -3
  301. package/api/resources/users/resources/tenants/types/AddUserToSingleTenantsParamsProfile.d.ts +3 -0
  302. package/api/resources/users/resources/tenants/types/ListTenantsForUserResponse.d.ts +1 -1
  303. package/api/resources/users/resources/tokens/client/Client.d.ts +64 -1
  304. package/api/resources/users/resources/tokens/client/Client.js +86 -13
  305. package/api/resources/users/resources/tokens/types/GetAllTokensResponse.d.ts +1 -1
  306. package/api/resources/users/resources/tokens/types/GetUserTokenResponse.d.ts +1 -1
  307. package/api/resources/users/resources/tokens/types/PatchUserTokenOpts.d.ts +1 -1
  308. package/api/resources/users/resources/tokens/types/PutUserTokenOpts.d.ts +1 -1
  309. package/api/resources/users/resources/tokens/types/PutUserTokensOpts.d.ts +1 -1
  310. package/api/resources/users/resources/tokens/types/UserToken.d.ts +1 -1
  311. package/core/fetcher/Fetcher.d.ts +2 -2
  312. package/core/fetcher/Fetcher.js +60 -6
  313. package/core/index.d.ts +1 -0
  314. package/core/index.js +1 -0
  315. package/core/runtime/index.d.ts +1 -0
  316. package/core/runtime/index.js +5 -0
  317. package/core/runtime/runtime.d.ts +8 -0
  318. package/core/runtime/runtime.js +82 -0
  319. package/dist/Client.d.ts +31 -2
  320. package/dist/Client.js +35 -6
  321. package/dist/api/client/requests/SendMessageRequest.d.ts +28 -1
  322. package/dist/api/client/requests/index.d.ts +1 -1
  323. package/dist/api/resources/audiences/client/Client.d.ts +47 -1
  324. package/dist/api/resources/audiences/client/Client.js +68 -12
  325. package/dist/api/resources/audiences/client/requests/AudienceMembersListParams.d.ts +6 -0
  326. package/dist/api/resources/audiences/client/requests/AudienceUpdateParams.d.ts +13 -1
  327. package/dist/api/resources/audiences/client/requests/AudiencesListParams.d.ts +6 -0
  328. package/dist/api/resources/audiences/client/requests/index.d.ts +3 -3
  329. package/dist/api/resources/audiences/types/Audience.d.ts +1 -1
  330. package/dist/api/resources/audiences/types/AudienceListResponse.d.ts +1 -1
  331. package/dist/api/resources/audiences/types/AudienceMemberGetResponse.d.ts +1 -1
  332. package/dist/api/resources/audiences/types/AudienceMemberListResponse.d.ts +1 -1
  333. package/dist/api/resources/audiences/types/AudienceUpdateResponse.d.ts +1 -1
  334. package/dist/api/resources/audiences/types/BaseFilterConfig.d.ts +1 -1
  335. package/dist/api/resources/audiences/types/Filter.d.ts +1 -1
  336. package/dist/api/resources/audiences/types/FilterConfig.d.ts +1 -1
  337. package/dist/api/resources/audiences/types/NestedFilterConfig.d.ts +1 -1
  338. package/dist/api/resources/audiences/types/Operator.d.ts +1 -1
  339. package/dist/api/resources/audiences/types/SingleFilterConfig.d.ts +1 -1
  340. package/dist/api/resources/auditEvents/client/Client.d.ts +15 -1
  341. package/dist/api/resources/auditEvents/client/Client.js +23 -5
  342. package/dist/api/resources/auditEvents/client/requests/ListAuditEventsRequest.d.ts +6 -0
  343. package/dist/api/resources/auditEvents/client/requests/index.d.ts +1 -1
  344. package/dist/api/resources/auditEvents/types/AuditEvent.d.ts +1 -1
  345. package/dist/api/resources/auditEvents/types/ListAuditEventsResponse.d.ts +1 -1
  346. package/dist/api/resources/authTokens/client/Client.d.ts +11 -2
  347. package/dist/api/resources/authTokens/client/Client.js +15 -6
  348. package/dist/api/resources/authTokens/client/requests/IssueTokenParams.d.ts +7 -0
  349. package/dist/api/resources/authTokens/client/requests/index.d.ts +1 -1
  350. package/dist/api/resources/automations/client/Client.d.ts +45 -2
  351. package/dist/api/resources/automations/client/Client.js +54 -11
  352. package/dist/api/resources/automations/types/AccessorType.d.ts +6 -0
  353. package/dist/api/resources/automations/types/AccessorType.js +5 -0
  354. package/dist/api/resources/automations/types/Automation.d.ts +1 -1
  355. package/dist/api/resources/automations/types/AutomationAdHocInvokeParams.d.ts +1 -1
  356. package/dist/api/resources/automations/types/AutomationAddToBatchMaxItemsType.d.ts +4 -0
  357. package/dist/api/resources/automations/types/AutomationAddToBatchMaxItemsType.js +5 -0
  358. package/dist/api/resources/automations/types/AutomationAddToBatchRetain.d.ts +34 -0
  359. package/dist/api/resources/automations/types/AutomationAddToBatchRetain.js +5 -0
  360. package/dist/api/resources/automations/types/AutomationAddToBatchRetainType.d.ts +10 -0
  361. package/dist/api/resources/automations/types/AutomationAddToBatchRetainType.js +12 -0
  362. package/dist/api/resources/automations/types/AutomationAddToBatchScope.d.ts +9 -0
  363. package/dist/api/resources/automations/types/AutomationAddToBatchScope.js +11 -0
  364. package/dist/api/resources/automations/types/AutomationAddToBatchStep.d.ts +39 -0
  365. package/dist/api/resources/automations/types/AutomationAddToBatchStep.js +5 -0
  366. package/dist/api/resources/automations/types/AutomationAddToDigestStep.d.ts +16 -0
  367. package/dist/api/resources/automations/types/AutomationAddToDigestStep.js +5 -0
  368. package/dist/api/resources/automations/types/AutomationCancelStep.d.ts +1 -1
  369. package/dist/api/resources/automations/types/AutomationDelayStep.d.ts +4 -1
  370. package/dist/api/resources/automations/types/AutomationFetchDataStep.d.ts +31 -0
  371. package/dist/api/resources/automations/types/AutomationFetchDataStep.js +5 -0
  372. package/dist/api/resources/automations/types/AutomationFetchDataWebhook.d.ts +11 -0
  373. package/dist/api/resources/automations/types/AutomationFetchDataWebhook.js +5 -0
  374. package/dist/api/resources/automations/types/AutomationFetchDataWebhookMethod.d.ts +8 -0
  375. package/dist/api/resources/automations/types/AutomationFetchDataWebhookMethod.js +10 -0
  376. package/dist/api/resources/automations/types/AutomationInvokeParams.d.ts +1 -1
  377. package/dist/api/resources/automations/types/AutomationInvokeStep.d.ts +1 -1
  378. package/dist/api/resources/automations/types/AutomationInvokeTemplateParams.d.ts +1 -1
  379. package/dist/api/resources/automations/types/AutomationRunContext.d.ts +1 -1
  380. package/dist/api/resources/automations/types/AutomationSendListStep.d.ts +1 -1
  381. package/dist/api/resources/automations/types/AutomationSendStep.d.ts +1 -1
  382. package/dist/api/resources/automations/types/AutomationStepOption.d.ts +2 -2
  383. package/dist/api/resources/automations/types/AutomationThrottleOnThrottle.d.ts +7 -0
  384. package/dist/api/resources/automations/types/AutomationThrottleOnThrottle.js +5 -0
  385. package/dist/api/resources/automations/types/AutomationThrottleScope.d.ts +9 -0
  386. package/dist/api/resources/automations/types/AutomationThrottleScope.js +11 -0
  387. package/dist/api/resources/automations/types/AutomationThrottleStep.d.ts +31 -0
  388. package/dist/api/resources/automations/types/AutomationThrottleStep.js +5 -0
  389. package/dist/api/resources/automations/types/AutomationUpdateProfileStep.d.ts +1 -1
  390. package/dist/api/resources/automations/types/AutomationV2SendStep.d.ts +1 -1
  391. package/dist/api/resources/automations/types/index.d.ts +13 -1
  392. package/dist/api/resources/automations/types/index.js +13 -1
  393. package/dist/api/resources/brands/client/Client.d.ts +57 -2
  394. package/dist/api/resources/brands/client/Client.js +77 -14
  395. package/dist/api/resources/brands/client/requests/BrandUpdateParameters.d.ts +21 -1
  396. package/dist/api/resources/brands/client/requests/ListBrandsRequest.d.ts +6 -0
  397. package/dist/api/resources/brands/client/requests/index.d.ts +2 -2
  398. package/dist/api/resources/brands/types/Brand.d.ts +1 -1
  399. package/dist/api/resources/brands/types/BrandGetAllResponse.d.ts +1 -1
  400. package/dist/api/resources/brands/types/BrandParameters.d.ts +1 -1
  401. package/dist/api/resources/brands/types/BrandSettings.d.ts +1 -1
  402. package/dist/api/resources/brands/types/BrandSnippets.d.ts +1 -1
  403. package/dist/api/resources/brands/types/BrandsResponse.d.ts +1 -1
  404. package/dist/api/resources/bulk/client/Client.d.ts +67 -2
  405. package/dist/api/resources/bulk/client/Client.js +90 -21
  406. package/dist/api/resources/bulk/client/requests/BulkCreateJobParams.d.ts +24 -1
  407. package/dist/api/resources/bulk/client/requests/index.d.ts +1 -1
  408. package/dist/api/resources/bulk/types/BulkGetJobResponse.d.ts +1 -1
  409. package/dist/api/resources/bulk/types/BulkGetJobUsersResponse.d.ts +1 -1
  410. package/dist/api/resources/bulk/types/BulkIngestUsersParams.d.ts +1 -1
  411. package/dist/api/resources/bulk/types/BulkIngestUsersResponse.d.ts +1 -1
  412. package/dist/api/resources/bulk/types/BulkMessageUserResponse.d.ts +1 -1
  413. package/dist/api/resources/bulk/types/InboundBulkContentMessage.d.ts +1 -1
  414. package/dist/api/resources/bulk/types/InboundBulkMessage.d.ts +1 -1
  415. package/dist/api/resources/bulk/types/InboundBulkMessageUser.d.ts +1 -1
  416. package/dist/api/resources/bulk/types/InboundBulkMessageV2.d.ts +1 -1
  417. package/dist/api/resources/bulk/types/InboundBulkTemplateMessage.d.ts +1 -1
  418. package/dist/api/resources/bulk/types/JobDetails.d.ts +1 -1
  419. package/dist/api/resources/commons/errors/AlreadyExistsError.d.ts +2 -2
  420. package/dist/api/resources/commons/errors/AlreadyExistsError.js +1 -1
  421. package/dist/api/resources/commons/errors/BadRequestError.d.ts +2 -2
  422. package/dist/api/resources/commons/errors/BadRequestError.js +1 -1
  423. package/dist/api/resources/commons/errors/ConflictError.d.ts +2 -2
  424. package/dist/api/resources/commons/errors/ConflictError.js +1 -1
  425. package/dist/api/resources/commons/errors/MessageNotFoundError.d.ts +2 -2
  426. package/dist/api/resources/commons/errors/MessageNotFoundError.js +1 -1
  427. package/dist/api/resources/commons/errors/NotFoundError.d.ts +2 -2
  428. package/dist/api/resources/commons/errors/NotFoundError.js +1 -1
  429. package/dist/api/resources/commons/errors/PaymentRequiredError.d.ts +2 -2
  430. package/dist/api/resources/commons/errors/PaymentRequiredError.js +1 -1
  431. package/dist/api/resources/commons/types/AlreadyExists.d.ts +1 -1
  432. package/dist/api/resources/commons/types/BadRequest.d.ts +1 -1
  433. package/dist/api/resources/commons/types/ChannelPreference.d.ts +1 -1
  434. package/dist/api/resources/commons/types/Conflict.d.ts +1 -1
  435. package/dist/api/resources/commons/types/MessageNotFound.d.ts +1 -1
  436. package/dist/api/resources/commons/types/NotFound.d.ts +1 -1
  437. package/dist/api/resources/commons/types/NotificationPreferenceDetails.d.ts +1 -1
  438. package/dist/api/resources/commons/types/NotificationPreferences.d.ts +1 -1
  439. package/dist/api/resources/commons/types/PaymentRequired.d.ts +1 -1
  440. package/dist/api/resources/commons/types/RecipientPreferences.d.ts +1 -1
  441. package/dist/api/resources/commons/types/UserTenantAssociation.d.ts +4 -3
  442. package/dist/api/resources/lists/client/Client.d.ts +197 -4
  443. package/dist/api/resources/lists/client/Client.js +236 -25
  444. package/dist/api/resources/lists/client/requests/AddSubscribersToList.d.ts +41 -0
  445. package/dist/api/resources/lists/client/requests/AddSubscribersToList.js +5 -0
  446. package/dist/api/resources/lists/client/requests/GetAllListsRequest.d.ts +7 -0
  447. package/dist/api/resources/lists/client/requests/GetSubscriptionForListRequest.d.ts +6 -0
  448. package/dist/api/resources/lists/client/requests/SubscribeUserToListRequest.d.ts +32 -1
  449. package/dist/api/resources/lists/client/requests/SubscribeUsersToListRequest.d.ts +41 -0
  450. package/dist/api/resources/lists/client/requests/SubscribeUsersToListRequest.js +5 -0
  451. package/dist/api/resources/lists/client/requests/index.d.ts +5 -3
  452. package/dist/api/resources/lists/types/ListGetAllResponse.d.ts +1 -1
  453. package/dist/api/resources/lists/types/ListGetSubscriptionsResponse.d.ts +1 -1
  454. package/dist/api/resources/lists/types/ListPutParams.d.ts +1 -1
  455. package/dist/api/resources/lists/types/ListSubscriptionRecipient.d.ts +1 -1
  456. package/dist/api/resources/lists/types/PutSubscriptionsRecipient.d.ts +1 -1
  457. package/dist/api/resources/messages/client/Client.d.ts +59 -2
  458. package/dist/api/resources/messages/client/Client.js +110 -19
  459. package/dist/api/resources/messages/client/requests/GetMessageHistoryRequest.d.ts +6 -0
  460. package/dist/api/resources/messages/client/requests/ListMessagesRequest.d.ts +34 -3
  461. package/dist/api/resources/messages/client/requests/index.d.ts +2 -2
  462. package/dist/api/resources/messages/types/ListMessagesResponse.d.ts +1 -1
  463. package/dist/api/resources/messages/types/MessageDetails.d.ts +1 -1
  464. package/dist/api/resources/messages/types/MessageHistoryResponse.d.ts +1 -2
  465. package/dist/api/resources/messages/types/MessageStatus.d.ts +4 -0
  466. package/dist/api/resources/messages/types/MessageStatus.js +1 -0
  467. package/dist/api/resources/messages/types/RenderOutput.d.ts +1 -1
  468. package/dist/api/resources/messages/types/RenderOutputResponse.d.ts +1 -1
  469. package/dist/api/resources/messages/types/RenderedMessageContent.d.ts +1 -1
  470. package/dist/api/resources/notifications/client/Client.d.ts +113 -1
  471. package/dist/api/resources/notifications/client/Client.js +145 -17
  472. package/dist/api/resources/notifications/client/requests/NotificationDraftUpdateVariationsParams.d.ts +26 -1
  473. package/dist/api/resources/notifications/client/requests/NotificationListParams.d.ts +6 -0
  474. package/dist/api/resources/notifications/client/requests/NotificationUpdateVariationsParams.d.ts +26 -1
  475. package/dist/api/resources/notifications/client/requests/SubmissionChecksReplaceParams.d.ts +11 -1
  476. package/dist/api/resources/notifications/client/requests/index.d.ts +4 -4
  477. package/dist/api/resources/notifications/types/BaseCheck.d.ts +1 -1
  478. package/dist/api/resources/notifications/types/Check.d.ts +1 -1
  479. package/dist/api/resources/notifications/types/MessageRouting.d.ts +1 -1
  480. package/dist/api/resources/notifications/types/MessageRoutingChannel.d.ts +1 -1
  481. package/dist/api/resources/notifications/types/Notification.d.ts +5 -1
  482. package/dist/api/resources/notifications/types/NotificationBlock.d.ts +1 -1
  483. package/dist/api/resources/notifications/types/NotificationChannel.d.ts +1 -1
  484. package/dist/api/resources/notifications/types/NotificationContent.d.ts +1 -1
  485. package/dist/api/resources/notifications/types/NotificationGetContentResponse.d.ts +1 -1
  486. package/dist/api/resources/notifications/types/NotificationListResponse.d.ts +1 -1
  487. package/dist/api/resources/notifications/types/NotificationTag.d.ts +7 -0
  488. package/dist/api/resources/notifications/types/NotificationTag.js +5 -0
  489. package/dist/api/resources/notifications/types/NotificationTagData.d.ts +7 -0
  490. package/dist/api/resources/notifications/types/NotificationTagData.js +5 -0
  491. package/dist/api/resources/notifications/types/SubmissionChecksGetResponse.d.ts +1 -1
  492. package/dist/api/resources/notifications/types/SubmissionChecksReplaceResponse.d.ts +1 -1
  493. package/dist/api/resources/notifications/types/index.d.ts +2 -0
  494. package/dist/api/resources/notifications/types/index.js +2 -0
  495. package/dist/api/resources/profiles/client/Client.d.ts +71 -2
  496. package/dist/api/resources/profiles/client/Client.js +102 -23
  497. package/dist/api/resources/profiles/client/requests/GetListSubscriptionsRequest.d.ts +6 -0
  498. package/dist/api/resources/profiles/client/requests/MergeProfileRequest.d.ts +10 -0
  499. package/dist/api/resources/profiles/client/requests/ReplaceProfileRequest.d.ts +10 -0
  500. package/dist/api/resources/profiles/client/requests/index.d.ts +3 -3
  501. package/dist/api/resources/profiles/types/AirshipProfile.d.ts +1 -1
  502. package/dist/api/resources/profiles/types/Discord.d.ts +1 -1
  503. package/dist/api/resources/profiles/types/Expo.d.ts +1 -1
  504. package/dist/api/resources/profiles/types/GetListSubscriptionsList.d.ts +1 -1
  505. package/dist/api/resources/profiles/types/GetListSubscriptionsResponse.d.ts +1 -1
  506. package/dist/api/resources/profiles/types/Intercom.d.ts +1 -1
  507. package/dist/api/resources/profiles/types/MsTeams.d.ts +1 -1
  508. package/dist/api/resources/profiles/types/MultipleTokens.d.ts +1 -1
  509. package/dist/api/resources/profiles/types/ProfileGetResponse.d.ts +1 -1
  510. package/dist/api/resources/profiles/types/SendToMsTeamsChannelId.d.ts +1 -1
  511. package/dist/api/resources/profiles/types/SendToMsTeamsChannelName.d.ts +1 -1
  512. package/dist/api/resources/profiles/types/SendToMsTeamsConversationId.d.ts +1 -1
  513. package/dist/api/resources/profiles/types/SendToMsTeamsEmail.d.ts +1 -1
  514. package/dist/api/resources/profiles/types/SendToMsTeamsUserId.d.ts +1 -1
  515. package/dist/api/resources/profiles/types/SendToSlackChannel.d.ts +1 -1
  516. package/dist/api/resources/profiles/types/SendToSlackEmail.d.ts +1 -1
  517. package/dist/api/resources/profiles/types/SendToSlackUserId.d.ts +1 -1
  518. package/dist/api/resources/profiles/types/Slack.d.ts +1 -1
  519. package/dist/api/resources/profiles/types/SnoozeRule.d.ts +1 -1
  520. package/dist/api/resources/profiles/types/SubscribeToListsRequest.d.ts +1 -1
  521. package/dist/api/resources/profiles/types/SubscribeToListsRequestListObject.d.ts +1 -1
  522. package/dist/api/resources/profiles/types/UserProfile.d.ts +1 -1
  523. package/dist/api/resources/send/types/AudienceRecipient.d.ts +1 -1
  524. package/dist/api/resources/send/types/BaseMessage.d.ts +1 -1
  525. package/dist/api/resources/send/types/BaseMessageSendTo.d.ts +8 -0
  526. package/dist/api/resources/send/types/BaseMessageSendTo.js +5 -0
  527. package/dist/api/resources/send/types/BrandSettingsEmail.d.ts +1 -1
  528. package/dist/api/resources/send/types/BrandSettingsInApp.d.ts +1 -1
  529. package/dist/api/resources/send/types/BrandSettingsSocialPresence.d.ts +1 -1
  530. package/dist/api/resources/send/types/BrandTemplateOverride.d.ts +1 -1
  531. package/dist/api/resources/send/types/Channel.d.ts +1 -1
  532. package/dist/api/resources/send/types/ChannelMetadata.d.ts +1 -1
  533. package/dist/api/resources/send/types/Content.d.ts +1 -1
  534. package/dist/api/resources/send/types/ContentMessage.d.ts +2 -4
  535. package/dist/api/resources/send/types/ElementalActionNode.d.ts +1 -1
  536. package/dist/api/resources/send/types/ElementalChannelNode.d.ts +1 -1
  537. package/dist/api/resources/send/types/ElementalContent.d.ts +1 -1
  538. package/dist/api/resources/send/types/ElementalDividerNode.d.ts +1 -1
  539. package/dist/api/resources/send/types/ElementalGroupNode.d.ts +1 -1
  540. package/dist/api/resources/send/types/ElementalImageNode.d.ts +1 -1
  541. package/dist/api/resources/send/types/ElementalMetaNode.d.ts +1 -1
  542. package/dist/api/resources/send/types/ElementalNode.d.ts +1 -1
  543. package/dist/api/resources/send/types/ElementalQuoteNode.d.ts +1 -1
  544. package/dist/api/resources/send/types/ElementalTextNode.d.ts +1 -1
  545. package/dist/api/resources/send/types/EmailHeader.d.ts +1 -1
  546. package/dist/api/resources/send/types/Expiry.d.ts +1 -1
  547. package/dist/api/resources/send/types/IPreferences.d.ts +1 -1
  548. package/dist/api/resources/send/types/IProfilePreferences.d.ts +1 -1
  549. package/dist/api/resources/send/types/ListPatternRecipient.d.ts +1 -1
  550. package/dist/api/resources/send/types/ListRecipient.d.ts +1 -1
  551. package/dist/api/resources/send/types/Locales.d.ts +1 -1
  552. package/dist/api/resources/send/types/Message.d.ts +1 -1
  553. package/dist/api/resources/send/types/MessageChannelEmailOverride.d.ts +1 -1
  554. package/dist/api/resources/send/types/MessageChannels.d.ts +1 -1
  555. package/dist/api/resources/send/types/MessageMetadata.d.ts +1 -1
  556. package/dist/api/resources/send/types/MessageProviders.d.ts +1 -1
  557. package/dist/api/resources/send/types/MessageProvidersType.d.ts +1 -1
  558. package/dist/api/resources/send/types/MessageRecipient.d.ts +1 -1
  559. package/dist/api/resources/send/types/Metadata.d.ts +1 -1
  560. package/dist/api/resources/send/types/MsTeamsRecipient.d.ts +1 -1
  561. package/dist/api/resources/send/types/Preference.d.ts +1 -1
  562. package/dist/api/resources/send/types/Recipient.d.ts +2 -2
  563. package/dist/api/resources/send/types/RecipientData.d.ts +4 -0
  564. package/dist/api/resources/send/types/RecipientData.js +5 -0
  565. package/dist/api/resources/send/types/Routing.d.ts +1 -1
  566. package/dist/api/resources/send/types/RoutingChannel.d.ts +1 -1
  567. package/dist/api/resources/send/types/RoutingStrategyChannel.d.ts +1 -1
  568. package/dist/api/resources/send/types/RoutingStrategyProvider.d.ts +1 -1
  569. package/dist/api/resources/send/types/SlackRecipient.d.ts +1 -1
  570. package/dist/api/resources/send/types/TemplateMessage.d.ts +2 -4
  571. package/dist/api/resources/send/types/Timeout.d.ts +1 -1
  572. package/dist/api/resources/send/types/UserRecipient.d.ts +1 -1
  573. package/dist/api/resources/send/types/index.d.ts +2 -0
  574. package/dist/api/resources/send/types/index.js +2 -0
  575. package/dist/api/resources/templates/client/Client.d.ts +9 -1
  576. package/dist/api/resources/templates/client/Client.js +13 -3
  577. package/dist/api/resources/templates/client/requests/ListTemplatesRequest.d.ts +6 -0
  578. package/dist/api/resources/templates/client/requests/index.d.ts +1 -1
  579. package/dist/api/resources/templates/types/ListTemplatesResponse.d.ts +1 -1
  580. package/dist/api/resources/templates/types/NotificationTemplates.d.ts +1 -1
  581. package/dist/api/resources/templates/types/RoutingStrategy.d.ts +1 -1
  582. package/dist/api/resources/templates/types/Tag.d.ts +1 -1
  583. package/dist/api/resources/tenants/client/Client.d.ts +82 -1
  584. package/dist/api/resources/tenants/client/Client.js +190 -13
  585. package/dist/api/resources/tenants/client/requests/ListTenantParams.d.ts +13 -1
  586. package/dist/api/resources/tenants/client/requests/ListUsersForTenantParams.d.ts +7 -0
  587. package/dist/api/resources/tenants/client/requests/TenantCreateOrReplaceParams.d.ts +23 -2
  588. package/dist/api/resources/tenants/client/requests/index.d.ts +3 -3
  589. package/dist/api/resources/tenants/types/DefaultPreferences.d.ts +2 -2
  590. package/dist/api/resources/tenants/types/ListUsersForTenantResponse.d.ts +1 -1
  591. package/dist/api/resources/tenants/types/SubscriptionTopic.d.ts +2 -3
  592. package/dist/api/resources/tenants/types/SubscriptionTopicNew.d.ts +11 -0
  593. package/dist/api/resources/tenants/types/SubscriptionTopicNew.js +5 -0
  594. package/dist/api/resources/tenants/types/TemplateProperty.d.ts +3 -0
  595. package/dist/api/resources/tenants/types/Tenant.d.ts +2 -2
  596. package/dist/api/resources/tenants/types/TenantListResponse.d.ts +1 -1
  597. package/dist/api/resources/tenants/types/index.d.ts +1 -0
  598. package/dist/api/resources/tenants/types/index.js +1 -0
  599. package/dist/api/resources/translations/client/Client.d.ts +17 -0
  600. package/dist/api/resources/translations/client/Client.js +28 -7
  601. package/dist/api/resources/users/resources/preferences/client/Client.d.ts +31 -1
  602. package/dist/api/resources/users/resources/preferences/client/Client.js +45 -9
  603. package/dist/api/resources/users/resources/preferences/client/requests/UserPreferencesUpdateParams.d.ts +12 -6
  604. package/dist/api/resources/users/resources/preferences/client/requests/index.d.ts +1 -1
  605. package/dist/api/resources/users/resources/preferences/types/TopicPreference.d.ts +1 -1
  606. package/dist/api/resources/users/resources/preferences/types/TopicPreferenceUpdate.d.ts +10 -0
  607. package/dist/api/resources/users/resources/preferences/types/TopicPreferenceUpdate.js +5 -0
  608. package/dist/api/resources/users/resources/preferences/types/UserPreferencesGetResponse.d.ts +1 -1
  609. package/dist/api/resources/users/resources/preferences/types/UserPreferencesListResponse.d.ts +1 -1
  610. package/dist/api/resources/users/resources/preferences/types/index.d.ts +1 -0
  611. package/dist/api/resources/users/resources/preferences/types/index.js +1 -0
  612. package/dist/api/resources/users/resources/tenants/client/Client.d.ts +57 -2
  613. package/dist/api/resources/users/resources/tenants/client/Client.js +78 -13
  614. package/dist/api/resources/users/resources/tenants/client/requests/AddUserToMultipleTenantsParams.d.ts +16 -1
  615. package/dist/api/resources/users/resources/tenants/client/requests/AddUserToSingleTenantsParams.d.ts +11 -2
  616. package/dist/api/resources/users/resources/tenants/client/requests/ListTenantsForUserParams.d.ts +7 -0
  617. package/dist/api/resources/users/resources/tenants/client/requests/index.d.ts +3 -3
  618. package/dist/api/resources/users/resources/tenants/types/AddUserToSingleTenantsParamsProfile.d.ts +3 -0
  619. package/dist/api/resources/users/resources/tenants/types/ListTenantsForUserResponse.d.ts +1 -1
  620. package/dist/api/resources/users/resources/tokens/client/Client.d.ts +64 -1
  621. package/dist/api/resources/users/resources/tokens/client/Client.js +86 -13
  622. package/dist/api/resources/users/resources/tokens/types/GetAllTokensResponse.d.ts +1 -1
  623. package/dist/api/resources/users/resources/tokens/types/GetUserTokenResponse.d.ts +1 -1
  624. package/dist/api/resources/users/resources/tokens/types/PatchUserTokenOpts.d.ts +1 -1
  625. package/dist/api/resources/users/resources/tokens/types/PutUserTokenOpts.d.ts +1 -1
  626. package/dist/api/resources/users/resources/tokens/types/PutUserTokensOpts.d.ts +1 -1
  627. package/dist/api/resources/users/resources/tokens/types/UserToken.d.ts +1 -1
  628. package/dist/core/fetcher/Fetcher.d.ts +2 -2
  629. package/dist/core/fetcher/Fetcher.js +60 -6
  630. package/dist/core/index.d.ts +1 -0
  631. package/dist/core/index.js +1 -0
  632. package/dist/core/runtime/index.d.ts +1 -0
  633. package/dist/core/runtime/index.js +5 -0
  634. package/dist/core/runtime/runtime.d.ts +8 -0
  635. package/dist/core/runtime/runtime.js +82 -0
  636. package/jest.config.js +2 -2
  637. package/package.json +8 -6
  638. package/api/resources/automations/types/AutomationStepAction.d.ts +0 -12
  639. package/api/resources/automations/types/AutomationStepAction.js +0 -14
  640. package/dist/api/resources/automations/types/AutomationStepAction.d.ts +0 -12
  641. package/dist/api/resources/automations/types/AutomationStepAction.js +0 -14
  642. package/tests/client.test.ts +0 -11
@@ -6,12 +6,12 @@ export declare namespace Fetcher {
6
6
  method: string;
7
7
  contentType?: string;
8
8
  headers?: Record<string, string | undefined>;
9
- queryParameters?: Record<string, string | string[]>;
9
+ queryParameters?: Record<string, string | string[] | object | object[]>;
10
10
  body?: unknown;
11
11
  timeoutMs?: number;
12
12
  maxRetries?: number;
13
13
  withCredentials?: boolean;
14
- responseType?: "json" | "blob" | "streaming";
14
+ responseType?: "json" | "blob" | "streaming" | "text";
15
15
  }
16
16
  type Error = FailedStatusCodeError | NonJsonError | TimeoutError | UnknownError;
17
17
  interface FailedStatusCodeError {
@@ -1,4 +1,27 @@
1
1
  "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || function (mod) {
19
+ if (mod && mod.__esModule) return mod;
20
+ var result = {};
21
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
+ __setModuleDefault(result, mod);
23
+ return result;
24
+ };
2
25
  var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
26
  function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
27
  return new (P || (P = Promise))(function (resolve, reject) {
@@ -13,8 +36,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
13
36
  };
14
37
  Object.defineProperty(exports, "__esModule", { value: true });
15
38
  exports.fetcher = void 0;
16
- const form_data_1 = __importDefault(require("form-data"));
17
39
  const qs_1 = __importDefault(require("qs"));
40
+ const runtime_1 = require("../runtime");
18
41
  const INITIAL_RETRY_DELAY = 1;
19
42
  const MAX_RETRY_DELAY = 60;
20
43
  const DEFAULT_MAX_RETRIES = 2;
@@ -36,14 +59,42 @@ function fetcherImpl(args) {
36
59
  ? `${args.url}?${qs_1.default.stringify(args.queryParameters, { arrayFormat: "repeat" })}`
37
60
  : args.url;
38
61
  let body = undefined;
39
- if (args.body instanceof form_data_1.default) {
40
- // @ts-expect-error
41
- body = args.body;
62
+ const maybeStringifyBody = (body) => {
63
+ if (body instanceof Uint8Array) {
64
+ return body;
65
+ }
66
+ else {
67
+ return JSON.stringify(body);
68
+ }
69
+ };
70
+ if (runtime_1.RUNTIME.type === "node") {
71
+ if (args.body instanceof (yield Promise.resolve().then(() => __importStar(require("formdata-node")))).FormData) {
72
+ // @ts-expect-error
73
+ body = args.body;
74
+ }
75
+ else {
76
+ body = maybeStringifyBody(args.body);
77
+ }
42
78
  }
43
79
  else {
44
- body = JSON.stringify(args.body);
80
+ if (args.body instanceof (yield Promise.resolve().then(() => __importStar(require("form-data")))).default) {
81
+ // @ts-expect-error
82
+ body = args.body;
83
+ }
84
+ else {
85
+ body = maybeStringifyBody(args.body);
86
+ }
45
87
  }
46
- const fetchFn = typeof fetch == "function" ? fetch : require("node-fetch");
88
+ // In Node.js environments, the SDK always uses`node-fetch`.
89
+ // If not in Node.js the SDK uses global fetch if available,
90
+ // and falls back to node-fetch.
91
+ const fetchFn = runtime_1.RUNTIME.type === "node"
92
+ ? // `.default` is required due to this issue:
93
+ // https://github.com/node-fetch/node-fetch/issues/450#issuecomment-387045223
94
+ (yield Promise.resolve().then(() => __importStar(require("node-fetch")))).default
95
+ : typeof fetch == "function"
96
+ ? fetch
97
+ : (yield Promise.resolve().then(() => __importStar(require("node-fetch")))).default;
47
98
  const makeRequest = () => __awaiter(this, void 0, void 0, function* () {
48
99
  const controller = new AbortController();
49
100
  let abortId = undefined;
@@ -84,6 +135,9 @@ function fetcherImpl(args) {
84
135
  else if (response.body != null && args.responseType === "streaming") {
85
136
  body = response.body;
86
137
  }
138
+ else if (response.body != null && args.responseType === "text") {
139
+ body = yield response.text();
140
+ }
87
141
  else {
88
142
  const text = yield response.text();
89
143
  if (text.length > 0) {
package/core/index.d.ts CHANGED
@@ -1,2 +1,3 @@
1
1
  export * from "./fetcher";
2
2
  export * from "./auth";
3
+ export * from "./runtime";
package/core/index.js CHANGED
@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./fetcher"), exports);
18
18
  __exportStar(require("./auth"), exports);
19
+ __exportStar(require("./runtime"), exports);
@@ -0,0 +1 @@
1
+ export { RUNTIME } from "./runtime";
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.RUNTIME = void 0;
4
+ var runtime_1 = require("./runtime");
5
+ Object.defineProperty(exports, "RUNTIME", { enumerable: true, get: function () { return runtime_1.RUNTIME; } });
@@ -0,0 +1,8 @@
1
+ /**
2
+ * A constant that indicates which environment and version the SDK is running in.
3
+ */
4
+ export declare const RUNTIME: Runtime;
5
+ export interface Runtime {
6
+ type: "browser" | "web-worker" | "deno" | "bun" | "node" | "react-native" | "unknown";
7
+ version?: string;
8
+ }
@@ -0,0 +1,82 @@
1
+ "use strict";
2
+ var _a, _b, _c, _d;
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.RUNTIME = void 0;
5
+ /**
6
+ * A constant that indicates whether the environment the code is running is a Web Browser.
7
+ */
8
+ const isBrowser = typeof window !== "undefined" && typeof window.document !== "undefined";
9
+ /**
10
+ * A constant that indicates whether the environment the code is running is a Web Worker.
11
+ */
12
+ const isWebWorker = typeof self === "object" &&
13
+ // @ts-ignore
14
+ typeof (self === null || self === void 0 ? void 0 : self.importScripts) === "function" &&
15
+ (((_a = self.constructor) === null || _a === void 0 ? void 0 : _a.name) === "DedicatedWorkerGlobalScope" ||
16
+ ((_b = self.constructor) === null || _b === void 0 ? void 0 : _b.name) === "ServiceWorkerGlobalScope" ||
17
+ ((_c = self.constructor) === null || _c === void 0 ? void 0 : _c.name) === "SharedWorkerGlobalScope");
18
+ /**
19
+ * A constant that indicates whether the environment the code is running is Deno.
20
+ */
21
+ const isDeno = typeof Deno !== "undefined" && typeof Deno.version !== "undefined" && typeof Deno.version.deno !== "undefined";
22
+ /**
23
+ * A constant that indicates whether the environment the code is running is Bun.sh.
24
+ */
25
+ const isBun = typeof Bun !== "undefined" && typeof Bun.version !== "undefined";
26
+ /**
27
+ * A constant that indicates whether the environment the code is running is Node.JS.
28
+ */
29
+ const isNode = typeof process !== "undefined" &&
30
+ Boolean(process.version) &&
31
+ Boolean((_d = process.versions) === null || _d === void 0 ? void 0 : _d.node) &&
32
+ // Deno spoofs process.versions.node, see https://deno.land/std@0.177.0/node/process.ts?s=versions
33
+ !isDeno &&
34
+ !isBun;
35
+ /**
36
+ * A constant that indicates whether the environment the code is running is in React-Native.
37
+ * https://github.com/facebook/react-native/blob/main/packages/react-native/Libraries/Core/setUpNavigator.js
38
+ */
39
+ const isReactNative = typeof navigator !== "undefined" && (navigator === null || navigator === void 0 ? void 0 : navigator.product) === "ReactNative";
40
+ /**
41
+ * A constant that indicates which environment and version the SDK is running in.
42
+ */
43
+ exports.RUNTIME = evaluateRuntime();
44
+ function evaluateRuntime() {
45
+ if (isBrowser) {
46
+ return {
47
+ type: "browser",
48
+ version: window.navigator.userAgent,
49
+ };
50
+ }
51
+ if (isWebWorker) {
52
+ return {
53
+ type: "web-worker",
54
+ };
55
+ }
56
+ if (isDeno) {
57
+ return {
58
+ type: "deno",
59
+ version: Deno.version.deno,
60
+ };
61
+ }
62
+ if (isBun) {
63
+ return {
64
+ type: "bun",
65
+ version: Bun.version,
66
+ };
67
+ }
68
+ if (isNode) {
69
+ return {
70
+ type: "node",
71
+ version: process.versions.node,
72
+ };
73
+ }
74
+ if (isReactNative) {
75
+ return {
76
+ type: "react-native",
77
+ };
78
+ }
79
+ return {
80
+ type: "unknown",
81
+ };
82
+ }
package/dist/Client.d.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  */
4
4
  import * as environments from "./environments";
5
5
  import * as core from "./core";
6
- import * as Courier from "./api";
6
+ import * as Courier from "./api/index";
7
7
  import { Audiences } from "./api/resources/audiences/client/Client";
8
8
  import { AuditEvents } from "./api/resources/auditEvents/client/Client";
9
9
  import { AuthTokens } from "./api/resources/authTokens/client/Client";
@@ -30,7 +30,7 @@ export declare namespace CourierClient {
30
30
  }
31
31
  interface IdempotentRequestOptions extends RequestOptions {
32
32
  idempotencyKey?: string | undefined;
33
- idempotencyExpiry?: number | undefined;
33
+ idempotencyExpiry?: string | undefined;
34
34
  }
35
35
  }
36
36
  export declare class CourierClient {
@@ -38,6 +38,35 @@ export declare class CourierClient {
38
38
  constructor(_options?: CourierClient.Options);
39
39
  /**
40
40
  * Use the send API to send a message to one or more recipients.
41
+ *
42
+ * @param {Courier.SendMessageRequest} request
43
+ * @param {CourierClient.IdempotentRequestOptions} requestOptions - Request-specific configuration.
44
+ *
45
+ * @example
46
+ * await courier.send({
47
+ * message: {
48
+ * content: {},
49
+ * data: {
50
+ * "string": {
51
+ * "key": "value"
52
+ * }
53
+ * },
54
+ * brand_id: "string",
55
+ * channels: {
56
+ * "string": {}
57
+ * },
58
+ * context: {},
59
+ * metadata: {},
60
+ * providers: {
61
+ * "string": {}
62
+ * },
63
+ * routing: {},
64
+ * timeout: {},
65
+ * delay: {},
66
+ * expiry: {},
67
+ * to: {}
68
+ * }
69
+ * })
41
70
  */
42
71
  send(request: Courier.SendMessageRequest, requestOptions?: CourierClient.IdempotentRequestOptions): Promise<Courier.SendMessageResponse>;
43
72
  protected _audiences: Audiences | undefined;
package/dist/Client.js CHANGED
@@ -42,7 +42,7 @@ exports.CourierClient = void 0;
42
42
  const environments = __importStar(require("./environments"));
43
43
  const core = __importStar(require("./core"));
44
44
  const url_join_1 = __importDefault(require("url-join"));
45
- const errors = __importStar(require("./errors"));
45
+ const errors = __importStar(require("./errors/index"));
46
46
  const Client_1 = require("./api/resources/audiences/client/Client");
47
47
  const Client_2 = require("./api/resources/auditEvents/client/Client");
48
48
  const Client_3 = require("./api/resources/authTokens/client/Client");
@@ -63,6 +63,35 @@ class CourierClient {
63
63
  }
64
64
  /**
65
65
  * Use the send API to send a message to one or more recipients.
66
+ *
67
+ * @param {Courier.SendMessageRequest} request
68
+ * @param {CourierClient.IdempotentRequestOptions} requestOptions - Request-specific configuration.
69
+ *
70
+ * @example
71
+ * await courier.send({
72
+ * message: {
73
+ * content: {},
74
+ * data: {
75
+ * "string": {
76
+ * "key": "value"
77
+ * }
78
+ * },
79
+ * brand_id: "string",
80
+ * channels: {
81
+ * "string": {}
82
+ * },
83
+ * context: {},
84
+ * metadata: {},
85
+ * providers: {
86
+ * "string": {}
87
+ * },
88
+ * routing: {},
89
+ * timeout: {},
90
+ * delay: {},
91
+ * expiry: {},
92
+ * to: {}
93
+ * }
94
+ * })
66
95
  */
67
96
  send(request, requestOptions) {
68
97
  var _a, _b;
@@ -74,11 +103,11 @@ class CourierClient {
74
103
  Authorization: yield this._getAuthorizationHeader(),
75
104
  "X-Fern-Language": "JavaScript",
76
105
  "X-Fern-SDK-Name": "@trycourier/courier",
77
- "X-Fern-SDK-Version": "v6.1.0",
106
+ "X-Fern-SDK-Version": "v6.1.2",
107
+ "X-Fern-Runtime": core.RUNTIME.type,
108
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
78
109
  "Idempotency-Key": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyKey : undefined,
79
- "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null
80
- ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry.toString()
81
- : undefined,
110
+ "X-Idempotency-Expiration": (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry) != null ? requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.idempotencyExpiry : undefined,
82
111
  },
83
112
  contentType: "application/json",
84
113
  body: request,
@@ -168,7 +197,7 @@ class CourierClient {
168
197
  _getAuthorizationHeader() {
169
198
  var _a;
170
199
  return __awaiter(this, void 0, void 0, function* () {
171
- const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process.env["COURIER_AUTH_TOKEN"];
200
+ 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"];
172
201
  if (bearer == null) {
173
202
  throw new errors.CourierError({
174
203
  message: "Please specify COURIER_AUTH_TOKEN when instantiating the client.",
@@ -1,7 +1,34 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
- import * as Courier from "../..";
4
+ import * as Courier from "../../index";
5
+ /**
6
+ * @example
7
+ * {
8
+ * message: {
9
+ * content: {},
10
+ * data: {
11
+ * "string": {
12
+ * "key": "value"
13
+ * }
14
+ * },
15
+ * brand_id: "string",
16
+ * channels: {
17
+ * "string": {}
18
+ * },
19
+ * context: {},
20
+ * metadata: {},
21
+ * providers: {
22
+ * "string": {}
23
+ * },
24
+ * routing: {},
25
+ * timeout: {},
26
+ * delay: {},
27
+ * expiry: {},
28
+ * to: {}
29
+ * }
30
+ * }
31
+ */
5
32
  export interface SendMessageRequest {
6
33
  /** Defines the message to be delivered */
7
34
  message: Courier.Message;
@@ -1 +1 @@
1
- export { SendMessageRequest } from "./SendMessageRequest";
1
+ export { type SendMessageRequest } from "./SendMessageRequest";
@@ -3,7 +3,7 @@
3
3
  */
4
4
  import * as environments from "../../../../environments";
5
5
  import * as core from "../../../../core";
6
- import * as Courier from "../../..";
6
+ import * as Courier from "../../../index";
7
7
  export declare namespace Audiences {
8
8
  interface Options {
9
9
  environment?: core.Supplier<environments.CourierEnvironment | string>;
@@ -20,24 +20,70 @@ export declare class Audiences {
20
20
  constructor(_options?: Audiences.Options);
21
21
  /**
22
22
  * Returns the specified audience by id.
23
+ *
24
+ * @param {string} audienceId - A unique identifier representing the audience_id
25
+ * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
26
+ *
27
+ * @example
28
+ * await courier.audiences.get("string")
23
29
  */
24
30
  get(audienceId: string, requestOptions?: Audiences.RequestOptions): Promise<Courier.Audience>;
25
31
  /**
26
32
  * Creates or updates audience.
33
+ *
34
+ * @param {string} audienceId - A unique identifier representing the audience id
35
+ * @param {Courier.AudienceUpdateParams} request
36
+ * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
37
+ *
38
+ * @example
39
+ * await courier.audiences.update("string", {
40
+ * name: "string",
41
+ * description: "string",
42
+ * filter: {
43
+ * value: "string",
44
+ * path: "string",
45
+ * operator: Courier.ComparisonOperator.EndsWith
46
+ * }
47
+ * })
27
48
  */
28
49
  update(audienceId: string, request?: Courier.AudienceUpdateParams, requestOptions?: Audiences.RequestOptions): Promise<Courier.AudienceUpdateResponse>;
29
50
  /**
30
51
  * Deletes the specified audience.
52
+ *
53
+ * @param {string} audienceId - A unique identifier representing the audience id
54
+ * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
55
+ *
56
+ * @example
57
+ * await courier.audiences.delete("string")
31
58
  */
32
59
  delete(audienceId: string, requestOptions?: Audiences.RequestOptions): Promise<void>;
33
60
  /**
34
61
  * Get list of members of an audience.
62
+ *
63
+ * @param {string} audienceId - A unique identifier representing the audience id
64
+ * @param {Courier.AudienceMembersListParams} request
65
+ * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
66
+ *
35
67
  * @throws {@link Courier.BadRequestError}
68
+ *
69
+ * @example
70
+ * await courier.audiences.listMembers("string", {
71
+ * cursor: "string"
72
+ * })
36
73
  */
37
74
  listMembers(audienceId: string, request?: Courier.AudienceMembersListParams, requestOptions?: Audiences.RequestOptions): Promise<Courier.AudienceMemberListResponse>;
38
75
  /**
39
76
  * Get the audiences associated with the authorization token.
77
+ *
78
+ * @param {Courier.AudiencesListParams} request
79
+ * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
80
+ *
40
81
  * @throws {@link Courier.BadRequestError}
82
+ *
83
+ * @example
84
+ * await courier.audiences.listAudiences({
85
+ * cursor: "string"
86
+ * })
41
87
  */
42
88
  listAudiences(request?: Courier.AudiencesListParams, requestOptions?: Audiences.RequestOptions): Promise<Courier.AudienceListResponse>;
43
89
  protected _getAuthorizationHeader(): Promise<string>;
@@ -41,27 +41,35 @@ Object.defineProperty(exports, "__esModule", { value: true });
41
41
  exports.Audiences = void 0;
42
42
  const environments = __importStar(require("../../../../environments"));
43
43
  const core = __importStar(require("../../../../core"));
44
- const Courier = __importStar(require("../../.."));
44
+ const Courier = __importStar(require("../../../index"));
45
45
  const url_join_1 = __importDefault(require("url-join"));
46
- const errors = __importStar(require("../../../../errors"));
46
+ const errors = __importStar(require("../../../../errors/index"));
47
47
  class Audiences {
48
48
  constructor(_options = {}) {
49
49
  this._options = _options;
50
50
  }
51
51
  /**
52
52
  * Returns the specified audience by id.
53
+ *
54
+ * @param {string} audienceId - A unique identifier representing the audience_id
55
+ * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
56
+ *
57
+ * @example
58
+ * await courier.audiences.get("string")
53
59
  */
54
60
  get(audienceId, requestOptions) {
55
61
  var _a, _b;
56
62
  return __awaiter(this, void 0, void 0, function* () {
57
63
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
58
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/audiences/${audienceId}`),
64
+ url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/audiences/${encodeURIComponent(audienceId)}`),
59
65
  method: "GET",
60
66
  headers: {
61
67
  Authorization: yield this._getAuthorizationHeader(),
62
68
  "X-Fern-Language": "JavaScript",
63
69
  "X-Fern-SDK-Name": "@trycourier/courier",
64
- "X-Fern-SDK-Version": "v6.1.0",
70
+ "X-Fern-SDK-Version": "v6.1.2",
71
+ "X-Fern-Runtime": core.RUNTIME.type,
72
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
65
73
  },
66
74
  contentType: "application/json",
67
75
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -93,18 +101,35 @@ class Audiences {
93
101
  }
94
102
  /**
95
103
  * Creates or updates audience.
104
+ *
105
+ * @param {string} audienceId - A unique identifier representing the audience id
106
+ * @param {Courier.AudienceUpdateParams} request
107
+ * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
108
+ *
109
+ * @example
110
+ * await courier.audiences.update("string", {
111
+ * name: "string",
112
+ * description: "string",
113
+ * filter: {
114
+ * value: "string",
115
+ * path: "string",
116
+ * operator: Courier.ComparisonOperator.EndsWith
117
+ * }
118
+ * })
96
119
  */
97
120
  update(audienceId, request = {}, requestOptions) {
98
121
  var _a, _b;
99
122
  return __awaiter(this, void 0, void 0, function* () {
100
123
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
101
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/audiences/${audienceId}`),
124
+ url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/audiences/${encodeURIComponent(audienceId)}`),
102
125
  method: "PUT",
103
126
  headers: {
104
127
  Authorization: yield this._getAuthorizationHeader(),
105
128
  "X-Fern-Language": "JavaScript",
106
129
  "X-Fern-SDK-Name": "@trycourier/courier",
107
- "X-Fern-SDK-Version": "v6.1.0",
130
+ "X-Fern-SDK-Version": "v6.1.2",
131
+ "X-Fern-Runtime": core.RUNTIME.type,
132
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
108
133
  },
109
134
  contentType: "application/json",
110
135
  body: request,
@@ -137,18 +162,26 @@ class Audiences {
137
162
  }
138
163
  /**
139
164
  * Deletes the specified audience.
165
+ *
166
+ * @param {string} audienceId - A unique identifier representing the audience id
167
+ * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
168
+ *
169
+ * @example
170
+ * await courier.audiences.delete("string")
140
171
  */
141
172
  delete(audienceId, requestOptions) {
142
173
  var _a, _b;
143
174
  return __awaiter(this, void 0, void 0, function* () {
144
175
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
145
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/audiences/${audienceId}`),
176
+ url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/audiences/${encodeURIComponent(audienceId)}`),
146
177
  method: "DELETE",
147
178
  headers: {
148
179
  Authorization: yield this._getAuthorizationHeader(),
149
180
  "X-Fern-Language": "JavaScript",
150
181
  "X-Fern-SDK-Name": "@trycourier/courier",
151
- "X-Fern-SDK-Version": "v6.1.0",
182
+ "X-Fern-SDK-Version": "v6.1.2",
183
+ "X-Fern-Runtime": core.RUNTIME.type,
184
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
152
185
  },
153
186
  contentType: "application/json",
154
187
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -180,7 +213,17 @@ class Audiences {
180
213
  }
181
214
  /**
182
215
  * Get list of members of an audience.
216
+ *
217
+ * @param {string} audienceId - A unique identifier representing the audience id
218
+ * @param {Courier.AudienceMembersListParams} request
219
+ * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
220
+ *
183
221
  * @throws {@link Courier.BadRequestError}
222
+ *
223
+ * @example
224
+ * await courier.audiences.listMembers("string", {
225
+ * cursor: "string"
226
+ * })
184
227
  */
185
228
  listMembers(audienceId, request = {}, requestOptions) {
186
229
  var _a, _b;
@@ -191,13 +234,15 @@ class Audiences {
191
234
  _queryParams["cursor"] = cursor;
192
235
  }
193
236
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
194
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/audiences/${audienceId}/members`),
237
+ url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/audiences/${encodeURIComponent(audienceId)}/members`),
195
238
  method: "GET",
196
239
  headers: {
197
240
  Authorization: yield this._getAuthorizationHeader(),
198
241
  "X-Fern-Language": "JavaScript",
199
242
  "X-Fern-SDK-Name": "@trycourier/courier",
200
- "X-Fern-SDK-Version": "v6.1.0",
243
+ "X-Fern-SDK-Version": "v6.1.2",
244
+ "X-Fern-Runtime": core.RUNTIME.type,
245
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
201
246
  },
202
247
  contentType: "application/json",
203
248
  queryParameters: _queryParams,
@@ -235,7 +280,16 @@ class Audiences {
235
280
  }
236
281
  /**
237
282
  * Get the audiences associated with the authorization token.
283
+ *
284
+ * @param {Courier.AudiencesListParams} request
285
+ * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
286
+ *
238
287
  * @throws {@link Courier.BadRequestError}
288
+ *
289
+ * @example
290
+ * await courier.audiences.listAudiences({
291
+ * cursor: "string"
292
+ * })
239
293
  */
240
294
  listAudiences(request = {}, requestOptions) {
241
295
  var _a, _b;
@@ -252,7 +306,9 @@ class Audiences {
252
306
  Authorization: yield this._getAuthorizationHeader(),
253
307
  "X-Fern-Language": "JavaScript",
254
308
  "X-Fern-SDK-Name": "@trycourier/courier",
255
- "X-Fern-SDK-Version": "v6.1.0",
309
+ "X-Fern-SDK-Version": "v6.1.2",
310
+ "X-Fern-Runtime": core.RUNTIME.type,
311
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
256
312
  },
257
313
  contentType: "application/json",
258
314
  queryParameters: _queryParams,
@@ -291,7 +347,7 @@ class Audiences {
291
347
  _getAuthorizationHeader() {
292
348
  var _a;
293
349
  return __awaiter(this, void 0, void 0, function* () {
294
- const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process.env["COURIER_AUTH_TOKEN"];
350
+ 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"];
295
351
  if (bearer == null) {
296
352
  throw new errors.CourierError({
297
353
  message: "Please specify COURIER_AUTH_TOKEN when instantiating the client.",
@@ -1,6 +1,12 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
+ /**
5
+ * @example
6
+ * {
7
+ * cursor: "string"
8
+ * }
9
+ */
4
10
  export interface AudienceMembersListParams {
5
11
  /**
6
12
  * A unique identifier that allows for fetching the next set of members