@getbrevo/brevo 5.0.4 → 6.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (495) hide show
  1. package/README.md +99 -37
  2. package/dist/cjs/BaseClient.d.ts +3 -0
  3. package/dist/cjs/BaseClient.js +17 -2
  4. package/dist/cjs/api/resources/account/client/Client.d.ts +5 -6
  5. package/dist/cjs/api/resources/account/client/Client.js +21 -13
  6. package/dist/cjs/api/resources/account/types/GetAccountResponse.d.ts +4 -17
  7. package/dist/cjs/api/resources/balance/client/Client.d.ts +8 -7
  8. package/dist/cjs/api/resources/balance/client/Client.js +70 -33
  9. package/dist/cjs/api/resources/balance/client/requests/BeginTransactionRequest.d.ts +21 -11
  10. package/dist/cjs/api/resources/balance/client/requests/BeginTransactionRequest.js +9 -0
  11. package/dist/cjs/api/resources/balance/client/requests/CreateBalanceOrderRequest.d.ts +11 -3
  12. package/dist/cjs/api/resources/balance/client/requests/CreateBalanceOrderRequest.js +9 -0
  13. package/dist/cjs/api/resources/balance/client/requests/GetContactBalancesRequest.d.ts +13 -1
  14. package/dist/cjs/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidActiveBalanceRequest.d.ts +7 -6
  15. package/dist/cjs/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidTransactionHistoryRequest.d.ts +6 -6
  16. package/dist/cjs/api/resources/balance/client/requests/index.d.ts +2 -2
  17. package/dist/cjs/api/resources/balance/client/requests/index.js +5 -1
  18. package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSort.d.ts +5 -0
  19. package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSort.js +8 -0
  20. package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSortField.d.ts +5 -0
  21. package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSortField.js +8 -0
  22. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.d.ts +5 -0
  23. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.js +8 -0
  24. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.d.ts +30 -0
  25. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.d.ts +10 -0
  26. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.js +15 -0
  27. package/dist/cjs/api/resources/balance/types/GetSubscriptionBalancesResponse.d.ts +7 -2
  28. package/dist/cjs/api/resources/balance/types/PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse.d.ts +14 -14
  29. package/dist/cjs/api/resources/balance/types/index.d.ts +4 -0
  30. package/dist/cjs/api/resources/balance/types/index.js +4 -0
  31. package/dist/cjs/api/resources/companies/client/Client.d.ts +22 -0
  32. package/dist/cjs/api/resources/companies/client/Client.js +49 -18
  33. package/dist/cjs/api/resources/companies/client/requests/GetCompaniesRequest.d.ts +4 -4
  34. package/dist/cjs/api/resources/companies/client/requests/PatchCompaniesIdRequest.d.ts +1 -1
  35. package/dist/cjs/api/resources/companies/client/requests/PostCompaniesImportRequest.d.ts +1 -1
  36. package/dist/cjs/api/resources/companies/client/requests/PostCrmAttributesRequest.d.ts +2 -2
  37. package/dist/cjs/api/resources/companies/client/requests/PostCrmAttributesRequest.js +1 -1
  38. package/dist/cjs/api/resources/companies/types/GetCrmAttributesCompaniesResponseItem.d.ts +20 -4
  39. package/dist/cjs/api/resources/contacts/client/Client.d.ts +37 -0
  40. package/dist/cjs/api/resources/contacts/client/Client.js +125 -36
  41. package/dist/cjs/api/resources/contacts/client/requests/CreateContactRequest.d.ts +4 -0
  42. package/dist/cjs/api/resources/contacts/client/requests/GetContactInfoRequest.d.ts +2 -2
  43. package/dist/cjs/api/resources/contacts/client/requests/GetContactStatsRequest.d.ts +2 -2
  44. package/dist/cjs/api/resources/contacts/client/requests/GetContactsRequest.d.ts +3 -1
  45. package/dist/cjs/api/resources/contacts/client/requests/GetListRequest.d.ts +1 -1
  46. package/dist/cjs/api/resources/contacts/client/requests/UpdateContactRequest.d.ts +4 -2
  47. package/dist/cjs/api/resources/contacts/types/GetAttributesResponse.d.ts +3 -1
  48. package/dist/cjs/api/resources/contacts/types/GetContactInfoResponse.d.ts +4 -2
  49. package/dist/cjs/api/resources/contacts/types/GetSegmentsResponse.d.ts +2 -2
  50. package/dist/cjs/api/resources/conversations/client/Client.d.ts +18 -8
  51. package/dist/cjs/api/resources/conversations/client/Client.js +28 -18
  52. package/dist/cjs/api/resources/conversations/client/requests/PostConversationsAgentOnlinePingRequest.d.ts +8 -8
  53. package/dist/cjs/api/resources/conversations/client/requests/PostConversationsMessagesRequest.d.ts +12 -10
  54. package/dist/cjs/api/resources/conversations/client/requests/PostConversationsPushedMessagesRequest.d.ts +11 -9
  55. package/dist/cjs/api/resources/conversations/client/requests/PutConversationsMessagesIdRequest.d.ts +1 -1
  56. package/dist/cjs/api/resources/conversations/client/requests/PutConversationsPushedMessagesIdRequest.d.ts +2 -2
  57. package/dist/cjs/api/resources/coupons/client/Client.d.ts +10 -0
  58. package/dist/cjs/api/resources/coupons/client/Client.js +19 -5
  59. package/dist/cjs/api/resources/customObjects/client/Client.d.ts +101 -21
  60. package/dist/cjs/api/resources/customObjects/client/Client.js +108 -26
  61. package/dist/cjs/api/resources/customObjects/client/requests/BatchDeleteObjectRecordsRequest.d.ts +2 -2
  62. package/dist/cjs/api/resources/customObjects/client/requests/GetrecordsRequest.d.ts +1 -1
  63. package/dist/cjs/api/resources/customObjects/client/requests/UpsertrecordsRequest.d.ts +114 -25
  64. package/dist/cjs/api/resources/customObjects/client/requests/UpsertrecordsRequest.js +21 -0
  65. package/dist/cjs/api/resources/customObjects/client/requests/index.d.ts +1 -1
  66. package/dist/cjs/api/resources/customObjects/client/requests/index.js +3 -0
  67. package/dist/cjs/api/resources/customObjects/types/GetrecordsResponse.d.ts +14 -5
  68. package/dist/cjs/api/resources/deals/client/Client.d.ts +22 -0
  69. package/dist/cjs/api/resources/deals/client/Client.js +59 -22
  70. package/dist/cjs/api/resources/deals/client/requests/GetCrmDealsRequest.d.ts +5 -3
  71. package/dist/cjs/api/resources/deals/client/requests/PatchCrmDealsIdRequest.d.ts +1 -1
  72. package/dist/cjs/api/resources/deals/client/requests/PostCrmDealsImportRequest.d.ts +1 -1
  73. package/dist/cjs/api/resources/deals/types/GetCrmAttributesDealsResponseItem.d.ts +20 -4
  74. package/dist/cjs/api/resources/domains/client/Client.js +5 -5
  75. package/dist/cjs/api/resources/ecommerce/client/Client.d.ts +30 -1
  76. package/dist/cjs/api/resources/ecommerce/client/Client.js +73 -20
  77. package/dist/cjs/api/resources/ecommerce/client/requests/CreateBatchOrderRequest.d.ts +2 -2
  78. package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.ts +4 -2
  79. package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateProductRequest.d.ts +4 -2
  80. package/dist/cjs/api/resources/ecommerce/client/requests/GetEcommerceAttributionMetricsRequest.d.ts +2 -1
  81. package/dist/cjs/api/resources/ecommerce/client/requests/GetProductsRequest.d.ts +18 -2
  82. package/dist/cjs/api/resources/ecommerce/types/CreateUpdateCategoryResponse.d.ts +1 -1
  83. package/dist/cjs/api/resources/ecommerce/types/CreateUpdateProductResponse.d.ts +2 -2
  84. package/dist/cjs/api/resources/ecommerce/types/GetProductsRequestSortByField.d.ts +7 -0
  85. package/dist/cjs/api/resources/ecommerce/types/GetProductsRequestSortByField.js +10 -0
  86. package/dist/cjs/api/resources/ecommerce/types/index.d.ts +1 -0
  87. package/dist/cjs/api/resources/ecommerce/types/index.js +1 -0
  88. package/dist/cjs/api/resources/emailCampaigns/client/Client.d.ts +22 -1
  89. package/dist/cjs/api/resources/emailCampaigns/client/Client.js +51 -15
  90. package/dist/cjs/api/resources/emailCampaigns/client/requests/CreateEmailCampaignRequest.d.ts +7 -7
  91. package/dist/cjs/api/resources/emailCampaigns/client/requests/GetEmailCampaignRequest.d.ts +1 -1
  92. package/dist/cjs/api/resources/emailCampaigns/client/requests/GetEmailCampaignsRequest.d.ts +6 -4
  93. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignResponse.d.ts +28 -5
  94. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignResponse.js +9 -0
  95. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.d.ts +27 -4
  96. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.js +9 -0
  97. package/dist/cjs/api/resources/event/client/Client.d.ts +8 -6
  98. package/dist/cjs/api/resources/event/client/Client.js +14 -8
  99. package/dist/cjs/api/resources/event/client/requests/CreateBatchEventsRequest.d.ts +76 -0
  100. package/dist/cjs/api/resources/event/client/requests/CreateEventRequest.d.ts +3 -3
  101. package/dist/cjs/api/resources/event/client/requests/index.d.ts +1 -0
  102. package/dist/cjs/api/resources/event/index.d.ts +0 -1
  103. package/dist/cjs/api/resources/event/index.js +0 -1
  104. package/dist/cjs/api/resources/externalFeeds/client/Client.js +9 -5
  105. package/dist/cjs/api/resources/externalFeeds/types/GetAllExternalFeedsResponse.d.ts +3 -7
  106. package/dist/cjs/api/resources/externalFeeds/types/GetExternalFeedByUuidResponse.d.ts +3 -9
  107. package/dist/cjs/api/resources/files/client/Client.d.ts +10 -0
  108. package/dist/cjs/api/resources/files/client/Client.js +19 -5
  109. package/dist/cjs/api/resources/inboundParsing/client/Client.d.ts +2 -1
  110. package/dist/cjs/api/resources/inboundParsing/client/Client.js +11 -4
  111. package/dist/cjs/api/resources/inboundParsing/client/requests/GetInboundEmailEventsRequest.d.ts +2 -2
  112. package/dist/cjs/api/resources/inboundParsing/types/GetInboundEmailEventsByUuidResponse.d.ts +2 -2
  113. package/dist/cjs/api/resources/index.d.ts +0 -1
  114. package/dist/cjs/api/resources/index.js +0 -1
  115. package/dist/cjs/api/resources/masterAccount/client/Client.d.ts +10 -0
  116. package/dist/cjs/api/resources/masterAccount/client/Client.js +84 -46
  117. package/dist/cjs/api/resources/notes/client/Client.d.ts +12 -2
  118. package/dist/cjs/api/resources/notes/client/Client.js +21 -7
  119. package/dist/cjs/api/resources/notes/client/requests/PatchCrmNotesIdRequest.d.ts +1 -1
  120. package/dist/cjs/api/resources/notes/types/PostCrmNotesResponse.d.ts +1 -1
  121. package/dist/cjs/api/resources/payments/client/Client.d.ts +6 -0
  122. package/dist/cjs/api/resources/payments/client/Client.js +9 -3
  123. package/dist/cjs/api/resources/process/client/Client.d.ts +13 -18
  124. package/dist/cjs/api/resources/process/client/Client.js +19 -20
  125. package/dist/cjs/api/resources/process/types/GetProcessResponse.d.ts +19 -36
  126. package/dist/cjs/api/resources/process/types/GetProcessesResponse.d.ts +19 -36
  127. package/dist/cjs/api/resources/program/client/Client.d.ts +1 -1
  128. package/dist/cjs/api/resources/program/client/Client.js +26 -14
  129. package/dist/cjs/api/resources/program/client/requests/GetLpListRequest.d.ts +2 -2
  130. package/dist/cjs/api/resources/program/client/requests/SubscribeToLoyaltyProgramRequest.d.ts +5 -3
  131. package/dist/cjs/api/resources/program/types/GetLpListRequestSort.d.ts +5 -0
  132. package/dist/cjs/api/resources/program/types/GetLpListRequestSort.js +8 -0
  133. package/dist/cjs/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.ts +2 -0
  134. package/dist/cjs/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.ts +4 -4
  135. package/dist/cjs/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.ts +10 -8
  136. package/dist/cjs/api/resources/program/types/index.d.ts +1 -0
  137. package/dist/cjs/api/resources/program/types/index.js +1 -0
  138. package/dist/cjs/api/resources/reward/client/Client.js +26 -10
  139. package/dist/cjs/api/resources/reward/client/requests/CreateVoucherRequest.d.ts +2 -0
  140. package/dist/cjs/api/resources/reward/client/requests/RedeemVoucherRequest.d.ts +2 -0
  141. package/dist/cjs/api/resources/reward/types/CreateRewardResponse.d.ts +7 -7
  142. package/dist/cjs/api/resources/reward/types/CreateVoucherResponse.d.ts +2 -0
  143. package/dist/cjs/api/resources/reward/types/GetLoyaltyOfferProgramsPidVouchersResponse.d.ts +2 -0
  144. package/dist/cjs/api/resources/senders/client/Client.js +11 -7
  145. package/dist/cjs/api/resources/senders/types/GetIpsResponse.d.ts +2 -2
  146. package/dist/cjs/api/resources/smsCampaigns/client/Client.d.ts +16 -0
  147. package/dist/cjs/api/resources/smsCampaigns/client/Client.js +30 -10
  148. package/dist/cjs/api/resources/smsCampaigns/client/requests/GetSmsCampaignsRequest.d.ts +3 -3
  149. package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.ts +38 -2
  150. package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.ts +7 -1
  151. package/dist/cjs/api/resources/smsTemplates/client/Client.js +5 -1
  152. package/dist/cjs/api/resources/tasks/client/Client.d.ts +16 -2
  153. package/dist/cjs/api/resources/tasks/client/Client.js +35 -12
  154. package/dist/cjs/api/resources/tasks/client/requests/PostCrmTasksRequest.d.ts +1 -1
  155. package/dist/cjs/api/resources/tasks/types/{GetCrmTasktypesResponse.d.ts → GetCrmTasktypesResponseItem.d.ts} +1 -4
  156. package/dist/cjs/api/resources/tasks/types/GetCrmTasktypesResponseItem.js +3 -0
  157. package/dist/cjs/api/resources/tasks/types/index.d.ts +1 -1
  158. package/dist/cjs/api/resources/tasks/types/index.js +1 -1
  159. package/dist/cjs/api/resources/tier/client/Client.js +22 -10
  160. package/dist/cjs/api/resources/tier/client/requests/CreateTierGroupRequest.d.ts +62 -0
  161. package/dist/cjs/api/resources/tier/client/requests/CreateTierGroupRequest.js +30 -0
  162. package/dist/cjs/api/resources/transactionalEmails/client/Client.d.ts +31 -2
  163. package/dist/cjs/api/resources/transactionalEmails/client/Client.js +114 -35
  164. package/dist/cjs/api/resources/transactionalEmails/client/requests/DeleteScheduledEmailByIdRequest.d.ts +1 -1
  165. package/dist/cjs/api/resources/transactionalEmails/client/requests/DeleteSmtpLogIdentifierRequest.d.ts +5 -1
  166. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetAggregatedSmtpReportRequest.d.ts +1 -1
  167. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetEmailEventReportRequest.d.ts +1 -1
  168. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.ts +2 -2
  169. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpReportRequest.d.ts +1 -1
  170. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpTemplateRequest.d.ts +3 -2
  171. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpTemplatesRequest.d.ts +2 -0
  172. package/dist/cjs/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.ts +3 -2
  173. package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.d.ts +1 -0
  174. package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.js +3 -0
  175. package/dist/cjs/api/resources/transactionalEmails/types/GetTransacEmailContentResponse.d.ts +2 -2
  176. package/dist/cjs/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.d.ts +1 -0
  177. package/dist/cjs/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.js +3 -0
  178. package/dist/cjs/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.d.ts +1 -0
  179. package/dist/cjs/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.js +3 -0
  180. package/dist/cjs/api/resources/transactionalEmails/types/index.d.ts +3 -0
  181. package/dist/cjs/api/resources/transactionalEmails/types/index.js +3 -0
  182. package/dist/cjs/api/resources/transactionalSms/client/Client.d.ts +9 -0
  183. package/dist/cjs/api/resources/transactionalSms/client/Client.js +28 -5
  184. package/dist/cjs/api/resources/transactionalWhatsApp/client/Client.js +6 -2
  185. package/dist/cjs/api/resources/user/client/Client.d.ts +8 -0
  186. package/dist/cjs/api/resources/user/client/Client.js +14 -6
  187. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +0 -1
  188. package/dist/cjs/api/resources/webhooks/client/Client.js +10 -7
  189. package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequest.d.ts +14 -21
  190. package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequest.js +2 -2
  191. package/dist/cjs/api/resources/webhooks/client/requests/ExportWebhooksHistoryRequest.d.ts +1 -1
  192. package/dist/cjs/api/resources/whatsAppCampaigns/client/Client.d.ts +6 -0
  193. package/dist/cjs/api/resources/whatsAppCampaigns/client/Client.js +23 -9
  194. package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.ts +15 -0
  195. package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.ts +2 -0
  196. package/dist/cjs/api/types/BalanceDefinition.d.ts +81 -32
  197. package/dist/cjs/api/types/BalanceDefinition.js +46 -2
  198. package/dist/cjs/api/types/BalanceLimit.d.ts +37 -14
  199. package/dist/cjs/api/types/BalanceLimit.js +22 -0
  200. package/dist/cjs/api/types/Company.d.ts +1 -1
  201. package/dist/cjs/api/types/ConversationsMessage.d.ts +59 -20
  202. package/dist/cjs/api/types/Deal.d.ts +4 -4
  203. package/dist/cjs/api/types/FileData.d.ts +8 -6
  204. package/dist/cjs/api/types/GetCampaignRecipients.d.ts +4 -0
  205. package/dist/cjs/api/types/GetCampaignStats.d.ts +4 -4
  206. package/dist/cjs/api/types/GetContactDetails.d.ts +2 -0
  207. package/dist/cjs/api/types/GetEventsList.d.ts +0 -2
  208. package/dist/cjs/api/types/GetExtendedCampaignOverview.d.ts +28 -5
  209. package/dist/cjs/api/types/GetExtendedCampaignOverview.js +9 -0
  210. package/dist/cjs/api/types/GetExtendedCampaignStats.d.ts +8 -10
  211. package/dist/cjs/api/types/GetProductDetails.d.ts +3 -1
  212. package/dist/cjs/api/types/GetSmsCampaignOverview.d.ts +7 -1
  213. package/dist/cjs/api/types/GetSmtpTemplateOverview.d.ts +3 -1
  214. package/dist/cjs/api/types/GetWebhook.d.ts +5 -10
  215. package/dist/cjs/api/types/GetWebhook.js +2 -6
  216. package/dist/cjs/api/types/LoyaltyProgram.d.ts +23 -20
  217. package/dist/cjs/api/types/LoyaltyProgram.js +2 -1
  218. package/dist/cjs/api/types/Note.d.ts +10 -8
  219. package/dist/cjs/api/types/NoteData.d.ts +1 -1
  220. package/dist/cjs/api/types/Order.d.ts +1 -1
  221. package/dist/cjs/api/types/Pipeline.d.ts +3 -3
  222. package/dist/cjs/api/types/SendTransacSms.d.ts +7 -14
  223. package/dist/cjs/api/types/Task.d.ts +20 -8
  224. package/dist/cjs/api/types/TierGroup.d.ts +66 -0
  225. package/dist/cjs/api/types/TierGroup.js +30 -0
  226. package/dist/cjs/api/types/Transaction.d.ts +36 -17
  227. package/dist/cjs/api/types/Transaction.js +17 -0
  228. package/dist/cjs/core/auth/AuthProvider.d.ts +1 -0
  229. package/dist/cjs/core/auth/AuthProvider.js +7 -0
  230. package/dist/cjs/core/auth/index.d.ts +1 -1
  231. package/dist/cjs/core/auth/index.js +3 -1
  232. package/dist/cjs/core/fetcher/Fetcher.d.ts +6 -0
  233. package/dist/cjs/core/fetcher/Fetcher.js +9 -8
  234. package/dist/cjs/core/fetcher/requestWithRetries.js +4 -1
  235. package/dist/cjs/core/url/QueryStringBuilder.d.ts +47 -0
  236. package/dist/cjs/core/url/QueryStringBuilder.js +83 -0
  237. package/dist/cjs/core/url/index.d.ts +1 -0
  238. package/dist/cjs/core/url/index.js +3 -1
  239. package/dist/cjs/core/url/qs.d.ts +2 -1
  240. package/dist/cjs/core/url/qs.js +24 -12
  241. package/dist/cjs/version.d.ts +1 -1
  242. package/dist/cjs/version.js +1 -1
  243. package/dist/esm/BaseClient.d.mts +3 -0
  244. package/dist/esm/BaseClient.mjs +17 -2
  245. package/dist/esm/api/resources/account/client/Client.d.mts +5 -6
  246. package/dist/esm/api/resources/account/client/Client.mjs +21 -13
  247. package/dist/esm/api/resources/account/types/GetAccountResponse.d.mts +4 -17
  248. package/dist/esm/api/resources/balance/client/Client.d.mts +8 -7
  249. package/dist/esm/api/resources/balance/client/Client.mjs +70 -33
  250. package/dist/esm/api/resources/balance/client/requests/BeginTransactionRequest.d.mts +21 -11
  251. package/dist/esm/api/resources/balance/client/requests/BeginTransactionRequest.mjs +8 -1
  252. package/dist/esm/api/resources/balance/client/requests/CreateBalanceOrderRequest.d.mts +11 -3
  253. package/dist/esm/api/resources/balance/client/requests/CreateBalanceOrderRequest.mjs +8 -1
  254. package/dist/esm/api/resources/balance/client/requests/GetContactBalancesRequest.d.mts +13 -1
  255. package/dist/esm/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidActiveBalanceRequest.d.mts +7 -6
  256. package/dist/esm/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidTransactionHistoryRequest.d.mts +6 -6
  257. package/dist/esm/api/resources/balance/client/requests/index.d.mts +2 -2
  258. package/dist/esm/api/resources/balance/client/requests/index.mjs +2 -0
  259. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSort.d.mts +5 -0
  260. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSort.mjs +5 -0
  261. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSortField.d.mts +5 -0
  262. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSortField.mjs +5 -0
  263. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.d.mts +5 -0
  264. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.mjs +5 -0
  265. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.d.mts +30 -0
  266. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.d.mts +10 -0
  267. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.mjs +14 -1
  268. package/dist/esm/api/resources/balance/types/GetSubscriptionBalancesResponse.d.mts +7 -2
  269. package/dist/esm/api/resources/balance/types/PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse.d.mts +14 -14
  270. package/dist/esm/api/resources/balance/types/index.d.mts +4 -0
  271. package/dist/esm/api/resources/balance/types/index.mjs +4 -0
  272. package/dist/esm/api/resources/companies/client/Client.d.mts +22 -0
  273. package/dist/esm/api/resources/companies/client/Client.mjs +49 -18
  274. package/dist/esm/api/resources/companies/client/requests/GetCompaniesRequest.d.mts +4 -4
  275. package/dist/esm/api/resources/companies/client/requests/PatchCompaniesIdRequest.d.mts +1 -1
  276. package/dist/esm/api/resources/companies/client/requests/PostCompaniesImportRequest.d.mts +1 -1
  277. package/dist/esm/api/resources/companies/client/requests/PostCrmAttributesRequest.d.mts +2 -2
  278. package/dist/esm/api/resources/companies/client/requests/PostCrmAttributesRequest.mjs +1 -1
  279. package/dist/esm/api/resources/companies/types/GetCrmAttributesCompaniesResponseItem.d.mts +20 -4
  280. package/dist/esm/api/resources/contacts/client/Client.d.mts +37 -0
  281. package/dist/esm/api/resources/contacts/client/Client.mjs +125 -36
  282. package/dist/esm/api/resources/contacts/client/requests/CreateContactRequest.d.mts +4 -0
  283. package/dist/esm/api/resources/contacts/client/requests/GetContactInfoRequest.d.mts +2 -2
  284. package/dist/esm/api/resources/contacts/client/requests/GetContactStatsRequest.d.mts +2 -2
  285. package/dist/esm/api/resources/contacts/client/requests/GetContactsRequest.d.mts +3 -1
  286. package/dist/esm/api/resources/contacts/client/requests/GetListRequest.d.mts +1 -1
  287. package/dist/esm/api/resources/contacts/client/requests/UpdateContactRequest.d.mts +4 -2
  288. package/dist/esm/api/resources/contacts/types/GetAttributesResponse.d.mts +3 -1
  289. package/dist/esm/api/resources/contacts/types/GetContactInfoResponse.d.mts +4 -2
  290. package/dist/esm/api/resources/contacts/types/GetSegmentsResponse.d.mts +2 -2
  291. package/dist/esm/api/resources/conversations/client/Client.d.mts +18 -8
  292. package/dist/esm/api/resources/conversations/client/Client.mjs +28 -18
  293. package/dist/esm/api/resources/conversations/client/requests/PostConversationsAgentOnlinePingRequest.d.mts +8 -8
  294. package/dist/esm/api/resources/conversations/client/requests/PostConversationsMessagesRequest.d.mts +12 -10
  295. package/dist/esm/api/resources/conversations/client/requests/PostConversationsPushedMessagesRequest.d.mts +11 -9
  296. package/dist/esm/api/resources/conversations/client/requests/PutConversationsMessagesIdRequest.d.mts +1 -1
  297. package/dist/esm/api/resources/conversations/client/requests/PutConversationsPushedMessagesIdRequest.d.mts +2 -2
  298. package/dist/esm/api/resources/coupons/client/Client.d.mts +10 -0
  299. package/dist/esm/api/resources/coupons/client/Client.mjs +19 -5
  300. package/dist/esm/api/resources/customObjects/client/Client.d.mts +101 -21
  301. package/dist/esm/api/resources/customObjects/client/Client.mjs +108 -26
  302. package/dist/esm/api/resources/customObjects/client/requests/BatchDeleteObjectRecordsRequest.d.mts +2 -2
  303. package/dist/esm/api/resources/customObjects/client/requests/GetrecordsRequest.d.mts +1 -1
  304. package/dist/esm/api/resources/customObjects/client/requests/UpsertrecordsRequest.d.mts +114 -25
  305. package/dist/esm/api/resources/customObjects/client/requests/UpsertrecordsRequest.mjs +20 -1
  306. package/dist/esm/api/resources/customObjects/client/requests/index.d.mts +1 -1
  307. package/dist/esm/api/resources/customObjects/client/requests/index.mjs +1 -1
  308. package/dist/esm/api/resources/customObjects/types/GetrecordsResponse.d.mts +14 -5
  309. package/dist/esm/api/resources/deals/client/Client.d.mts +22 -0
  310. package/dist/esm/api/resources/deals/client/Client.mjs +59 -22
  311. package/dist/esm/api/resources/deals/client/requests/GetCrmDealsRequest.d.mts +5 -3
  312. package/dist/esm/api/resources/deals/client/requests/PatchCrmDealsIdRequest.d.mts +1 -1
  313. package/dist/esm/api/resources/deals/client/requests/PostCrmDealsImportRequest.d.mts +1 -1
  314. package/dist/esm/api/resources/deals/types/GetCrmAttributesDealsResponseItem.d.mts +20 -4
  315. package/dist/esm/api/resources/domains/client/Client.mjs +5 -5
  316. package/dist/esm/api/resources/ecommerce/client/Client.d.mts +30 -1
  317. package/dist/esm/api/resources/ecommerce/client/Client.mjs +73 -20
  318. package/dist/esm/api/resources/ecommerce/client/requests/CreateBatchOrderRequest.d.mts +2 -2
  319. package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.mts +4 -2
  320. package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateProductRequest.d.mts +4 -2
  321. package/dist/esm/api/resources/ecommerce/client/requests/GetEcommerceAttributionMetricsRequest.d.mts +2 -1
  322. package/dist/esm/api/resources/ecommerce/client/requests/GetProductsRequest.d.mts +18 -2
  323. package/dist/esm/api/resources/ecommerce/types/CreateUpdateCategoryResponse.d.mts +1 -1
  324. package/dist/esm/api/resources/ecommerce/types/CreateUpdateProductResponse.d.mts +2 -2
  325. package/dist/esm/api/resources/ecommerce/types/GetProductsRequestSortByField.d.mts +7 -0
  326. package/dist/esm/api/resources/ecommerce/types/GetProductsRequestSortByField.mjs +7 -0
  327. package/dist/esm/api/resources/ecommerce/types/index.d.mts +1 -0
  328. package/dist/esm/api/resources/ecommerce/types/index.mjs +1 -0
  329. package/dist/esm/api/resources/emailCampaigns/client/Client.d.mts +22 -1
  330. package/dist/esm/api/resources/emailCampaigns/client/Client.mjs +51 -15
  331. package/dist/esm/api/resources/emailCampaigns/client/requests/CreateEmailCampaignRequest.d.mts +7 -7
  332. package/dist/esm/api/resources/emailCampaigns/client/requests/GetEmailCampaignRequest.d.mts +1 -1
  333. package/dist/esm/api/resources/emailCampaigns/client/requests/GetEmailCampaignsRequest.d.mts +6 -4
  334. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignResponse.d.mts +28 -5
  335. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignResponse.mjs +9 -0
  336. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.d.mts +27 -4
  337. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.mjs +9 -0
  338. package/dist/esm/api/resources/event/client/Client.d.mts +8 -6
  339. package/dist/esm/api/resources/event/client/Client.mjs +14 -8
  340. package/dist/esm/api/resources/event/client/requests/CreateBatchEventsRequest.d.mts +76 -0
  341. package/dist/esm/api/resources/event/client/requests/CreateEventRequest.d.mts +3 -3
  342. package/dist/esm/api/resources/event/client/requests/index.d.mts +1 -0
  343. package/dist/esm/api/resources/event/index.d.mts +0 -1
  344. package/dist/esm/api/resources/event/index.mjs +0 -1
  345. package/dist/esm/api/resources/externalFeeds/client/Client.mjs +9 -5
  346. package/dist/esm/api/resources/externalFeeds/types/GetAllExternalFeedsResponse.d.mts +3 -7
  347. package/dist/esm/api/resources/externalFeeds/types/GetExternalFeedByUuidResponse.d.mts +3 -9
  348. package/dist/esm/api/resources/files/client/Client.d.mts +10 -0
  349. package/dist/esm/api/resources/files/client/Client.mjs +19 -5
  350. package/dist/esm/api/resources/inboundParsing/client/Client.d.mts +2 -1
  351. package/dist/esm/api/resources/inboundParsing/client/Client.mjs +11 -4
  352. package/dist/esm/api/resources/inboundParsing/client/requests/GetInboundEmailEventsRequest.d.mts +2 -2
  353. package/dist/esm/api/resources/inboundParsing/types/GetInboundEmailEventsByUuidResponse.d.mts +2 -2
  354. package/dist/esm/api/resources/index.d.mts +0 -1
  355. package/dist/esm/api/resources/index.mjs +0 -1
  356. package/dist/esm/api/resources/masterAccount/client/Client.d.mts +10 -0
  357. package/dist/esm/api/resources/masterAccount/client/Client.mjs +84 -46
  358. package/dist/esm/api/resources/notes/client/Client.d.mts +12 -2
  359. package/dist/esm/api/resources/notes/client/Client.mjs +21 -7
  360. package/dist/esm/api/resources/notes/client/requests/PatchCrmNotesIdRequest.d.mts +1 -1
  361. package/dist/esm/api/resources/notes/types/PostCrmNotesResponse.d.mts +1 -1
  362. package/dist/esm/api/resources/payments/client/Client.d.mts +6 -0
  363. package/dist/esm/api/resources/payments/client/Client.mjs +9 -3
  364. package/dist/esm/api/resources/process/client/Client.d.mts +13 -18
  365. package/dist/esm/api/resources/process/client/Client.mjs +19 -20
  366. package/dist/esm/api/resources/process/types/GetProcessResponse.d.mts +19 -36
  367. package/dist/esm/api/resources/process/types/GetProcessesResponse.d.mts +19 -36
  368. package/dist/esm/api/resources/program/client/Client.d.mts +1 -1
  369. package/dist/esm/api/resources/program/client/Client.mjs +26 -14
  370. package/dist/esm/api/resources/program/client/requests/GetLpListRequest.d.mts +2 -2
  371. package/dist/esm/api/resources/program/client/requests/SubscribeToLoyaltyProgramRequest.d.mts +5 -3
  372. package/dist/esm/api/resources/program/types/GetLpListRequestSort.d.mts +5 -0
  373. package/dist/esm/api/resources/program/types/GetLpListRequestSort.mjs +5 -0
  374. package/dist/esm/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.mts +2 -0
  375. package/dist/esm/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.mts +4 -4
  376. package/dist/esm/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.mts +10 -8
  377. package/dist/esm/api/resources/program/types/index.d.mts +1 -0
  378. package/dist/esm/api/resources/program/types/index.mjs +1 -0
  379. package/dist/esm/api/resources/reward/client/Client.mjs +26 -10
  380. package/dist/esm/api/resources/reward/client/requests/CreateVoucherRequest.d.mts +2 -0
  381. package/dist/esm/api/resources/reward/client/requests/RedeemVoucherRequest.d.mts +2 -0
  382. package/dist/esm/api/resources/reward/types/CreateRewardResponse.d.mts +7 -7
  383. package/dist/esm/api/resources/reward/types/CreateVoucherResponse.d.mts +2 -0
  384. package/dist/esm/api/resources/reward/types/GetLoyaltyOfferProgramsPidVouchersResponse.d.mts +2 -0
  385. package/dist/esm/api/resources/senders/client/Client.mjs +11 -7
  386. package/dist/esm/api/resources/senders/types/GetIpsResponse.d.mts +2 -2
  387. package/dist/esm/api/resources/smsCampaigns/client/Client.d.mts +16 -0
  388. package/dist/esm/api/resources/smsCampaigns/client/Client.mjs +30 -10
  389. package/dist/esm/api/resources/smsCampaigns/client/requests/GetSmsCampaignsRequest.d.mts +3 -3
  390. package/dist/esm/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.mts +38 -2
  391. package/dist/esm/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.mts +7 -1
  392. package/dist/esm/api/resources/smsTemplates/client/Client.mjs +5 -1
  393. package/dist/esm/api/resources/tasks/client/Client.d.mts +16 -2
  394. package/dist/esm/api/resources/tasks/client/Client.mjs +35 -12
  395. package/dist/esm/api/resources/tasks/client/requests/PostCrmTasksRequest.d.mts +1 -1
  396. package/dist/esm/api/resources/tasks/types/{GetCrmTasktypesResponse.d.mts → GetCrmTasktypesResponseItem.d.mts} +1 -4
  397. package/dist/esm/api/resources/tasks/types/GetCrmTasktypesResponseItem.mjs +2 -0
  398. package/dist/esm/api/resources/tasks/types/index.d.mts +1 -1
  399. package/dist/esm/api/resources/tasks/types/index.mjs +1 -1
  400. package/dist/esm/api/resources/tier/client/Client.mjs +22 -10
  401. package/dist/esm/api/resources/tier/client/requests/CreateTierGroupRequest.d.mts +62 -0
  402. package/dist/esm/api/resources/tier/client/requests/CreateTierGroupRequest.mjs +30 -0
  403. package/dist/esm/api/resources/transactionalEmails/client/Client.d.mts +31 -2
  404. package/dist/esm/api/resources/transactionalEmails/client/Client.mjs +114 -35
  405. package/dist/esm/api/resources/transactionalEmails/client/requests/DeleteScheduledEmailByIdRequest.d.mts +1 -1
  406. package/dist/esm/api/resources/transactionalEmails/client/requests/DeleteSmtpLogIdentifierRequest.d.mts +5 -1
  407. package/dist/esm/api/resources/transactionalEmails/client/requests/GetAggregatedSmtpReportRequest.d.mts +1 -1
  408. package/dist/esm/api/resources/transactionalEmails/client/requests/GetEmailEventReportRequest.d.mts +1 -1
  409. package/dist/esm/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.mts +2 -2
  410. package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpReportRequest.d.mts +1 -1
  411. package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpTemplateRequest.d.mts +3 -2
  412. package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpTemplatesRequest.d.mts +2 -0
  413. package/dist/esm/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.mts +3 -2
  414. package/dist/esm/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.d.mts +1 -0
  415. package/dist/esm/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.mjs +2 -0
  416. package/dist/esm/api/resources/transactionalEmails/types/GetTransacEmailContentResponse.d.mts +2 -2
  417. package/dist/esm/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.d.mts +1 -0
  418. package/dist/esm/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.mjs +2 -0
  419. package/dist/esm/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.d.mts +1 -0
  420. package/dist/esm/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.mjs +2 -0
  421. package/dist/esm/api/resources/transactionalEmails/types/index.d.mts +3 -0
  422. package/dist/esm/api/resources/transactionalEmails/types/index.mjs +3 -0
  423. package/dist/esm/api/resources/transactionalSms/client/Client.d.mts +9 -0
  424. package/dist/esm/api/resources/transactionalSms/client/Client.mjs +28 -5
  425. package/dist/esm/api/resources/transactionalWhatsApp/client/Client.mjs +6 -2
  426. package/dist/esm/api/resources/user/client/Client.d.mts +8 -0
  427. package/dist/esm/api/resources/user/client/Client.mjs +14 -6
  428. package/dist/esm/api/resources/webhooks/client/Client.d.mts +0 -1
  429. package/dist/esm/api/resources/webhooks/client/Client.mjs +10 -7
  430. package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequest.d.mts +14 -21
  431. package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequest.mjs +2 -2
  432. package/dist/esm/api/resources/webhooks/client/requests/ExportWebhooksHistoryRequest.d.mts +1 -1
  433. package/dist/esm/api/resources/whatsAppCampaigns/client/Client.d.mts +6 -0
  434. package/dist/esm/api/resources/whatsAppCampaigns/client/Client.mjs +23 -9
  435. package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.mts +15 -0
  436. package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.mts +2 -0
  437. package/dist/esm/api/types/BalanceDefinition.d.mts +81 -32
  438. package/dist/esm/api/types/BalanceDefinition.mjs +46 -2
  439. package/dist/esm/api/types/BalanceLimit.d.mts +37 -14
  440. package/dist/esm/api/types/BalanceLimit.mjs +21 -1
  441. package/dist/esm/api/types/Company.d.mts +1 -1
  442. package/dist/esm/api/types/ConversationsMessage.d.mts +59 -20
  443. package/dist/esm/api/types/Deal.d.mts +4 -4
  444. package/dist/esm/api/types/FileData.d.mts +8 -6
  445. package/dist/esm/api/types/GetCampaignRecipients.d.mts +4 -0
  446. package/dist/esm/api/types/GetCampaignStats.d.mts +4 -4
  447. package/dist/esm/api/types/GetContactDetails.d.mts +2 -0
  448. package/dist/esm/api/types/GetEventsList.d.mts +0 -2
  449. package/dist/esm/api/types/GetExtendedCampaignOverview.d.mts +28 -5
  450. package/dist/esm/api/types/GetExtendedCampaignOverview.mjs +9 -0
  451. package/dist/esm/api/types/GetExtendedCampaignStats.d.mts +8 -10
  452. package/dist/esm/api/types/GetProductDetails.d.mts +3 -1
  453. package/dist/esm/api/types/GetSmsCampaignOverview.d.mts +7 -1
  454. package/dist/esm/api/types/GetSmtpTemplateOverview.d.mts +3 -1
  455. package/dist/esm/api/types/GetWebhook.d.mts +5 -10
  456. package/dist/esm/api/types/GetWebhook.mjs +2 -6
  457. package/dist/esm/api/types/LoyaltyProgram.d.mts +23 -20
  458. package/dist/esm/api/types/LoyaltyProgram.mjs +2 -1
  459. package/dist/esm/api/types/Note.d.mts +10 -8
  460. package/dist/esm/api/types/NoteData.d.mts +1 -1
  461. package/dist/esm/api/types/Order.d.mts +1 -1
  462. package/dist/esm/api/types/Pipeline.d.mts +3 -3
  463. package/dist/esm/api/types/SendTransacSms.d.mts +7 -14
  464. package/dist/esm/api/types/Task.d.mts +20 -8
  465. package/dist/esm/api/types/TierGroup.d.mts +66 -0
  466. package/dist/esm/api/types/TierGroup.mjs +30 -0
  467. package/dist/esm/api/types/Transaction.d.mts +36 -17
  468. package/dist/esm/api/types/Transaction.mjs +16 -1
  469. package/dist/esm/core/auth/AuthProvider.d.mts +1 -0
  470. package/dist/esm/core/auth/AuthProvider.mjs +6 -1
  471. package/dist/esm/core/auth/index.d.mts +1 -1
  472. package/dist/esm/core/auth/index.mjs +1 -0
  473. package/dist/esm/core/fetcher/Fetcher.d.mts +6 -0
  474. package/dist/esm/core/fetcher/Fetcher.mjs +9 -8
  475. package/dist/esm/core/fetcher/requestWithRetries.mjs +4 -1
  476. package/dist/esm/core/url/QueryStringBuilder.d.mts +47 -0
  477. package/dist/esm/core/url/QueryStringBuilder.mjs +80 -0
  478. package/dist/esm/core/url/index.d.mts +1 -0
  479. package/dist/esm/core/url/index.mjs +1 -0
  480. package/dist/esm/core/url/qs.d.mts +2 -1
  481. package/dist/esm/core/url/qs.mjs +24 -12
  482. package/dist/esm/version.d.mts +1 -1
  483. package/dist/esm/version.mjs +1 -1
  484. package/package.json +2 -2
  485. package/reference.md +1825 -96
  486. package/dist/cjs/api/resources/event/types/CreateBatchEventsRequestItem.d.ts +0 -59
  487. package/dist/cjs/api/resources/event/types/index.d.ts +0 -1
  488. package/dist/cjs/api/resources/event/types/index.js +0 -17
  489. package/dist/esm/api/resources/event/types/CreateBatchEventsRequestItem.d.mts +0 -59
  490. package/dist/esm/api/resources/event/types/index.d.mts +0 -1
  491. package/dist/esm/api/resources/event/types/index.mjs +0 -1
  492. /package/dist/cjs/api/resources/{event/types/CreateBatchEventsRequestItem.js → balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.js} +0 -0
  493. /package/dist/cjs/api/resources/{tasks/types/GetCrmTasktypesResponse.js → event/client/requests/CreateBatchEventsRequest.js} +0 -0
  494. /package/dist/esm/api/resources/{event/types/CreateBatchEventsRequestItem.mjs → balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.mjs} +0 -0
  495. /package/dist/esm/api/resources/{tasks/types/GetCrmTasktypesResponse.mjs → event/client/requests/CreateBatchEventsRequest.mjs} +0 -0
@@ -97,7 +97,7 @@ class RewardClient {
97
97
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/offer/programs/${core.url.encodePathParam(pid)}/code-pools/${core.url.encodePathParam(cpid)}/codes-count`),
98
98
  method: "GET",
99
99
  headers: _headers,
100
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
100
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
101
101
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
102
102
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
103
103
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -167,7 +167,11 @@ class RewardClient {
167
167
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/offer/programs/${core.url.encodePathParam(pid)}/offers`),
168
168
  method: "GET",
169
169
  headers: _headers,
170
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
170
+ queryString: core.url
171
+ .queryBuilder()
172
+ .addMany(_queryParams)
173
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
174
+ .build(),
171
175
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
172
176
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
173
177
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -236,7 +240,7 @@ class RewardClient {
236
240
  method: "POST",
237
241
  headers: _headers,
238
242
  contentType: "application/json",
239
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
243
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
240
244
  requestType: "json",
241
245
  body: _body,
242
246
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -302,7 +306,7 @@ class RewardClient {
302
306
  method: "POST",
303
307
  headers: _headers,
304
308
  contentType: "application/json",
305
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
309
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
306
310
  requestType: "json",
307
311
  body: _body,
308
312
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -373,7 +377,7 @@ class RewardClient {
373
377
  method: "POST",
374
378
  headers: _headers,
375
379
  contentType: "application/json",
376
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
380
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
377
381
  requestType: "json",
378
382
  body: _body,
379
383
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -448,7 +452,7 @@ class RewardClient {
448
452
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/offer/programs/${core.url.encodePathParam(pid)}/rewards/redeem/${core.url.encodePathParam(tid)}/complete`),
449
453
  method: "POST",
450
454
  headers: _headers,
451
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
455
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
452
456
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
453
457
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
454
458
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -517,7 +521,11 @@ class RewardClient {
517
521
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/offer/programs/${core.url.encodePathParam(pid)}/rewards/revoke`),
518
522
  method: "DELETE",
519
523
  headers: _headers,
520
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
524
+ queryString: core.url
525
+ .queryBuilder()
526
+ .addMany(_queryParams)
527
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
528
+ .build(),
521
529
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
522
530
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
523
531
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -576,7 +584,7 @@ class RewardClient {
576
584
  method: "POST",
577
585
  headers: _headers,
578
586
  contentType: "application/json",
579
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
587
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
580
588
  requestType: "json",
581
589
  body: _body,
582
590
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -648,7 +656,11 @@ class RewardClient {
648
656
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/offer/programs/${core.url.encodePathParam(pid)}/rewards/${core.url.encodePathParam(rid)}`),
649
657
  method: "GET",
650
658
  headers: _headers,
651
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
659
+ queryString: core.url
660
+ .queryBuilder()
661
+ .addMany(_queryParams)
662
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
663
+ .build(),
652
664
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
653
665
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
654
666
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -726,7 +738,11 @@ class RewardClient {
726
738
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/offer/programs/${core.url.encodePathParam(pid)}/vouchers`),
727
739
  method: "GET",
728
740
  headers: _headers,
729
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
741
+ queryString: core.url
742
+ .queryBuilder()
743
+ .addMany(_queryParams)
744
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
745
+ .build(),
730
746
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
731
747
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
732
748
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -22,4 +22,6 @@ export interface CreateVoucherRequest {
22
22
  rewardId: string;
23
23
  /** Value of the selected reward config */
24
24
  value?: number;
25
+ /** Date from which the voucher becomes valid. Accepts RFC 3339 or DD/MM/YYYY HH:MM AM/PM format. Converted to UTC using the organization's timezone. */
26
+ validFrom?: string;
25
27
  }
@@ -23,6 +23,8 @@ export interface RedeemVoucherRequest {
23
23
  rewardId?: string;
24
24
  /** Time to live in seconds for the redemption request */
25
25
  ttl?: number;
26
+ /** Whether the redemption should be automatically completed */
27
+ autoComplete?: boolean;
26
28
  }
27
29
  export declare namespace RedeemVoucherRequest {
28
30
  interface Order {
@@ -1,18 +1,18 @@
1
1
  export interface CreateRewardResponse {
2
- /** Timestamp when the reward was created */
3
- createdAt?: string | undefined;
4
2
  /** Unique identifier for the reward */
5
3
  id?: string | undefined;
6
- /** Id of the loyalty program to which the current reward belongs to */
4
+ /** Loyalty program to which the reward belongs */
7
5
  loyaltyProgramId?: string | undefined;
8
6
  /** Name of the reward */
9
7
  name?: string | undefined;
10
- /** Public description for the reward */
8
+ /** Public description of the reward */
11
9
  publicDescription?: string | undefined;
12
- /** Public Image for the reward */
10
+ /** Public image URL of the reward */
13
11
  publicImage?: string | undefined;
14
- /** Public name for the reward */
12
+ /** Public name of the reward */
15
13
  publicName?: string | undefined;
16
- /** Timestamp for when this reward was last updated. */
14
+ /** Timestamp when the reward was created */
15
+ createdAt?: string | undefined;
16
+ /** Timestamp when the reward was last updated */
17
17
  updatedAt?: string | undefined;
18
18
  }
@@ -21,4 +21,6 @@ export interface CreateVoucherResponse {
21
21
  updatedAt?: string | undefined;
22
22
  /** Value of the selected reward config */
23
23
  value?: number | undefined;
24
+ /** Date from which the voucher becomes valid */
25
+ validFrom?: string | undefined;
24
26
  }
@@ -34,6 +34,8 @@ export declare namespace GetLoyaltyOfferProgramsPidVouchersResponse {
34
34
  updatedAt?: string | undefined;
35
35
  /** Value of the selected reward config */
36
36
  value?: number | undefined;
37
+ /** Date from which the voucher becomes valid */
38
+ validFrom?: string | undefined;
37
39
  }
38
40
  }
39
41
  }
@@ -114,7 +114,11 @@ class SendersClient {
114
114
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, "senders"),
115
115
  method: "GET",
116
116
  headers: _headers,
117
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
117
+ queryString: core.url
118
+ .queryBuilder()
119
+ .addMany(_queryParams)
120
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
121
+ .build(),
118
122
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
119
123
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
120
124
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -210,7 +214,7 @@ class SendersClient {
210
214
  method: "POST",
211
215
  headers: _headers,
212
216
  contentType: "application/json",
213
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
217
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
214
218
  requestType: "json",
215
219
  body: request,
216
220
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -272,7 +276,7 @@ class SendersClient {
272
276
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, "senders/ips"),
273
277
  method: "GET",
274
278
  headers: _headers,
275
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
279
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
276
280
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
277
281
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
278
282
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -377,7 +381,7 @@ class SendersClient {
377
381
  method: "PUT",
378
382
  headers: _headers,
379
383
  contentType: "application/json",
380
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
384
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
381
385
  requestType: "json",
382
386
  body: _body,
383
387
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -441,7 +445,7 @@ class SendersClient {
441
445
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `senders/${core.url.encodePathParam(senderId)}`),
442
446
  method: "DELETE",
443
447
  headers: _headers,
444
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
448
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
445
449
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
446
450
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
447
451
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -506,7 +510,7 @@ class SendersClient {
506
510
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `senders/${core.url.encodePathParam(senderId)}/ips`),
507
511
  method: "GET",
508
512
  headers: _headers,
509
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
513
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
510
514
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
511
515
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
512
516
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -578,7 +582,7 @@ class SendersClient {
578
582
  method: "PUT",
579
583
  headers: _headers,
580
584
  contentType: "application/json",
581
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
585
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
582
586
  requestType: "json",
583
587
  body: _body,
584
588
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -9,12 +9,12 @@ export declare namespace GetIpsResponse {
9
9
  type Ips = Ips.Item[];
10
10
  namespace Ips {
11
11
  interface Item {
12
+ /** ID of the dedicated IP */
13
+ id: number;
12
14
  /** Status of the IP (true=active, false=inactive) */
13
15
  active: boolean;
14
16
  /** Domain associated to the IP */
15
17
  domain: string;
16
- /** ID of the dedicated IP */
17
- id: number;
18
18
  /** Dedicated IP address */
19
19
  ip: string;
20
20
  }
@@ -11,6 +11,8 @@ export declare class SmsCampaignsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<SmsCampaignsClient.Options>;
12
12
  constructor(options: SmsCampaignsClient.Options);
13
13
  /**
14
+ * Retrieve a paginated list of all your SMS campaigns with their statistics and recipient information. Results can be filtered by status and date range, with a default limit of 500 and maximum of 1000 per page. The sort order defaults to descending by creation date; date filters are only available when status is not passed or is set to sent.
15
+ *
14
16
  * @param {Brevo.GetSmsCampaignsRequest} request
15
17
  * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
16
18
  *
@@ -22,6 +24,8 @@ export declare class SmsCampaignsClient {
22
24
  getSmsCampaigns(request?: Brevo.GetSmsCampaignsRequest, requestOptions?: SmsCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetSmsCampaignsResponse>;
23
25
  private __getSmsCampaigns;
24
26
  /**
27
+ * Create a new SMS campaign with the required name, sender, and content fields. The sender name is limited to 11 alphanumeric characters or 15 numeric characters, and the content should stay within 160 characters per SMS segment. If a scheduledAt date is provided, listIds in recipients become mandatory; accounts under validation are limited to 4 total campaigns and campaigns with more than 10 recipients will be saved as draft.
28
+ *
25
29
  * @param {Brevo.CreateSmsCampaignRequest} request
26
30
  * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
27
31
  *
@@ -37,6 +41,8 @@ export declare class SmsCampaignsClient {
37
41
  createSmsCampaign(request: Brevo.CreateSmsCampaignRequest, requestOptions?: SmsCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateSmsCampaignResponse>;
38
42
  private __createSmsCampaign;
39
43
  /**
44
+ * Retrieve detailed information about a specific SMS campaign by its ID, including campaign content, sender, recipients with list names, statistics (delivered, sent, bounces, unsubscriptions, answered), and tags. Unlike the list endpoint, recipients are returned as objects with id and name fields rather than plain IDs.
45
+ *
40
46
  * @param {Brevo.GetSmsCampaignRequest} request
41
47
  * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
42
48
  *
@@ -51,6 +57,8 @@ export declare class SmsCampaignsClient {
51
57
  getSmsCampaign(request: Brevo.GetSmsCampaignRequest, requestOptions?: SmsCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetSmsCampaignResponse>;
52
58
  private __getSmsCampaign;
53
59
  /**
60
+ * Update an existing SMS campaign''s properties such as name, sender, content, recipients, scheduled date, organisation prefix, and unsubscribe instructions. The request body must contain at least one valid field to update. The campaign must exist and must be of type SMS; if a scheduledAt is provided, valid recipients must be present either in the request or already configured on the campaign.
61
+ *
54
62
  * @param {Brevo.UpdateSmsCampaignRequest} request
55
63
  * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
56
64
  *
@@ -65,6 +73,8 @@ export declare class SmsCampaignsClient {
65
73
  updateSmsCampaign(request: Brevo.UpdateSmsCampaignRequest, requestOptions?: SmsCampaignsClient.RequestOptions): core.HttpResponsePromise<void>;
66
74
  private __updateSmsCampaign;
67
75
  /**
76
+ * Delete an SMS campaign by its campaign ID. Only campaigns that have not been scheduled or sent can be deleted; attempting to delete a campaign that is queued, in process, or has been sent with recipients will return a 403 permission denied error.
77
+ *
68
78
  * @param {Brevo.DeleteSmsCampaignRequest} request
69
79
  * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
70
80
  *
@@ -96,6 +106,8 @@ export declare class SmsCampaignsClient {
96
106
  requestSmsRecipientExport(request: Brevo.RequestSmsRecipientExportRequest, requestOptions?: SmsCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.RequestSmsRecipientExportResponse>;
97
107
  private __requestSmsRecipientExport;
98
108
  /**
109
+ * Send an existing SMS campaign immediately by scheduling it for the current time. The system verifies your account''s SMS credit balance before dispatching; if credits are insufficient or the remaining credit is less than the number of recipients, a 402 error is returned. The campaign must have valid recipients and content already configured.
110
+ *
99
111
  * @param {Brevo.SendSmsCampaignNowRequest} request
100
112
  * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
101
113
  *
@@ -133,6 +145,8 @@ export declare class SmsCampaignsClient {
133
145
  sendSmsReport(request: Brevo.SendSmsReportRequest, requestOptions?: SmsCampaignsClient.RequestOptions): core.HttpResponsePromise<void>;
134
146
  private __sendSmsReport;
135
147
  /**
148
+ * Send a test SMS to a specified phone number to preview the campaign before sending it to all recipients. The phone number must belong to one of your existing contacts in your Brevo account and must not be blacklisted. The number should include the country code (e.g. 33689965433).
149
+ *
136
150
  * @param {Brevo.SendTestSmsRequest} request
137
151
  * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
138
152
  *
@@ -147,6 +161,8 @@ export declare class SmsCampaignsClient {
147
161
  sendTestSms(request: Brevo.SendTestSmsRequest, requestOptions?: SmsCampaignsClient.RequestOptions): core.HttpResponsePromise<void>;
148
162
  private __sendTestSms;
149
163
  /**
164
+ * Update the status of an SMS campaign, such as suspending, archiving, or replicating it. Available status values include suspended, archive, darchive, sent, queued, replicate, replicateTemplate, cancel, and draft. Note that the replicateTemplate status is only available for template type campaigns.
165
+ *
150
166
  * @param {Brevo.UpdateSmsCampaignStatusRequest} request
151
167
  * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
152
168
  *
@@ -67,6 +67,8 @@ class SmsCampaignsClient {
67
67
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
68
68
  }
69
69
  /**
70
+ * Retrieve a paginated list of all your SMS campaigns with their statistics and recipient information. Results can be filtered by status and date range, with a default limit of 500 and maximum of 1000 per page. The sort order defaults to descending by creation date; date filters are only available when status is not passed or is set to sent.
71
+ *
70
72
  * @param {Brevo.GetSmsCampaignsRequest} request
71
73
  * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
72
74
  *
@@ -96,7 +98,11 @@ class SmsCampaignsClient {
96
98
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, "smsCampaigns"),
97
99
  method: "GET",
98
100
  headers: _headers,
99
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
101
+ queryString: core.url
102
+ .queryBuilder()
103
+ .addMany(_queryParams)
104
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
105
+ .build(),
100
106
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
101
107
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
102
108
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -122,6 +128,8 @@ class SmsCampaignsClient {
122
128
  });
123
129
  }
124
130
  /**
131
+ * Create a new SMS campaign with the required name, sender, and content fields. The sender name is limited to 11 alphanumeric characters or 15 numeric characters, and the content should stay within 160 characters per SMS segment. If a scheduledAt date is provided, listIds in recipients become mandatory; accounts under validation are limited to 4 total campaigns and campaigns with more than 10 recipients will be saved as draft.
132
+ *
125
133
  * @param {Brevo.CreateSmsCampaignRequest} request
126
134
  * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
127
135
  *
@@ -147,7 +155,7 @@ class SmsCampaignsClient {
147
155
  method: "POST",
148
156
  headers: _headers,
149
157
  contentType: "application/json",
150
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
158
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
151
159
  requestType: "json",
152
160
  body: request,
153
161
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -175,6 +183,8 @@ class SmsCampaignsClient {
175
183
  });
176
184
  }
177
185
  /**
186
+ * Retrieve detailed information about a specific SMS campaign by its ID, including campaign content, sender, recipients with list names, statistics (delivered, sent, bounces, unsubscriptions, answered), and tags. Unlike the list endpoint, recipients are returned as objects with id and name fields rather than plain IDs.
187
+ *
178
188
  * @param {Brevo.GetSmsCampaignRequest} request
179
189
  * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
180
190
  *
@@ -199,7 +209,7 @@ class SmsCampaignsClient {
199
209
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `smsCampaigns/${core.url.encodePathParam(campaignId)}`),
200
210
  method: "GET",
201
211
  headers: _headers,
202
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
212
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
203
213
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
204
214
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
205
215
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -227,6 +237,8 @@ class SmsCampaignsClient {
227
237
  });
228
238
  }
229
239
  /**
240
+ * Update an existing SMS campaign''s properties such as name, sender, content, recipients, scheduled date, organisation prefix, and unsubscribe instructions. The request body must contain at least one valid field to update. The campaign must exist and must be of type SMS; if a scheduledAt is provided, valid recipients must be present either in the request or already configured on the campaign.
241
+ *
230
242
  * @param {Brevo.UpdateSmsCampaignRequest} request
231
243
  * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
232
244
  *
@@ -252,7 +264,7 @@ class SmsCampaignsClient {
252
264
  method: "PUT",
253
265
  headers: _headers,
254
266
  contentType: "application/json",
255
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
267
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
256
268
  requestType: "json",
257
269
  body: _body,
258
270
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -282,6 +294,8 @@ class SmsCampaignsClient {
282
294
  });
283
295
  }
284
296
  /**
297
+ * Delete an SMS campaign by its campaign ID. Only campaigns that have not been scheduled or sent can be deleted; attempting to delete a campaign that is queued, in process, or has been sent with recipients will return a 403 permission denied error.
298
+ *
285
299
  * @param {Brevo.DeleteSmsCampaignRequest} request
286
300
  * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
287
301
  *
@@ -306,7 +320,7 @@ class SmsCampaignsClient {
306
320
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `smsCampaigns/${core.url.encodePathParam(campaignId)}`),
307
321
  method: "DELETE",
308
322
  headers: _headers,
309
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
323
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
310
324
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
311
325
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
312
326
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -362,7 +376,7 @@ class SmsCampaignsClient {
362
376
  method: "POST",
363
377
  headers: _headers,
364
378
  contentType: "application/json",
365
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
379
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
366
380
  requestType: "json",
367
381
  body: _body,
368
382
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -395,6 +409,8 @@ class SmsCampaignsClient {
395
409
  });
396
410
  }
397
411
  /**
412
+ * Send an existing SMS campaign immediately by scheduling it for the current time. The system verifies your account''s SMS credit balance before dispatching; if credits are insufficient or the remaining credit is less than the number of recipients, a 402 error is returned. The campaign must have valid recipients and content already configured.
413
+ *
398
414
  * @param {Brevo.SendSmsCampaignNowRequest} request
399
415
  * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
400
416
  *
@@ -420,7 +436,7 @@ class SmsCampaignsClient {
420
436
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `smsCampaigns/${core.url.encodePathParam(campaignId)}/sendNow`),
421
437
  method: "POST",
422
438
  headers: _headers,
423
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
439
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
424
440
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
425
441
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
426
442
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -483,7 +499,7 @@ class SmsCampaignsClient {
483
499
  method: "POST",
484
500
  headers: _headers,
485
501
  contentType: "application/json",
486
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
502
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
487
503
  requestType: "json",
488
504
  body: _body,
489
505
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -513,6 +529,8 @@ class SmsCampaignsClient {
513
529
  });
514
530
  }
515
531
  /**
532
+ * Send a test SMS to a specified phone number to preview the campaign before sending it to all recipients. The phone number must belong to one of your existing contacts in your Brevo account and must not be blacklisted. The number should include the country code (e.g. 33689965433).
533
+ *
516
534
  * @param {Brevo.SendTestSmsRequest} request
517
535
  * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
518
536
  *
@@ -538,7 +556,7 @@ class SmsCampaignsClient {
538
556
  method: "POST",
539
557
  headers: _headers,
540
558
  contentType: "application/json",
541
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
559
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
542
560
  requestType: "json",
543
561
  body: _body,
544
562
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -568,6 +586,8 @@ class SmsCampaignsClient {
568
586
  });
569
587
  }
570
588
  /**
589
+ * Update the status of an SMS campaign, such as suspending, archiving, or replicating it. Available status values include suspended, archive, darchive, sent, queued, replicate, replicateTemplate, cancel, and draft. Note that the replicateTemplate status is only available for template type campaigns.
590
+ *
571
591
  * @param {Brevo.UpdateSmsCampaignStatusRequest} request
572
592
  * @param {SmsCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
573
593
  *
@@ -594,7 +614,7 @@ class SmsCampaignsClient {
594
614
  method: "PUT",
595
615
  headers: _headers,
596
616
  contentType: "application/json",
597
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
617
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
598
618
  requestType: "json",
599
619
  body: _body,
600
620
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
@@ -6,11 +6,11 @@ import type * as Brevo from "../../../../index.js";
6
6
  export interface GetSmsCampaignsRequest {
7
7
  /** Status of campaign. */
8
8
  status?: Brevo.GetSmsCampaignsRequestStatus;
9
- /** **Mandatory if endDate is used.** Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' ) */
9
+ /** **Mandatory if endDate is used.** Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent SMS campaigns. **Prefer to pass your timezone in date-time format for accurate result.** Only available if `status` is not passed or is set to `sent`. `startDate` must not be in the future. */
10
10
  startDate?: string;
11
- /** **Mandatory if startDate is used.** Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' ) */
11
+ /** **Mandatory if startDate is used.** Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent SMS campaigns. **Prefer to pass your timezone in date-time format for accurate result.** Only available if `status` is not passed or is set to `sent`. `endDate` must not be in the future. */
12
12
  endDate?: string;
13
- /** Number limitation for the result returned */
13
+ /** Number of documents per page */
14
14
  limit?: number;
15
15
  /** Beginning point in the list to retrieve from. */
16
16
  offset?: number;
@@ -10,14 +10,23 @@ export interface GetSmsCampaignResponse {
10
10
  modifiedAt: string;
11
11
  /** Name of the SMS Campaign */
12
12
  name: string;
13
- /** UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format */
13
+ /** A recognizable prefix added as the Brand Name before the message content. Empty string if not set. */
14
+ organisationPrefix?: string | undefined;
15
+ /** UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format. Empty string if not scheduled. */
14
16
  scheduledAt?: string | undefined;
15
17
  /** Sender of the SMS Campaign */
16
18
  sender: string;
19
+ /** UTC date-time on which the SMS campaign was sent (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if the campaign status is 'sent'. */
20
+ sentDate?: string | undefined;
17
21
  /** Status of the SMS Campaign */
18
22
  status: GetSmsCampaignResponse.Status;
19
- recipients: Brevo.GetCampaignRecipients;
23
+ /** Instructions to unsubscribe from future communications. Empty string if not set. */
24
+ unsubscribeInstruction?: string | undefined;
25
+ /** Recipients of the SMS campaign. For a single campaign, lists and exclusion lists are returned as objects with id and name. */
26
+ recipients: GetSmsCampaignResponse.Recipients;
20
27
  statistics: Brevo.GetSmsCampaignStats;
28
+ /** Tags (labels) associated with the SMS campaign. Only available when retrieving a single campaign. */
29
+ tags?: string[] | undefined;
21
30
  }
22
31
  export declare namespace GetSmsCampaignResponse {
23
32
  /** Status of the SMS Campaign */
@@ -30,4 +39,31 @@ export declare namespace GetSmsCampaignResponse {
30
39
  readonly InProcess: "inProcess";
31
40
  };
32
41
  type Status = (typeof Status)[keyof typeof Status];
42
+ /**
43
+ * Recipients of the SMS campaign. For a single campaign, lists and exclusion lists are returned as objects with id and name.
44
+ */
45
+ interface Recipients {
46
+ exclusionLists?: Recipients.ExclusionLists.Item[] | undefined;
47
+ lists?: Recipients.Lists.Item[] | undefined;
48
+ }
49
+ namespace Recipients {
50
+ type ExclusionLists = ExclusionLists.Item[];
51
+ namespace ExclusionLists {
52
+ interface Item {
53
+ /** ID of the exclusion list */
54
+ id?: number | undefined;
55
+ /** Name of the exclusion list */
56
+ name?: string | undefined;
57
+ }
58
+ }
59
+ type Lists = Lists.Item[];
60
+ namespace Lists {
61
+ interface Item {
62
+ /** ID of the list */
63
+ id?: number | undefined;
64
+ /** Name of the list */
65
+ name?: string | undefined;
66
+ }
67
+ }
68
+ }
33
69
  }
@@ -18,12 +18,18 @@ export declare namespace GetSmsCampaignsResponse {
18
18
  modifiedAt: string;
19
19
  /** Name of the SMS Campaign */
20
20
  name: string;
21
- /** UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format */
21
+ /** A recognizable prefix added as the Brand Name before the message content. Empty string if not set. */
22
+ organisationPrefix?: string | undefined;
23
+ /** UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format. Empty string if not scheduled. */
22
24
  scheduledAt?: string | undefined;
23
25
  /** Sender of the SMS Campaign */
24
26
  sender: string;
27
+ /** UTC date-time on which the SMS campaign was sent (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if the campaign status is 'sent'. */
28
+ sentDate?: string | undefined;
25
29
  /** Status of the SMS Campaign */
26
30
  status: Item.Status;
31
+ /** Instructions to unsubscribe from future communications. Empty string if not set. */
32
+ unsubscribeInstruction?: string | undefined;
27
33
  recipients: Brevo.GetCampaignRecipients;
28
34
  statistics: Brevo.GetSmsCampaignStats;
29
35
  }
@@ -82,7 +82,11 @@ class SmsTemplatesClient {
82
82
  url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, "transactionalSMS/templates"),
83
83
  method: "GET",
84
84
  headers: _headers,
85
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
85
+ queryString: core.url
86
+ .queryBuilder()
87
+ .addMany(_queryParams)
88
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
89
+ .build(),
86
90
  timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
87
91
  maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
88
92
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,