@getbrevo/brevo 5.0.4 → 6.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (640) hide show
  1. package/README.md +99 -37
  2. package/dist/cjs/BaseClient.d.ts +13 -0
  3. package/dist/cjs/BaseClient.js +17 -2
  4. package/dist/cjs/Client.d.ts +6 -0
  5. package/dist/cjs/Client.js +68 -58
  6. package/dist/cjs/api/errors/BadRequestError.js +1 -1
  7. package/dist/cjs/api/errors/ConflictError.js +1 -1
  8. package/dist/cjs/api/errors/ExpectationFailedError.js +1 -1
  9. package/dist/cjs/api/errors/FailedDependencyError.js +1 -1
  10. package/dist/cjs/api/errors/ForbiddenError.js +1 -1
  11. package/dist/cjs/api/errors/InternalServerError.js +1 -1
  12. package/dist/cjs/api/errors/MethodNotAllowedError.js +1 -1
  13. package/dist/cjs/api/errors/NotFoundError.js +1 -1
  14. package/dist/cjs/api/errors/PaymentRequiredError.js +1 -1
  15. package/dist/cjs/api/errors/PreconditionFailedError.js +1 -1
  16. package/dist/cjs/api/errors/TooEarlyError.js +1 -1
  17. package/dist/cjs/api/errors/TooManyRequestsError.js +1 -1
  18. package/dist/cjs/api/errors/UnauthorizedError.js +1 -1
  19. package/dist/cjs/api/errors/UnprocessableEntityError.js +1 -1
  20. package/dist/cjs/api/errors/UnsupportedMediaTypeError.js +1 -1
  21. package/dist/cjs/api/resources/account/client/Client.d.ts +5 -6
  22. package/dist/cjs/api/resources/account/client/Client.js +21 -13
  23. package/dist/cjs/api/resources/account/types/GetAccountResponse.d.ts +4 -17
  24. package/dist/cjs/api/resources/balance/client/Client.d.ts +9 -8
  25. package/dist/cjs/api/resources/balance/client/Client.js +70 -33
  26. package/dist/cjs/api/resources/balance/client/requests/BeginTransactionRequest.d.ts +21 -11
  27. package/dist/cjs/api/resources/balance/client/requests/BeginTransactionRequest.js +9 -0
  28. package/dist/cjs/api/resources/balance/client/requests/CreateBalanceOrderRequest.d.ts +11 -3
  29. package/dist/cjs/api/resources/balance/client/requests/CreateBalanceOrderRequest.js +9 -0
  30. package/dist/cjs/api/resources/balance/client/requests/GetContactBalancesRequest.d.ts +13 -1
  31. package/dist/cjs/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidActiveBalanceRequest.d.ts +7 -6
  32. package/dist/cjs/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidTransactionHistoryRequest.d.ts +6 -6
  33. package/dist/cjs/api/resources/balance/client/requests/index.d.ts +2 -2
  34. package/dist/cjs/api/resources/balance/client/requests/index.js +5 -1
  35. package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSort.d.ts +5 -0
  36. package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSort.js +8 -0
  37. package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSortField.d.ts +5 -0
  38. package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSortField.js +8 -0
  39. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.d.ts +5 -0
  40. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.js +8 -0
  41. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.d.ts +30 -0
  42. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.d.ts +10 -0
  43. package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.js +15 -0
  44. package/dist/cjs/api/resources/balance/types/GetSubscriptionBalancesResponse.d.ts +7 -2
  45. package/dist/cjs/api/resources/balance/types/PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse.d.ts +14 -14
  46. package/dist/cjs/api/resources/balance/types/index.d.ts +4 -0
  47. package/dist/cjs/api/resources/balance/types/index.js +4 -0
  48. package/dist/cjs/api/resources/companies/client/Client.d.ts +22 -0
  49. package/dist/cjs/api/resources/companies/client/Client.js +49 -18
  50. package/dist/cjs/api/resources/companies/client/requests/GetCompaniesRequest.d.ts +4 -4
  51. package/dist/cjs/api/resources/companies/client/requests/PatchCompaniesIdRequest.d.ts +1 -1
  52. package/dist/cjs/api/resources/companies/client/requests/PostCompaniesImportRequest.d.ts +1 -1
  53. package/dist/cjs/api/resources/companies/client/requests/PostCrmAttributesRequest.d.ts +2 -2
  54. package/dist/cjs/api/resources/companies/client/requests/PostCrmAttributesRequest.js +1 -1
  55. package/dist/cjs/api/resources/companies/types/GetCrmAttributesCompaniesResponseItem.d.ts +20 -4
  56. package/dist/cjs/api/resources/consentGroups/client/Client.d.ts +108 -0
  57. package/dist/cjs/api/resources/consentGroups/client/Client.js +383 -0
  58. package/dist/cjs/api/resources/consentGroups/client/index.d.ts +1 -0
  59. package/dist/cjs/api/resources/{event/types → consentGroups/client}/index.js +1 -1
  60. package/dist/cjs/api/resources/consentGroups/client/requests/CreateConsentGroupRequest.d.ts +25 -0
  61. package/dist/cjs/api/resources/consentGroups/client/requests/CreateConsentGroupRequest.js +12 -0
  62. package/dist/cjs/api/resources/consentGroups/client/requests/DeleteConsentGroupRequest.d.ts +10 -0
  63. package/dist/cjs/api/resources/consentGroups/client/requests/GetConsentGroupRequest.d.ts +10 -0
  64. package/dist/cjs/api/resources/consentGroups/client/requests/GetConsentGroupRequest.js +3 -0
  65. package/dist/cjs/api/resources/consentGroups/client/requests/GetConsentGroupsRequest.d.ts +17 -0
  66. package/dist/cjs/api/resources/consentGroups/client/requests/GetConsentGroupsRequest.js +3 -0
  67. package/dist/cjs/api/resources/consentGroups/client/requests/UpdateConsentGroupRequest.d.ts +24 -0
  68. package/dist/cjs/api/resources/consentGroups/client/requests/UpdateConsentGroupRequest.js +12 -0
  69. package/dist/cjs/api/resources/consentGroups/client/requests/index.d.ts +5 -0
  70. package/dist/cjs/api/resources/consentGroups/client/requests/index.js +7 -0
  71. package/dist/cjs/api/resources/consentGroups/exports.d.ts +2 -0
  72. package/dist/cjs/api/resources/consentGroups/exports.js +21 -0
  73. package/dist/cjs/api/resources/consentGroups/index.d.ts +2 -0
  74. package/dist/cjs/api/resources/consentGroups/index.js +18 -0
  75. package/dist/cjs/api/resources/consentGroups/types/GetConsentGroupsRequestSignupMode.d.ts +5 -0
  76. package/dist/cjs/api/resources/consentGroups/types/GetConsentGroupsRequestSignupMode.js +8 -0
  77. package/dist/cjs/api/resources/consentGroups/types/index.d.ts +1 -0
  78. package/dist/cjs/api/resources/consentGroups/types/index.js +17 -0
  79. package/dist/cjs/api/resources/contacts/client/Client.d.ts +37 -0
  80. package/dist/cjs/api/resources/contacts/client/Client.js +125 -36
  81. package/dist/cjs/api/resources/contacts/client/requests/CreateContactRequest.d.ts +4 -0
  82. package/dist/cjs/api/resources/contacts/client/requests/GetContactInfoRequest.d.ts +2 -2
  83. package/dist/cjs/api/resources/contacts/client/requests/GetContactStatsRequest.d.ts +2 -2
  84. package/dist/cjs/api/resources/contacts/client/requests/GetContactsRequest.d.ts +3 -1
  85. package/dist/cjs/api/resources/contacts/client/requests/GetListRequest.d.ts +1 -1
  86. package/dist/cjs/api/resources/contacts/client/requests/ImportContactsRequest.d.ts +2 -0
  87. package/dist/cjs/api/resources/contacts/client/requests/UpdateContactRequest.d.ts +4 -2
  88. package/dist/cjs/api/resources/contacts/types/GetAttributesResponse.d.ts +3 -1
  89. package/dist/cjs/api/resources/contacts/types/GetContactInfoResponse.d.ts +8 -3
  90. package/dist/cjs/api/resources/contacts/types/GetContactStatsResponse.d.ts +1 -1
  91. package/dist/cjs/api/resources/contacts/types/GetSegmentsResponse.d.ts +2 -2
  92. package/dist/cjs/api/resources/conversations/client/Client.d.ts +18 -8
  93. package/dist/cjs/api/resources/conversations/client/Client.js +28 -18
  94. package/dist/cjs/api/resources/conversations/client/requests/PostConversationsAgentOnlinePingRequest.d.ts +8 -8
  95. package/dist/cjs/api/resources/conversations/client/requests/PostConversationsMessagesRequest.d.ts +12 -10
  96. package/dist/cjs/api/resources/conversations/client/requests/PostConversationsPushedMessagesRequest.d.ts +11 -9
  97. package/dist/cjs/api/resources/conversations/client/requests/PutConversationsMessagesIdRequest.d.ts +1 -1
  98. package/dist/cjs/api/resources/conversations/client/requests/PutConversationsPushedMessagesIdRequest.d.ts +2 -2
  99. package/dist/cjs/api/resources/coupons/client/Client.d.ts +10 -0
  100. package/dist/cjs/api/resources/coupons/client/Client.js +19 -5
  101. package/dist/cjs/api/resources/customObjects/client/Client.d.ts +101 -21
  102. package/dist/cjs/api/resources/customObjects/client/Client.js +108 -26
  103. package/dist/cjs/api/resources/customObjects/client/requests/BatchDeleteObjectRecordsRequest.d.ts +2 -2
  104. package/dist/cjs/api/resources/customObjects/client/requests/GetrecordsRequest.d.ts +1 -1
  105. package/dist/cjs/api/resources/customObjects/client/requests/UpsertrecordsRequest.d.ts +114 -25
  106. package/dist/cjs/api/resources/customObjects/client/requests/UpsertrecordsRequest.js +21 -0
  107. package/dist/cjs/api/resources/customObjects/client/requests/index.d.ts +1 -1
  108. package/dist/cjs/api/resources/customObjects/client/requests/index.js +3 -0
  109. package/dist/cjs/api/resources/customObjects/types/GetrecordsResponse.d.ts +14 -5
  110. package/dist/cjs/api/resources/deals/client/Client.d.ts +22 -0
  111. package/dist/cjs/api/resources/deals/client/Client.js +62 -22
  112. package/dist/cjs/api/resources/deals/client/requests/GetCrmDealsRequest.d.ts +11 -3
  113. package/dist/cjs/api/resources/deals/client/requests/PatchCrmDealsIdRequest.d.ts +1 -1
  114. package/dist/cjs/api/resources/deals/client/requests/PostCrmDealsImportRequest.d.ts +1 -1
  115. package/dist/cjs/api/resources/deals/types/GetCrmAttributesDealsResponseItem.d.ts +20 -4
  116. package/dist/cjs/api/resources/domains/client/Client.js +5 -5
  117. package/dist/cjs/api/resources/ecommerce/client/Client.d.ts +30 -1
  118. package/dist/cjs/api/resources/ecommerce/client/Client.js +73 -20
  119. package/dist/cjs/api/resources/ecommerce/client/requests/CreateBatchOrderRequest.d.ts +2 -2
  120. package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.ts +4 -2
  121. package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateProductRequest.d.ts +4 -2
  122. package/dist/cjs/api/resources/ecommerce/client/requests/GetEcommerceAttributionMetricsRequest.d.ts +2 -1
  123. package/dist/cjs/api/resources/ecommerce/client/requests/GetProductsRequest.d.ts +18 -2
  124. package/dist/cjs/api/resources/ecommerce/types/CreateBatchOrderResponse.d.ts +2 -2
  125. package/dist/cjs/api/resources/ecommerce/types/CreateUpdateCategoryResponse.d.ts +1 -1
  126. package/dist/cjs/api/resources/ecommerce/types/CreateUpdateProductResponse.d.ts +2 -2
  127. package/dist/cjs/api/resources/ecommerce/types/GetProductsRequestSortByField.d.ts +7 -0
  128. package/dist/cjs/api/resources/ecommerce/types/GetProductsRequestSortByField.js +10 -0
  129. package/dist/cjs/api/resources/ecommerce/types/index.d.ts +1 -0
  130. package/dist/cjs/api/resources/ecommerce/types/index.js +1 -0
  131. package/dist/cjs/api/resources/emailCampaigns/client/Client.d.ts +22 -1
  132. package/dist/cjs/api/resources/emailCampaigns/client/Client.js +51 -15
  133. package/dist/cjs/api/resources/emailCampaigns/client/requests/CreateEmailCampaignRequest.d.ts +7 -7
  134. package/dist/cjs/api/resources/emailCampaigns/client/requests/GetEmailCampaignRequest.d.ts +1 -1
  135. package/dist/cjs/api/resources/emailCampaigns/client/requests/GetEmailCampaignsRequest.d.ts +6 -4
  136. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignResponse.d.ts +28 -5
  137. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignResponse.js +9 -0
  138. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.d.ts +27 -4
  139. package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.js +9 -0
  140. package/dist/cjs/api/resources/event/client/Client.d.ts +8 -6
  141. package/dist/cjs/api/resources/event/client/Client.js +14 -8
  142. package/dist/cjs/api/resources/event/client/requests/CreateBatchEventsRequest.d.ts +76 -0
  143. package/dist/cjs/api/resources/event/client/requests/CreateBatchEventsRequest.js +3 -0
  144. package/dist/cjs/api/resources/event/client/requests/CreateEventRequest.d.ts +3 -3
  145. package/dist/cjs/api/resources/event/client/requests/index.d.ts +1 -0
  146. package/dist/cjs/api/resources/event/index.d.ts +0 -1
  147. package/dist/cjs/api/resources/event/index.js +0 -1
  148. package/dist/cjs/api/resources/externalFeeds/client/Client.js +9 -5
  149. package/dist/cjs/api/resources/externalFeeds/types/GetAllExternalFeedsResponse.d.ts +3 -7
  150. package/dist/cjs/api/resources/externalFeeds/types/GetExternalFeedByUuidResponse.d.ts +3 -9
  151. package/dist/cjs/api/resources/files/client/Client.d.ts +10 -0
  152. package/dist/cjs/api/resources/files/client/Client.js +19 -5
  153. package/dist/cjs/api/resources/inboundParsing/client/Client.d.ts +2 -1
  154. package/dist/cjs/api/resources/inboundParsing/client/Client.js +11 -4
  155. package/dist/cjs/api/resources/inboundParsing/client/requests/GetInboundEmailEventsRequest.d.ts +2 -2
  156. package/dist/cjs/api/resources/inboundParsing/types/GetInboundEmailEventsByUuidResponse.d.ts +2 -2
  157. package/dist/cjs/api/resources/index.d.ts +5 -1
  158. package/dist/cjs/api/resources/index.js +6 -2
  159. package/dist/cjs/api/resources/masterAccount/client/Client.d.ts +10 -0
  160. package/dist/cjs/api/resources/masterAccount/client/Client.js +84 -46
  161. package/dist/cjs/api/resources/notes/client/Client.d.ts +12 -2
  162. package/dist/cjs/api/resources/notes/client/Client.js +21 -7
  163. package/dist/cjs/api/resources/notes/client/requests/PatchCrmNotesIdRequest.d.ts +1 -1
  164. package/dist/cjs/api/resources/notes/types/PostCrmNotesResponse.d.ts +1 -1
  165. package/dist/cjs/api/resources/payments/client/Client.d.ts +6 -0
  166. package/dist/cjs/api/resources/payments/client/Client.js +9 -3
  167. package/dist/cjs/api/resources/process/client/Client.d.ts +13 -18
  168. package/dist/cjs/api/resources/process/client/Client.js +19 -20
  169. package/dist/cjs/api/resources/process/types/GetProcessResponse.d.ts +19 -36
  170. package/dist/cjs/api/resources/process/types/GetProcessesResponse.d.ts +19 -36
  171. package/dist/cjs/api/resources/program/client/Client.d.ts +1 -1
  172. package/dist/cjs/api/resources/program/client/Client.js +26 -14
  173. package/dist/cjs/api/resources/program/client/requests/GetLpListRequest.d.ts +2 -2
  174. package/dist/cjs/api/resources/program/client/requests/SubscribeToLoyaltyProgramRequest.d.ts +5 -3
  175. package/dist/cjs/api/resources/program/types/GetLpListRequestSort.d.ts +5 -0
  176. package/dist/cjs/api/resources/program/types/GetLpListRequestSort.js +8 -0
  177. package/dist/cjs/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.ts +2 -0
  178. package/dist/cjs/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.ts +4 -4
  179. package/dist/cjs/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.ts +10 -8
  180. package/dist/cjs/api/resources/program/types/index.d.ts +1 -0
  181. package/dist/cjs/api/resources/program/types/index.js +1 -0
  182. package/dist/cjs/api/resources/reward/client/Client.js +26 -10
  183. package/dist/cjs/api/resources/reward/client/requests/CreateVoucherRequest.d.ts +2 -0
  184. package/dist/cjs/api/resources/reward/client/requests/RedeemVoucherRequest.d.ts +2 -0
  185. package/dist/cjs/api/resources/reward/types/CreateRewardResponse.d.ts +7 -7
  186. package/dist/cjs/api/resources/reward/types/CreateVoucherResponse.d.ts +2 -0
  187. package/dist/cjs/api/resources/reward/types/GetLoyaltyOfferProgramsPidVouchersResponse.d.ts +2 -0
  188. package/dist/cjs/api/resources/senders/client/Client.js +11 -7
  189. package/dist/cjs/api/resources/senders/types/GetIpsResponse.d.ts +2 -2
  190. package/dist/cjs/api/resources/smsCampaigns/client/Client.d.ts +16 -0
  191. package/dist/cjs/api/resources/smsCampaigns/client/Client.js +30 -10
  192. package/dist/cjs/api/resources/smsCampaigns/client/requests/GetSmsCampaignsRequest.d.ts +3 -3
  193. package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.ts +38 -2
  194. package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.ts +7 -1
  195. package/dist/cjs/api/resources/smsTemplates/client/Client.js +5 -1
  196. package/dist/cjs/api/resources/tasks/client/Client.d.ts +16 -2
  197. package/dist/cjs/api/resources/tasks/client/Client.js +35 -12
  198. package/dist/cjs/api/resources/tasks/client/requests/PostCrmTasksRequest.d.ts +1 -1
  199. package/dist/cjs/api/resources/tasks/types/{GetCrmTasktypesResponse.d.ts → GetCrmTasktypesResponseItem.d.ts} +1 -4
  200. package/dist/cjs/api/resources/tasks/types/GetCrmTasktypesResponseItem.js +3 -0
  201. package/dist/cjs/api/resources/tasks/types/index.d.ts +1 -1
  202. package/dist/cjs/api/resources/tasks/types/index.js +1 -1
  203. package/dist/cjs/api/resources/tier/client/Client.js +22 -10
  204. package/dist/cjs/api/resources/tier/client/requests/CreateTierGroupRequest.d.ts +62 -0
  205. package/dist/cjs/api/resources/tier/client/requests/CreateTierGroupRequest.js +30 -0
  206. package/dist/cjs/api/resources/transactionalEmails/client/Client.d.ts +31 -2
  207. package/dist/cjs/api/resources/transactionalEmails/client/Client.js +114 -35
  208. package/dist/cjs/api/resources/transactionalEmails/client/requests/DeleteScheduledEmailByIdRequest.d.ts +1 -1
  209. package/dist/cjs/api/resources/transactionalEmails/client/requests/DeleteSmtpLogIdentifierRequest.d.ts +5 -1
  210. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetAggregatedSmtpReportRequest.d.ts +1 -1
  211. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetEmailEventReportRequest.d.ts +1 -1
  212. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.ts +2 -2
  213. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpReportRequest.d.ts +1 -1
  214. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpTemplateRequest.d.ts +3 -2
  215. package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpTemplatesRequest.d.ts +2 -0
  216. package/dist/cjs/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.ts +3 -2
  217. package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.d.ts +1 -0
  218. package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.js +3 -0
  219. package/dist/cjs/api/resources/transactionalEmails/types/GetTransacBlockedContactsResponse.d.ts +1 -1
  220. package/dist/cjs/api/resources/transactionalEmails/types/GetTransacEmailContentResponse.d.ts +2 -2
  221. package/dist/cjs/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.d.ts +1 -0
  222. package/dist/cjs/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.js +3 -0
  223. package/dist/cjs/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.d.ts +1 -0
  224. package/dist/cjs/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.js +3 -0
  225. package/dist/cjs/api/resources/transactionalEmails/types/index.d.ts +3 -0
  226. package/dist/cjs/api/resources/transactionalEmails/types/index.js +3 -0
  227. package/dist/cjs/api/resources/transactionalSms/client/Client.d.ts +9 -0
  228. package/dist/cjs/api/resources/transactionalSms/client/Client.js +28 -5
  229. package/dist/cjs/api/resources/transactionalWhatsApp/client/Client.js +6 -2
  230. package/dist/cjs/api/resources/user/client/Client.d.ts +8 -0
  231. package/dist/cjs/api/resources/user/client/Client.js +14 -6
  232. package/dist/cjs/api/resources/wallet/client/Client.d.ts +34 -0
  233. package/dist/cjs/api/resources/wallet/client/Client.js +126 -0
  234. package/dist/cjs/api/resources/wallet/client/index.d.ts +1 -0
  235. package/dist/cjs/api/resources/wallet/client/index.js +17 -0
  236. package/dist/cjs/api/resources/wallet/client/requests/GetWalletPassInstallUrlRequest.d.ts +13 -0
  237. package/dist/cjs/api/resources/wallet/client/requests/GetWalletPassInstallUrlRequest.js +3 -0
  238. package/dist/cjs/api/resources/wallet/client/requests/index.d.ts +1 -0
  239. package/dist/cjs/api/resources/wallet/client/requests/index.js +2 -0
  240. package/dist/cjs/api/resources/wallet/exports.d.ts +2 -0
  241. package/dist/cjs/api/resources/wallet/exports.js +21 -0
  242. package/dist/cjs/api/resources/wallet/index.d.ts +1 -0
  243. package/dist/cjs/api/resources/wallet/index.js +17 -0
  244. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +0 -1
  245. package/dist/cjs/api/resources/webhooks/client/Client.js +10 -7
  246. package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequest.d.ts +14 -21
  247. package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequest.js +2 -2
  248. package/dist/cjs/api/resources/webhooks/client/requests/ExportWebhooksHistoryRequest.d.ts +1 -1
  249. package/dist/cjs/api/resources/whatsAppCampaigns/client/Client.d.ts +6 -0
  250. package/dist/cjs/api/resources/whatsAppCampaigns/client/Client.js +23 -9
  251. package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.ts +15 -0
  252. package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.ts +2 -0
  253. package/dist/cjs/api/types/BalanceDefinition.d.ts +81 -32
  254. package/dist/cjs/api/types/BalanceDefinition.js +46 -2
  255. package/dist/cjs/api/types/BalanceLimit.d.ts +37 -14
  256. package/dist/cjs/api/types/BalanceLimit.js +22 -0
  257. package/dist/cjs/api/types/Company.d.ts +1 -1
  258. package/dist/cjs/api/types/ConsentGroup.d.ts +29 -0
  259. package/dist/cjs/api/types/ConsentGroup.js +12 -0
  260. package/dist/cjs/api/types/ConsentGroupItem.d.ts +17 -0
  261. package/dist/cjs/api/types/ConsentGroupItem.js +12 -0
  262. package/dist/cjs/api/types/ConsentGroupsListResponse.d.ts +14 -0
  263. package/dist/cjs/api/types/ConsentGroupsListResponse.js +3 -0
  264. package/dist/cjs/api/types/ConversationsMessage.d.ts +59 -20
  265. package/dist/cjs/api/types/Deal.d.ts +4 -4
  266. package/dist/cjs/api/types/FileData.d.ts +8 -6
  267. package/dist/cjs/api/types/GetCampaignRecipients.d.ts +4 -0
  268. package/dist/cjs/api/types/GetCampaignStats.d.ts +15 -15
  269. package/dist/cjs/api/types/GetContactDetails.d.ts +5 -0
  270. package/dist/cjs/api/types/GetEventsList.d.ts +0 -2
  271. package/dist/cjs/api/types/GetExtendedCampaignOverview.d.ts +28 -5
  272. package/dist/cjs/api/types/GetExtendedCampaignOverview.js +9 -0
  273. package/dist/cjs/api/types/GetExtendedCampaignStats.d.ts +8 -10
  274. package/dist/cjs/api/types/GetProductDetails.d.ts +3 -1
  275. package/dist/cjs/api/types/GetSmsCampaignOverview.d.ts +7 -1
  276. package/dist/cjs/api/types/GetSmtpTemplateOverview.d.ts +3 -1
  277. package/dist/cjs/api/types/GetWebhook.d.ts +5 -10
  278. package/dist/cjs/api/types/GetWebhook.js +2 -6
  279. package/dist/cjs/api/types/LoyaltyProgram.d.ts +23 -20
  280. package/dist/cjs/api/types/LoyaltyProgram.js +2 -1
  281. package/dist/cjs/api/types/Note.d.ts +10 -8
  282. package/dist/cjs/api/types/NoteData.d.ts +1 -1
  283. package/dist/cjs/api/types/Order.d.ts +1 -1
  284. package/dist/cjs/api/types/Pipeline.d.ts +3 -3
  285. package/dist/cjs/api/types/SendTransacSms.d.ts +7 -14
  286. package/dist/cjs/api/types/Task.d.ts +20 -8
  287. package/dist/cjs/api/types/TierGroup.d.ts +66 -0
  288. package/dist/cjs/api/types/TierGroup.js +30 -0
  289. package/dist/cjs/api/types/Transaction.d.ts +36 -17
  290. package/dist/cjs/api/types/Transaction.js +17 -0
  291. package/dist/cjs/api/types/WalletPassInstallUrl.d.ts +4 -0
  292. package/dist/cjs/api/types/WalletPassInstallUrl.js +3 -0
  293. package/dist/cjs/api/types/index.d.ts +4 -0
  294. package/dist/cjs/api/types/index.js +4 -0
  295. package/dist/cjs/core/auth/AuthProvider.d.ts +1 -0
  296. package/dist/cjs/core/auth/AuthProvider.js +7 -0
  297. package/dist/cjs/core/auth/index.d.ts +1 -1
  298. package/dist/cjs/core/auth/index.js +3 -1
  299. package/dist/cjs/core/fetcher/Fetcher.d.ts +6 -0
  300. package/dist/cjs/core/fetcher/Fetcher.js +9 -8
  301. package/dist/cjs/core/fetcher/getResponseBody.js +11 -0
  302. package/dist/cjs/core/fetcher/requestWithRetries.js +4 -1
  303. package/dist/cjs/core/fetcher/signals.js +9 -1
  304. package/dist/cjs/core/url/QueryStringBuilder.d.ts +47 -0
  305. package/dist/cjs/core/url/QueryStringBuilder.js +83 -0
  306. package/dist/cjs/core/url/index.d.ts +1 -0
  307. package/dist/cjs/core/url/index.js +3 -1
  308. package/dist/cjs/core/url/qs.d.ts +2 -1
  309. package/dist/cjs/core/url/qs.js +25 -13
  310. package/dist/cjs/errors/BrevoError.d.ts +1 -0
  311. package/dist/cjs/errors/BrevoError.js +5 -1
  312. package/dist/cjs/errors/BrevoTimeoutError.d.ts +2 -2
  313. package/dist/cjs/errors/BrevoTimeoutError.js +40 -6
  314. package/dist/cjs/version.d.ts +1 -1
  315. package/dist/cjs/version.js +1 -1
  316. package/dist/esm/BaseClient.d.mts +13 -0
  317. package/dist/esm/BaseClient.mjs +17 -2
  318. package/dist/esm/Client.d.mts +6 -0
  319. package/dist/esm/Client.mjs +10 -0
  320. package/dist/esm/api/errors/BadRequestError.mjs +1 -1
  321. package/dist/esm/api/errors/ConflictError.mjs +1 -1
  322. package/dist/esm/api/errors/ExpectationFailedError.mjs +1 -1
  323. package/dist/esm/api/errors/FailedDependencyError.mjs +1 -1
  324. package/dist/esm/api/errors/ForbiddenError.mjs +1 -1
  325. package/dist/esm/api/errors/InternalServerError.mjs +1 -1
  326. package/dist/esm/api/errors/MethodNotAllowedError.mjs +1 -1
  327. package/dist/esm/api/errors/NotFoundError.mjs +1 -1
  328. package/dist/esm/api/errors/PaymentRequiredError.mjs +1 -1
  329. package/dist/esm/api/errors/PreconditionFailedError.mjs +1 -1
  330. package/dist/esm/api/errors/TooEarlyError.mjs +1 -1
  331. package/dist/esm/api/errors/TooManyRequestsError.mjs +1 -1
  332. package/dist/esm/api/errors/UnauthorizedError.mjs +1 -1
  333. package/dist/esm/api/errors/UnprocessableEntityError.mjs +1 -1
  334. package/dist/esm/api/errors/UnsupportedMediaTypeError.mjs +1 -1
  335. package/dist/esm/api/resources/account/client/Client.d.mts +5 -6
  336. package/dist/esm/api/resources/account/client/Client.mjs +21 -13
  337. package/dist/esm/api/resources/account/types/GetAccountResponse.d.mts +4 -17
  338. package/dist/esm/api/resources/balance/client/Client.d.mts +9 -8
  339. package/dist/esm/api/resources/balance/client/Client.mjs +70 -33
  340. package/dist/esm/api/resources/balance/client/requests/BeginTransactionRequest.d.mts +21 -11
  341. package/dist/esm/api/resources/balance/client/requests/BeginTransactionRequest.mjs +8 -1
  342. package/dist/esm/api/resources/balance/client/requests/CreateBalanceOrderRequest.d.mts +11 -3
  343. package/dist/esm/api/resources/balance/client/requests/CreateBalanceOrderRequest.mjs +8 -1
  344. package/dist/esm/api/resources/balance/client/requests/GetContactBalancesRequest.d.mts +13 -1
  345. package/dist/esm/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidActiveBalanceRequest.d.mts +7 -6
  346. package/dist/esm/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidTransactionHistoryRequest.d.mts +6 -6
  347. package/dist/esm/api/resources/balance/client/requests/index.d.mts +2 -2
  348. package/dist/esm/api/resources/balance/client/requests/index.mjs +2 -0
  349. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSort.d.mts +5 -0
  350. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSort.mjs +5 -0
  351. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSortField.d.mts +5 -0
  352. package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSortField.mjs +5 -0
  353. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.d.mts +5 -0
  354. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.mjs +5 -0
  355. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.d.mts +30 -0
  356. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.d.mts +10 -0
  357. package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.mjs +14 -1
  358. package/dist/esm/api/resources/balance/types/GetSubscriptionBalancesResponse.d.mts +7 -2
  359. package/dist/esm/api/resources/balance/types/PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse.d.mts +14 -14
  360. package/dist/esm/api/resources/balance/types/index.d.mts +4 -0
  361. package/dist/esm/api/resources/balance/types/index.mjs +4 -0
  362. package/dist/esm/api/resources/companies/client/Client.d.mts +22 -0
  363. package/dist/esm/api/resources/companies/client/Client.mjs +49 -18
  364. package/dist/esm/api/resources/companies/client/requests/GetCompaniesRequest.d.mts +4 -4
  365. package/dist/esm/api/resources/companies/client/requests/PatchCompaniesIdRequest.d.mts +1 -1
  366. package/dist/esm/api/resources/companies/client/requests/PostCompaniesImportRequest.d.mts +1 -1
  367. package/dist/esm/api/resources/companies/client/requests/PostCrmAttributesRequest.d.mts +2 -2
  368. package/dist/esm/api/resources/companies/client/requests/PostCrmAttributesRequest.mjs +1 -1
  369. package/dist/esm/api/resources/companies/types/GetCrmAttributesCompaniesResponseItem.d.mts +20 -4
  370. package/dist/esm/api/resources/consentGroups/client/Client.d.mts +108 -0
  371. package/dist/esm/api/resources/consentGroups/client/Client.mjs +346 -0
  372. package/dist/esm/api/resources/consentGroups/client/index.d.mts +1 -0
  373. package/dist/esm/api/resources/consentGroups/client/index.mjs +1 -0
  374. package/dist/esm/api/resources/consentGroups/client/requests/CreateConsentGroupRequest.d.mts +25 -0
  375. package/dist/esm/api/resources/consentGroups/client/requests/CreateConsentGroupRequest.mjs +9 -0
  376. package/dist/esm/api/resources/consentGroups/client/requests/DeleteConsentGroupRequest.d.mts +10 -0
  377. package/dist/esm/api/resources/consentGroups/client/requests/GetConsentGroupRequest.d.mts +10 -0
  378. package/dist/esm/api/resources/consentGroups/client/requests/GetConsentGroupRequest.mjs +2 -0
  379. package/dist/esm/api/resources/consentGroups/client/requests/GetConsentGroupsRequest.d.mts +17 -0
  380. package/dist/esm/api/resources/consentGroups/client/requests/GetConsentGroupsRequest.mjs +2 -0
  381. package/dist/esm/api/resources/consentGroups/client/requests/UpdateConsentGroupRequest.d.mts +24 -0
  382. package/dist/esm/api/resources/consentGroups/client/requests/UpdateConsentGroupRequest.mjs +9 -0
  383. package/dist/esm/api/resources/consentGroups/client/requests/index.d.mts +5 -0
  384. package/dist/esm/api/resources/consentGroups/client/requests/index.mjs +2 -0
  385. package/dist/esm/api/resources/consentGroups/exports.d.mts +2 -0
  386. package/dist/esm/api/resources/consentGroups/exports.mjs +3 -0
  387. package/dist/esm/api/resources/consentGroups/index.d.mts +2 -0
  388. package/dist/esm/api/resources/consentGroups/index.mjs +2 -0
  389. package/dist/esm/api/resources/consentGroups/types/GetConsentGroupsRequestSignupMode.d.mts +5 -0
  390. package/dist/esm/api/resources/consentGroups/types/GetConsentGroupsRequestSignupMode.mjs +5 -0
  391. package/dist/esm/api/resources/consentGroups/types/index.d.mts +1 -0
  392. package/dist/esm/api/resources/consentGroups/types/index.mjs +1 -0
  393. package/dist/esm/api/resources/contacts/client/Client.d.mts +37 -0
  394. package/dist/esm/api/resources/contacts/client/Client.mjs +125 -36
  395. package/dist/esm/api/resources/contacts/client/requests/CreateContactRequest.d.mts +4 -0
  396. package/dist/esm/api/resources/contacts/client/requests/GetContactInfoRequest.d.mts +2 -2
  397. package/dist/esm/api/resources/contacts/client/requests/GetContactStatsRequest.d.mts +2 -2
  398. package/dist/esm/api/resources/contacts/client/requests/GetContactsRequest.d.mts +3 -1
  399. package/dist/esm/api/resources/contacts/client/requests/GetListRequest.d.mts +1 -1
  400. package/dist/esm/api/resources/contacts/client/requests/ImportContactsRequest.d.mts +2 -0
  401. package/dist/esm/api/resources/contacts/client/requests/UpdateContactRequest.d.mts +4 -2
  402. package/dist/esm/api/resources/contacts/types/GetAttributesResponse.d.mts +3 -1
  403. package/dist/esm/api/resources/contacts/types/GetContactInfoResponse.d.mts +8 -3
  404. package/dist/esm/api/resources/contacts/types/GetContactStatsResponse.d.mts +1 -1
  405. package/dist/esm/api/resources/contacts/types/GetSegmentsResponse.d.mts +2 -2
  406. package/dist/esm/api/resources/conversations/client/Client.d.mts +18 -8
  407. package/dist/esm/api/resources/conversations/client/Client.mjs +28 -18
  408. package/dist/esm/api/resources/conversations/client/requests/PostConversationsAgentOnlinePingRequest.d.mts +8 -8
  409. package/dist/esm/api/resources/conversations/client/requests/PostConversationsMessagesRequest.d.mts +12 -10
  410. package/dist/esm/api/resources/conversations/client/requests/PostConversationsPushedMessagesRequest.d.mts +11 -9
  411. package/dist/esm/api/resources/conversations/client/requests/PutConversationsMessagesIdRequest.d.mts +1 -1
  412. package/dist/esm/api/resources/conversations/client/requests/PutConversationsPushedMessagesIdRequest.d.mts +2 -2
  413. package/dist/esm/api/resources/coupons/client/Client.d.mts +10 -0
  414. package/dist/esm/api/resources/coupons/client/Client.mjs +19 -5
  415. package/dist/esm/api/resources/customObjects/client/Client.d.mts +101 -21
  416. package/dist/esm/api/resources/customObjects/client/Client.mjs +108 -26
  417. package/dist/esm/api/resources/customObjects/client/requests/BatchDeleteObjectRecordsRequest.d.mts +2 -2
  418. package/dist/esm/api/resources/customObjects/client/requests/GetrecordsRequest.d.mts +1 -1
  419. package/dist/esm/api/resources/customObjects/client/requests/UpsertrecordsRequest.d.mts +114 -25
  420. package/dist/esm/api/resources/customObjects/client/requests/UpsertrecordsRequest.mjs +20 -1
  421. package/dist/esm/api/resources/customObjects/client/requests/index.d.mts +1 -1
  422. package/dist/esm/api/resources/customObjects/client/requests/index.mjs +1 -1
  423. package/dist/esm/api/resources/customObjects/types/GetrecordsResponse.d.mts +14 -5
  424. package/dist/esm/api/resources/deals/client/Client.d.mts +22 -0
  425. package/dist/esm/api/resources/deals/client/Client.mjs +62 -22
  426. package/dist/esm/api/resources/deals/client/requests/GetCrmDealsRequest.d.mts +11 -3
  427. package/dist/esm/api/resources/deals/client/requests/PatchCrmDealsIdRequest.d.mts +1 -1
  428. package/dist/esm/api/resources/deals/client/requests/PostCrmDealsImportRequest.d.mts +1 -1
  429. package/dist/esm/api/resources/deals/types/GetCrmAttributesDealsResponseItem.d.mts +20 -4
  430. package/dist/esm/api/resources/domains/client/Client.mjs +5 -5
  431. package/dist/esm/api/resources/ecommerce/client/Client.d.mts +30 -1
  432. package/dist/esm/api/resources/ecommerce/client/Client.mjs +73 -20
  433. package/dist/esm/api/resources/ecommerce/client/requests/CreateBatchOrderRequest.d.mts +2 -2
  434. package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.mts +4 -2
  435. package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateProductRequest.d.mts +4 -2
  436. package/dist/esm/api/resources/ecommerce/client/requests/GetEcommerceAttributionMetricsRequest.d.mts +2 -1
  437. package/dist/esm/api/resources/ecommerce/client/requests/GetProductsRequest.d.mts +18 -2
  438. package/dist/esm/api/resources/ecommerce/types/CreateBatchOrderResponse.d.mts +2 -2
  439. package/dist/esm/api/resources/ecommerce/types/CreateUpdateCategoryResponse.d.mts +1 -1
  440. package/dist/esm/api/resources/ecommerce/types/CreateUpdateProductResponse.d.mts +2 -2
  441. package/dist/esm/api/resources/ecommerce/types/GetProductsRequestSortByField.d.mts +7 -0
  442. package/dist/esm/api/resources/ecommerce/types/GetProductsRequestSortByField.mjs +7 -0
  443. package/dist/esm/api/resources/ecommerce/types/index.d.mts +1 -0
  444. package/dist/esm/api/resources/ecommerce/types/index.mjs +1 -0
  445. package/dist/esm/api/resources/emailCampaigns/client/Client.d.mts +22 -1
  446. package/dist/esm/api/resources/emailCampaigns/client/Client.mjs +51 -15
  447. package/dist/esm/api/resources/emailCampaigns/client/requests/CreateEmailCampaignRequest.d.mts +7 -7
  448. package/dist/esm/api/resources/emailCampaigns/client/requests/GetEmailCampaignRequest.d.mts +1 -1
  449. package/dist/esm/api/resources/emailCampaigns/client/requests/GetEmailCampaignsRequest.d.mts +6 -4
  450. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignResponse.d.mts +28 -5
  451. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignResponse.mjs +9 -0
  452. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.d.mts +27 -4
  453. package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.mjs +9 -0
  454. package/dist/esm/api/resources/event/client/Client.d.mts +8 -6
  455. package/dist/esm/api/resources/event/client/Client.mjs +14 -8
  456. package/dist/esm/api/resources/event/client/requests/CreateBatchEventsRequest.d.mts +76 -0
  457. package/dist/esm/api/resources/event/client/requests/CreateBatchEventsRequest.mjs +2 -0
  458. package/dist/esm/api/resources/event/client/requests/CreateEventRequest.d.mts +3 -3
  459. package/dist/esm/api/resources/event/client/requests/index.d.mts +1 -0
  460. package/dist/esm/api/resources/event/index.d.mts +0 -1
  461. package/dist/esm/api/resources/event/index.mjs +0 -1
  462. package/dist/esm/api/resources/externalFeeds/client/Client.mjs +9 -5
  463. package/dist/esm/api/resources/externalFeeds/types/GetAllExternalFeedsResponse.d.mts +3 -7
  464. package/dist/esm/api/resources/externalFeeds/types/GetExternalFeedByUuidResponse.d.mts +3 -9
  465. package/dist/esm/api/resources/files/client/Client.d.mts +10 -0
  466. package/dist/esm/api/resources/files/client/Client.mjs +19 -5
  467. package/dist/esm/api/resources/inboundParsing/client/Client.d.mts +2 -1
  468. package/dist/esm/api/resources/inboundParsing/client/Client.mjs +11 -4
  469. package/dist/esm/api/resources/inboundParsing/client/requests/GetInboundEmailEventsRequest.d.mts +2 -2
  470. package/dist/esm/api/resources/inboundParsing/types/GetInboundEmailEventsByUuidResponse.d.mts +2 -2
  471. package/dist/esm/api/resources/index.d.mts +5 -1
  472. package/dist/esm/api/resources/index.mjs +5 -1
  473. package/dist/esm/api/resources/masterAccount/client/Client.d.mts +10 -0
  474. package/dist/esm/api/resources/masterAccount/client/Client.mjs +84 -46
  475. package/dist/esm/api/resources/notes/client/Client.d.mts +12 -2
  476. package/dist/esm/api/resources/notes/client/Client.mjs +21 -7
  477. package/dist/esm/api/resources/notes/client/requests/PatchCrmNotesIdRequest.d.mts +1 -1
  478. package/dist/esm/api/resources/notes/types/PostCrmNotesResponse.d.mts +1 -1
  479. package/dist/esm/api/resources/payments/client/Client.d.mts +6 -0
  480. package/dist/esm/api/resources/payments/client/Client.mjs +9 -3
  481. package/dist/esm/api/resources/process/client/Client.d.mts +13 -18
  482. package/dist/esm/api/resources/process/client/Client.mjs +19 -20
  483. package/dist/esm/api/resources/process/types/GetProcessResponse.d.mts +19 -36
  484. package/dist/esm/api/resources/process/types/GetProcessesResponse.d.mts +19 -36
  485. package/dist/esm/api/resources/program/client/Client.d.mts +1 -1
  486. package/dist/esm/api/resources/program/client/Client.mjs +26 -14
  487. package/dist/esm/api/resources/program/client/requests/GetLpListRequest.d.mts +2 -2
  488. package/dist/esm/api/resources/program/client/requests/SubscribeToLoyaltyProgramRequest.d.mts +5 -3
  489. package/dist/esm/api/resources/program/types/GetLpListRequestSort.d.mts +5 -0
  490. package/dist/esm/api/resources/program/types/GetLpListRequestSort.mjs +5 -0
  491. package/dist/esm/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.mts +2 -0
  492. package/dist/esm/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.mts +4 -4
  493. package/dist/esm/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.mts +10 -8
  494. package/dist/esm/api/resources/program/types/index.d.mts +1 -0
  495. package/dist/esm/api/resources/program/types/index.mjs +1 -0
  496. package/dist/esm/api/resources/reward/client/Client.mjs +26 -10
  497. package/dist/esm/api/resources/reward/client/requests/CreateVoucherRequest.d.mts +2 -0
  498. package/dist/esm/api/resources/reward/client/requests/RedeemVoucherRequest.d.mts +2 -0
  499. package/dist/esm/api/resources/reward/types/CreateRewardResponse.d.mts +7 -7
  500. package/dist/esm/api/resources/reward/types/CreateVoucherResponse.d.mts +2 -0
  501. package/dist/esm/api/resources/reward/types/GetLoyaltyOfferProgramsPidVouchersResponse.d.mts +2 -0
  502. package/dist/esm/api/resources/senders/client/Client.mjs +11 -7
  503. package/dist/esm/api/resources/senders/types/GetIpsResponse.d.mts +2 -2
  504. package/dist/esm/api/resources/smsCampaigns/client/Client.d.mts +16 -0
  505. package/dist/esm/api/resources/smsCampaigns/client/Client.mjs +30 -10
  506. package/dist/esm/api/resources/smsCampaigns/client/requests/GetSmsCampaignsRequest.d.mts +3 -3
  507. package/dist/esm/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.mts +38 -2
  508. package/dist/esm/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.mts +7 -1
  509. package/dist/esm/api/resources/smsTemplates/client/Client.mjs +5 -1
  510. package/dist/esm/api/resources/tasks/client/Client.d.mts +16 -2
  511. package/dist/esm/api/resources/tasks/client/Client.mjs +35 -12
  512. package/dist/esm/api/resources/tasks/client/requests/PostCrmTasksRequest.d.mts +1 -1
  513. package/dist/esm/api/resources/tasks/types/{GetCrmTasktypesResponse.d.mts → GetCrmTasktypesResponseItem.d.mts} +1 -4
  514. package/dist/esm/api/resources/tasks/types/GetCrmTasktypesResponseItem.mjs +2 -0
  515. package/dist/esm/api/resources/tasks/types/index.d.mts +1 -1
  516. package/dist/esm/api/resources/tasks/types/index.mjs +1 -1
  517. package/dist/esm/api/resources/tier/client/Client.mjs +22 -10
  518. package/dist/esm/api/resources/tier/client/requests/CreateTierGroupRequest.d.mts +62 -0
  519. package/dist/esm/api/resources/tier/client/requests/CreateTierGroupRequest.mjs +30 -0
  520. package/dist/esm/api/resources/transactionalEmails/client/Client.d.mts +31 -2
  521. package/dist/esm/api/resources/transactionalEmails/client/Client.mjs +114 -35
  522. package/dist/esm/api/resources/transactionalEmails/client/requests/DeleteScheduledEmailByIdRequest.d.mts +1 -1
  523. package/dist/esm/api/resources/transactionalEmails/client/requests/DeleteSmtpLogIdentifierRequest.d.mts +5 -1
  524. package/dist/esm/api/resources/transactionalEmails/client/requests/GetAggregatedSmtpReportRequest.d.mts +1 -1
  525. package/dist/esm/api/resources/transactionalEmails/client/requests/GetEmailEventReportRequest.d.mts +1 -1
  526. package/dist/esm/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.mts +2 -2
  527. package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpReportRequest.d.mts +1 -1
  528. package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpTemplateRequest.d.mts +3 -2
  529. package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpTemplatesRequest.d.mts +2 -0
  530. package/dist/esm/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.mts +3 -2
  531. package/dist/esm/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.d.mts +1 -0
  532. package/dist/esm/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.mjs +2 -0
  533. package/dist/esm/api/resources/transactionalEmails/types/GetTransacBlockedContactsResponse.d.mts +1 -1
  534. package/dist/esm/api/resources/transactionalEmails/types/GetTransacEmailContentResponse.d.mts +2 -2
  535. package/dist/esm/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.d.mts +1 -0
  536. package/dist/esm/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.mjs +2 -0
  537. package/dist/esm/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.d.mts +1 -0
  538. package/dist/esm/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.mjs +2 -0
  539. package/dist/esm/api/resources/transactionalEmails/types/index.d.mts +3 -0
  540. package/dist/esm/api/resources/transactionalEmails/types/index.mjs +3 -0
  541. package/dist/esm/api/resources/transactionalSms/client/Client.d.mts +9 -0
  542. package/dist/esm/api/resources/transactionalSms/client/Client.mjs +28 -5
  543. package/dist/esm/api/resources/transactionalWhatsApp/client/Client.mjs +6 -2
  544. package/dist/esm/api/resources/user/client/Client.d.mts +8 -0
  545. package/dist/esm/api/resources/user/client/Client.mjs +14 -6
  546. package/dist/esm/api/resources/wallet/client/Client.d.mts +34 -0
  547. package/dist/esm/api/resources/wallet/client/Client.mjs +89 -0
  548. package/dist/esm/api/resources/wallet/client/index.d.mts +1 -0
  549. package/dist/esm/api/resources/wallet/client/index.mjs +1 -0
  550. package/dist/esm/api/resources/wallet/client/requests/GetWalletPassInstallUrlRequest.d.mts +13 -0
  551. package/dist/esm/api/resources/wallet/client/requests/GetWalletPassInstallUrlRequest.mjs +2 -0
  552. package/dist/esm/api/resources/wallet/client/requests/index.d.mts +1 -0
  553. package/dist/esm/api/resources/wallet/client/requests/index.mjs +1 -0
  554. package/dist/esm/api/resources/wallet/exports.d.mts +2 -0
  555. package/dist/esm/api/resources/wallet/exports.mjs +3 -0
  556. package/dist/esm/api/resources/wallet/index.d.mts +1 -0
  557. package/dist/esm/api/resources/wallet/index.mjs +1 -0
  558. package/dist/esm/api/resources/webhooks/client/Client.d.mts +0 -1
  559. package/dist/esm/api/resources/webhooks/client/Client.mjs +10 -7
  560. package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequest.d.mts +14 -21
  561. package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequest.mjs +2 -2
  562. package/dist/esm/api/resources/webhooks/client/requests/ExportWebhooksHistoryRequest.d.mts +1 -1
  563. package/dist/esm/api/resources/whatsAppCampaigns/client/Client.d.mts +6 -0
  564. package/dist/esm/api/resources/whatsAppCampaigns/client/Client.mjs +23 -9
  565. package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.mts +15 -0
  566. package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.mts +2 -0
  567. package/dist/esm/api/types/BalanceDefinition.d.mts +81 -32
  568. package/dist/esm/api/types/BalanceDefinition.mjs +46 -2
  569. package/dist/esm/api/types/BalanceLimit.d.mts +37 -14
  570. package/dist/esm/api/types/BalanceLimit.mjs +21 -1
  571. package/dist/esm/api/types/Company.d.mts +1 -1
  572. package/dist/esm/api/types/ConsentGroup.d.mts +29 -0
  573. package/dist/esm/api/types/ConsentGroup.mjs +9 -0
  574. package/dist/esm/api/types/ConsentGroupItem.d.mts +17 -0
  575. package/dist/esm/api/types/ConsentGroupItem.mjs +9 -0
  576. package/dist/esm/api/types/ConsentGroupsListResponse.d.mts +14 -0
  577. package/dist/esm/api/types/ConsentGroupsListResponse.mjs +2 -0
  578. package/dist/esm/api/types/ConversationsMessage.d.mts +59 -20
  579. package/dist/esm/api/types/Deal.d.mts +4 -4
  580. package/dist/esm/api/types/FileData.d.mts +8 -6
  581. package/dist/esm/api/types/GetCampaignRecipients.d.mts +4 -0
  582. package/dist/esm/api/types/GetCampaignStats.d.mts +15 -15
  583. package/dist/esm/api/types/GetContactDetails.d.mts +5 -0
  584. package/dist/esm/api/types/GetEventsList.d.mts +0 -2
  585. package/dist/esm/api/types/GetExtendedCampaignOverview.d.mts +28 -5
  586. package/dist/esm/api/types/GetExtendedCampaignOverview.mjs +9 -0
  587. package/dist/esm/api/types/GetExtendedCampaignStats.d.mts +8 -10
  588. package/dist/esm/api/types/GetProductDetails.d.mts +3 -1
  589. package/dist/esm/api/types/GetSmsCampaignOverview.d.mts +7 -1
  590. package/dist/esm/api/types/GetSmtpTemplateOverview.d.mts +3 -1
  591. package/dist/esm/api/types/GetWebhook.d.mts +5 -10
  592. package/dist/esm/api/types/GetWebhook.mjs +2 -6
  593. package/dist/esm/api/types/LoyaltyProgram.d.mts +23 -20
  594. package/dist/esm/api/types/LoyaltyProgram.mjs +2 -1
  595. package/dist/esm/api/types/Note.d.mts +10 -8
  596. package/dist/esm/api/types/NoteData.d.mts +1 -1
  597. package/dist/esm/api/types/Order.d.mts +1 -1
  598. package/dist/esm/api/types/Pipeline.d.mts +3 -3
  599. package/dist/esm/api/types/SendTransacSms.d.mts +7 -14
  600. package/dist/esm/api/types/Task.d.mts +20 -8
  601. package/dist/esm/api/types/TierGroup.d.mts +66 -0
  602. package/dist/esm/api/types/TierGroup.mjs +30 -0
  603. package/dist/esm/api/types/Transaction.d.mts +36 -17
  604. package/dist/esm/api/types/Transaction.mjs +16 -1
  605. package/dist/esm/api/types/WalletPassInstallUrl.d.mts +4 -0
  606. package/dist/esm/api/types/WalletPassInstallUrl.mjs +2 -0
  607. package/dist/esm/api/types/index.d.mts +4 -0
  608. package/dist/esm/api/types/index.mjs +4 -0
  609. package/dist/esm/core/auth/AuthProvider.d.mts +1 -0
  610. package/dist/esm/core/auth/AuthProvider.mjs +6 -1
  611. package/dist/esm/core/auth/index.d.mts +1 -1
  612. package/dist/esm/core/auth/index.mjs +1 -0
  613. package/dist/esm/core/fetcher/Fetcher.d.mts +6 -0
  614. package/dist/esm/core/fetcher/Fetcher.mjs +9 -8
  615. package/dist/esm/core/fetcher/getResponseBody.mjs +11 -0
  616. package/dist/esm/core/fetcher/requestWithRetries.mjs +4 -1
  617. package/dist/esm/core/fetcher/signals.mjs +9 -1
  618. package/dist/esm/core/url/QueryStringBuilder.d.mts +47 -0
  619. package/dist/esm/core/url/QueryStringBuilder.mjs +80 -0
  620. package/dist/esm/core/url/index.d.mts +1 -0
  621. package/dist/esm/core/url/index.mjs +1 -0
  622. package/dist/esm/core/url/qs.d.mts +2 -1
  623. package/dist/esm/core/url/qs.mjs +25 -13
  624. package/dist/esm/errors/BrevoError.d.mts +1 -0
  625. package/dist/esm/errors/BrevoError.mjs +5 -1
  626. package/dist/esm/errors/BrevoTimeoutError.d.mts +2 -2
  627. package/dist/esm/errors/BrevoTimeoutError.mjs +7 -6
  628. package/dist/esm/version.d.mts +1 -1
  629. package/dist/esm/version.mjs +1 -1
  630. package/package.json +24 -2
  631. package/reference.md +2301 -170
  632. package/dist/cjs/api/resources/event/types/CreateBatchEventsRequestItem.d.ts +0 -59
  633. package/dist/cjs/api/resources/event/types/index.d.ts +0 -1
  634. package/dist/esm/api/resources/event/types/CreateBatchEventsRequestItem.d.mts +0 -59
  635. package/dist/esm/api/resources/event/types/index.d.mts +0 -1
  636. package/dist/esm/api/resources/event/types/index.mjs +0 -1
  637. /package/dist/cjs/api/resources/{event/types/CreateBatchEventsRequestItem.js → balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.js} +0 -0
  638. /package/dist/cjs/api/resources/{tasks/types/GetCrmTasktypesResponse.js → consentGroups/client/requests/DeleteConsentGroupRequest.js} +0 -0
  639. /package/dist/esm/api/resources/{event/types/CreateBatchEventsRequestItem.mjs → balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.mjs} +0 -0
  640. /package/dist/esm/api/resources/{tasks/types/GetCrmTasktypesResponse.mjs → consentGroups/client/requests/DeleteConsentGroupRequest.mjs} +0 -0
@@ -108,7 +108,11 @@ class WebhooksClient {
108
108
  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, "webhooks"),
109
109
  method: "GET",
110
110
  headers: _headers,
111
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
111
+ queryString: core.url
112
+ .queryBuilder()
113
+ .addMany(_queryParams)
114
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
115
+ .build(),
112
116
  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,
113
117
  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,
114
118
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -154,7 +158,6 @@ class WebhooksClient {
154
158
  *
155
159
  * @example
156
160
  * await client.webhooks.createWebhook({
157
- * events: ["sent"],
158
161
  * url: "http://requestb.in/173lyyx1"
159
162
  * })
160
163
  */
@@ -171,7 +174,7 @@ class WebhooksClient {
171
174
  method: "POST",
172
175
  headers: _headers,
173
176
  contentType: "application/json",
174
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
177
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
175
178
  requestType: "json",
176
179
  body: request,
177
180
  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,
@@ -235,7 +238,7 @@ class WebhooksClient {
235
238
  method: "POST",
236
239
  headers: _headers,
237
240
  contentType: "application/json",
238
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
241
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
239
242
  requestType: "json",
240
243
  body: request,
241
244
  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,
@@ -303,7 +306,7 @@ class WebhooksClient {
303
306
  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, `webhooks/${core.url.encodePathParam(webhookId)}`),
304
307
  method: "GET",
305
308
  headers: _headers,
306
- 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(),
307
310
  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,
308
311
  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,
309
312
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -368,7 +371,7 @@ class WebhooksClient {
368
371
  method: "PUT",
369
372
  headers: _headers,
370
373
  contentType: "application/json",
371
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
374
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
372
375
  requestType: "json",
373
376
  body: _body,
374
377
  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,
@@ -433,7 +436,7 @@ class WebhooksClient {
433
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, `webhooks/${core.url.encodePathParam(webhookId)}`),
434
437
  method: "DELETE",
435
438
  headers: _headers,
436
- 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(),
437
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,
438
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,
439
442
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -1,7 +1,6 @@
1
1
  /**
2
2
  * @example
3
3
  * {
4
- * events: ["sent"],
5
4
  * url: "http://requestb.in/173lyyx1"
6
5
  * }
7
6
  */
@@ -10,7 +9,7 @@ export interface CreateWebhookRequest {
10
9
  auth?: CreateWebhookRequest.Auth;
11
10
  /** To send batched webhooks */
12
11
  batched?: boolean;
13
- /** channel of webhook */
12
+ /** Channel of the webhook */
14
13
  channel?: CreateWebhookRequest.Channel;
15
14
  /** Description of the webhook */
16
15
  description?: string;
@@ -20,24 +19,18 @@ export interface CreateWebhookRequest {
20
19
  */
21
20
  domain?: string;
22
21
  /**
23
- * - Events triggering the webhook. Possible values for
24
- * **Transactional** type webhook: #### `sent` OR `request`,
25
- * `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`,
26
- * `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and
27
- * `unsubscribed` - Possible values for **Marketing** type webhook:
28
- * #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`,
29
- * `unsubscribed`, `listAddition` & `delivered` - Possible values
30
- * for **Inbound** type webhook: #### `inboundEmailProcessed` -
31
- * Possible values for type **Transactional** and channel **SMS**
32
- * ####
33
- * `accepted`,`delivered`,`softBounce`,`hardBounce`,`unsubscribe`,`reply`,
34
- * `subscribe`,`sent`,`blacklisted`,`skip` - Possible values for
35
- * type **Marketing** channel **SMS** ####
36
- * `sent`,`delivered`,`softBounce`,`hardBounce`,`unsubscribe`,`reply`,
37
- * `subscribe`,`skip`
38
- * #### `reply`
22
+ * Events triggering the webhook. Required for transactional and
23
+ * marketing types, optional for inbound type (defaults to
24
+ * `inboundEmailProcessed`). Possible values for **Transactional**
25
+ * type webhook: `sent` OR `request`, `delivered`, `hardBounce`,
26
+ * `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`,
27
+ * `opened`, `uniqueOpened` and `unsubscribed`. Possible values for
28
+ * **Marketing** type webhook: `spam`, `opened`, `click`,
29
+ * `hardBounce`, `softBounce`, `unsubscribed`, `listAddition`,
30
+ * `delivered`, `contactUpdated` & `contactDeleted`. Possible values
31
+ * for **Inbound** type webhook: `inboundEmailProcessed`.
39
32
  */
40
- events: CreateWebhookRequest.Events.Item[];
33
+ events?: CreateWebhookRequest.Events.Item[];
41
34
  /** Custom headers to be send with webhooks */
42
35
  headers?: CreateWebhookRequest.Headers.Item[];
43
36
  /** Type of the webhook */
@@ -55,10 +48,10 @@ export declare namespace CreateWebhookRequest {
55
48
  /** Type of authentication */
56
49
  type?: string | undefined;
57
50
  }
58
- /** channel of webhook */
51
+ /** Channel of the webhook */
59
52
  const Channel: {
60
- readonly Sms: "sms";
61
53
  readonly Email: "email";
54
+ readonly Sms: "sms";
62
55
  };
63
56
  type Channel = (typeof Channel)[keyof typeof Channel];
64
57
  type Events = Events.Item[];
@@ -4,10 +4,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.CreateWebhookRequest = void 0;
5
5
  var CreateWebhookRequest;
6
6
  (function (CreateWebhookRequest) {
7
- /** channel of webhook */
7
+ /** Channel of the webhook */
8
8
  CreateWebhookRequest.Channel = {
9
- Sms: "sms",
10
9
  Email: "email",
10
+ Sms: "sms",
11
11
  };
12
12
  let Events;
13
13
  (function (Events) {
@@ -25,7 +25,7 @@ export interface ExportWebhooksHistoryRequest {
25
25
  * Filter the history for a specific message id. Applicable
26
26
  * only for transactional webhooks.
27
27
  */
28
- messageId?: number;
28
+ messageId?: string;
29
29
  /** Webhook URL to receive CSV file link */
30
30
  notifyURL: string;
31
31
  /** Sorting order of records (asc or desc) */
@@ -11,6 +11,8 @@ export declare class WhatsAppCampaignsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<WhatsAppCampaignsClient.Options>;
12
12
  constructor(options: WhatsAppCampaignsClient.Options);
13
13
  /**
14
+ * Retrieve a paginated list of all your WhatsApp campaigns with their statistics and metadata. Results can be filtered by creation date range using startDate and endDate, with a default limit of 50 and maximum of 100 per page. The sort order defaults to descending by modification date.
15
+ *
14
16
  * @param {Brevo.GetWhatsAppCampaignsRequest} request
15
17
  * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
16
18
  *
@@ -76,6 +78,8 @@ export declare class WhatsAppCampaignsClient {
76
78
  createWhatsAppTemplate(request: Brevo.CreateWhatsAppTemplateRequest, requestOptions?: WhatsAppCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateWhatsAppTemplateResponse>;
77
79
  private __createWhatsAppTemplate;
78
80
  /**
81
+ * Retrieve a paginated list of all your WhatsApp templates with their status, category, language, and metadata. Results can be filtered by creation date range and optionally by source (Automation or Conversations), with a default limit of 50 and maximum of 100 per page. The sort order defaults to descending by modification date.
82
+ *
79
83
  * @param {Brevo.GetWhatsAppTemplatesRequest} request
80
84
  * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
81
85
  *
@@ -142,6 +146,8 @@ export declare class WhatsAppCampaignsClient {
142
146
  updateWhatsAppCampaign(request: Brevo.UpdateWhatsAppCampaignRequest, requestOptions?: WhatsAppCampaignsClient.RequestOptions): core.HttpResponsePromise<void>;
143
147
  private __updateWhatsAppCampaign;
144
148
  /**
149
+ * Delete a WhatsApp campaign by its campaign ID. The campaign must exist; if the campaign ID is not found, a 404 error is returned. This action is permanent and cannot be undone.
150
+ *
145
151
  * @param {Brevo.DeleteWhatsAppCampaignRequest} request
146
152
  * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
147
153
  *
@@ -67,6 +67,8 @@ class WhatsAppCampaignsClient {
67
67
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
68
68
  }
69
69
  /**
70
+ * Retrieve a paginated list of all your WhatsApp campaigns with their statistics and metadata. Results can be filtered by creation date range using startDate and endDate, with a default limit of 50 and maximum of 100 per page. The sort order defaults to descending by modification date.
71
+ *
70
72
  * @param {Brevo.GetWhatsAppCampaignsRequest} request
71
73
  * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
72
74
  *
@@ -95,7 +97,11 @@ class WhatsAppCampaignsClient {
95
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, "whatsappCampaigns"),
96
98
  method: "GET",
97
99
  headers: _headers,
98
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
100
+ queryString: core.url
101
+ .queryBuilder()
102
+ .addMany(_queryParams)
103
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
104
+ .build(),
99
105
  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,
100
106
  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,
101
107
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -153,7 +159,7 @@ class WhatsAppCampaignsClient {
153
159
  method: "POST",
154
160
  headers: _headers,
155
161
  contentType: "application/json",
156
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
162
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
157
163
  requestType: "json",
158
164
  body: request,
159
165
  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,
@@ -203,7 +209,7 @@ class WhatsAppCampaignsClient {
203
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, "whatsappCampaigns/config"),
204
210
  method: "GET",
205
211
  headers: _headers,
206
- 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(),
207
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,
208
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,
209
215
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -258,7 +264,7 @@ class WhatsAppCampaignsClient {
258
264
  method: "POST",
259
265
  headers: _headers,
260
266
  contentType: "application/json",
261
- 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(),
262
268
  requestType: "json",
263
269
  body: request,
264
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,
@@ -286,6 +292,8 @@ class WhatsAppCampaignsClient {
286
292
  });
287
293
  }
288
294
  /**
295
+ * Retrieve a paginated list of all your WhatsApp templates with their status, category, language, and metadata. Results can be filtered by creation date range and optionally by source (Automation or Conversations), with a default limit of 50 and maximum of 100 per page. The sort order defaults to descending by modification date.
296
+ *
289
297
  * @param {Brevo.GetWhatsAppTemplatesRequest} request
290
298
  * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
291
299
  *
@@ -315,7 +323,11 @@ class WhatsAppCampaignsClient {
315
323
  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, "whatsappCampaigns/template-list"),
316
324
  method: "GET",
317
325
  headers: _headers,
318
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
326
+ queryString: core.url
327
+ .queryBuilder()
328
+ .addMany(_queryParams)
329
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
330
+ .build(),
319
331
  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,
320
332
  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,
321
333
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -367,7 +379,7 @@ class WhatsAppCampaignsClient {
367
379
  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, `whatsappCampaigns/template/approval/${core.url.encodePathParam(templateId)}`),
368
380
  method: "POST",
369
381
  headers: _headers,
370
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
382
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
371
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,
372
384
  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,
373
385
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -423,7 +435,7 @@ class WhatsAppCampaignsClient {
423
435
  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, `whatsappCampaigns/${core.url.encodePathParam(campaignId)}`),
424
436
  method: "GET",
425
437
  headers: _headers,
426
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
438
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
427
439
  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,
428
440
  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,
429
441
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -481,7 +493,7 @@ class WhatsAppCampaignsClient {
481
493
  method: "PUT",
482
494
  headers: _headers,
483
495
  contentType: "application/json",
484
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
496
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
485
497
  requestType: "json",
486
498
  body: _body,
487
499
  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,
@@ -509,6 +521,8 @@ class WhatsAppCampaignsClient {
509
521
  });
510
522
  }
511
523
  /**
524
+ * Delete a WhatsApp campaign by its campaign ID. The campaign must exist; if the campaign ID is not found, a 404 error is returned. This action is permanent and cannot be undone.
525
+ *
512
526
  * @param {Brevo.DeleteWhatsAppCampaignRequest} request
513
527
  * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
514
528
  *
@@ -533,7 +547,7 @@ class WhatsAppCampaignsClient {
533
547
  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, `whatsappCampaigns/${core.url.encodePathParam(campaignId)}`),
534
548
  method: "DELETE",
535
549
  headers: _headers,
536
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
550
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
537
551
  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,
538
552
  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,
539
553
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -12,6 +12,8 @@ export interface GetWhatsAppCampaignResponse {
12
12
  modifiedAt: string;
13
13
  /** UTC date-time on which WhatsApp campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format */
14
14
  scheduledAt?: string | undefined;
15
+ /** Recipients of the WhatsApp Campaign */
16
+ recipients: GetWhatsAppCampaignResponse.Recipients;
15
17
  /** Sender of the WhatsApp Campaign */
16
18
  senderNumber: string;
17
19
  stats?: Brevo.WhatsappCampStats | undefined;
@@ -30,6 +32,19 @@ export declare namespace GetWhatsAppCampaignResponse {
30
32
  readonly Sent: "sent";
31
33
  };
32
34
  type CampaignStatus = (typeof CampaignStatus)[keyof typeof CampaignStatus];
35
+ /**
36
+ * Recipients of the WhatsApp Campaign
37
+ */
38
+ interface Recipients {
39
+ /** List of excluded list IDs */
40
+ excludedLists?: number[] | undefined;
41
+ /** List of included list IDs */
42
+ includedLists?: number[] | undefined;
43
+ /** List of segment IDs */
44
+ segments?: number[] | undefined;
45
+ /** Type of recipients (list or segment) */
46
+ type?: string | undefined;
47
+ }
33
48
  interface Template {
34
49
  /** array of variables item variables */
35
50
  body_variables?: Brevo.VariablesItems[] | undefined;
@@ -23,6 +23,8 @@ export declare namespace GetWhatsAppTemplatesResponse {
23
23
  name: string;
24
24
  /** Status of the whatsApp template */
25
25
  status: string;
26
+ /** Type of the whatsApp template */
27
+ type: string;
26
28
  }
27
29
  }
28
30
  }
@@ -1,51 +1,100 @@
1
1
  export interface BalanceDefinition {
2
- /** startOfPeriod depicts the balancy expiry on start of day/week/month/year. endOfPeriod depicts the balancy expiry on end of day/week/month/year */
3
- balanceAvailabilityDurationModifier?: BalanceDefinition.BalanceAvailabilityDurationModifier | undefined;
4
- /** Unit of time for the balance's availability (e.g., day/week/month/year). */
5
- balanceAvailabilityDurationUnit?: string | undefined;
6
- /** Number of days/weeks/month/year for balance expiry */
7
- balanceAvailabilityDurationValue?: number | undefined;
8
- /** Date when the balance expires and can no longer be used, in dd/mm format. The balance will be expired when this date appears next in the calendar and only one of balanceExpirationDate or balance availability fields can be used. */
9
- balanceExpirationDate?: string | undefined;
10
- /** Partial enables partial credit of balance if maximum balance limit is reaching. Strict enables rejection of transaction if it will breach the max credit amount limit. */
11
- balanceOptionAmountOvertakingStrategy?: string | undefined;
12
- /** Rounding strategy for credit transactions. */
13
- balanceOptionCreditRounding?: string | undefined;
14
- /** Rounding strategy for debit transactions. */
15
- balanceOptionDebitRounding?: string | undefined;
16
- /** Timestamp of balance definition creation. */
17
- createdAt?: string | undefined;
18
- /** Timestamp of balance definition deletion (nullable). */
19
- deletedAt?: string | undefined;
20
- /** Short description of the balance definition. */
21
- description?: string | undefined;
22
2
  /** Unique identifier for the balance definition. */
23
3
  id?: string | undefined;
4
+ /** Name of the balance definition. */
5
+ name?: string | undefined;
6
+ /** Short description of the balance definition. */
7
+ description?: string | undefined;
24
8
  /** Optional image reference URL. */
25
9
  imageRef?: string | undefined;
26
- /** Maximum allowable balance. */
27
- maxAmount?: number | undefined;
28
- /** Max credit allowed per operation. */
29
- maxCreditAmountLimit?: number | undefined;
30
- /** Max debit allowed per operation. */
31
- maxDebitAmountLimit?: number | undefined;
32
10
  /** Additional metadata for the balance definition. */
33
11
  meta?: Record<string, unknown> | undefined;
12
+ /** Unit of balance measurement. */
13
+ unit?: BalanceDefinition.Unit | undefined;
34
14
  /** Minimum allowable balance. */
35
15
  minAmount?: number | undefined;
36
- /** Name of the balance definition. */
37
- name?: string | undefined;
38
- /** Unit of balance (e.g., points, currency). */
39
- unit?: string | undefined;
16
+ /** Maximum allowable balance. */
17
+ maxAmount?: number | undefined;
18
+ /** Maximum credit allowed per operation. */
19
+ maxCreditAmountLimit?: number | undefined;
20
+ /** Maximum debit allowed per operation. */
21
+ maxDebitAmountLimit?: number | undefined;
22
+ /** Partial enables partial credit of balance if maximum balance limit is reached. Strict enables rejection of a transaction if it will breach the max balance limit. */
23
+ balanceOptionAmountOvertakingStrategy?: BalanceDefinition.BalanceOptionAmountOvertakingStrategy | undefined;
24
+ /** Rounding strategy for credit transactions. */
25
+ balanceOptionCreditRounding?: BalanceDefinition.BalanceOptionCreditRounding | undefined;
26
+ /** Rounding strategy for debit transactions. */
27
+ balanceOptionDebitRounding?: BalanceDefinition.BalanceOptionDebitRounding | undefined;
28
+ /** Number of time units before the balance expires. */
29
+ balanceAvailabilityDurationValue?: number | undefined;
30
+ /** Unit of time for the balance availability duration. */
31
+ balanceAvailabilityDurationUnit?: BalanceDefinition.BalanceAvailabilityDurationUnit | undefined;
32
+ /** Modifier for balance availability duration. startOfPeriod causes expiry at the start of the period, endOfPeriod at the end. noModification uses the exact duration from the credit date. */
33
+ balanceAvailabilityDurationModifier?: BalanceDefinition.BalanceAvailabilityDurationModifier | undefined;
34
+ /** Fixed expiration date in dd/mm format. The balance expires when this date next appears in the calendar. Only one of balanceExpirationDate or balance availability duration fields can be used. */
35
+ balanceExpirationDate?: string | undefined;
36
+ /** Timestamp of balance definition creation. */
37
+ createdAt?: string | undefined;
40
38
  /** Timestamp of the last update. */
41
39
  updatedAt?: string | undefined;
40
+ /** Timestamp of balance definition deletion (nullable). */
41
+ deletedAt?: string | undefined;
42
42
  }
43
43
  export declare namespace BalanceDefinition {
44
- /** startOfPeriod depicts the balancy expiry on start of day/week/month/year. endOfPeriod depicts the balancy expiry on end of day/week/month/year */
44
+ /** Unit of balance measurement. */
45
+ const Unit: {
46
+ readonly Points: "POINTS";
47
+ readonly Eur: "EUR";
48
+ readonly Usd: "USD";
49
+ readonly Mxn: "MXN";
50
+ readonly Gbp: "GBP";
51
+ readonly Inr: "INR";
52
+ readonly Cad: "CAD";
53
+ readonly Sgd: "SGD";
54
+ readonly Ron: "RON";
55
+ readonly Jpy: "JPY";
56
+ readonly Myr: "MYR";
57
+ readonly Clp: "CLP";
58
+ readonly Pen: "PEN";
59
+ readonly Mad: "MAD";
60
+ readonly Aud: "AUD";
61
+ readonly Chf: "CHF";
62
+ readonly Brl: "BRL";
63
+ };
64
+ type Unit = (typeof Unit)[keyof typeof Unit];
65
+ /** Partial enables partial credit of balance if maximum balance limit is reached. Strict enables rejection of a transaction if it will breach the max balance limit. */
66
+ const BalanceOptionAmountOvertakingStrategy: {
67
+ readonly Strict: "strict";
68
+ readonly Partial: "partial";
69
+ };
70
+ type BalanceOptionAmountOvertakingStrategy = (typeof BalanceOptionAmountOvertakingStrategy)[keyof typeof BalanceOptionAmountOvertakingStrategy];
71
+ /** Rounding strategy for credit transactions. */
72
+ const BalanceOptionCreditRounding: {
73
+ readonly Lower: "lower";
74
+ readonly Upper: "upper";
75
+ readonly Natural: "natural";
76
+ };
77
+ type BalanceOptionCreditRounding = (typeof BalanceOptionCreditRounding)[keyof typeof BalanceOptionCreditRounding];
78
+ /** Rounding strategy for debit transactions. */
79
+ const BalanceOptionDebitRounding: {
80
+ readonly Lower: "lower";
81
+ readonly Upper: "upper";
82
+ readonly Natural: "natural";
83
+ };
84
+ type BalanceOptionDebitRounding = (typeof BalanceOptionDebitRounding)[keyof typeof BalanceOptionDebitRounding];
85
+ /** Unit of time for the balance availability duration. */
86
+ const BalanceAvailabilityDurationUnit: {
87
+ readonly Day: "day";
88
+ readonly Week: "week";
89
+ readonly Month: "month";
90
+ readonly Year: "year";
91
+ };
92
+ type BalanceAvailabilityDurationUnit = (typeof BalanceAvailabilityDurationUnit)[keyof typeof BalanceAvailabilityDurationUnit];
93
+ /** Modifier for balance availability duration. startOfPeriod causes expiry at the start of the period, endOfPeriod at the end. noModification uses the exact duration from the credit date. */
45
94
  const BalanceAvailabilityDurationModifier: {
95
+ readonly NoModification: "noModification";
46
96
  readonly StartOfPeriod: "startOfPeriod";
47
97
  readonly EndOfPeriod: "endOfPeriod";
48
- readonly NoModification: "noModification";
49
98
  };
50
99
  type BalanceAvailabilityDurationModifier = (typeof BalanceAvailabilityDurationModifier)[keyof typeof BalanceAvailabilityDurationModifier];
51
100
  }
@@ -4,10 +4,54 @@ Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.BalanceDefinition = void 0;
5
5
  var BalanceDefinition;
6
6
  (function (BalanceDefinition) {
7
- /** startOfPeriod depicts the balancy expiry on start of day/week/month/year. endOfPeriod depicts the balancy expiry on end of day/week/month/year */
7
+ /** Unit of balance measurement. */
8
+ BalanceDefinition.Unit = {
9
+ Points: "POINTS",
10
+ Eur: "EUR",
11
+ Usd: "USD",
12
+ Mxn: "MXN",
13
+ Gbp: "GBP",
14
+ Inr: "INR",
15
+ Cad: "CAD",
16
+ Sgd: "SGD",
17
+ Ron: "RON",
18
+ Jpy: "JPY",
19
+ Myr: "MYR",
20
+ Clp: "CLP",
21
+ Pen: "PEN",
22
+ Mad: "MAD",
23
+ Aud: "AUD",
24
+ Chf: "CHF",
25
+ Brl: "BRL",
26
+ };
27
+ /** Partial enables partial credit of balance if maximum balance limit is reached. Strict enables rejection of a transaction if it will breach the max balance limit. */
28
+ BalanceDefinition.BalanceOptionAmountOvertakingStrategy = {
29
+ Strict: "strict",
30
+ Partial: "partial",
31
+ };
32
+ /** Rounding strategy for credit transactions. */
33
+ BalanceDefinition.BalanceOptionCreditRounding = {
34
+ Lower: "lower",
35
+ Upper: "upper",
36
+ Natural: "natural",
37
+ };
38
+ /** Rounding strategy for debit transactions. */
39
+ BalanceDefinition.BalanceOptionDebitRounding = {
40
+ Lower: "lower",
41
+ Upper: "upper",
42
+ Natural: "natural",
43
+ };
44
+ /** Unit of time for the balance availability duration. */
45
+ BalanceDefinition.BalanceAvailabilityDurationUnit = {
46
+ Day: "day",
47
+ Week: "week",
48
+ Month: "month",
49
+ Year: "year",
50
+ };
51
+ /** Modifier for balance availability duration. startOfPeriod causes expiry at the start of the period, endOfPeriod at the end. noModification uses the exact duration from the credit date. */
8
52
  BalanceDefinition.BalanceAvailabilityDurationModifier = {
53
+ NoModification: "noModification",
9
54
  StartOfPeriod: "startOfPeriod",
10
55
  EndOfPeriod: "endOfPeriod",
11
- NoModification: "noModification",
12
56
  };
13
57
  })(BalanceDefinition || (exports.BalanceDefinition = BalanceDefinition = {}));
@@ -1,22 +1,45 @@
1
1
  export interface BalanceLimit {
2
- /** balance definition ID */
2
+ /** Unique identifier for the balance limit. */
3
+ id?: string | undefined;
4
+ /** Balance definition ID. */
3
5
  balanceDefinitionId?: string | undefined;
4
- /** Defines the type of constraint (e.g., transaction-based or amount-based). */
5
- constraintType?: string | undefined;
6
- /** Timestamp of when the balance limit was created. */
7
- createdAt: string;
8
- /** Time unit for the balance limit (day, week, month, year). */
9
- durationUnit?: string | undefined;
6
+ /** Specifies whether the limit applies to credit or debit transactions. */
7
+ transactionType?: BalanceLimit.TransactionType | undefined;
8
+ /** Defines the type of constraint (transaction count or amount). */
9
+ constraintType?: BalanceLimit.ConstraintType | undefined;
10
10
  /** Number of time units the balance limit applies to. */
11
11
  durationValue?: number | undefined;
12
- /** Unique identifier for the balance limit. */
13
- id?: string | undefined;
12
+ /** Time unit for the balance limit. */
13
+ durationUnit?: BalanceLimit.DurationUnit | undefined;
14
+ /** The maximum allowed value for the defined constraint. */
15
+ value?: number | undefined;
14
16
  /** Indicates if the limit resets periodically based on a sliding schedule. */
15
17
  slidingSchedule?: boolean | undefined;
16
- /** Specifies whether the limit applies to credit or debit transactions. */
17
- transactionType?: string | undefined;
18
+ /** Timestamp of when the balance limit was created. */
19
+ createdAt?: string | undefined;
18
20
  /** Timestamp of the last update to the balance limit. */
19
- updatedAt: string;
20
- /** The maximum allowed value for the defined constraint. */
21
- value?: number | undefined;
21
+ updatedAt?: string | undefined;
22
+ }
23
+ export declare namespace BalanceLimit {
24
+ /** Specifies whether the limit applies to credit or debit transactions. */
25
+ const TransactionType: {
26
+ readonly Credit: "credit";
27
+ readonly Debit: "debit";
28
+ };
29
+ type TransactionType = (typeof TransactionType)[keyof typeof TransactionType];
30
+ /** Defines the type of constraint (transaction count or amount). */
31
+ const ConstraintType: {
32
+ readonly Transaction: "transaction";
33
+ readonly Amount: "amount";
34
+ };
35
+ type ConstraintType = (typeof ConstraintType)[keyof typeof ConstraintType];
36
+ /** Time unit for the balance limit. */
37
+ const DurationUnit: {
38
+ readonly Hour: "hour";
39
+ readonly Day: "day";
40
+ readonly Week: "week";
41
+ readonly Month: "month";
42
+ readonly Year: "year";
43
+ };
44
+ type DurationUnit = (typeof DurationUnit)[keyof typeof DurationUnit];
22
45
  }
@@ -1,3 +1,25 @@
1
1
  "use strict";
2
2
  // This file was auto-generated by Fern from our API Definition.
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.BalanceLimit = void 0;
5
+ var BalanceLimit;
6
+ (function (BalanceLimit) {
7
+ /** Specifies whether the limit applies to credit or debit transactions. */
8
+ BalanceLimit.TransactionType = {
9
+ Credit: "credit",
10
+ Debit: "debit",
11
+ };
12
+ /** Defines the type of constraint (transaction count or amount). */
13
+ BalanceLimit.ConstraintType = {
14
+ Transaction: "transaction",
15
+ Amount: "amount",
16
+ };
17
+ /** Time unit for the balance limit. */
18
+ BalanceLimit.DurationUnit = {
19
+ Hour: "hour",
20
+ Day: "day",
21
+ Week: "week",
22
+ Month: "month",
23
+ Year: "year",
24
+ };
25
+ })(BalanceLimit || (exports.BalanceLimit = BalanceLimit = {}));
@@ -8,6 +8,6 @@ export interface Company {
8
8
  id?: string | undefined;
9
9
  /** Contact ids for contacts linked to this company */
10
10
  linkedContactsIds?: number[] | undefined;
11
- /** Deals ids for companies linked to this company */
11
+ /** Deal ids for deals linked to this company */
12
12
  linkedDealsIds?: string[] | undefined;
13
13
  }