@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
@@ -31,6 +31,8 @@ export class WhatsAppCampaignsClient {
31
31
  this._options = normalizeClientOptionsWithAuth(options);
32
32
  }
33
33
  /**
34
+ * 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.
35
+ *
34
36
  * @param {Brevo.GetWhatsAppCampaignsRequest} request
35
37
  * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
36
38
  *
@@ -59,7 +61,11 @@ export class WhatsAppCampaignsClient {
59
61
  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"),
60
62
  method: "GET",
61
63
  headers: _headers,
62
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
64
+ queryString: core.url
65
+ .queryBuilder()
66
+ .addMany(_queryParams)
67
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
68
+ .build(),
63
69
  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,
64
70
  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,
65
71
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -117,7 +123,7 @@ export class WhatsAppCampaignsClient {
117
123
  method: "POST",
118
124
  headers: _headers,
119
125
  contentType: "application/json",
120
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
126
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
121
127
  requestType: "json",
122
128
  body: request,
123
129
  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,
@@ -167,7 +173,7 @@ export class WhatsAppCampaignsClient {
167
173
  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"),
168
174
  method: "GET",
169
175
  headers: _headers,
170
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
176
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
171
177
  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
178
  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
179
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -222,7 +228,7 @@ export class WhatsAppCampaignsClient {
222
228
  method: "POST",
223
229
  headers: _headers,
224
230
  contentType: "application/json",
225
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
231
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
226
232
  requestType: "json",
227
233
  body: request,
228
234
  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,
@@ -250,6 +256,8 @@ export class WhatsAppCampaignsClient {
250
256
  });
251
257
  }
252
258
  /**
259
+ * 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.
260
+ *
253
261
  * @param {Brevo.GetWhatsAppTemplatesRequest} request
254
262
  * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
255
263
  *
@@ -279,7 +287,11 @@ export class WhatsAppCampaignsClient {
279
287
  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"),
280
288
  method: "GET",
281
289
  headers: _headers,
282
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
290
+ queryString: core.url
291
+ .queryBuilder()
292
+ .addMany(_queryParams)
293
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
294
+ .build(),
283
295
  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,
284
296
  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,
285
297
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -331,7 +343,7 @@ export class WhatsAppCampaignsClient {
331
343
  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)}`),
332
344
  method: "POST",
333
345
  headers: _headers,
334
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
346
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
335
347
  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,
336
348
  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,
337
349
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -387,7 +399,7 @@ export class WhatsAppCampaignsClient {
387
399
  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)}`),
388
400
  method: "GET",
389
401
  headers: _headers,
390
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
402
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
391
403
  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,
392
404
  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,
393
405
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -445,7 +457,7 @@ export class WhatsAppCampaignsClient {
445
457
  method: "PUT",
446
458
  headers: _headers,
447
459
  contentType: "application/json",
448
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
460
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
449
461
  requestType: "json",
450
462
  body: _body,
451
463
  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,
@@ -473,6 +485,8 @@ export class WhatsAppCampaignsClient {
473
485
  });
474
486
  }
475
487
  /**
488
+ * 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.
489
+ *
476
490
  * @param {Brevo.DeleteWhatsAppCampaignRequest} request
477
491
  * @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
478
492
  *
@@ -497,7 +511,7 @@ export class WhatsAppCampaignsClient {
497
511
  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)}`),
498
512
  method: "DELETE",
499
513
  headers: _headers,
500
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
514
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
501
515
  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,
502
516
  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,
503
517
  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
  }
@@ -1,10 +1,54 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
2
  export var BalanceDefinition;
3
3
  (function (BalanceDefinition) {
4
- /** startOfPeriod depicts the balancy expiry on start of day/week/month/year. endOfPeriod depicts the balancy expiry on end of day/week/month/year */
4
+ /** Unit of balance measurement. */
5
+ BalanceDefinition.Unit = {
6
+ Points: "POINTS",
7
+ Eur: "EUR",
8
+ Usd: "USD",
9
+ Mxn: "MXN",
10
+ Gbp: "GBP",
11
+ Inr: "INR",
12
+ Cad: "CAD",
13
+ Sgd: "SGD",
14
+ Ron: "RON",
15
+ Jpy: "JPY",
16
+ Myr: "MYR",
17
+ Clp: "CLP",
18
+ Pen: "PEN",
19
+ Mad: "MAD",
20
+ Aud: "AUD",
21
+ Chf: "CHF",
22
+ Brl: "BRL",
23
+ };
24
+ /** 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. */
25
+ BalanceDefinition.BalanceOptionAmountOvertakingStrategy = {
26
+ Strict: "strict",
27
+ Partial: "partial",
28
+ };
29
+ /** Rounding strategy for credit transactions. */
30
+ BalanceDefinition.BalanceOptionCreditRounding = {
31
+ Lower: "lower",
32
+ Upper: "upper",
33
+ Natural: "natural",
34
+ };
35
+ /** Rounding strategy for debit transactions. */
36
+ BalanceDefinition.BalanceOptionDebitRounding = {
37
+ Lower: "lower",
38
+ Upper: "upper",
39
+ Natural: "natural",
40
+ };
41
+ /** Unit of time for the balance availability duration. */
42
+ BalanceDefinition.BalanceAvailabilityDurationUnit = {
43
+ Day: "day",
44
+ Week: "week",
45
+ Month: "month",
46
+ Year: "year",
47
+ };
48
+ /** 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. */
5
49
  BalanceDefinition.BalanceAvailabilityDurationModifier = {
50
+ NoModification: "noModification",
6
51
  StartOfPeriod: "startOfPeriod",
7
52
  EndOfPeriod: "endOfPeriod",
8
- NoModification: "noModification",
9
53
  };
10
54
  })(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,2 +1,22 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
- export {};
2
+ export var BalanceLimit;
3
+ (function (BalanceLimit) {
4
+ /** Specifies whether the limit applies to credit or debit transactions. */
5
+ BalanceLimit.TransactionType = {
6
+ Credit: "credit",
7
+ Debit: "debit",
8
+ };
9
+ /** Defines the type of constraint (transaction count or amount). */
10
+ BalanceLimit.ConstraintType = {
11
+ Transaction: "transaction",
12
+ Amount: "amount",
13
+ };
14
+ /** Time unit for the balance limit. */
15
+ BalanceLimit.DurationUnit = {
16
+ Hour: "hour",
17
+ Day: "day",
18
+ Week: "week",
19
+ Month: "month",
20
+ Year: "year",
21
+ };
22
+ })(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
  }
@@ -53,6 +53,14 @@ export interface ConversationsMessage {
53
53
  to?: ConversationsMessage.To.Item[] | undefined;
54
54
  /** `"agent"` for agents’ messages, `"visitor"` for visitors’ messages. */
55
55
  type?: ConversationsMessage.Type | undefined;
56
+ /** ‘`true` if the message was sent via JavaScript API.’ */
57
+ isSentViaJsApi?: boolean | undefined;
58
+ /** The type of message content (e.g. for integration-specific message types). */
59
+ messageType?: string | undefined;
60
+ /** ‘`true` if the message is a forwarded message.’ */
61
+ isForward?: boolean | undefined;
62
+ /** Source information for the message. */
63
+ source?: Record<string, unknown> | undefined;
56
64
  /** visitor’s ID */
57
65
  visitorId?: string | undefined;
58
66
  }
@@ -61,17 +69,38 @@ export declare namespace ConversationsMessage {
61
69
  namespace Attachments {
62
70
  interface Item {
63
71
  /** The name of the file. */
64
- fileName?: string | undefined;
65
- /** The ID of the inline file. */
66
- inlineId?: string | undefined;
72
+ name?: string | undefined;
73
+ /** The URL of the file. */
74
+ link?: string | undefined;
75
+ /** The MIME type of the file. */
76
+ mimeType?: string | undefined;
67
77
  /** `true` for images. */
68
78
  isImage?: boolean | undefined;
79
+ /** `true` for sticker files. */
80
+ isSticker?: boolean | undefined;
69
81
  /** `true` for inline files. */
70
- isInline?: string | undefined;
82
+ isInline?: boolean | undefined;
83
+ /** The ID of the inline file. */
84
+ inlineId?: string | undefined;
71
85
  /** The size of the file in bytes. */
72
86
  size?: number | undefined;
73
- /** The URL of the file. */
74
- url?: string | undefined;
87
+ /** Image information (only present for image files). */
88
+ imageInfo?: Item.ImageInfo | undefined;
89
+ /** Whether the file extension is allowed for download. */
90
+ isAllowedFileType?: boolean | undefined;
91
+ }
92
+ namespace Item {
93
+ /**
94
+ * Image information (only present for image files).
95
+ */
96
+ interface ImageInfo {
97
+ /** Width of the image in pixels. */
98
+ width?: number | undefined;
99
+ /** Height of the image in pixels. */
100
+ height?: number | undefined;
101
+ /** URL of the image preview. */
102
+ previewLink?: string | undefined;
103
+ }
75
104
  }
76
105
  }
77
106
  type Bcc = Bcc.Item[];
@@ -89,28 +118,38 @@ export declare namespace ConversationsMessage {
89
118
  }
90
119
  }
91
120
  interface File_ {
92
- /** Name of the file */
93
- filename?: string | undefined;
94
- /** image info is passed in case the file is an image */
95
- imageInfo?: File_.ImageInfo | undefined;
96
- /** Whether the file is an image */
121
+ /** Name of the file. */
122
+ name?: string | undefined;
123
+ /** URL of the file. */
124
+ link?: string | undefined;
125
+ /** MIME type of the file. */
126
+ mimeType?: string | undefined;
127
+ /** Whether the file is an image. */
97
128
  isImage?: boolean | undefined;
98
- /** Size in bytes */
129
+ /** Whether the file is a sticker. */
130
+ isSticker?: boolean | undefined;
131
+ /** Whether the file is inline. */
132
+ isInline?: boolean | undefined;
133
+ /** The ID of the inline file. */
134
+ inlineId?: string | undefined;
135
+ /** Size in bytes. */
99
136
  size?: number | undefined;
100
- /** URL of the file */
101
- url?: string | undefined;
137
+ /** Image info, present when the file is an image. */
138
+ imageInfo?: File_.ImageInfo | undefined;
139
+ /** Whether the file extension is allowed for download. */
140
+ isAllowedFileType?: boolean | undefined;
102
141
  }
103
142
  namespace File_ {
104
143
  /**
105
- * image info is passed in case the file is an image
144
+ * Image info, present when the file is an image.
106
145
  */
107
146
  interface ImageInfo {
108
- /** height of the image */
109
- height?: number | undefined;
110
- /** URL of the preview */
111
- previewUrl?: string | undefined;
112
- /** Width of the image */
147
+ /** Width of the image in pixels. */
113
148
  width?: number | undefined;
149
+ /** Height of the image in pixels. */
150
+ height?: number | undefined;
151
+ /** URL of the image preview. */
152
+ previewLink?: string | undefined;
114
153
  }
115
154
  }
116
155
  /**
@@ -2,12 +2,12 @@
2
2
  * Deal Details
3
3
  */
4
4
  export interface Deal {
5
- /** Deal attributes with values */
6
- attributes?: Record<string, unknown> | undefined;
7
5
  /** Unique deal id */
8
6
  id?: string | undefined;
9
- /** Companies ids for companies linked to this deal */
10
- linkedCompaniesIds?: string[] | undefined;
7
+ /** Deal attributes with values */
8
+ attributes?: Record<string, unknown> | undefined;
11
9
  /** Contact ids for contacts linked to this deal */
12
10
  linkedContactsIds?: number[] | undefined;
11
+ /** Companies ids for companies linked to this deal */
12
+ linkedCompaniesIds?: string[] | undefined;
13
13
  }
@@ -2,18 +2,20 @@
2
2
  * File data that is uploaded
3
3
  */
4
4
  export interface FileData {
5
+ /** Unique file id */
6
+ id?: string | undefined;
7
+ /** Name of uploaded file */
8
+ name?: string | undefined;
5
9
  /** Account id of user which created the file */
6
10
  authorId?: string | undefined;
7
- /** Company id linked to a file */
8
- companyId?: string | undefined;
9
11
  /** Contact id of contact on which file is uploaded */
10
12
  contactId?: number | undefined;
11
- /** File created date/time */
12
- createdAt?: string | undefined;
13
13
  /** Deal id linked to a file */
14
14
  dealId?: string | undefined;
15
- /** Name of uploaded file */
16
- name?: string | undefined;
15
+ /** Company id linked to a file */
16
+ companyId?: string | undefined;
17
17
  /** Size of file in bytes */
18
18
  size?: number | undefined;
19
+ /** File created date/time */
20
+ createdAt?: string | undefined;
19
21
  }
@@ -1,4 +1,8 @@
1
1
  export interface GetCampaignRecipients {
2
+ /** Segment IDs excluded from the campaign */
3
+ excludedSegments?: number[] | undefined;
2
4
  exclusionLists: number[];
3
5
  lists: number[];
6
+ /** Segment IDs included in the campaign */
7
+ segments?: number[] | undefined;
4
8
  }
@@ -9,9 +9,9 @@ export interface GetCampaignStats {
9
9
  deferred?: number | undefined;
10
10
  /** Number of delivered emails for the campaign */
11
11
  delivered: number;
12
- /** Rate of recipients without any privacy protection option enabled in their email client_dev, applied to all delivered emails */
12
+ /** Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails */
13
13
  estimatedViews?: number | undefined;
14
- /** Number of harbounce for the campaign */
14
+ /** Number of hard bounces for the campaign */
15
15
  hardBounces: number;
16
16
  /** List Id of email campaign (only in case of get email campaign(s)(not for global stats)) */
17
17
  listId?: number | undefined;
@@ -23,9 +23,9 @@ export interface GetCampaignStats {
23
23
  sent: number;
24
24
  /** Number of softbounce for the campaign */
25
25
  softBounces: number;
26
- /** Recipients without any privacy protection option enabled in their email client_dev */
26
+ /** Recipients without any privacy protection option enabled in their email email client */
27
27
  trackableViews: number;
28
- /** Rate of recipients without any privacy protection option enabled in their email client_dev */
28
+ /** Rate of recipients without any privacy protection option enabled in their email client */
29
29
  trackableViewsRate?: number | undefined;
30
30
  /** Number of unique clicks for the campaign */
31
31
  uniqueClicks: number;
@@ -15,6 +15,8 @@ export interface GetContactDetails {
15
15
  modifiedAt: string;
16
16
  /** Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) */
17
17
  smsBlacklisted: boolean;
18
+ /** Blacklist status for WhatsApp campaigns (true=blacklisted, false=not blacklisted) */
19
+ whatsappBlacklisted: boolean;
18
20
  }
19
21
  export declare namespace GetContactDetails {
20
22
  /**