@trycourier/courier 6.1.1 → 6.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (573) hide show
  1. package/Client.d.ts +31 -2
  2. package/Client.js +35 -6
  3. package/api/client/requests/SendMessageRequest.d.ts +28 -1
  4. package/api/client/requests/index.d.ts +1 -1
  5. package/api/resources/audiences/client/Client.d.ts +47 -1
  6. package/api/resources/audiences/client/Client.js +68 -12
  7. package/api/resources/audiences/client/requests/AudienceMembersListParams.d.ts +6 -0
  8. package/api/resources/audiences/client/requests/AudienceUpdateParams.d.ts +13 -1
  9. package/api/resources/audiences/client/requests/AudiencesListParams.d.ts +6 -0
  10. package/api/resources/audiences/client/requests/index.d.ts +3 -3
  11. package/api/resources/audiences/types/Audience.d.ts +1 -1
  12. package/api/resources/audiences/types/AudienceListResponse.d.ts +1 -1
  13. package/api/resources/audiences/types/AudienceMemberGetResponse.d.ts +1 -1
  14. package/api/resources/audiences/types/AudienceMemberListResponse.d.ts +1 -1
  15. package/api/resources/audiences/types/AudienceUpdateResponse.d.ts +1 -1
  16. package/api/resources/audiences/types/BaseFilterConfig.d.ts +1 -1
  17. package/api/resources/audiences/types/Filter.d.ts +1 -1
  18. package/api/resources/audiences/types/FilterConfig.d.ts +1 -1
  19. package/api/resources/audiences/types/NestedFilterConfig.d.ts +1 -1
  20. package/api/resources/audiences/types/Operator.d.ts +1 -1
  21. package/api/resources/audiences/types/SingleFilterConfig.d.ts +1 -1
  22. package/api/resources/auditEvents/client/Client.d.ts +15 -1
  23. package/api/resources/auditEvents/client/Client.js +23 -5
  24. package/api/resources/auditEvents/client/requests/ListAuditEventsRequest.d.ts +6 -0
  25. package/api/resources/auditEvents/client/requests/index.d.ts +1 -1
  26. package/api/resources/auditEvents/types/AuditEvent.d.ts +1 -1
  27. package/api/resources/auditEvents/types/ListAuditEventsResponse.d.ts +1 -1
  28. package/api/resources/authTokens/client/Client.d.ts +11 -2
  29. package/api/resources/authTokens/client/Client.js +15 -6
  30. package/api/resources/authTokens/client/requests/IssueTokenParams.d.ts +7 -0
  31. package/api/resources/authTokens/client/requests/index.d.ts +1 -1
  32. package/api/resources/automations/client/Client.d.ts +31 -3
  33. package/api/resources/automations/client/Client.js +40 -12
  34. package/api/resources/automations/types/Automation.d.ts +1 -1
  35. package/api/resources/automations/types/AutomationAdHocInvokeParams.d.ts +1 -1
  36. package/api/resources/automations/types/AutomationAddToBatchRetain.d.ts +1 -1
  37. package/api/resources/automations/types/AutomationAddToBatchStep.d.ts +1 -1
  38. package/api/resources/automations/types/AutomationAddToDigestStep.d.ts +1 -1
  39. package/api/resources/automations/types/AutomationCancelStep.d.ts +1 -1
  40. package/api/resources/automations/types/AutomationDelayStep.d.ts +1 -1
  41. package/api/resources/automations/types/AutomationFetchDataStep.d.ts +1 -1
  42. package/api/resources/automations/types/AutomationFetchDataWebhook.d.ts +1 -1
  43. package/api/resources/automations/types/AutomationInvokeParams.d.ts +1 -1
  44. package/api/resources/automations/types/AutomationInvokeStep.d.ts +1 -1
  45. package/api/resources/automations/types/AutomationInvokeTemplateParams.d.ts +1 -1
  46. package/api/resources/automations/types/AutomationRunContext.d.ts +1 -1
  47. package/api/resources/automations/types/AutomationSendListStep.d.ts +1 -1
  48. package/api/resources/automations/types/AutomationSendStep.d.ts +1 -1
  49. package/api/resources/automations/types/AutomationStepOption.d.ts +1 -1
  50. package/api/resources/automations/types/AutomationThrottleStep.d.ts +1 -1
  51. package/api/resources/automations/types/AutomationUpdateProfileStep.d.ts +1 -1
  52. package/api/resources/automations/types/AutomationV2SendStep.d.ts +1 -1
  53. package/api/resources/brands/client/Client.d.ts +57 -2
  54. package/api/resources/brands/client/Client.js +77 -14
  55. package/api/resources/brands/client/requests/BrandUpdateParameters.d.ts +21 -1
  56. package/api/resources/brands/client/requests/ListBrandsRequest.d.ts +6 -0
  57. package/api/resources/brands/client/requests/index.d.ts +2 -2
  58. package/api/resources/brands/types/Brand.d.ts +1 -1
  59. package/api/resources/brands/types/BrandGetAllResponse.d.ts +1 -1
  60. package/api/resources/brands/types/BrandParameters.d.ts +1 -1
  61. package/api/resources/brands/types/BrandSettings.d.ts +1 -1
  62. package/api/resources/brands/types/BrandSnippets.d.ts +1 -1
  63. package/api/resources/brands/types/BrandsResponse.d.ts +1 -1
  64. package/api/resources/bulk/client/Client.d.ts +67 -2
  65. package/api/resources/bulk/client/Client.js +90 -21
  66. package/api/resources/bulk/client/requests/BulkCreateJobParams.d.ts +24 -1
  67. package/api/resources/bulk/client/requests/index.d.ts +1 -1
  68. package/api/resources/bulk/types/BulkGetJobResponse.d.ts +1 -1
  69. package/api/resources/bulk/types/BulkGetJobUsersResponse.d.ts +1 -1
  70. package/api/resources/bulk/types/BulkIngestUsersParams.d.ts +1 -1
  71. package/api/resources/bulk/types/BulkIngestUsersResponse.d.ts +1 -1
  72. package/api/resources/bulk/types/BulkMessageUserResponse.d.ts +1 -1
  73. package/api/resources/bulk/types/InboundBulkContentMessage.d.ts +1 -1
  74. package/api/resources/bulk/types/InboundBulkMessage.d.ts +1 -1
  75. package/api/resources/bulk/types/InboundBulkMessageUser.d.ts +1 -1
  76. package/api/resources/bulk/types/InboundBulkMessageV2.d.ts +1 -1
  77. package/api/resources/bulk/types/InboundBulkTemplateMessage.d.ts +1 -1
  78. package/api/resources/bulk/types/JobDetails.d.ts +1 -1
  79. package/api/resources/commons/errors/AlreadyExistsError.d.ts +2 -2
  80. package/api/resources/commons/errors/AlreadyExistsError.js +1 -1
  81. package/api/resources/commons/errors/BadRequestError.d.ts +2 -2
  82. package/api/resources/commons/errors/BadRequestError.js +1 -1
  83. package/api/resources/commons/errors/ConflictError.d.ts +2 -2
  84. package/api/resources/commons/errors/ConflictError.js +1 -1
  85. package/api/resources/commons/errors/MessageNotFoundError.d.ts +2 -2
  86. package/api/resources/commons/errors/MessageNotFoundError.js +1 -1
  87. package/api/resources/commons/errors/NotFoundError.d.ts +2 -2
  88. package/api/resources/commons/errors/NotFoundError.js +1 -1
  89. package/api/resources/commons/errors/PaymentRequiredError.d.ts +2 -2
  90. package/api/resources/commons/errors/PaymentRequiredError.js +1 -1
  91. package/api/resources/commons/types/AlreadyExists.d.ts +1 -1
  92. package/api/resources/commons/types/BadRequest.d.ts +1 -1
  93. package/api/resources/commons/types/ChannelPreference.d.ts +1 -1
  94. package/api/resources/commons/types/Conflict.d.ts +1 -1
  95. package/api/resources/commons/types/MessageNotFound.d.ts +1 -1
  96. package/api/resources/commons/types/NotFound.d.ts +1 -1
  97. package/api/resources/commons/types/NotificationPreferenceDetails.d.ts +1 -1
  98. package/api/resources/commons/types/NotificationPreferences.d.ts +1 -1
  99. package/api/resources/commons/types/PaymentRequired.d.ts +1 -1
  100. package/api/resources/commons/types/RecipientPreferences.d.ts +1 -1
  101. package/api/resources/commons/types/UserTenantAssociation.d.ts +4 -3
  102. package/api/resources/lists/client/Client.d.ts +197 -4
  103. package/api/resources/lists/client/Client.js +236 -25
  104. package/api/resources/lists/client/requests/AddSubscribersToList.d.ts +41 -0
  105. package/api/resources/lists/client/requests/AddSubscribersToList.js +5 -0
  106. package/api/resources/lists/client/requests/GetAllListsRequest.d.ts +7 -0
  107. package/api/resources/lists/client/requests/GetSubscriptionForListRequest.d.ts +6 -0
  108. package/api/resources/lists/client/requests/SubscribeUserToListRequest.d.ts +32 -1
  109. package/api/resources/lists/client/requests/SubscribeUsersToListRequest.d.ts +41 -0
  110. package/api/resources/lists/client/requests/SubscribeUsersToListRequest.js +5 -0
  111. package/api/resources/lists/client/requests/index.d.ts +5 -3
  112. package/api/resources/lists/types/ListGetAllResponse.d.ts +1 -1
  113. package/api/resources/lists/types/ListGetSubscriptionsResponse.d.ts +1 -1
  114. package/api/resources/lists/types/ListPutParams.d.ts +1 -1
  115. package/api/resources/lists/types/ListSubscriptionRecipient.d.ts +1 -1
  116. package/api/resources/lists/types/PutSubscriptionsRecipient.d.ts +1 -1
  117. package/api/resources/messages/client/Client.d.ts +59 -2
  118. package/api/resources/messages/client/Client.js +89 -28
  119. package/api/resources/messages/client/requests/GetMessageHistoryRequest.d.ts +6 -0
  120. package/api/resources/messages/client/requests/ListMessagesRequest.d.ts +19 -8
  121. package/api/resources/messages/client/requests/index.d.ts +2 -2
  122. package/api/resources/messages/types/ListMessagesResponse.d.ts +1 -1
  123. package/api/resources/messages/types/MessageDetails.d.ts +1 -1
  124. package/api/resources/messages/types/MessageHistoryResponse.d.ts +1 -2
  125. package/api/resources/messages/types/RenderOutput.d.ts +1 -1
  126. package/api/resources/messages/types/RenderOutputResponse.d.ts +1 -1
  127. package/api/resources/messages/types/RenderedMessageContent.d.ts +1 -1
  128. package/api/resources/notifications/client/Client.d.ts +113 -1
  129. package/api/resources/notifications/client/Client.js +145 -17
  130. package/api/resources/notifications/client/requests/NotificationDraftUpdateVariationsParams.d.ts +26 -1
  131. package/api/resources/notifications/client/requests/NotificationListParams.d.ts +6 -0
  132. package/api/resources/notifications/client/requests/NotificationUpdateVariationsParams.d.ts +26 -1
  133. package/api/resources/notifications/client/requests/SubmissionChecksReplaceParams.d.ts +11 -1
  134. package/api/resources/notifications/client/requests/index.d.ts +4 -4
  135. package/api/resources/notifications/types/BaseCheck.d.ts +1 -1
  136. package/api/resources/notifications/types/Check.d.ts +1 -1
  137. package/api/resources/notifications/types/MessageRouting.d.ts +1 -1
  138. package/api/resources/notifications/types/MessageRoutingChannel.d.ts +1 -1
  139. package/api/resources/notifications/types/Notification.d.ts +5 -1
  140. package/api/resources/notifications/types/NotificationBlock.d.ts +1 -1
  141. package/api/resources/notifications/types/NotificationChannel.d.ts +1 -1
  142. package/api/resources/notifications/types/NotificationContent.d.ts +1 -1
  143. package/api/resources/notifications/types/NotificationGetContentResponse.d.ts +1 -1
  144. package/api/resources/notifications/types/NotificationListResponse.d.ts +1 -1
  145. package/api/resources/notifications/types/NotificationTag.d.ts +7 -0
  146. package/api/resources/notifications/types/NotificationTag.js +5 -0
  147. package/api/resources/notifications/types/NotificationTagData.d.ts +7 -0
  148. package/api/resources/notifications/types/NotificationTagData.js +5 -0
  149. package/api/resources/notifications/types/SubmissionChecksGetResponse.d.ts +1 -1
  150. package/api/resources/notifications/types/SubmissionChecksReplaceResponse.d.ts +1 -1
  151. package/api/resources/notifications/types/index.d.ts +2 -0
  152. package/api/resources/notifications/types/index.js +2 -0
  153. package/api/resources/profiles/client/Client.d.ts +71 -2
  154. package/api/resources/profiles/client/Client.js +102 -23
  155. package/api/resources/profiles/client/requests/GetListSubscriptionsRequest.d.ts +6 -0
  156. package/api/resources/profiles/client/requests/MergeProfileRequest.d.ts +10 -0
  157. package/api/resources/profiles/client/requests/ReplaceProfileRequest.d.ts +10 -0
  158. package/api/resources/profiles/client/requests/index.d.ts +3 -3
  159. package/api/resources/profiles/types/AirshipProfile.d.ts +1 -1
  160. package/api/resources/profiles/types/Discord.d.ts +1 -1
  161. package/api/resources/profiles/types/Expo.d.ts +1 -1
  162. package/api/resources/profiles/types/GetListSubscriptionsList.d.ts +1 -1
  163. package/api/resources/profiles/types/GetListSubscriptionsResponse.d.ts +1 -1
  164. package/api/resources/profiles/types/Intercom.d.ts +1 -1
  165. package/api/resources/profiles/types/MsTeams.d.ts +1 -1
  166. package/api/resources/profiles/types/MultipleTokens.d.ts +1 -1
  167. package/api/resources/profiles/types/ProfileGetResponse.d.ts +1 -1
  168. package/api/resources/profiles/types/SendToMsTeamsChannelId.d.ts +1 -1
  169. package/api/resources/profiles/types/SendToMsTeamsChannelName.d.ts +1 -1
  170. package/api/resources/profiles/types/SendToMsTeamsConversationId.d.ts +1 -1
  171. package/api/resources/profiles/types/SendToMsTeamsEmail.d.ts +1 -1
  172. package/api/resources/profiles/types/SendToMsTeamsUserId.d.ts +1 -1
  173. package/api/resources/profiles/types/SendToSlackChannel.d.ts +1 -1
  174. package/api/resources/profiles/types/SendToSlackEmail.d.ts +1 -1
  175. package/api/resources/profiles/types/SendToSlackUserId.d.ts +1 -1
  176. package/api/resources/profiles/types/Slack.d.ts +1 -1
  177. package/api/resources/profiles/types/SnoozeRule.d.ts +1 -1
  178. package/api/resources/profiles/types/SubscribeToListsRequest.d.ts +1 -1
  179. package/api/resources/profiles/types/SubscribeToListsRequestListObject.d.ts +1 -1
  180. package/api/resources/profiles/types/UserProfile.d.ts +1 -1
  181. package/api/resources/send/types/AudienceRecipient.d.ts +1 -1
  182. package/api/resources/send/types/BaseMessage.d.ts +1 -1
  183. package/api/resources/send/types/BaseMessageSendTo.d.ts +1 -1
  184. package/api/resources/send/types/BrandSettingsEmail.d.ts +1 -1
  185. package/api/resources/send/types/BrandSettingsInApp.d.ts +1 -1
  186. package/api/resources/send/types/BrandSettingsSocialPresence.d.ts +1 -1
  187. package/api/resources/send/types/BrandTemplateOverride.d.ts +1 -1
  188. package/api/resources/send/types/Channel.d.ts +1 -1
  189. package/api/resources/send/types/ChannelMetadata.d.ts +1 -1
  190. package/api/resources/send/types/Content.d.ts +1 -1
  191. package/api/resources/send/types/ContentMessage.d.ts +1 -1
  192. package/api/resources/send/types/ElementalActionNode.d.ts +1 -1
  193. package/api/resources/send/types/ElementalChannelNode.d.ts +1 -1
  194. package/api/resources/send/types/ElementalContent.d.ts +1 -1
  195. package/api/resources/send/types/ElementalDividerNode.d.ts +1 -1
  196. package/api/resources/send/types/ElementalGroupNode.d.ts +1 -1
  197. package/api/resources/send/types/ElementalImageNode.d.ts +1 -1
  198. package/api/resources/send/types/ElementalMetaNode.d.ts +1 -1
  199. package/api/resources/send/types/ElementalNode.d.ts +1 -1
  200. package/api/resources/send/types/ElementalQuoteNode.d.ts +1 -1
  201. package/api/resources/send/types/ElementalTextNode.d.ts +1 -1
  202. package/api/resources/send/types/EmailHeader.d.ts +1 -1
  203. package/api/resources/send/types/Expiry.d.ts +1 -1
  204. package/api/resources/send/types/IPreferences.d.ts +1 -1
  205. package/api/resources/send/types/IProfilePreferences.d.ts +1 -1
  206. package/api/resources/send/types/ListPatternRecipient.d.ts +1 -1
  207. package/api/resources/send/types/ListRecipient.d.ts +1 -1
  208. package/api/resources/send/types/Locales.d.ts +1 -1
  209. package/api/resources/send/types/Message.d.ts +1 -1
  210. package/api/resources/send/types/MessageChannelEmailOverride.d.ts +1 -1
  211. package/api/resources/send/types/MessageChannels.d.ts +1 -1
  212. package/api/resources/send/types/MessageMetadata.d.ts +1 -1
  213. package/api/resources/send/types/MessageProviders.d.ts +1 -1
  214. package/api/resources/send/types/MessageProvidersType.d.ts +1 -1
  215. package/api/resources/send/types/MessageRecipient.d.ts +1 -1
  216. package/api/resources/send/types/Metadata.d.ts +1 -1
  217. package/api/resources/send/types/MsTeamsRecipient.d.ts +1 -1
  218. package/api/resources/send/types/Preference.d.ts +1 -1
  219. package/api/resources/send/types/Recipient.d.ts +1 -1
  220. package/api/resources/send/types/Routing.d.ts +1 -1
  221. package/api/resources/send/types/RoutingChannel.d.ts +1 -1
  222. package/api/resources/send/types/RoutingStrategyChannel.d.ts +1 -1
  223. package/api/resources/send/types/RoutingStrategyProvider.d.ts +1 -1
  224. package/api/resources/send/types/SlackRecipient.d.ts +1 -1
  225. package/api/resources/send/types/TemplateMessage.d.ts +1 -1
  226. package/api/resources/send/types/Timeout.d.ts +1 -1
  227. package/api/resources/send/types/UserRecipient.d.ts +1 -1
  228. package/api/resources/templates/client/Client.d.ts +9 -1
  229. package/api/resources/templates/client/Client.js +13 -3
  230. package/api/resources/templates/client/requests/ListTemplatesRequest.d.ts +6 -0
  231. package/api/resources/templates/client/requests/index.d.ts +1 -1
  232. package/api/resources/templates/types/ListTemplatesResponse.d.ts +1 -1
  233. package/api/resources/templates/types/NotificationTemplates.d.ts +1 -1
  234. package/api/resources/templates/types/RoutingStrategy.d.ts +1 -1
  235. package/api/resources/templates/types/Tag.d.ts +1 -1
  236. package/api/resources/tenants/client/Client.d.ts +82 -1
  237. package/api/resources/tenants/client/Client.js +190 -13
  238. package/api/resources/tenants/client/requests/ListTenantParams.d.ts +13 -1
  239. package/api/resources/tenants/client/requests/ListUsersForTenantParams.d.ts +7 -0
  240. package/api/resources/tenants/client/requests/TenantCreateOrReplaceParams.d.ts +23 -2
  241. package/api/resources/tenants/client/requests/index.d.ts +3 -3
  242. package/api/resources/tenants/types/DefaultPreferences.d.ts +2 -2
  243. package/api/resources/tenants/types/ListUsersForTenantResponse.d.ts +1 -1
  244. package/api/resources/tenants/types/SubscriptionTopic.d.ts +2 -3
  245. package/api/resources/tenants/types/SubscriptionTopicNew.d.ts +11 -0
  246. package/api/resources/tenants/types/SubscriptionTopicNew.js +5 -0
  247. package/api/resources/tenants/types/TemplateProperty.d.ts +3 -0
  248. package/api/resources/tenants/types/Tenant.d.ts +2 -2
  249. package/api/resources/tenants/types/TenantListResponse.d.ts +1 -1
  250. package/api/resources/tenants/types/index.d.ts +1 -0
  251. package/api/resources/tenants/types/index.js +1 -0
  252. package/api/resources/translations/client/Client.d.ts +17 -0
  253. package/api/resources/translations/client/Client.js +28 -7
  254. package/api/resources/users/resources/preferences/client/Client.d.ts +22 -1
  255. package/api/resources/users/resources/preferences/client/Client.js +36 -9
  256. package/api/resources/users/resources/preferences/client/requests/UserPreferencesUpdateParams.d.ts +1 -1
  257. package/api/resources/users/resources/preferences/client/requests/index.d.ts +1 -1
  258. package/api/resources/users/resources/preferences/types/TopicPreference.d.ts +1 -1
  259. package/api/resources/users/resources/preferences/types/TopicPreferenceUpdate.d.ts +1 -1
  260. package/api/resources/users/resources/preferences/types/UserPreferencesGetResponse.d.ts +1 -1
  261. package/api/resources/users/resources/preferences/types/UserPreferencesListResponse.d.ts +1 -1
  262. package/api/resources/users/resources/tenants/client/Client.d.ts +57 -2
  263. package/api/resources/users/resources/tenants/client/Client.js +78 -13
  264. package/api/resources/users/resources/tenants/client/requests/AddUserToMultipleTenantsParams.d.ts +16 -1
  265. package/api/resources/users/resources/tenants/client/requests/AddUserToSingleTenantsParams.d.ts +11 -2
  266. package/api/resources/users/resources/tenants/client/requests/ListTenantsForUserParams.d.ts +7 -0
  267. package/api/resources/users/resources/tenants/client/requests/index.d.ts +3 -3
  268. package/api/resources/users/resources/tenants/types/AddUserToSingleTenantsParamsProfile.d.ts +3 -0
  269. package/api/resources/users/resources/tenants/types/ListTenantsForUserResponse.d.ts +1 -1
  270. package/api/resources/users/resources/tokens/client/Client.d.ts +73 -1
  271. package/api/resources/users/resources/tokens/client/Client.js +136 -13
  272. package/api/resources/users/resources/tokens/types/GetAllTokensResponse.d.ts +1 -1
  273. package/api/resources/users/resources/tokens/types/GetUserTokenResponse.d.ts +1 -1
  274. package/api/resources/users/resources/tokens/types/PatchUserTokenOpts.d.ts +1 -1
  275. package/api/resources/users/resources/tokens/types/PutUserTokenOpts.d.ts +1 -1
  276. package/api/resources/users/resources/tokens/types/PutUserTokensOpts.d.ts +1 -1
  277. package/api/resources/users/resources/tokens/types/UserToken.d.ts +1 -1
  278. package/core/fetcher/Fetcher.d.ts +2 -2
  279. package/core/fetcher/Fetcher.js +60 -6
  280. package/core/index.d.ts +1 -0
  281. package/core/index.js +1 -0
  282. package/core/runtime/index.d.ts +1 -0
  283. package/core/runtime/index.js +5 -0
  284. package/core/runtime/runtime.d.ts +8 -0
  285. package/core/runtime/runtime.js +82 -0
  286. package/dist/Client.d.ts +31 -2
  287. package/dist/Client.js +35 -6
  288. package/dist/api/client/requests/SendMessageRequest.d.ts +28 -1
  289. package/dist/api/client/requests/index.d.ts +1 -1
  290. package/dist/api/resources/audiences/client/Client.d.ts +47 -1
  291. package/dist/api/resources/audiences/client/Client.js +68 -12
  292. package/dist/api/resources/audiences/client/requests/AudienceMembersListParams.d.ts +6 -0
  293. package/dist/api/resources/audiences/client/requests/AudienceUpdateParams.d.ts +13 -1
  294. package/dist/api/resources/audiences/client/requests/AudiencesListParams.d.ts +6 -0
  295. package/dist/api/resources/audiences/client/requests/index.d.ts +3 -3
  296. package/dist/api/resources/audiences/types/Audience.d.ts +1 -1
  297. package/dist/api/resources/audiences/types/AudienceListResponse.d.ts +1 -1
  298. package/dist/api/resources/audiences/types/AudienceMemberGetResponse.d.ts +1 -1
  299. package/dist/api/resources/audiences/types/AudienceMemberListResponse.d.ts +1 -1
  300. package/dist/api/resources/audiences/types/AudienceUpdateResponse.d.ts +1 -1
  301. package/dist/api/resources/audiences/types/BaseFilterConfig.d.ts +1 -1
  302. package/dist/api/resources/audiences/types/Filter.d.ts +1 -1
  303. package/dist/api/resources/audiences/types/FilterConfig.d.ts +1 -1
  304. package/dist/api/resources/audiences/types/NestedFilterConfig.d.ts +1 -1
  305. package/dist/api/resources/audiences/types/Operator.d.ts +1 -1
  306. package/dist/api/resources/audiences/types/SingleFilterConfig.d.ts +1 -1
  307. package/dist/api/resources/auditEvents/client/Client.d.ts +15 -1
  308. package/dist/api/resources/auditEvents/client/Client.js +23 -5
  309. package/dist/api/resources/auditEvents/client/requests/ListAuditEventsRequest.d.ts +6 -0
  310. package/dist/api/resources/auditEvents/client/requests/index.d.ts +1 -1
  311. package/dist/api/resources/auditEvents/types/AuditEvent.d.ts +1 -1
  312. package/dist/api/resources/auditEvents/types/ListAuditEventsResponse.d.ts +1 -1
  313. package/dist/api/resources/authTokens/client/Client.d.ts +11 -2
  314. package/dist/api/resources/authTokens/client/Client.js +15 -6
  315. package/dist/api/resources/authTokens/client/requests/IssueTokenParams.d.ts +7 -0
  316. package/dist/api/resources/authTokens/client/requests/index.d.ts +1 -1
  317. package/dist/api/resources/automations/client/Client.d.ts +31 -3
  318. package/dist/api/resources/automations/client/Client.js +40 -12
  319. package/dist/api/resources/automations/types/Automation.d.ts +1 -1
  320. package/dist/api/resources/automations/types/AutomationAdHocInvokeParams.d.ts +1 -1
  321. package/dist/api/resources/automations/types/AutomationAddToBatchRetain.d.ts +1 -1
  322. package/dist/api/resources/automations/types/AutomationAddToBatchStep.d.ts +1 -1
  323. package/dist/api/resources/automations/types/AutomationAddToDigestStep.d.ts +1 -1
  324. package/dist/api/resources/automations/types/AutomationCancelStep.d.ts +1 -1
  325. package/dist/api/resources/automations/types/AutomationDelayStep.d.ts +1 -1
  326. package/dist/api/resources/automations/types/AutomationFetchDataStep.d.ts +1 -1
  327. package/dist/api/resources/automations/types/AutomationFetchDataWebhook.d.ts +1 -1
  328. package/dist/api/resources/automations/types/AutomationInvokeParams.d.ts +1 -1
  329. package/dist/api/resources/automations/types/AutomationInvokeStep.d.ts +1 -1
  330. package/dist/api/resources/automations/types/AutomationInvokeTemplateParams.d.ts +1 -1
  331. package/dist/api/resources/automations/types/AutomationRunContext.d.ts +1 -1
  332. package/dist/api/resources/automations/types/AutomationSendListStep.d.ts +1 -1
  333. package/dist/api/resources/automations/types/AutomationSendStep.d.ts +1 -1
  334. package/dist/api/resources/automations/types/AutomationStepOption.d.ts +1 -1
  335. package/dist/api/resources/automations/types/AutomationThrottleStep.d.ts +1 -1
  336. package/dist/api/resources/automations/types/AutomationUpdateProfileStep.d.ts +1 -1
  337. package/dist/api/resources/automations/types/AutomationV2SendStep.d.ts +1 -1
  338. package/dist/api/resources/brands/client/Client.d.ts +57 -2
  339. package/dist/api/resources/brands/client/Client.js +77 -14
  340. package/dist/api/resources/brands/client/requests/BrandUpdateParameters.d.ts +21 -1
  341. package/dist/api/resources/brands/client/requests/ListBrandsRequest.d.ts +6 -0
  342. package/dist/api/resources/brands/client/requests/index.d.ts +2 -2
  343. package/dist/api/resources/brands/types/Brand.d.ts +1 -1
  344. package/dist/api/resources/brands/types/BrandGetAllResponse.d.ts +1 -1
  345. package/dist/api/resources/brands/types/BrandParameters.d.ts +1 -1
  346. package/dist/api/resources/brands/types/BrandSettings.d.ts +1 -1
  347. package/dist/api/resources/brands/types/BrandSnippets.d.ts +1 -1
  348. package/dist/api/resources/brands/types/BrandsResponse.d.ts +1 -1
  349. package/dist/api/resources/bulk/client/Client.d.ts +67 -2
  350. package/dist/api/resources/bulk/client/Client.js +90 -21
  351. package/dist/api/resources/bulk/client/requests/BulkCreateJobParams.d.ts +24 -1
  352. package/dist/api/resources/bulk/client/requests/index.d.ts +1 -1
  353. package/dist/api/resources/bulk/types/BulkGetJobResponse.d.ts +1 -1
  354. package/dist/api/resources/bulk/types/BulkGetJobUsersResponse.d.ts +1 -1
  355. package/dist/api/resources/bulk/types/BulkIngestUsersParams.d.ts +1 -1
  356. package/dist/api/resources/bulk/types/BulkIngestUsersResponse.d.ts +1 -1
  357. package/dist/api/resources/bulk/types/BulkMessageUserResponse.d.ts +1 -1
  358. package/dist/api/resources/bulk/types/InboundBulkContentMessage.d.ts +1 -1
  359. package/dist/api/resources/bulk/types/InboundBulkMessage.d.ts +1 -1
  360. package/dist/api/resources/bulk/types/InboundBulkMessageUser.d.ts +1 -1
  361. package/dist/api/resources/bulk/types/InboundBulkMessageV2.d.ts +1 -1
  362. package/dist/api/resources/bulk/types/InboundBulkTemplateMessage.d.ts +1 -1
  363. package/dist/api/resources/bulk/types/JobDetails.d.ts +1 -1
  364. package/dist/api/resources/commons/errors/AlreadyExistsError.d.ts +2 -2
  365. package/dist/api/resources/commons/errors/AlreadyExistsError.js +1 -1
  366. package/dist/api/resources/commons/errors/BadRequestError.d.ts +2 -2
  367. package/dist/api/resources/commons/errors/BadRequestError.js +1 -1
  368. package/dist/api/resources/commons/errors/ConflictError.d.ts +2 -2
  369. package/dist/api/resources/commons/errors/ConflictError.js +1 -1
  370. package/dist/api/resources/commons/errors/MessageNotFoundError.d.ts +2 -2
  371. package/dist/api/resources/commons/errors/MessageNotFoundError.js +1 -1
  372. package/dist/api/resources/commons/errors/NotFoundError.d.ts +2 -2
  373. package/dist/api/resources/commons/errors/NotFoundError.js +1 -1
  374. package/dist/api/resources/commons/errors/PaymentRequiredError.d.ts +2 -2
  375. package/dist/api/resources/commons/errors/PaymentRequiredError.js +1 -1
  376. package/dist/api/resources/commons/types/AlreadyExists.d.ts +1 -1
  377. package/dist/api/resources/commons/types/BadRequest.d.ts +1 -1
  378. package/dist/api/resources/commons/types/ChannelPreference.d.ts +1 -1
  379. package/dist/api/resources/commons/types/Conflict.d.ts +1 -1
  380. package/dist/api/resources/commons/types/MessageNotFound.d.ts +1 -1
  381. package/dist/api/resources/commons/types/NotFound.d.ts +1 -1
  382. package/dist/api/resources/commons/types/NotificationPreferenceDetails.d.ts +1 -1
  383. package/dist/api/resources/commons/types/NotificationPreferences.d.ts +1 -1
  384. package/dist/api/resources/commons/types/PaymentRequired.d.ts +1 -1
  385. package/dist/api/resources/commons/types/RecipientPreferences.d.ts +1 -1
  386. package/dist/api/resources/commons/types/UserTenantAssociation.d.ts +4 -3
  387. package/dist/api/resources/lists/client/Client.d.ts +197 -4
  388. package/dist/api/resources/lists/client/Client.js +236 -25
  389. package/dist/api/resources/lists/client/requests/AddSubscribersToList.d.ts +41 -0
  390. package/dist/api/resources/lists/client/requests/AddSubscribersToList.js +5 -0
  391. package/dist/api/resources/lists/client/requests/GetAllListsRequest.d.ts +7 -0
  392. package/dist/api/resources/lists/client/requests/GetSubscriptionForListRequest.d.ts +6 -0
  393. package/dist/api/resources/lists/client/requests/SubscribeUserToListRequest.d.ts +32 -1
  394. package/dist/api/resources/lists/client/requests/SubscribeUsersToListRequest.d.ts +41 -0
  395. package/dist/api/resources/lists/client/requests/SubscribeUsersToListRequest.js +5 -0
  396. package/dist/api/resources/lists/client/requests/index.d.ts +5 -3
  397. package/dist/api/resources/lists/types/ListGetAllResponse.d.ts +1 -1
  398. package/dist/api/resources/lists/types/ListGetSubscriptionsResponse.d.ts +1 -1
  399. package/dist/api/resources/lists/types/ListPutParams.d.ts +1 -1
  400. package/dist/api/resources/lists/types/ListSubscriptionRecipient.d.ts +1 -1
  401. package/dist/api/resources/lists/types/PutSubscriptionsRecipient.d.ts +1 -1
  402. package/dist/api/resources/messages/client/Client.d.ts +59 -2
  403. package/dist/api/resources/messages/client/Client.js +89 -28
  404. package/dist/api/resources/messages/client/requests/GetMessageHistoryRequest.d.ts +6 -0
  405. package/dist/api/resources/messages/client/requests/ListMessagesRequest.d.ts +19 -8
  406. package/dist/api/resources/messages/client/requests/index.d.ts +2 -2
  407. package/dist/api/resources/messages/types/ListMessagesResponse.d.ts +1 -1
  408. package/dist/api/resources/messages/types/MessageDetails.d.ts +1 -1
  409. package/dist/api/resources/messages/types/MessageHistoryResponse.d.ts +1 -2
  410. package/dist/api/resources/messages/types/RenderOutput.d.ts +1 -1
  411. package/dist/api/resources/messages/types/RenderOutputResponse.d.ts +1 -1
  412. package/dist/api/resources/messages/types/RenderedMessageContent.d.ts +1 -1
  413. package/dist/api/resources/notifications/client/Client.d.ts +113 -1
  414. package/dist/api/resources/notifications/client/Client.js +145 -17
  415. package/dist/api/resources/notifications/client/requests/NotificationDraftUpdateVariationsParams.d.ts +26 -1
  416. package/dist/api/resources/notifications/client/requests/NotificationListParams.d.ts +6 -0
  417. package/dist/api/resources/notifications/client/requests/NotificationUpdateVariationsParams.d.ts +26 -1
  418. package/dist/api/resources/notifications/client/requests/SubmissionChecksReplaceParams.d.ts +11 -1
  419. package/dist/api/resources/notifications/client/requests/index.d.ts +4 -4
  420. package/dist/api/resources/notifications/types/BaseCheck.d.ts +1 -1
  421. package/dist/api/resources/notifications/types/Check.d.ts +1 -1
  422. package/dist/api/resources/notifications/types/MessageRouting.d.ts +1 -1
  423. package/dist/api/resources/notifications/types/MessageRoutingChannel.d.ts +1 -1
  424. package/dist/api/resources/notifications/types/Notification.d.ts +5 -1
  425. package/dist/api/resources/notifications/types/NotificationBlock.d.ts +1 -1
  426. package/dist/api/resources/notifications/types/NotificationChannel.d.ts +1 -1
  427. package/dist/api/resources/notifications/types/NotificationContent.d.ts +1 -1
  428. package/dist/api/resources/notifications/types/NotificationGetContentResponse.d.ts +1 -1
  429. package/dist/api/resources/notifications/types/NotificationListResponse.d.ts +1 -1
  430. package/dist/api/resources/notifications/types/NotificationTag.d.ts +7 -0
  431. package/dist/api/resources/notifications/types/NotificationTag.js +5 -0
  432. package/dist/api/resources/notifications/types/NotificationTagData.d.ts +7 -0
  433. package/dist/api/resources/notifications/types/NotificationTagData.js +5 -0
  434. package/dist/api/resources/notifications/types/SubmissionChecksGetResponse.d.ts +1 -1
  435. package/dist/api/resources/notifications/types/SubmissionChecksReplaceResponse.d.ts +1 -1
  436. package/dist/api/resources/notifications/types/index.d.ts +2 -0
  437. package/dist/api/resources/notifications/types/index.js +2 -0
  438. package/dist/api/resources/profiles/client/Client.d.ts +71 -2
  439. package/dist/api/resources/profiles/client/Client.js +102 -23
  440. package/dist/api/resources/profiles/client/requests/GetListSubscriptionsRequest.d.ts +6 -0
  441. package/dist/api/resources/profiles/client/requests/MergeProfileRequest.d.ts +10 -0
  442. package/dist/api/resources/profiles/client/requests/ReplaceProfileRequest.d.ts +10 -0
  443. package/dist/api/resources/profiles/client/requests/index.d.ts +3 -3
  444. package/dist/api/resources/profiles/types/AirshipProfile.d.ts +1 -1
  445. package/dist/api/resources/profiles/types/Discord.d.ts +1 -1
  446. package/dist/api/resources/profiles/types/Expo.d.ts +1 -1
  447. package/dist/api/resources/profiles/types/GetListSubscriptionsList.d.ts +1 -1
  448. package/dist/api/resources/profiles/types/GetListSubscriptionsResponse.d.ts +1 -1
  449. package/dist/api/resources/profiles/types/Intercom.d.ts +1 -1
  450. package/dist/api/resources/profiles/types/MsTeams.d.ts +1 -1
  451. package/dist/api/resources/profiles/types/MultipleTokens.d.ts +1 -1
  452. package/dist/api/resources/profiles/types/ProfileGetResponse.d.ts +1 -1
  453. package/dist/api/resources/profiles/types/SendToMsTeamsChannelId.d.ts +1 -1
  454. package/dist/api/resources/profiles/types/SendToMsTeamsChannelName.d.ts +1 -1
  455. package/dist/api/resources/profiles/types/SendToMsTeamsConversationId.d.ts +1 -1
  456. package/dist/api/resources/profiles/types/SendToMsTeamsEmail.d.ts +1 -1
  457. package/dist/api/resources/profiles/types/SendToMsTeamsUserId.d.ts +1 -1
  458. package/dist/api/resources/profiles/types/SendToSlackChannel.d.ts +1 -1
  459. package/dist/api/resources/profiles/types/SendToSlackEmail.d.ts +1 -1
  460. package/dist/api/resources/profiles/types/SendToSlackUserId.d.ts +1 -1
  461. package/dist/api/resources/profiles/types/Slack.d.ts +1 -1
  462. package/dist/api/resources/profiles/types/SnoozeRule.d.ts +1 -1
  463. package/dist/api/resources/profiles/types/SubscribeToListsRequest.d.ts +1 -1
  464. package/dist/api/resources/profiles/types/SubscribeToListsRequestListObject.d.ts +1 -1
  465. package/dist/api/resources/profiles/types/UserProfile.d.ts +1 -1
  466. package/dist/api/resources/send/types/AudienceRecipient.d.ts +1 -1
  467. package/dist/api/resources/send/types/BaseMessage.d.ts +1 -1
  468. package/dist/api/resources/send/types/BaseMessageSendTo.d.ts +1 -1
  469. package/dist/api/resources/send/types/BrandSettingsEmail.d.ts +1 -1
  470. package/dist/api/resources/send/types/BrandSettingsInApp.d.ts +1 -1
  471. package/dist/api/resources/send/types/BrandSettingsSocialPresence.d.ts +1 -1
  472. package/dist/api/resources/send/types/BrandTemplateOverride.d.ts +1 -1
  473. package/dist/api/resources/send/types/Channel.d.ts +1 -1
  474. package/dist/api/resources/send/types/ChannelMetadata.d.ts +1 -1
  475. package/dist/api/resources/send/types/Content.d.ts +1 -1
  476. package/dist/api/resources/send/types/ContentMessage.d.ts +1 -1
  477. package/dist/api/resources/send/types/ElementalActionNode.d.ts +1 -1
  478. package/dist/api/resources/send/types/ElementalChannelNode.d.ts +1 -1
  479. package/dist/api/resources/send/types/ElementalContent.d.ts +1 -1
  480. package/dist/api/resources/send/types/ElementalDividerNode.d.ts +1 -1
  481. package/dist/api/resources/send/types/ElementalGroupNode.d.ts +1 -1
  482. package/dist/api/resources/send/types/ElementalImageNode.d.ts +1 -1
  483. package/dist/api/resources/send/types/ElementalMetaNode.d.ts +1 -1
  484. package/dist/api/resources/send/types/ElementalNode.d.ts +1 -1
  485. package/dist/api/resources/send/types/ElementalQuoteNode.d.ts +1 -1
  486. package/dist/api/resources/send/types/ElementalTextNode.d.ts +1 -1
  487. package/dist/api/resources/send/types/EmailHeader.d.ts +1 -1
  488. package/dist/api/resources/send/types/Expiry.d.ts +1 -1
  489. package/dist/api/resources/send/types/IPreferences.d.ts +1 -1
  490. package/dist/api/resources/send/types/IProfilePreferences.d.ts +1 -1
  491. package/dist/api/resources/send/types/ListPatternRecipient.d.ts +1 -1
  492. package/dist/api/resources/send/types/ListRecipient.d.ts +1 -1
  493. package/dist/api/resources/send/types/Locales.d.ts +1 -1
  494. package/dist/api/resources/send/types/Message.d.ts +1 -1
  495. package/dist/api/resources/send/types/MessageChannelEmailOverride.d.ts +1 -1
  496. package/dist/api/resources/send/types/MessageChannels.d.ts +1 -1
  497. package/dist/api/resources/send/types/MessageMetadata.d.ts +1 -1
  498. package/dist/api/resources/send/types/MessageProviders.d.ts +1 -1
  499. package/dist/api/resources/send/types/MessageProvidersType.d.ts +1 -1
  500. package/dist/api/resources/send/types/MessageRecipient.d.ts +1 -1
  501. package/dist/api/resources/send/types/Metadata.d.ts +1 -1
  502. package/dist/api/resources/send/types/MsTeamsRecipient.d.ts +1 -1
  503. package/dist/api/resources/send/types/Preference.d.ts +1 -1
  504. package/dist/api/resources/send/types/Recipient.d.ts +1 -1
  505. package/dist/api/resources/send/types/Routing.d.ts +1 -1
  506. package/dist/api/resources/send/types/RoutingChannel.d.ts +1 -1
  507. package/dist/api/resources/send/types/RoutingStrategyChannel.d.ts +1 -1
  508. package/dist/api/resources/send/types/RoutingStrategyProvider.d.ts +1 -1
  509. package/dist/api/resources/send/types/SlackRecipient.d.ts +1 -1
  510. package/dist/api/resources/send/types/TemplateMessage.d.ts +1 -1
  511. package/dist/api/resources/send/types/Timeout.d.ts +1 -1
  512. package/dist/api/resources/send/types/UserRecipient.d.ts +1 -1
  513. package/dist/api/resources/templates/client/Client.d.ts +9 -1
  514. package/dist/api/resources/templates/client/Client.js +13 -3
  515. package/dist/api/resources/templates/client/requests/ListTemplatesRequest.d.ts +6 -0
  516. package/dist/api/resources/templates/client/requests/index.d.ts +1 -1
  517. package/dist/api/resources/templates/types/ListTemplatesResponse.d.ts +1 -1
  518. package/dist/api/resources/templates/types/NotificationTemplates.d.ts +1 -1
  519. package/dist/api/resources/templates/types/RoutingStrategy.d.ts +1 -1
  520. package/dist/api/resources/templates/types/Tag.d.ts +1 -1
  521. package/dist/api/resources/tenants/client/Client.d.ts +82 -1
  522. package/dist/api/resources/tenants/client/Client.js +190 -13
  523. package/dist/api/resources/tenants/client/requests/ListTenantParams.d.ts +13 -1
  524. package/dist/api/resources/tenants/client/requests/ListUsersForTenantParams.d.ts +7 -0
  525. package/dist/api/resources/tenants/client/requests/TenantCreateOrReplaceParams.d.ts +23 -2
  526. package/dist/api/resources/tenants/client/requests/index.d.ts +3 -3
  527. package/dist/api/resources/tenants/types/DefaultPreferences.d.ts +2 -2
  528. package/dist/api/resources/tenants/types/ListUsersForTenantResponse.d.ts +1 -1
  529. package/dist/api/resources/tenants/types/SubscriptionTopic.d.ts +2 -3
  530. package/dist/api/resources/tenants/types/SubscriptionTopicNew.d.ts +11 -0
  531. package/dist/api/resources/tenants/types/SubscriptionTopicNew.js +5 -0
  532. package/dist/api/resources/tenants/types/TemplateProperty.d.ts +3 -0
  533. package/dist/api/resources/tenants/types/Tenant.d.ts +2 -2
  534. package/dist/api/resources/tenants/types/TenantListResponse.d.ts +1 -1
  535. package/dist/api/resources/tenants/types/index.d.ts +1 -0
  536. package/dist/api/resources/tenants/types/index.js +1 -0
  537. package/dist/api/resources/translations/client/Client.d.ts +17 -0
  538. package/dist/api/resources/translations/client/Client.js +28 -7
  539. package/dist/api/resources/users/resources/preferences/client/Client.d.ts +22 -1
  540. package/dist/api/resources/users/resources/preferences/client/Client.js +36 -9
  541. package/dist/api/resources/users/resources/preferences/client/requests/UserPreferencesUpdateParams.d.ts +1 -1
  542. package/dist/api/resources/users/resources/preferences/client/requests/index.d.ts +1 -1
  543. package/dist/api/resources/users/resources/preferences/types/TopicPreference.d.ts +1 -1
  544. package/dist/api/resources/users/resources/preferences/types/TopicPreferenceUpdate.d.ts +1 -1
  545. package/dist/api/resources/users/resources/preferences/types/UserPreferencesGetResponse.d.ts +1 -1
  546. package/dist/api/resources/users/resources/preferences/types/UserPreferencesListResponse.d.ts +1 -1
  547. package/dist/api/resources/users/resources/tenants/client/Client.d.ts +57 -2
  548. package/dist/api/resources/users/resources/tenants/client/Client.js +78 -13
  549. package/dist/api/resources/users/resources/tenants/client/requests/AddUserToMultipleTenantsParams.d.ts +16 -1
  550. package/dist/api/resources/users/resources/tenants/client/requests/AddUserToSingleTenantsParams.d.ts +11 -2
  551. package/dist/api/resources/users/resources/tenants/client/requests/ListTenantsForUserParams.d.ts +7 -0
  552. package/dist/api/resources/users/resources/tenants/client/requests/index.d.ts +3 -3
  553. package/dist/api/resources/users/resources/tenants/types/AddUserToSingleTenantsParamsProfile.d.ts +3 -0
  554. package/dist/api/resources/users/resources/tenants/types/ListTenantsForUserResponse.d.ts +1 -1
  555. package/dist/api/resources/users/resources/tokens/client/Client.d.ts +73 -1
  556. package/dist/api/resources/users/resources/tokens/client/Client.js +136 -13
  557. package/dist/api/resources/users/resources/tokens/types/GetAllTokensResponse.d.ts +1 -1
  558. package/dist/api/resources/users/resources/tokens/types/GetUserTokenResponse.d.ts +1 -1
  559. package/dist/api/resources/users/resources/tokens/types/PatchUserTokenOpts.d.ts +1 -1
  560. package/dist/api/resources/users/resources/tokens/types/PutUserTokenOpts.d.ts +1 -1
  561. package/dist/api/resources/users/resources/tokens/types/PutUserTokensOpts.d.ts +1 -1
  562. package/dist/api/resources/users/resources/tokens/types/UserToken.d.ts +1 -1
  563. package/dist/core/fetcher/Fetcher.d.ts +2 -2
  564. package/dist/core/fetcher/Fetcher.js +60 -6
  565. package/dist/core/index.d.ts +1 -0
  566. package/dist/core/index.js +1 -0
  567. package/dist/core/runtime/index.d.ts +1 -0
  568. package/dist/core/runtime/index.js +5 -0
  569. package/dist/core/runtime/runtime.d.ts +8 -0
  570. package/dist/core/runtime/runtime.js +82 -0
  571. package/jest.config.js +2 -2
  572. package/package.json +8 -6
  573. package/tests/client.test.ts +0 -11
@@ -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 Tenants {
8
8
  interface Options {
9
9
  environment?: core.Supplier<environments.CourierEnvironment | string>;
@@ -19,18 +19,99 @@ export declare class Tenants {
19
19
  protected readonly _options: Tenants.Options;
20
20
  constructor(_options?: Tenants.Options);
21
21
  /**
22
+ * @param {string} tenantId - A unique identifier representing the tenant to be returned.
23
+ * @param {Courier.TenantCreateOrReplaceParams} request
24
+ * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
25
+ *
22
26
  * @throws {@link Courier.BadRequestError}
27
+ *
28
+ * @example
29
+ * await courier.tenants.createOrReplace("string", {
30
+ * name: "string",
31
+ * parent_tenant_id: "string",
32
+ * default_preferences: {
33
+ * items: [{}]
34
+ * },
35
+ * properties: {
36
+ * "string": {
37
+ * "key": "value"
38
+ * }
39
+ * },
40
+ * user_profile: {
41
+ * "string": {
42
+ * "key": "value"
43
+ * }
44
+ * },
45
+ * brand_id: "string"
46
+ * })
23
47
  */
24
48
  createOrReplace(tenantId: string, request: Courier.TenantCreateOrReplaceParams, requestOptions?: Tenants.RequestOptions): Promise<Courier.Tenant>;
25
49
  /**
50
+ * @param {string} tenantId - A unique identifier representing the tenant to be returned.
51
+ * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
52
+ *
26
53
  * @throws {@link Courier.BadRequestError}
54
+ *
55
+ * @example
56
+ * await courier.tenants.get("string")
27
57
  */
28
58
  get(tenantId: string, requestOptions?: Tenants.RequestOptions): Promise<Courier.Tenant>;
59
+ /**
60
+ * @param {Courier.ListTenantParams} request
61
+ * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
62
+ *
63
+ * @example
64
+ * await courier.tenants.list({
65
+ * parent_tenant_id: "string",
66
+ * limit: 1,
67
+ * cursor: "string"
68
+ * })
69
+ */
29
70
  list(request?: Courier.ListTenantParams, requestOptions?: Tenants.RequestOptions): Promise<Courier.TenantListResponse>;
71
+ /**
72
+ * @param {string} tenantId - Id of the tenant to be deleted.
73
+ * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
74
+ *
75
+ * @example
76
+ * await courier.tenants.delete("string")
77
+ */
30
78
  delete(tenantId: string, requestOptions?: Tenants.RequestOptions): Promise<void>;
31
79
  /**
80
+ * @param {string} tenantId - Id of the tenant for user membership.
81
+ * @param {Courier.ListUsersForTenantParams} request
82
+ * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
83
+ *
32
84
  * @throws {@link Courier.BadRequestError}
85
+ *
86
+ * @example
87
+ * await courier.tenants.getUsersByTenant("string", {
88
+ * limit: 1,
89
+ * cursor: "string"
90
+ * })
33
91
  */
34
92
  getUsersByTenant(tenantId: string, request?: Courier.ListUsersForTenantParams, requestOptions?: Tenants.RequestOptions): Promise<Courier.ListUsersForTenantResponse>;
93
+ /**
94
+ * @param {string} tenantId - Id of the tenant to update the default preferences for.
95
+ * @param {string} topicId - Id fo the susbcription topic you want to have a default preference for.
96
+ * @param {Courier.SubscriptionTopicNew} request
97
+ * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
98
+ *
99
+ * @example
100
+ * await courier.tenants.createOrReplaceDefaultPreferencesForTopic("tenantABC", "HB529N49MD4D5PMX9WR5P4JH78NA", {
101
+ * status: Courier.SubscriptionTopicStatus.OptedIn,
102
+ * has_custom_routing: true,
103
+ * custom_routing: [Courier.ChannelClassification.Inbox]
104
+ * })
105
+ */
106
+ createOrReplaceDefaultPreferencesForTopic(tenantId: string, topicId: string, request: Courier.SubscriptionTopicNew, requestOptions?: Tenants.RequestOptions): Promise<void>;
107
+ /**
108
+ * @param {string} tenantId - Id of the tenant to update the default preferences for.
109
+ * @param {string} topicId - Id fo the susbcription topic you want to have a default preference for.
110
+ * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
111
+ *
112
+ * @example
113
+ * await courier.tenants.removeDefaultPreferencesForTopic("string", "string")
114
+ */
115
+ removeDefaultPreferencesForTopic(tenantId: string, topicId: string, requestOptions?: Tenants.RequestOptions): Promise<void>;
35
116
  protected _getAuthorizationHeader(): Promise<string>;
36
117
  }
@@ -41,27 +41,53 @@ Object.defineProperty(exports, "__esModule", { value: true });
41
41
  exports.Tenants = 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 Tenants {
48
48
  constructor(_options = {}) {
49
49
  this._options = _options;
50
50
  }
51
51
  /**
52
+ * @param {string} tenantId - A unique identifier representing the tenant to be returned.
53
+ * @param {Courier.TenantCreateOrReplaceParams} request
54
+ * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
55
+ *
52
56
  * @throws {@link Courier.BadRequestError}
57
+ *
58
+ * @example
59
+ * await courier.tenants.createOrReplace("string", {
60
+ * name: "string",
61
+ * parent_tenant_id: "string",
62
+ * default_preferences: {
63
+ * items: [{}]
64
+ * },
65
+ * properties: {
66
+ * "string": {
67
+ * "key": "value"
68
+ * }
69
+ * },
70
+ * user_profile: {
71
+ * "string": {
72
+ * "key": "value"
73
+ * }
74
+ * },
75
+ * brand_id: "string"
76
+ * })
53
77
  */
54
78
  createOrReplace(tenantId, request, requestOptions) {
55
79
  var _a, _b;
56
80
  return __awaiter(this, void 0, void 0, function* () {
57
81
  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, `/tenants/${tenantId}`),
82
+ url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/tenants/${encodeURIComponent(tenantId)}`),
59
83
  method: "PUT",
60
84
  headers: {
61
85
  Authorization: yield this._getAuthorizationHeader(),
62
86
  "X-Fern-Language": "JavaScript",
63
87
  "X-Fern-SDK-Name": "@trycourier/courier",
64
- "X-Fern-SDK-Version": "v6.1.1",
88
+ "X-Fern-SDK-Version": "v6.1.3",
89
+ "X-Fern-Runtime": core.RUNTIME.type,
90
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
65
91
  },
66
92
  contentType: "application/json",
67
93
  body: request,
@@ -98,19 +124,27 @@ class Tenants {
98
124
  });
99
125
  }
100
126
  /**
127
+ * @param {string} tenantId - A unique identifier representing the tenant to be returned.
128
+ * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
129
+ *
101
130
  * @throws {@link Courier.BadRequestError}
131
+ *
132
+ * @example
133
+ * await courier.tenants.get("string")
102
134
  */
103
135
  get(tenantId, requestOptions) {
104
136
  var _a, _b;
105
137
  return __awaiter(this, void 0, void 0, function* () {
106
138
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
107
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/tenants/${tenantId}`),
139
+ url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/tenants/${encodeURIComponent(tenantId)}`),
108
140
  method: "GET",
109
141
  headers: {
110
142
  Authorization: yield this._getAuthorizationHeader(),
111
143
  "X-Fern-Language": "JavaScript",
112
144
  "X-Fern-SDK-Name": "@trycourier/courier",
113
- "X-Fern-SDK-Version": "v6.1.1",
145
+ "X-Fern-SDK-Version": "v6.1.3",
146
+ "X-Fern-Runtime": core.RUNTIME.type,
147
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
114
148
  },
115
149
  contentType: "application/json",
116
150
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -145,11 +179,25 @@ class Tenants {
145
179
  }
146
180
  });
147
181
  }
182
+ /**
183
+ * @param {Courier.ListTenantParams} request
184
+ * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
185
+ *
186
+ * @example
187
+ * await courier.tenants.list({
188
+ * parent_tenant_id: "string",
189
+ * limit: 1,
190
+ * cursor: "string"
191
+ * })
192
+ */
148
193
  list(request = {}, requestOptions) {
149
194
  var _a, _b;
150
195
  return __awaiter(this, void 0, void 0, function* () {
151
- const { limit, cursor } = request;
196
+ const { parent_tenant_id: parentTenantId, limit, cursor } = request;
152
197
  const _queryParams = {};
198
+ if (parentTenantId != null) {
199
+ _queryParams["parent_tenant_id"] = parentTenantId;
200
+ }
153
201
  if (limit != null) {
154
202
  _queryParams["limit"] = limit.toString();
155
203
  }
@@ -163,7 +211,9 @@ class Tenants {
163
211
  Authorization: yield this._getAuthorizationHeader(),
164
212
  "X-Fern-Language": "JavaScript",
165
213
  "X-Fern-SDK-Name": "@trycourier/courier",
166
- "X-Fern-SDK-Version": "v6.1.1",
214
+ "X-Fern-SDK-Version": "v6.1.3",
215
+ "X-Fern-Runtime": core.RUNTIME.type,
216
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
167
217
  },
168
218
  contentType: "application/json",
169
219
  queryParameters: _queryParams,
@@ -194,17 +244,26 @@ class Tenants {
194
244
  }
195
245
  });
196
246
  }
247
+ /**
248
+ * @param {string} tenantId - Id of the tenant to be deleted.
249
+ * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
250
+ *
251
+ * @example
252
+ * await courier.tenants.delete("string")
253
+ */
197
254
  delete(tenantId, requestOptions) {
198
255
  var _a, _b;
199
256
  return __awaiter(this, void 0, void 0, function* () {
200
257
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
201
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/tenants/${tenantId}`),
258
+ url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/tenants/${encodeURIComponent(tenantId)}`),
202
259
  method: "DELETE",
203
260
  headers: {
204
261
  Authorization: yield this._getAuthorizationHeader(),
205
262
  "X-Fern-Language": "JavaScript",
206
263
  "X-Fern-SDK-Name": "@trycourier/courier",
207
- "X-Fern-SDK-Version": "v6.1.1",
264
+ "X-Fern-SDK-Version": "v6.1.3",
265
+ "X-Fern-Runtime": core.RUNTIME.type,
266
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
208
267
  },
209
268
  contentType: "application/json",
210
269
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -235,7 +294,17 @@ class Tenants {
235
294
  });
236
295
  }
237
296
  /**
297
+ * @param {string} tenantId - Id of the tenant for user membership.
298
+ * @param {Courier.ListUsersForTenantParams} request
299
+ * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
300
+ *
238
301
  * @throws {@link Courier.BadRequestError}
302
+ *
303
+ * @example
304
+ * await courier.tenants.getUsersByTenant("string", {
305
+ * limit: 1,
306
+ * cursor: "string"
307
+ * })
239
308
  */
240
309
  getUsersByTenant(tenantId, request = {}, requestOptions) {
241
310
  var _a, _b;
@@ -249,13 +318,15 @@ class Tenants {
249
318
  _queryParams["cursor"] = cursor;
250
319
  }
251
320
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
252
- url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/tenants/${tenantId}/users`),
321
+ url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/tenants/${encodeURIComponent(tenantId)}/users`),
253
322
  method: "GET",
254
323
  headers: {
255
324
  Authorization: yield this._getAuthorizationHeader(),
256
325
  "X-Fern-Language": "JavaScript",
257
326
  "X-Fern-SDK-Name": "@trycourier/courier",
258
- "X-Fern-SDK-Version": "v6.1.1",
327
+ "X-Fern-SDK-Version": "v6.1.3",
328
+ "X-Fern-Runtime": core.RUNTIME.type,
329
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
259
330
  },
260
331
  contentType: "application/json",
261
332
  queryParameters: _queryParams,
@@ -291,10 +362,116 @@ class Tenants {
291
362
  }
292
363
  });
293
364
  }
365
+ /**
366
+ * @param {string} tenantId - Id of the tenant to update the default preferences for.
367
+ * @param {string} topicId - Id fo the susbcription topic you want to have a default preference for.
368
+ * @param {Courier.SubscriptionTopicNew} request
369
+ * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
370
+ *
371
+ * @example
372
+ * await courier.tenants.createOrReplaceDefaultPreferencesForTopic("tenantABC", "HB529N49MD4D5PMX9WR5P4JH78NA", {
373
+ * status: Courier.SubscriptionTopicStatus.OptedIn,
374
+ * has_custom_routing: true,
375
+ * custom_routing: [Courier.ChannelClassification.Inbox]
376
+ * })
377
+ */
378
+ createOrReplaceDefaultPreferencesForTopic(tenantId, topicId, request, requestOptions) {
379
+ var _a, _b;
380
+ return __awaiter(this, void 0, void 0, function* () {
381
+ const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
382
+ url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/tenants/${encodeURIComponent(tenantId)}/default_preferences/items/${encodeURIComponent(topicId)}`),
383
+ method: "PUT",
384
+ headers: {
385
+ Authorization: yield this._getAuthorizationHeader(),
386
+ "X-Fern-Language": "JavaScript",
387
+ "X-Fern-SDK-Name": "@trycourier/courier",
388
+ "X-Fern-SDK-Version": "v6.1.3",
389
+ "X-Fern-Runtime": core.RUNTIME.type,
390
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
391
+ },
392
+ contentType: "application/json",
393
+ body: request,
394
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
395
+ maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
396
+ });
397
+ if (_response.ok) {
398
+ return;
399
+ }
400
+ if (_response.error.reason === "status-code") {
401
+ throw new errors.CourierError({
402
+ statusCode: _response.error.statusCode,
403
+ body: _response.error.body,
404
+ });
405
+ }
406
+ switch (_response.error.reason) {
407
+ case "non-json":
408
+ throw new errors.CourierError({
409
+ statusCode: _response.error.statusCode,
410
+ body: _response.error.rawBody,
411
+ });
412
+ case "timeout":
413
+ throw new errors.CourierTimeoutError();
414
+ case "unknown":
415
+ throw new errors.CourierError({
416
+ message: _response.error.errorMessage,
417
+ });
418
+ }
419
+ });
420
+ }
421
+ /**
422
+ * @param {string} tenantId - Id of the tenant to update the default preferences for.
423
+ * @param {string} topicId - Id fo the susbcription topic you want to have a default preference for.
424
+ * @param {Tenants.RequestOptions} requestOptions - Request-specific configuration.
425
+ *
426
+ * @example
427
+ * await courier.tenants.removeDefaultPreferencesForTopic("string", "string")
428
+ */
429
+ removeDefaultPreferencesForTopic(tenantId, topicId, requestOptions) {
430
+ var _a, _b;
431
+ return __awaiter(this, void 0, void 0, function* () {
432
+ const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
433
+ url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CourierEnvironment.Production, `/tenants/${encodeURIComponent(tenantId)}/default_preferences/items/${encodeURIComponent(topicId)}`),
434
+ method: "DELETE",
435
+ headers: {
436
+ Authorization: yield this._getAuthorizationHeader(),
437
+ "X-Fern-Language": "JavaScript",
438
+ "X-Fern-SDK-Name": "@trycourier/courier",
439
+ "X-Fern-SDK-Version": "v6.1.3",
440
+ "X-Fern-Runtime": core.RUNTIME.type,
441
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
442
+ },
443
+ contentType: "application/json",
444
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
445
+ maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
446
+ });
447
+ if (_response.ok) {
448
+ return;
449
+ }
450
+ if (_response.error.reason === "status-code") {
451
+ throw new errors.CourierError({
452
+ statusCode: _response.error.statusCode,
453
+ body: _response.error.body,
454
+ });
455
+ }
456
+ switch (_response.error.reason) {
457
+ case "non-json":
458
+ throw new errors.CourierError({
459
+ statusCode: _response.error.statusCode,
460
+ body: _response.error.rawBody,
461
+ });
462
+ case "timeout":
463
+ throw new errors.CourierTimeoutError();
464
+ case "unknown":
465
+ throw new errors.CourierError({
466
+ message: _response.error.errorMessage,
467
+ });
468
+ }
469
+ });
470
+ }
294
471
  _getAuthorizationHeader() {
295
472
  var _a;
296
473
  return __awaiter(this, void 0, void 0, function* () {
297
- const bearer = (_a = (yield core.Supplier.get(this._options.authorizationToken))) !== null && _a !== void 0 ? _a : process.env["COURIER_AUTH_TOKEN"];
474
+ 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"];
298
475
  if (bearer == null) {
299
476
  throw new errors.CourierError({
300
477
  message: "Please specify COURIER_AUTH_TOKEN when instantiating the client.",
@@ -1,9 +1,21 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
+ /**
5
+ * @example
6
+ * {
7
+ * parent_tenant_id: "string",
8
+ * limit: 1,
9
+ * cursor: "string"
10
+ * }
11
+ */
4
12
  export interface ListTenantParams {
5
13
  /**
6
- * The number of accousnts to return
14
+ * Filter the list of tenants by parent_id
15
+ */
16
+ parent_tenant_id?: string;
17
+ /**
18
+ * The number of tenants to return
7
19
  * (defaults to 20, maximum value of 100)
8
20
  */
9
21
  limit?: number;
@@ -1,6 +1,13 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
+ /**
5
+ * @example
6
+ * {
7
+ * limit: 1,
8
+ * cursor: "string"
9
+ * }
10
+ */
4
11
  export interface ListUsersForTenantParams {
5
12
  /**
6
13
  * The number of accounts to return
@@ -1,7 +1,28 @@
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
+ * name: "string",
9
+ * parent_tenant_id: "string",
10
+ * default_preferences: {
11
+ * items: [{}]
12
+ * },
13
+ * properties: {
14
+ * "string": {
15
+ * "key": "value"
16
+ * }
17
+ * },
18
+ * user_profile: {
19
+ * "string": {
20
+ * "key": "value"
21
+ * }
22
+ * },
23
+ * brand_id: "string"
24
+ * }
25
+ */
5
26
  export interface TenantCreateOrReplaceParams {
6
27
  /** Name of the tenant. */
7
28
  name: string;
@@ -10,7 +31,7 @@ export interface TenantCreateOrReplaceParams {
10
31
  /** Defines the preferences used for the tenant when the user hasn't specified their own. */
11
32
  default_preferences?: Courier.DefaultPreferences;
12
33
  /** Arbitrary properties accessible to a template. */
13
- properties?: (Courier.TemplateProperty | undefined)[];
34
+ properties?: Record<string, any>;
14
35
  /** A user profile object merged with user profile on send. */
15
36
  user_profile?: Record<string, any>;
16
37
  /** Brand to be used for the account when one is not specified by the send call. */
@@ -1,3 +1,3 @@
1
- export { TenantCreateOrReplaceParams } from "./TenantCreateOrReplaceParams";
2
- export { ListTenantParams } from "./ListTenantParams";
3
- export { ListUsersForTenantParams } from "./ListUsersForTenantParams";
1
+ export { type TenantCreateOrReplaceParams } from "./TenantCreateOrReplaceParams";
2
+ export { type ListTenantParams } from "./ListTenantParams";
3
+ export { type ListUsersForTenantParams } from "./ListUsersForTenantParams";
@@ -1,7 +1,7 @@
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
5
  export interface DefaultPreferences {
6
- items: Courier.SubscriptionTopic[];
6
+ items?: Courier.SubscriptionTopic[];
7
7
  }
@@ -1,7 +1,7 @@
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
5
  export interface ListUsersForTenantResponse {
6
6
  items?: Courier.UserTenantAssociation[];
7
7
  /** Set to true when there are more pages that can be retrieved. */
@@ -1,9 +1,8 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
- import * as Courier from "../../..";
5
- export interface SubscriptionTopic {
4
+ import * as Courier from "../../../index";
5
+ export interface SubscriptionTopic extends Courier.SubscriptionTopicNew {
6
6
  /** Topic ID */
7
7
  id: string;
8
- status: Courier.SubscriptionTopicStatus;
9
8
  }
@@ -0,0 +1,11 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Courier from "../../../index";
5
+ export interface SubscriptionTopicNew {
6
+ status: Courier.SubscriptionTopicStatus;
7
+ /** Override channel routing with custom preferences. This will override any template prefernces that are set, but a user can still customize their preferences */
8
+ has_custom_routing?: boolean;
9
+ /** The default channels to send to this tenant when has_custom_routing is enabled */
10
+ custom_routing?: Courier.ChannelClassification[];
11
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,4 +1,7 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
+ /**
5
+ * Unused type for tenants
6
+ */
4
7
  export declare type TemplateProperty = any;
@@ -1,7 +1,7 @@
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
5
  export interface Tenant {
6
6
  /** Id of the tenant. */
7
7
  id: string;
@@ -12,7 +12,7 @@ export interface Tenant {
12
12
  /** Defines the preferences used for the account when the user hasn't specified their own. */
13
13
  default_preferences?: Courier.DefaultPreferences;
14
14
  /** Arbitrary properties accessible to a template. */
15
- properties?: Courier.TemplateProperty | undefined;
15
+ properties?: Record<string, any>;
16
16
  /** A user profile object merged with user profile on send. */
17
17
  user_profile?: Record<string, any>;
18
18
  /** Brand to be used for the account when one is not specified by the send call. */
@@ -1,7 +1,7 @@
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
5
  export interface TenantListResponse {
6
6
  /** A pointer to the next page of results. Defined only when has_more is set to true. */
7
7
  cursor?: string;
@@ -1,4 +1,5 @@
1
1
  export * from "./DefaultPreferences";
2
+ export * from "./SubscriptionTopicNew";
2
3
  export * from "./SubscriptionTopic";
3
4
  export * from "./SubscriptionTopicStatus";
4
5
  export * from "./Tenant";
@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./DefaultPreferences"), exports);
18
+ __exportStar(require("./SubscriptionTopicNew"), exports);
18
19
  __exportStar(require("./SubscriptionTopic"), exports);
19
20
  __exportStar(require("./SubscriptionTopicStatus"), exports);
20
21
  __exportStar(require("./Tenant"), exports);
@@ -19,12 +19,29 @@ export declare class Translations {
19
19
  constructor(_options?: Translations.Options);
20
20
  /**
21
21
  * Get translations by locale
22
+ *
23
+ * @param {string} domain - The domain you want to retrieve translations for. Only `default` is supported at the moment
24
+ * @param {string} locale - The locale you want to retrieve the translations for
25
+ * @param {Translations.RequestOptions} requestOptions - Request-specific configuration.
26
+ *
22
27
  * @throws {@link Courier.NotFoundError}
28
+ *
29
+ * @example
30
+ * await courier.translations.get("string", "string")
23
31
  */
24
32
  get(domain: string, locale: string, requestOptions?: Translations.RequestOptions): Promise<string>;
25
33
  /**
26
34
  * Update a translation
35
+ *
36
+ * @param {string} domain - The domain you want to retrieve translations for. Only `default` is supported at the moment
37
+ * @param {string} locale - The locale you want to retrieve the translations for
38
+ * @param {string} request
39
+ * @param {Translations.RequestOptions} requestOptions - Request-specific configuration.
40
+ *
27
41
  * @throws {@link Courier.NotFoundError}
42
+ *
43
+ * @example
44
+ * await courier.translations.update("string", "string", "string")
28
45
  */
29
46
  update(domain: string, locale: string, request: string, requestOptions?: Translations.RequestOptions): Promise<void>;
30
47
  protected _getAuthorizationHeader(): Promise<string>;