@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.
- package/README.md +99 -37
- package/dist/cjs/BaseClient.d.ts +3 -0
- package/dist/cjs/BaseClient.js +17 -2
- package/dist/cjs/api/resources/account/client/Client.d.ts +5 -6
- package/dist/cjs/api/resources/account/client/Client.js +21 -13
- package/dist/cjs/api/resources/account/types/GetAccountResponse.d.ts +4 -17
- package/dist/cjs/api/resources/balance/client/Client.d.ts +8 -7
- package/dist/cjs/api/resources/balance/client/Client.js +70 -33
- package/dist/cjs/api/resources/balance/client/requests/BeginTransactionRequest.d.ts +21 -11
- package/dist/cjs/api/resources/balance/client/requests/BeginTransactionRequest.js +9 -0
- package/dist/cjs/api/resources/balance/client/requests/CreateBalanceOrderRequest.d.ts +11 -3
- package/dist/cjs/api/resources/balance/client/requests/CreateBalanceOrderRequest.js +9 -0
- package/dist/cjs/api/resources/balance/client/requests/GetContactBalancesRequest.d.ts +13 -1
- package/dist/cjs/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidActiveBalanceRequest.d.ts +7 -6
- package/dist/cjs/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidTransactionHistoryRequest.d.ts +6 -6
- package/dist/cjs/api/resources/balance/client/requests/index.d.ts +2 -2
- package/dist/cjs/api/resources/balance/client/requests/index.js +5 -1
- package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSort.d.ts +5 -0
- package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSort.js +8 -0
- package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSortField.d.ts +5 -0
- package/dist/cjs/api/resources/balance/types/GetContactBalancesRequestSortField.js +8 -0
- package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.d.ts +5 -0
- package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.js +8 -0
- package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.d.ts +30 -0
- package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.d.ts +10 -0
- package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.js +15 -0
- package/dist/cjs/api/resources/balance/types/GetSubscriptionBalancesResponse.d.ts +7 -2
- package/dist/cjs/api/resources/balance/types/PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse.d.ts +14 -14
- package/dist/cjs/api/resources/balance/types/index.d.ts +4 -0
- package/dist/cjs/api/resources/balance/types/index.js +4 -0
- package/dist/cjs/api/resources/companies/client/Client.d.ts +22 -0
- package/dist/cjs/api/resources/companies/client/Client.js +49 -18
- package/dist/cjs/api/resources/companies/client/requests/GetCompaniesRequest.d.ts +4 -4
- package/dist/cjs/api/resources/companies/client/requests/PatchCompaniesIdRequest.d.ts +1 -1
- package/dist/cjs/api/resources/companies/client/requests/PostCompaniesImportRequest.d.ts +1 -1
- package/dist/cjs/api/resources/companies/client/requests/PostCrmAttributesRequest.d.ts +2 -2
- package/dist/cjs/api/resources/companies/client/requests/PostCrmAttributesRequest.js +1 -1
- package/dist/cjs/api/resources/companies/types/GetCrmAttributesCompaniesResponseItem.d.ts +20 -4
- package/dist/cjs/api/resources/contacts/client/Client.d.ts +37 -0
- package/dist/cjs/api/resources/contacts/client/Client.js +125 -36
- package/dist/cjs/api/resources/contacts/client/requests/CreateContactRequest.d.ts +4 -0
- package/dist/cjs/api/resources/contacts/client/requests/GetContactInfoRequest.d.ts +2 -2
- package/dist/cjs/api/resources/contacts/client/requests/GetContactStatsRequest.d.ts +2 -2
- package/dist/cjs/api/resources/contacts/client/requests/GetContactsRequest.d.ts +3 -1
- package/dist/cjs/api/resources/contacts/client/requests/GetListRequest.d.ts +1 -1
- package/dist/cjs/api/resources/contacts/client/requests/UpdateContactRequest.d.ts +4 -2
- package/dist/cjs/api/resources/contacts/types/GetAttributesResponse.d.ts +3 -1
- package/dist/cjs/api/resources/contacts/types/GetContactInfoResponse.d.ts +4 -2
- package/dist/cjs/api/resources/contacts/types/GetSegmentsResponse.d.ts +2 -2
- package/dist/cjs/api/resources/conversations/client/Client.d.ts +18 -8
- package/dist/cjs/api/resources/conversations/client/Client.js +28 -18
- package/dist/cjs/api/resources/conversations/client/requests/PostConversationsAgentOnlinePingRequest.d.ts +8 -8
- package/dist/cjs/api/resources/conversations/client/requests/PostConversationsMessagesRequest.d.ts +12 -10
- package/dist/cjs/api/resources/conversations/client/requests/PostConversationsPushedMessagesRequest.d.ts +11 -9
- package/dist/cjs/api/resources/conversations/client/requests/PutConversationsMessagesIdRequest.d.ts +1 -1
- package/dist/cjs/api/resources/conversations/client/requests/PutConversationsPushedMessagesIdRequest.d.ts +2 -2
- package/dist/cjs/api/resources/coupons/client/Client.d.ts +10 -0
- package/dist/cjs/api/resources/coupons/client/Client.js +19 -5
- package/dist/cjs/api/resources/customObjects/client/Client.d.ts +101 -21
- package/dist/cjs/api/resources/customObjects/client/Client.js +108 -26
- package/dist/cjs/api/resources/customObjects/client/requests/BatchDeleteObjectRecordsRequest.d.ts +2 -2
- package/dist/cjs/api/resources/customObjects/client/requests/GetrecordsRequest.d.ts +1 -1
- package/dist/cjs/api/resources/customObjects/client/requests/UpsertrecordsRequest.d.ts +114 -25
- package/dist/cjs/api/resources/customObjects/client/requests/UpsertrecordsRequest.js +21 -0
- package/dist/cjs/api/resources/customObjects/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/customObjects/client/requests/index.js +3 -0
- package/dist/cjs/api/resources/customObjects/types/GetrecordsResponse.d.ts +14 -5
- package/dist/cjs/api/resources/deals/client/Client.d.ts +22 -0
- package/dist/cjs/api/resources/deals/client/Client.js +59 -22
- package/dist/cjs/api/resources/deals/client/requests/GetCrmDealsRequest.d.ts +5 -3
- package/dist/cjs/api/resources/deals/client/requests/PatchCrmDealsIdRequest.d.ts +1 -1
- package/dist/cjs/api/resources/deals/client/requests/PostCrmDealsImportRequest.d.ts +1 -1
- package/dist/cjs/api/resources/deals/types/GetCrmAttributesDealsResponseItem.d.ts +20 -4
- package/dist/cjs/api/resources/domains/client/Client.js +5 -5
- package/dist/cjs/api/resources/ecommerce/client/Client.d.ts +30 -1
- package/dist/cjs/api/resources/ecommerce/client/Client.js +73 -20
- package/dist/cjs/api/resources/ecommerce/client/requests/CreateBatchOrderRequest.d.ts +2 -2
- package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.ts +4 -2
- package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateProductRequest.d.ts +4 -2
- package/dist/cjs/api/resources/ecommerce/client/requests/GetEcommerceAttributionMetricsRequest.d.ts +2 -1
- package/dist/cjs/api/resources/ecommerce/client/requests/GetProductsRequest.d.ts +18 -2
- package/dist/cjs/api/resources/ecommerce/types/CreateUpdateCategoryResponse.d.ts +1 -1
- package/dist/cjs/api/resources/ecommerce/types/CreateUpdateProductResponse.d.ts +2 -2
- package/dist/cjs/api/resources/ecommerce/types/GetProductsRequestSortByField.d.ts +7 -0
- package/dist/cjs/api/resources/ecommerce/types/GetProductsRequestSortByField.js +10 -0
- package/dist/cjs/api/resources/ecommerce/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/ecommerce/types/index.js +1 -0
- package/dist/cjs/api/resources/emailCampaigns/client/Client.d.ts +22 -1
- package/dist/cjs/api/resources/emailCampaigns/client/Client.js +51 -15
- package/dist/cjs/api/resources/emailCampaigns/client/requests/CreateEmailCampaignRequest.d.ts +7 -7
- package/dist/cjs/api/resources/emailCampaigns/client/requests/GetEmailCampaignRequest.d.ts +1 -1
- package/dist/cjs/api/resources/emailCampaigns/client/requests/GetEmailCampaignsRequest.d.ts +6 -4
- package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignResponse.d.ts +28 -5
- package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignResponse.js +9 -0
- package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.d.ts +27 -4
- package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.js +9 -0
- package/dist/cjs/api/resources/event/client/Client.d.ts +8 -6
- package/dist/cjs/api/resources/event/client/Client.js +14 -8
- package/dist/cjs/api/resources/event/client/requests/CreateBatchEventsRequest.d.ts +76 -0
- package/dist/cjs/api/resources/event/client/requests/CreateEventRequest.d.ts +3 -3
- package/dist/cjs/api/resources/event/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/event/index.d.ts +0 -1
- package/dist/cjs/api/resources/event/index.js +0 -1
- package/dist/cjs/api/resources/externalFeeds/client/Client.js +9 -5
- package/dist/cjs/api/resources/externalFeeds/types/GetAllExternalFeedsResponse.d.ts +3 -7
- package/dist/cjs/api/resources/externalFeeds/types/GetExternalFeedByUuidResponse.d.ts +3 -9
- package/dist/cjs/api/resources/files/client/Client.d.ts +10 -0
- package/dist/cjs/api/resources/files/client/Client.js +19 -5
- package/dist/cjs/api/resources/inboundParsing/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/inboundParsing/client/Client.js +11 -4
- package/dist/cjs/api/resources/inboundParsing/client/requests/GetInboundEmailEventsRequest.d.ts +2 -2
- package/dist/cjs/api/resources/inboundParsing/types/GetInboundEmailEventsByUuidResponse.d.ts +2 -2
- package/dist/cjs/api/resources/index.d.ts +0 -1
- package/dist/cjs/api/resources/index.js +0 -1
- package/dist/cjs/api/resources/masterAccount/client/Client.d.ts +10 -0
- package/dist/cjs/api/resources/masterAccount/client/Client.js +84 -46
- package/dist/cjs/api/resources/notes/client/Client.d.ts +12 -2
- package/dist/cjs/api/resources/notes/client/Client.js +21 -7
- package/dist/cjs/api/resources/notes/client/requests/PatchCrmNotesIdRequest.d.ts +1 -1
- package/dist/cjs/api/resources/notes/types/PostCrmNotesResponse.d.ts +1 -1
- package/dist/cjs/api/resources/payments/client/Client.d.ts +6 -0
- package/dist/cjs/api/resources/payments/client/Client.js +9 -3
- package/dist/cjs/api/resources/process/client/Client.d.ts +13 -18
- package/dist/cjs/api/resources/process/client/Client.js +19 -20
- package/dist/cjs/api/resources/process/types/GetProcessResponse.d.ts +19 -36
- package/dist/cjs/api/resources/process/types/GetProcessesResponse.d.ts +19 -36
- package/dist/cjs/api/resources/program/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/program/client/Client.js +26 -14
- package/dist/cjs/api/resources/program/client/requests/GetLpListRequest.d.ts +2 -2
- package/dist/cjs/api/resources/program/client/requests/SubscribeToLoyaltyProgramRequest.d.ts +5 -3
- package/dist/cjs/api/resources/program/types/GetLpListRequestSort.d.ts +5 -0
- package/dist/cjs/api/resources/program/types/GetLpListRequestSort.js +8 -0
- package/dist/cjs/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.ts +2 -0
- package/dist/cjs/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.ts +4 -4
- package/dist/cjs/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.ts +10 -8
- package/dist/cjs/api/resources/program/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/program/types/index.js +1 -0
- package/dist/cjs/api/resources/reward/client/Client.js +26 -10
- package/dist/cjs/api/resources/reward/client/requests/CreateVoucherRequest.d.ts +2 -0
- package/dist/cjs/api/resources/reward/client/requests/RedeemVoucherRequest.d.ts +2 -0
- package/dist/cjs/api/resources/reward/types/CreateRewardResponse.d.ts +7 -7
- package/dist/cjs/api/resources/reward/types/CreateVoucherResponse.d.ts +2 -0
- package/dist/cjs/api/resources/reward/types/GetLoyaltyOfferProgramsPidVouchersResponse.d.ts +2 -0
- package/dist/cjs/api/resources/senders/client/Client.js +11 -7
- package/dist/cjs/api/resources/senders/types/GetIpsResponse.d.ts +2 -2
- package/dist/cjs/api/resources/smsCampaigns/client/Client.d.ts +16 -0
- package/dist/cjs/api/resources/smsCampaigns/client/Client.js +30 -10
- package/dist/cjs/api/resources/smsCampaigns/client/requests/GetSmsCampaignsRequest.d.ts +3 -3
- package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.ts +38 -2
- package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.ts +7 -1
- package/dist/cjs/api/resources/smsTemplates/client/Client.js +5 -1
- package/dist/cjs/api/resources/tasks/client/Client.d.ts +16 -2
- package/dist/cjs/api/resources/tasks/client/Client.js +35 -12
- package/dist/cjs/api/resources/tasks/client/requests/PostCrmTasksRequest.d.ts +1 -1
- package/dist/cjs/api/resources/tasks/types/{GetCrmTasktypesResponse.d.ts → GetCrmTasktypesResponseItem.d.ts} +1 -4
- package/dist/cjs/api/resources/tasks/types/GetCrmTasktypesResponseItem.js +3 -0
- package/dist/cjs/api/resources/tasks/types/index.d.ts +1 -1
- package/dist/cjs/api/resources/tasks/types/index.js +1 -1
- package/dist/cjs/api/resources/tier/client/Client.js +22 -10
- package/dist/cjs/api/resources/tier/client/requests/CreateTierGroupRequest.d.ts +62 -0
- package/dist/cjs/api/resources/tier/client/requests/CreateTierGroupRequest.js +30 -0
- package/dist/cjs/api/resources/transactionalEmails/client/Client.d.ts +31 -2
- package/dist/cjs/api/resources/transactionalEmails/client/Client.js +114 -35
- package/dist/cjs/api/resources/transactionalEmails/client/requests/DeleteScheduledEmailByIdRequest.d.ts +1 -1
- package/dist/cjs/api/resources/transactionalEmails/client/requests/DeleteSmtpLogIdentifierRequest.d.ts +5 -1
- package/dist/cjs/api/resources/transactionalEmails/client/requests/GetAggregatedSmtpReportRequest.d.ts +1 -1
- package/dist/cjs/api/resources/transactionalEmails/client/requests/GetEmailEventReportRequest.d.ts +1 -1
- package/dist/cjs/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.ts +2 -2
- package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpReportRequest.d.ts +1 -1
- package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpTemplateRequest.d.ts +3 -2
- package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpTemplatesRequest.d.ts +2 -0
- package/dist/cjs/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.ts +3 -2
- package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.d.ts +1 -0
- package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.js +3 -0
- package/dist/cjs/api/resources/transactionalEmails/types/GetTransacEmailContentResponse.d.ts +2 -2
- package/dist/cjs/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.d.ts +1 -0
- package/dist/cjs/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.js +3 -0
- package/dist/cjs/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.d.ts +1 -0
- package/dist/cjs/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.js +3 -0
- package/dist/cjs/api/resources/transactionalEmails/types/index.d.ts +3 -0
- package/dist/cjs/api/resources/transactionalEmails/types/index.js +3 -0
- package/dist/cjs/api/resources/transactionalSms/client/Client.d.ts +9 -0
- package/dist/cjs/api/resources/transactionalSms/client/Client.js +28 -5
- package/dist/cjs/api/resources/transactionalWhatsApp/client/Client.js +6 -2
- package/dist/cjs/api/resources/user/client/Client.d.ts +8 -0
- package/dist/cjs/api/resources/user/client/Client.js +14 -6
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +0 -1
- package/dist/cjs/api/resources/webhooks/client/Client.js +10 -7
- package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequest.d.ts +14 -21
- package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequest.js +2 -2
- package/dist/cjs/api/resources/webhooks/client/requests/ExportWebhooksHistoryRequest.d.ts +1 -1
- package/dist/cjs/api/resources/whatsAppCampaigns/client/Client.d.ts +6 -0
- package/dist/cjs/api/resources/whatsAppCampaigns/client/Client.js +23 -9
- package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.ts +15 -0
- package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.ts +2 -0
- package/dist/cjs/api/types/BalanceDefinition.d.ts +81 -32
- package/dist/cjs/api/types/BalanceDefinition.js +46 -2
- package/dist/cjs/api/types/BalanceLimit.d.ts +37 -14
- package/dist/cjs/api/types/BalanceLimit.js +22 -0
- package/dist/cjs/api/types/Company.d.ts +1 -1
- package/dist/cjs/api/types/ConversationsMessage.d.ts +59 -20
- package/dist/cjs/api/types/Deal.d.ts +4 -4
- package/dist/cjs/api/types/FileData.d.ts +8 -6
- package/dist/cjs/api/types/GetCampaignRecipients.d.ts +4 -0
- package/dist/cjs/api/types/GetCampaignStats.d.ts +4 -4
- package/dist/cjs/api/types/GetContactDetails.d.ts +2 -0
- package/dist/cjs/api/types/GetEventsList.d.ts +0 -2
- package/dist/cjs/api/types/GetExtendedCampaignOverview.d.ts +28 -5
- package/dist/cjs/api/types/GetExtendedCampaignOverview.js +9 -0
- package/dist/cjs/api/types/GetExtendedCampaignStats.d.ts +8 -10
- package/dist/cjs/api/types/GetProductDetails.d.ts +3 -1
- package/dist/cjs/api/types/GetSmsCampaignOverview.d.ts +7 -1
- package/dist/cjs/api/types/GetSmtpTemplateOverview.d.ts +3 -1
- package/dist/cjs/api/types/GetWebhook.d.ts +5 -10
- package/dist/cjs/api/types/GetWebhook.js +2 -6
- package/dist/cjs/api/types/LoyaltyProgram.d.ts +23 -20
- package/dist/cjs/api/types/LoyaltyProgram.js +2 -1
- package/dist/cjs/api/types/Note.d.ts +10 -8
- package/dist/cjs/api/types/NoteData.d.ts +1 -1
- package/dist/cjs/api/types/Order.d.ts +1 -1
- package/dist/cjs/api/types/Pipeline.d.ts +3 -3
- package/dist/cjs/api/types/SendTransacSms.d.ts +7 -14
- package/dist/cjs/api/types/Task.d.ts +20 -8
- package/dist/cjs/api/types/TierGroup.d.ts +66 -0
- package/dist/cjs/api/types/TierGroup.js +30 -0
- package/dist/cjs/api/types/Transaction.d.ts +36 -17
- package/dist/cjs/api/types/Transaction.js +17 -0
- package/dist/cjs/core/auth/AuthProvider.d.ts +1 -0
- package/dist/cjs/core/auth/AuthProvider.js +7 -0
- package/dist/cjs/core/auth/index.d.ts +1 -1
- package/dist/cjs/core/auth/index.js +3 -1
- package/dist/cjs/core/fetcher/Fetcher.d.ts +6 -0
- package/dist/cjs/core/fetcher/Fetcher.js +9 -8
- package/dist/cjs/core/fetcher/requestWithRetries.js +4 -1
- package/dist/cjs/core/url/QueryStringBuilder.d.ts +47 -0
- package/dist/cjs/core/url/QueryStringBuilder.js +83 -0
- package/dist/cjs/core/url/index.d.ts +1 -0
- package/dist/cjs/core/url/index.js +3 -1
- package/dist/cjs/core/url/qs.d.ts +2 -1
- package/dist/cjs/core/url/qs.js +24 -12
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.d.mts +3 -0
- package/dist/esm/BaseClient.mjs +17 -2
- package/dist/esm/api/resources/account/client/Client.d.mts +5 -6
- package/dist/esm/api/resources/account/client/Client.mjs +21 -13
- package/dist/esm/api/resources/account/types/GetAccountResponse.d.mts +4 -17
- package/dist/esm/api/resources/balance/client/Client.d.mts +8 -7
- package/dist/esm/api/resources/balance/client/Client.mjs +70 -33
- package/dist/esm/api/resources/balance/client/requests/BeginTransactionRequest.d.mts +21 -11
- package/dist/esm/api/resources/balance/client/requests/BeginTransactionRequest.mjs +8 -1
- package/dist/esm/api/resources/balance/client/requests/CreateBalanceOrderRequest.d.mts +11 -3
- package/dist/esm/api/resources/balance/client/requests/CreateBalanceOrderRequest.mjs +8 -1
- package/dist/esm/api/resources/balance/client/requests/GetContactBalancesRequest.d.mts +13 -1
- package/dist/esm/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidActiveBalanceRequest.d.mts +7 -6
- package/dist/esm/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidTransactionHistoryRequest.d.mts +6 -6
- package/dist/esm/api/resources/balance/client/requests/index.d.mts +2 -2
- package/dist/esm/api/resources/balance/client/requests/index.mjs +2 -0
- package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSort.d.mts +5 -0
- package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSort.mjs +5 -0
- package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSortField.d.mts +5 -0
- package/dist/esm/api/resources/balance/types/GetContactBalancesRequestSortField.mjs +5 -0
- package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.d.mts +5 -0
- package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.mjs +5 -0
- package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.d.mts +30 -0
- package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.d.mts +10 -0
- package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.mjs +14 -1
- package/dist/esm/api/resources/balance/types/GetSubscriptionBalancesResponse.d.mts +7 -2
- package/dist/esm/api/resources/balance/types/PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse.d.mts +14 -14
- package/dist/esm/api/resources/balance/types/index.d.mts +4 -0
- package/dist/esm/api/resources/balance/types/index.mjs +4 -0
- package/dist/esm/api/resources/companies/client/Client.d.mts +22 -0
- package/dist/esm/api/resources/companies/client/Client.mjs +49 -18
- package/dist/esm/api/resources/companies/client/requests/GetCompaniesRequest.d.mts +4 -4
- package/dist/esm/api/resources/companies/client/requests/PatchCompaniesIdRequest.d.mts +1 -1
- package/dist/esm/api/resources/companies/client/requests/PostCompaniesImportRequest.d.mts +1 -1
- package/dist/esm/api/resources/companies/client/requests/PostCrmAttributesRequest.d.mts +2 -2
- package/dist/esm/api/resources/companies/client/requests/PostCrmAttributesRequest.mjs +1 -1
- package/dist/esm/api/resources/companies/types/GetCrmAttributesCompaniesResponseItem.d.mts +20 -4
- package/dist/esm/api/resources/contacts/client/Client.d.mts +37 -0
- package/dist/esm/api/resources/contacts/client/Client.mjs +125 -36
- package/dist/esm/api/resources/contacts/client/requests/CreateContactRequest.d.mts +4 -0
- package/dist/esm/api/resources/contacts/client/requests/GetContactInfoRequest.d.mts +2 -2
- package/dist/esm/api/resources/contacts/client/requests/GetContactStatsRequest.d.mts +2 -2
- package/dist/esm/api/resources/contacts/client/requests/GetContactsRequest.d.mts +3 -1
- package/dist/esm/api/resources/contacts/client/requests/GetListRequest.d.mts +1 -1
- package/dist/esm/api/resources/contacts/client/requests/UpdateContactRequest.d.mts +4 -2
- package/dist/esm/api/resources/contacts/types/GetAttributesResponse.d.mts +3 -1
- package/dist/esm/api/resources/contacts/types/GetContactInfoResponse.d.mts +4 -2
- package/dist/esm/api/resources/contacts/types/GetSegmentsResponse.d.mts +2 -2
- package/dist/esm/api/resources/conversations/client/Client.d.mts +18 -8
- package/dist/esm/api/resources/conversations/client/Client.mjs +28 -18
- package/dist/esm/api/resources/conversations/client/requests/PostConversationsAgentOnlinePingRequest.d.mts +8 -8
- package/dist/esm/api/resources/conversations/client/requests/PostConversationsMessagesRequest.d.mts +12 -10
- package/dist/esm/api/resources/conversations/client/requests/PostConversationsPushedMessagesRequest.d.mts +11 -9
- package/dist/esm/api/resources/conversations/client/requests/PutConversationsMessagesIdRequest.d.mts +1 -1
- package/dist/esm/api/resources/conversations/client/requests/PutConversationsPushedMessagesIdRequest.d.mts +2 -2
- package/dist/esm/api/resources/coupons/client/Client.d.mts +10 -0
- package/dist/esm/api/resources/coupons/client/Client.mjs +19 -5
- package/dist/esm/api/resources/customObjects/client/Client.d.mts +101 -21
- package/dist/esm/api/resources/customObjects/client/Client.mjs +108 -26
- package/dist/esm/api/resources/customObjects/client/requests/BatchDeleteObjectRecordsRequest.d.mts +2 -2
- package/dist/esm/api/resources/customObjects/client/requests/GetrecordsRequest.d.mts +1 -1
- package/dist/esm/api/resources/customObjects/client/requests/UpsertrecordsRequest.d.mts +114 -25
- package/dist/esm/api/resources/customObjects/client/requests/UpsertrecordsRequest.mjs +20 -1
- package/dist/esm/api/resources/customObjects/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/customObjects/client/requests/index.mjs +1 -1
- package/dist/esm/api/resources/customObjects/types/GetrecordsResponse.d.mts +14 -5
- package/dist/esm/api/resources/deals/client/Client.d.mts +22 -0
- package/dist/esm/api/resources/deals/client/Client.mjs +59 -22
- package/dist/esm/api/resources/deals/client/requests/GetCrmDealsRequest.d.mts +5 -3
- package/dist/esm/api/resources/deals/client/requests/PatchCrmDealsIdRequest.d.mts +1 -1
- package/dist/esm/api/resources/deals/client/requests/PostCrmDealsImportRequest.d.mts +1 -1
- package/dist/esm/api/resources/deals/types/GetCrmAttributesDealsResponseItem.d.mts +20 -4
- package/dist/esm/api/resources/domains/client/Client.mjs +5 -5
- package/dist/esm/api/resources/ecommerce/client/Client.d.mts +30 -1
- package/dist/esm/api/resources/ecommerce/client/Client.mjs +73 -20
- package/dist/esm/api/resources/ecommerce/client/requests/CreateBatchOrderRequest.d.mts +2 -2
- package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.mts +4 -2
- package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateProductRequest.d.mts +4 -2
- package/dist/esm/api/resources/ecommerce/client/requests/GetEcommerceAttributionMetricsRequest.d.mts +2 -1
- package/dist/esm/api/resources/ecommerce/client/requests/GetProductsRequest.d.mts +18 -2
- package/dist/esm/api/resources/ecommerce/types/CreateUpdateCategoryResponse.d.mts +1 -1
- package/dist/esm/api/resources/ecommerce/types/CreateUpdateProductResponse.d.mts +2 -2
- package/dist/esm/api/resources/ecommerce/types/GetProductsRequestSortByField.d.mts +7 -0
- package/dist/esm/api/resources/ecommerce/types/GetProductsRequestSortByField.mjs +7 -0
- package/dist/esm/api/resources/ecommerce/types/index.d.mts +1 -0
- package/dist/esm/api/resources/ecommerce/types/index.mjs +1 -0
- package/dist/esm/api/resources/emailCampaigns/client/Client.d.mts +22 -1
- package/dist/esm/api/resources/emailCampaigns/client/Client.mjs +51 -15
- package/dist/esm/api/resources/emailCampaigns/client/requests/CreateEmailCampaignRequest.d.mts +7 -7
- package/dist/esm/api/resources/emailCampaigns/client/requests/GetEmailCampaignRequest.d.mts +1 -1
- package/dist/esm/api/resources/emailCampaigns/client/requests/GetEmailCampaignsRequest.d.mts +6 -4
- package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignResponse.d.mts +28 -5
- package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignResponse.mjs +9 -0
- package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.d.mts +27 -4
- package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.mjs +9 -0
- package/dist/esm/api/resources/event/client/Client.d.mts +8 -6
- package/dist/esm/api/resources/event/client/Client.mjs +14 -8
- package/dist/esm/api/resources/event/client/requests/CreateBatchEventsRequest.d.mts +76 -0
- package/dist/esm/api/resources/event/client/requests/CreateEventRequest.d.mts +3 -3
- package/dist/esm/api/resources/event/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/event/index.d.mts +0 -1
- package/dist/esm/api/resources/event/index.mjs +0 -1
- package/dist/esm/api/resources/externalFeeds/client/Client.mjs +9 -5
- package/dist/esm/api/resources/externalFeeds/types/GetAllExternalFeedsResponse.d.mts +3 -7
- package/dist/esm/api/resources/externalFeeds/types/GetExternalFeedByUuidResponse.d.mts +3 -9
- package/dist/esm/api/resources/files/client/Client.d.mts +10 -0
- package/dist/esm/api/resources/files/client/Client.mjs +19 -5
- package/dist/esm/api/resources/inboundParsing/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/inboundParsing/client/Client.mjs +11 -4
- package/dist/esm/api/resources/inboundParsing/client/requests/GetInboundEmailEventsRequest.d.mts +2 -2
- package/dist/esm/api/resources/inboundParsing/types/GetInboundEmailEventsByUuidResponse.d.mts +2 -2
- package/dist/esm/api/resources/index.d.mts +0 -1
- package/dist/esm/api/resources/index.mjs +0 -1
- package/dist/esm/api/resources/masterAccount/client/Client.d.mts +10 -0
- package/dist/esm/api/resources/masterAccount/client/Client.mjs +84 -46
- package/dist/esm/api/resources/notes/client/Client.d.mts +12 -2
- package/dist/esm/api/resources/notes/client/Client.mjs +21 -7
- package/dist/esm/api/resources/notes/client/requests/PatchCrmNotesIdRequest.d.mts +1 -1
- package/dist/esm/api/resources/notes/types/PostCrmNotesResponse.d.mts +1 -1
- package/dist/esm/api/resources/payments/client/Client.d.mts +6 -0
- package/dist/esm/api/resources/payments/client/Client.mjs +9 -3
- package/dist/esm/api/resources/process/client/Client.d.mts +13 -18
- package/dist/esm/api/resources/process/client/Client.mjs +19 -20
- package/dist/esm/api/resources/process/types/GetProcessResponse.d.mts +19 -36
- package/dist/esm/api/resources/process/types/GetProcessesResponse.d.mts +19 -36
- package/dist/esm/api/resources/program/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/program/client/Client.mjs +26 -14
- package/dist/esm/api/resources/program/client/requests/GetLpListRequest.d.mts +2 -2
- package/dist/esm/api/resources/program/client/requests/SubscribeToLoyaltyProgramRequest.d.mts +5 -3
- package/dist/esm/api/resources/program/types/GetLpListRequestSort.d.mts +5 -0
- package/dist/esm/api/resources/program/types/GetLpListRequestSort.mjs +5 -0
- package/dist/esm/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.mts +2 -0
- package/dist/esm/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.mts +4 -4
- package/dist/esm/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.mts +10 -8
- package/dist/esm/api/resources/program/types/index.d.mts +1 -0
- package/dist/esm/api/resources/program/types/index.mjs +1 -0
- package/dist/esm/api/resources/reward/client/Client.mjs +26 -10
- package/dist/esm/api/resources/reward/client/requests/CreateVoucherRequest.d.mts +2 -0
- package/dist/esm/api/resources/reward/client/requests/RedeemVoucherRequest.d.mts +2 -0
- package/dist/esm/api/resources/reward/types/CreateRewardResponse.d.mts +7 -7
- package/dist/esm/api/resources/reward/types/CreateVoucherResponse.d.mts +2 -0
- package/dist/esm/api/resources/reward/types/GetLoyaltyOfferProgramsPidVouchersResponse.d.mts +2 -0
- package/dist/esm/api/resources/senders/client/Client.mjs +11 -7
- package/dist/esm/api/resources/senders/types/GetIpsResponse.d.mts +2 -2
- package/dist/esm/api/resources/smsCampaigns/client/Client.d.mts +16 -0
- package/dist/esm/api/resources/smsCampaigns/client/Client.mjs +30 -10
- package/dist/esm/api/resources/smsCampaigns/client/requests/GetSmsCampaignsRequest.d.mts +3 -3
- package/dist/esm/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.mts +38 -2
- package/dist/esm/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.mts +7 -1
- package/dist/esm/api/resources/smsTemplates/client/Client.mjs +5 -1
- package/dist/esm/api/resources/tasks/client/Client.d.mts +16 -2
- package/dist/esm/api/resources/tasks/client/Client.mjs +35 -12
- package/dist/esm/api/resources/tasks/client/requests/PostCrmTasksRequest.d.mts +1 -1
- package/dist/esm/api/resources/tasks/types/{GetCrmTasktypesResponse.d.mts → GetCrmTasktypesResponseItem.d.mts} +1 -4
- package/dist/esm/api/resources/tasks/types/GetCrmTasktypesResponseItem.mjs +2 -0
- package/dist/esm/api/resources/tasks/types/index.d.mts +1 -1
- package/dist/esm/api/resources/tasks/types/index.mjs +1 -1
- package/dist/esm/api/resources/tier/client/Client.mjs +22 -10
- package/dist/esm/api/resources/tier/client/requests/CreateTierGroupRequest.d.mts +62 -0
- package/dist/esm/api/resources/tier/client/requests/CreateTierGroupRequest.mjs +30 -0
- package/dist/esm/api/resources/transactionalEmails/client/Client.d.mts +31 -2
- package/dist/esm/api/resources/transactionalEmails/client/Client.mjs +114 -35
- package/dist/esm/api/resources/transactionalEmails/client/requests/DeleteScheduledEmailByIdRequest.d.mts +1 -1
- package/dist/esm/api/resources/transactionalEmails/client/requests/DeleteSmtpLogIdentifierRequest.d.mts +5 -1
- package/dist/esm/api/resources/transactionalEmails/client/requests/GetAggregatedSmtpReportRequest.d.mts +1 -1
- package/dist/esm/api/resources/transactionalEmails/client/requests/GetEmailEventReportRequest.d.mts +1 -1
- package/dist/esm/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.mts +2 -2
- package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpReportRequest.d.mts +1 -1
- package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpTemplateRequest.d.mts +3 -2
- package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpTemplatesRequest.d.mts +2 -0
- package/dist/esm/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.mts +3 -2
- package/dist/esm/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.d.mts +1 -0
- package/dist/esm/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.mjs +2 -0
- package/dist/esm/api/resources/transactionalEmails/types/GetTransacEmailContentResponse.d.mts +2 -2
- package/dist/esm/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.d.mts +1 -0
- package/dist/esm/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesRequest.mjs +2 -0
- package/dist/esm/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.d.mts +1 -0
- package/dist/esm/api/resources/transactionalEmails/types/UpdateSmtpTemplateRequestTemplateId.mjs +2 -0
- package/dist/esm/api/resources/transactionalEmails/types/index.d.mts +3 -0
- package/dist/esm/api/resources/transactionalEmails/types/index.mjs +3 -0
- package/dist/esm/api/resources/transactionalSms/client/Client.d.mts +9 -0
- package/dist/esm/api/resources/transactionalSms/client/Client.mjs +28 -5
- package/dist/esm/api/resources/transactionalWhatsApp/client/Client.mjs +6 -2
- package/dist/esm/api/resources/user/client/Client.d.mts +8 -0
- package/dist/esm/api/resources/user/client/Client.mjs +14 -6
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +0 -1
- package/dist/esm/api/resources/webhooks/client/Client.mjs +10 -7
- package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequest.d.mts +14 -21
- package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequest.mjs +2 -2
- package/dist/esm/api/resources/webhooks/client/requests/ExportWebhooksHistoryRequest.d.mts +1 -1
- package/dist/esm/api/resources/whatsAppCampaigns/client/Client.d.mts +6 -0
- package/dist/esm/api/resources/whatsAppCampaigns/client/Client.mjs +23 -9
- package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.mts +15 -0
- package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.mts +2 -0
- package/dist/esm/api/types/BalanceDefinition.d.mts +81 -32
- package/dist/esm/api/types/BalanceDefinition.mjs +46 -2
- package/dist/esm/api/types/BalanceLimit.d.mts +37 -14
- package/dist/esm/api/types/BalanceLimit.mjs +21 -1
- package/dist/esm/api/types/Company.d.mts +1 -1
- package/dist/esm/api/types/ConversationsMessage.d.mts +59 -20
- package/dist/esm/api/types/Deal.d.mts +4 -4
- package/dist/esm/api/types/FileData.d.mts +8 -6
- package/dist/esm/api/types/GetCampaignRecipients.d.mts +4 -0
- package/dist/esm/api/types/GetCampaignStats.d.mts +4 -4
- package/dist/esm/api/types/GetContactDetails.d.mts +2 -0
- package/dist/esm/api/types/GetEventsList.d.mts +0 -2
- package/dist/esm/api/types/GetExtendedCampaignOverview.d.mts +28 -5
- package/dist/esm/api/types/GetExtendedCampaignOverview.mjs +9 -0
- package/dist/esm/api/types/GetExtendedCampaignStats.d.mts +8 -10
- package/dist/esm/api/types/GetProductDetails.d.mts +3 -1
- package/dist/esm/api/types/GetSmsCampaignOverview.d.mts +7 -1
- package/dist/esm/api/types/GetSmtpTemplateOverview.d.mts +3 -1
- package/dist/esm/api/types/GetWebhook.d.mts +5 -10
- package/dist/esm/api/types/GetWebhook.mjs +2 -6
- package/dist/esm/api/types/LoyaltyProgram.d.mts +23 -20
- package/dist/esm/api/types/LoyaltyProgram.mjs +2 -1
- package/dist/esm/api/types/Note.d.mts +10 -8
- package/dist/esm/api/types/NoteData.d.mts +1 -1
- package/dist/esm/api/types/Order.d.mts +1 -1
- package/dist/esm/api/types/Pipeline.d.mts +3 -3
- package/dist/esm/api/types/SendTransacSms.d.mts +7 -14
- package/dist/esm/api/types/Task.d.mts +20 -8
- package/dist/esm/api/types/TierGroup.d.mts +66 -0
- package/dist/esm/api/types/TierGroup.mjs +30 -0
- package/dist/esm/api/types/Transaction.d.mts +36 -17
- package/dist/esm/api/types/Transaction.mjs +16 -1
- package/dist/esm/core/auth/AuthProvider.d.mts +1 -0
- package/dist/esm/core/auth/AuthProvider.mjs +6 -1
- package/dist/esm/core/auth/index.d.mts +1 -1
- package/dist/esm/core/auth/index.mjs +1 -0
- package/dist/esm/core/fetcher/Fetcher.d.mts +6 -0
- package/dist/esm/core/fetcher/Fetcher.mjs +9 -8
- package/dist/esm/core/fetcher/requestWithRetries.mjs +4 -1
- package/dist/esm/core/url/QueryStringBuilder.d.mts +47 -0
- package/dist/esm/core/url/QueryStringBuilder.mjs +80 -0
- package/dist/esm/core/url/index.d.mts +1 -0
- package/dist/esm/core/url/index.mjs +1 -0
- package/dist/esm/core/url/qs.d.mts +2 -1
- package/dist/esm/core/url/qs.mjs +24 -12
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +2 -2
- package/reference.md +1825 -96
- package/dist/cjs/api/resources/event/types/CreateBatchEventsRequestItem.d.ts +0 -59
- package/dist/cjs/api/resources/event/types/index.d.ts +0 -1
- package/dist/cjs/api/resources/event/types/index.js +0 -17
- package/dist/esm/api/resources/event/types/CreateBatchEventsRequestItem.d.mts +0 -59
- package/dist/esm/api/resources/event/types/index.d.mts +0 -1
- package/dist/esm/api/resources/event/types/index.mjs +0 -1
- /package/dist/cjs/api/resources/{event/types/CreateBatchEventsRequestItem.js → balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.js} +0 -0
- /package/dist/cjs/api/resources/{tasks/types/GetCrmTasktypesResponse.js → event/client/requests/CreateBatchEventsRequest.js} +0 -0
- /package/dist/esm/api/resources/{event/types/CreateBatchEventsRequestItem.mjs → balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.mjs} +0 -0
- /package/dist/esm/api/resources/{tasks/types/GetCrmTasktypesResponse.mjs → event/client/requests/CreateBatchEventsRequest.mjs} +0 -0
|
@@ -25,11 +25,11 @@ export declare class BalanceClient {
|
|
|
25
25
|
* @example
|
|
26
26
|
* await client.balance.getActiveBalancesApi({
|
|
27
27
|
* pid: "pid",
|
|
28
|
-
*
|
|
29
|
-
*
|
|
28
|
+
* contactId: 1000000,
|
|
29
|
+
* balanceDefinitionId: "balanceDefinitionId"
|
|
30
30
|
* })
|
|
31
31
|
*/
|
|
32
|
-
getActiveBalancesApi(request: Brevo.GetLoyaltyBalanceProgramsPidActiveBalanceRequest, requestOptions?: BalanceClient.RequestOptions): core.HttpResponsePromise<Brevo.
|
|
32
|
+
getActiveBalancesApi(request: Brevo.GetLoyaltyBalanceProgramsPidActiveBalanceRequest, requestOptions?: BalanceClient.RequestOptions): core.HttpResponsePromise<Brevo.GetLoyaltyBalanceProgramsPidActiveBalanceResponse>;
|
|
33
33
|
private __getActiveBalancesApi;
|
|
34
34
|
/**
|
|
35
35
|
* Returns balance definition page
|
|
@@ -227,7 +227,7 @@ export declare class BalanceClient {
|
|
|
227
227
|
deleteBalanceLimit(request: Brevo.DeleteBalanceLimitRequest, requestOptions?: BalanceClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
228
228
|
private __deleteBalanceLimit;
|
|
229
229
|
/**
|
|
230
|
-
* Returns balance
|
|
230
|
+
* Returns contact balances for a given balance definition across all subscriptions.
|
|
231
231
|
*
|
|
232
232
|
* @param {Brevo.GetContactBalancesRequest} request
|
|
233
233
|
* @param {BalanceClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -240,7 +240,8 @@ export declare class BalanceClient {
|
|
|
240
240
|
*
|
|
241
241
|
* @example
|
|
242
242
|
* await client.balance.getContactBalances({
|
|
243
|
-
* pid: "pid"
|
|
243
|
+
* pid: "pid",
|
|
244
|
+
* balanceDefinitionId: "balanceDefinitionId"
|
|
244
245
|
* })
|
|
245
246
|
*/
|
|
246
247
|
getContactBalances(request: Brevo.GetContactBalancesRequest, requestOptions?: BalanceClient.RequestOptions): core.HttpResponsePromise<Brevo.GetContactBalancesResponse>;
|
|
@@ -263,7 +264,7 @@ export declare class BalanceClient {
|
|
|
263
264
|
* balanceDefinitionId: "balanceDefinitionId",
|
|
264
265
|
* contactId: 1,
|
|
265
266
|
* dueAt: "dueAt",
|
|
266
|
-
* source: "
|
|
267
|
+
* source: "engine"
|
|
267
268
|
* })
|
|
268
269
|
*/
|
|
269
270
|
createBalanceOrder(request: Brevo.CreateBalanceOrderRequest, requestOptions?: BalanceClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateBalanceOrderResponse>;
|
|
@@ -324,7 +325,7 @@ export declare class BalanceClient {
|
|
|
324
325
|
* @example
|
|
325
326
|
* await client.balance.getTransactionHistoryApi({
|
|
326
327
|
* pid: "pid",
|
|
327
|
-
* contactId:
|
|
328
|
+
* contactId: 1000000,
|
|
328
329
|
* balanceDefinitionId: "balanceDefinitionId"
|
|
329
330
|
* })
|
|
330
331
|
*/
|
|
@@ -45,8 +45,8 @@ export class BalanceClient {
|
|
|
45
45
|
* @example
|
|
46
46
|
* await client.balance.getActiveBalancesApi({
|
|
47
47
|
* pid: "pid",
|
|
48
|
-
*
|
|
49
|
-
*
|
|
48
|
+
* contactId: 1000000,
|
|
49
|
+
* balanceDefinitionId: "balanceDefinitionId"
|
|
50
50
|
* })
|
|
51
51
|
*/
|
|
52
52
|
getActiveBalancesApi(request, requestOptions) {
|
|
@@ -55,14 +55,14 @@ export class BalanceClient {
|
|
|
55
55
|
__getActiveBalancesApi(request, requestOptions) {
|
|
56
56
|
return __awaiter(this, void 0, void 0, function* () {
|
|
57
57
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
58
|
-
const { pid, limit, offset,
|
|
58
|
+
const { pid, limit, offset, sortField, sort, contactId, balanceDefinitionId, includeInternal } = request;
|
|
59
59
|
const _queryParams = {
|
|
60
60
|
limit,
|
|
61
61
|
offset,
|
|
62
|
-
|
|
63
|
-
sort,
|
|
64
|
-
|
|
65
|
-
|
|
62
|
+
sortField: sortField != null ? sortField : undefined,
|
|
63
|
+
sort: sort != null ? sort : undefined,
|
|
64
|
+
contactId,
|
|
65
|
+
balanceDefinitionId,
|
|
66
66
|
includeInternal,
|
|
67
67
|
};
|
|
68
68
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
@@ -71,7 +71,11 @@ export class BalanceClient {
|
|
|
71
71
|
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/active-balance`),
|
|
72
72
|
method: "GET",
|
|
73
73
|
headers: _headers,
|
|
74
|
-
|
|
74
|
+
queryString: core.url
|
|
75
|
+
.queryBuilder()
|
|
76
|
+
.addMany(_queryParams)
|
|
77
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
78
|
+
.build(),
|
|
75
79
|
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,
|
|
76
80
|
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,
|
|
77
81
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -79,7 +83,10 @@ export class BalanceClient {
|
|
|
79
83
|
logging: this._options.logging,
|
|
80
84
|
});
|
|
81
85
|
if (_response.ok) {
|
|
82
|
-
return {
|
|
86
|
+
return {
|
|
87
|
+
data: _response.body,
|
|
88
|
+
rawResponse: _response.rawResponse,
|
|
89
|
+
};
|
|
83
90
|
}
|
|
84
91
|
if (_response.error.reason === "status-code") {
|
|
85
92
|
switch (_response.error.statusCode) {
|
|
@@ -140,7 +147,11 @@ export class BalanceClient {
|
|
|
140
147
|
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/balance-definitions`),
|
|
141
148
|
method: "GET",
|
|
142
149
|
headers: _headers,
|
|
143
|
-
|
|
150
|
+
queryString: core.url
|
|
151
|
+
.queryBuilder()
|
|
152
|
+
.addMany(_queryParams)
|
|
153
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
154
|
+
.build(),
|
|
144
155
|
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,
|
|
145
156
|
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,
|
|
146
157
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -207,7 +218,7 @@ export class BalanceClient {
|
|
|
207
218
|
method: "POST",
|
|
208
219
|
headers: _headers,
|
|
209
220
|
contentType: "application/json",
|
|
210
|
-
|
|
221
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
211
222
|
requestType: "json",
|
|
212
223
|
body: _body,
|
|
213
224
|
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,
|
|
@@ -276,7 +287,11 @@ export class BalanceClient {
|
|
|
276
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, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/balance-definitions/${core.url.encodePathParam(bdid)}`),
|
|
277
288
|
method: "GET",
|
|
278
289
|
headers: _headers,
|
|
279
|
-
|
|
290
|
+
queryString: core.url
|
|
291
|
+
.queryBuilder()
|
|
292
|
+
.addMany(_queryParams)
|
|
293
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
294
|
+
.build(),
|
|
280
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,
|
|
281
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,
|
|
282
297
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -344,7 +359,7 @@ export class BalanceClient {
|
|
|
344
359
|
method: "PUT",
|
|
345
360
|
headers: _headers,
|
|
346
361
|
contentType: "application/json",
|
|
347
|
-
|
|
362
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
348
363
|
requestType: "json",
|
|
349
364
|
body: _body,
|
|
350
365
|
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,
|
|
@@ -412,7 +427,7 @@ export class BalanceClient {
|
|
|
412
427
|
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/balance-definitions/${core.url.encodePathParam(bdid)}`),
|
|
413
428
|
method: "DELETE",
|
|
414
429
|
headers: _headers,
|
|
415
|
-
|
|
430
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
416
431
|
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,
|
|
417
432
|
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,
|
|
418
433
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -482,7 +497,7 @@ export class BalanceClient {
|
|
|
482
497
|
method: "POST",
|
|
483
498
|
headers: _headers,
|
|
484
499
|
contentType: "application/json",
|
|
485
|
-
|
|
500
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
486
501
|
requestType: "json",
|
|
487
502
|
body: _body,
|
|
488
503
|
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,
|
|
@@ -552,7 +567,11 @@ export class BalanceClient {
|
|
|
552
567
|
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/balance-definitions/${core.url.encodePathParam(bdid)}/limits/${core.url.encodePathParam(blid)}`),
|
|
553
568
|
method: "GET",
|
|
554
569
|
headers: _headers,
|
|
555
|
-
|
|
570
|
+
queryString: core.url
|
|
571
|
+
.queryBuilder()
|
|
572
|
+
.addMany(_queryParams)
|
|
573
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
574
|
+
.build(),
|
|
556
575
|
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,
|
|
557
576
|
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,
|
|
558
577
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -623,7 +642,7 @@ export class BalanceClient {
|
|
|
623
642
|
method: "PUT",
|
|
624
643
|
headers: _headers,
|
|
625
644
|
contentType: "application/json",
|
|
626
|
-
|
|
645
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
627
646
|
requestType: "json",
|
|
628
647
|
body: _body,
|
|
629
648
|
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,
|
|
@@ -690,7 +709,7 @@ export class BalanceClient {
|
|
|
690
709
|
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/balance-definitions/${core.url.encodePathParam(bdid)}/limits/${core.url.encodePathParam(blid)}`),
|
|
691
710
|
method: "DELETE",
|
|
692
711
|
headers: _headers,
|
|
693
|
-
|
|
712
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
694
713
|
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,
|
|
695
714
|
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,
|
|
696
715
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -724,7 +743,7 @@ export class BalanceClient {
|
|
|
724
743
|
});
|
|
725
744
|
}
|
|
726
745
|
/**
|
|
727
|
-
* Returns balance
|
|
746
|
+
* Returns contact balances for a given balance definition across all subscriptions.
|
|
728
747
|
*
|
|
729
748
|
* @param {Brevo.GetContactBalancesRequest} request
|
|
730
749
|
* @param {BalanceClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -737,7 +756,8 @@ export class BalanceClient {
|
|
|
737
756
|
*
|
|
738
757
|
* @example
|
|
739
758
|
* await client.balance.getContactBalances({
|
|
740
|
-
* pid: "pid"
|
|
759
|
+
* pid: "pid",
|
|
760
|
+
* balanceDefinitionId: "balanceDefinitionId"
|
|
741
761
|
* })
|
|
742
762
|
*/
|
|
743
763
|
getContactBalances(request, requestOptions) {
|
|
@@ -746,9 +766,14 @@ export class BalanceClient {
|
|
|
746
766
|
__getContactBalances(request, requestOptions) {
|
|
747
767
|
return __awaiter(this, void 0, void 0, function* () {
|
|
748
768
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
749
|
-
const { pid, includeInternal } = request;
|
|
769
|
+
const { pid, includeInternal, limit, offset, sort, sortField, balanceDefinitionId } = request;
|
|
750
770
|
const _queryParams = {
|
|
751
771
|
includeInternal,
|
|
772
|
+
limit,
|
|
773
|
+
offset,
|
|
774
|
+
sort: sort != null ? sort : undefined,
|
|
775
|
+
sortField: sortField != null ? sortField : undefined,
|
|
776
|
+
balanceDefinitionId,
|
|
752
777
|
};
|
|
753
778
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
754
779
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
@@ -756,7 +781,11 @@ export class BalanceClient {
|
|
|
756
781
|
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/contact-balances`),
|
|
757
782
|
method: "GET",
|
|
758
783
|
headers: _headers,
|
|
759
|
-
|
|
784
|
+
queryString: core.url
|
|
785
|
+
.queryBuilder()
|
|
786
|
+
.addMany(_queryParams)
|
|
787
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
788
|
+
.build(),
|
|
760
789
|
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,
|
|
761
790
|
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,
|
|
762
791
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -807,7 +836,7 @@ export class BalanceClient {
|
|
|
807
836
|
* balanceDefinitionId: "balanceDefinitionId",
|
|
808
837
|
* contactId: 1,
|
|
809
838
|
* dueAt: "dueAt",
|
|
810
|
-
* source: "
|
|
839
|
+
* source: "engine"
|
|
811
840
|
* })
|
|
812
841
|
*/
|
|
813
842
|
createBalanceOrder(request, requestOptions) {
|
|
@@ -824,7 +853,7 @@ export class BalanceClient {
|
|
|
824
853
|
method: "POST",
|
|
825
854
|
headers: _headers,
|
|
826
855
|
contentType: "application/json",
|
|
827
|
-
|
|
856
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
828
857
|
requestType: "json",
|
|
829
858
|
body: _body,
|
|
830
859
|
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,
|
|
@@ -891,7 +920,11 @@ export class BalanceClient {
|
|
|
891
920
|
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/subscriptions/${core.url.encodePathParam(cid)}/balances`),
|
|
892
921
|
method: "GET",
|
|
893
922
|
headers: _headers,
|
|
894
|
-
|
|
923
|
+
queryString: core.url
|
|
924
|
+
.queryBuilder()
|
|
925
|
+
.addMany(_queryParams)
|
|
926
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
927
|
+
.build(),
|
|
895
928
|
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,
|
|
896
929
|
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,
|
|
897
930
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -960,7 +993,7 @@ export class BalanceClient {
|
|
|
960
993
|
method: "POST",
|
|
961
994
|
headers: _headers,
|
|
962
995
|
contentType: "application/json",
|
|
963
|
-
|
|
996
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
964
997
|
requestType: "json",
|
|
965
998
|
body: _body,
|
|
966
999
|
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,
|
|
@@ -1013,7 +1046,7 @@ export class BalanceClient {
|
|
|
1013
1046
|
* @example
|
|
1014
1047
|
* await client.balance.getTransactionHistoryApi({
|
|
1015
1048
|
* pid: "pid",
|
|
1016
|
-
* contactId:
|
|
1049
|
+
* contactId: 1000000,
|
|
1017
1050
|
* balanceDefinitionId: "balanceDefinitionId"
|
|
1018
1051
|
* })
|
|
1019
1052
|
*/
|
|
@@ -1023,7 +1056,7 @@ export class BalanceClient {
|
|
|
1023
1056
|
__getTransactionHistoryApi(request, requestOptions) {
|
|
1024
1057
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1025
1058
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
1026
|
-
const { pid, limit, offset, sortField, sort, contactId, balanceDefinitionId,
|
|
1059
|
+
const { pid, limit, offset, sortField, sort, contactId, balanceDefinitionId, status, transactionType, loyaltySubscriptionId, } = request;
|
|
1027
1060
|
const _queryParams = {
|
|
1028
1061
|
limit,
|
|
1029
1062
|
offset,
|
|
@@ -1031,9 +1064,9 @@ export class BalanceClient {
|
|
|
1031
1064
|
sort: sort != null ? sort : undefined,
|
|
1032
1065
|
contactId,
|
|
1033
1066
|
balanceDefinitionId,
|
|
1034
|
-
filters,
|
|
1035
1067
|
status: status != null ? status : undefined,
|
|
1036
1068
|
transactionType: transactionType != null ? transactionType : undefined,
|
|
1069
|
+
loyaltySubscriptionId,
|
|
1037
1070
|
};
|
|
1038
1071
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
1039
1072
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
@@ -1041,7 +1074,11 @@ export class BalanceClient {
|
|
|
1041
1074
|
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/transaction-history`),
|
|
1042
1075
|
method: "GET",
|
|
1043
1076
|
headers: _headers,
|
|
1044
|
-
|
|
1077
|
+
queryString: core.url
|
|
1078
|
+
.queryBuilder()
|
|
1079
|
+
.addMany(_queryParams)
|
|
1080
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
1081
|
+
.build(),
|
|
1045
1082
|
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,
|
|
1046
1083
|
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,
|
|
1047
1084
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -1110,7 +1147,7 @@ export class BalanceClient {
|
|
|
1110
1147
|
method: "POST",
|
|
1111
1148
|
headers: _headers,
|
|
1112
1149
|
contentType: "application/json",
|
|
1113
|
-
|
|
1150
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
1114
1151
|
requestType: "json",
|
|
1115
1152
|
body: _body,
|
|
1116
1153
|
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,
|
|
@@ -1176,7 +1213,7 @@ export class BalanceClient {
|
|
|
1176
1213
|
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/transactions/${core.url.encodePathParam(tid)}/cancel`),
|
|
1177
1214
|
method: "POST",
|
|
1178
1215
|
headers: _headers,
|
|
1179
|
-
|
|
1216
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
1180
1217
|
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,
|
|
1181
1218
|
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,
|
|
1182
1219
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -1240,7 +1277,7 @@ export class BalanceClient {
|
|
|
1240
1277
|
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/transactions/${core.url.encodePathParam(tid)}/complete`),
|
|
1241
1278
|
method: "POST",
|
|
1242
1279
|
headers: _headers,
|
|
1243
|
-
|
|
1280
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
1244
1281
|
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,
|
|
1245
1282
|
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,
|
|
1246
1283
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -9,22 +9,32 @@
|
|
|
9
9
|
export interface BeginTransactionRequest {
|
|
10
10
|
/** Loyalty Program Id */
|
|
11
11
|
pid: string;
|
|
12
|
-
/**
|
|
13
|
-
LoyaltySubscriptionId?: string;
|
|
14
|
-
/** Transaction amount (must be provided). */
|
|
12
|
+
/** Transaction amount. A positive value creates a credit transaction and a negative value creates a debit transaction (unless transactionType is explicitly provided). */
|
|
15
13
|
amount: number;
|
|
16
|
-
/**
|
|
17
|
-
|
|
14
|
+
/** Explicit transaction type. If not provided, the type is inferred from the sign of the amount (positive = credit, negative = debit). */
|
|
15
|
+
transactionType?: BeginTransactionRequest.TransactionType;
|
|
18
16
|
/** Unique identifier (UUID) of the associated balance definition. */
|
|
19
17
|
balanceDefinitionId: string;
|
|
20
|
-
/**
|
|
21
|
-
balanceExpiryInMinutes?: number;
|
|
22
|
-
/** Unique identifier of the contact involved in the transaction (required unless `LoyaltySubscriptionId` is provided). */
|
|
18
|
+
/** Unique identifier of the contact involved in the transaction. Required unless `LoyaltySubscriptionId` is provided. */
|
|
23
19
|
contactId?: number;
|
|
24
|
-
/**
|
|
25
|
-
|
|
20
|
+
/** Unique identifier for the loyalty subscription. Required unless `contactId` is provided. */
|
|
21
|
+
LoyaltySubscriptionId?: string;
|
|
26
22
|
/** Optional metadata associated with the transaction. */
|
|
27
23
|
meta?: Record<string, unknown>;
|
|
28
|
-
/**
|
|
24
|
+
/** Time-to-live for the transaction in seconds. Must be at least 10 seconds if provided. */
|
|
29
25
|
ttl?: number;
|
|
26
|
+
/** Timestamp specifying when the transaction event occurred (ISO 8601 / RFC 3339 format). */
|
|
27
|
+
eventTime?: string;
|
|
28
|
+
/** Whether the transaction should be automatically completed. */
|
|
29
|
+
autoComplete?: boolean;
|
|
30
|
+
/** Expiry time for the balance in minutes. Must be greater than 0 if provided. Only applicable when autoComplete is true. */
|
|
31
|
+
balanceExpiryInMinutes?: number;
|
|
32
|
+
}
|
|
33
|
+
export declare namespace BeginTransactionRequest {
|
|
34
|
+
/** Explicit transaction type. If not provided, the type is inferred from the sign of the amount (positive = credit, negative = debit). */
|
|
35
|
+
const TransactionType: {
|
|
36
|
+
readonly Credit: "credit";
|
|
37
|
+
readonly Debit: "debit";
|
|
38
|
+
};
|
|
39
|
+
type TransactionType = (typeof TransactionType)[keyof typeof TransactionType];
|
|
30
40
|
}
|
|
@@ -1,2 +1,9 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
-
export
|
|
2
|
+
export var BeginTransactionRequest;
|
|
3
|
+
(function (BeginTransactionRequest) {
|
|
4
|
+
/** Explicit transaction type. If not provided, the type is inferred from the sign of the amount (positive = credit, negative = debit). */
|
|
5
|
+
BeginTransactionRequest.TransactionType = {
|
|
6
|
+
Credit: "credit",
|
|
7
|
+
Debit: "debit",
|
|
8
|
+
};
|
|
9
|
+
})(BeginTransactionRequest || (BeginTransactionRequest = {}));
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
* balanceDefinitionId: "balanceDefinitionId",
|
|
7
7
|
* contactId: 1,
|
|
8
8
|
* dueAt: "dueAt",
|
|
9
|
-
* source: "
|
|
9
|
+
* source: "engine"
|
|
10
10
|
* }
|
|
11
11
|
*/
|
|
12
12
|
export interface CreateBalanceOrderRequest {
|
|
@@ -24,6 +24,14 @@ export interface CreateBalanceOrderRequest {
|
|
|
24
24
|
expiresAt?: string;
|
|
25
25
|
/** Optional metadata associated with the order. */
|
|
26
26
|
meta?: Record<string, unknown>;
|
|
27
|
-
/** Specifies the origin of the order
|
|
28
|
-
source:
|
|
27
|
+
/** Specifies the origin of the order. */
|
|
28
|
+
source: CreateBalanceOrderRequest.Source;
|
|
29
|
+
}
|
|
30
|
+
export declare namespace CreateBalanceOrderRequest {
|
|
31
|
+
/** Specifies the origin of the order. */
|
|
32
|
+
const Source: {
|
|
33
|
+
readonly Engine: "engine";
|
|
34
|
+
readonly User: "user";
|
|
35
|
+
};
|
|
36
|
+
type Source = (typeof Source)[keyof typeof Source];
|
|
29
37
|
}
|
|
@@ -1,2 +1,9 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
-
export
|
|
2
|
+
export var CreateBalanceOrderRequest;
|
|
3
|
+
(function (CreateBalanceOrderRequest) {
|
|
4
|
+
/** Specifies the origin of the order. */
|
|
5
|
+
CreateBalanceOrderRequest.Source = {
|
|
6
|
+
Engine: "engine",
|
|
7
|
+
User: "user",
|
|
8
|
+
};
|
|
9
|
+
})(CreateBalanceOrderRequest || (CreateBalanceOrderRequest = {}));
|
|
@@ -1,7 +1,9 @@
|
|
|
1
|
+
import type * as Brevo from "../../../../index.mjs";
|
|
1
2
|
/**
|
|
2
3
|
* @example
|
|
3
4
|
* {
|
|
4
|
-
* pid: "pid"
|
|
5
|
+
* pid: "pid",
|
|
6
|
+
* balanceDefinitionId: "balanceDefinitionId"
|
|
5
7
|
* }
|
|
6
8
|
*/
|
|
7
9
|
export interface GetContactBalancesRequest {
|
|
@@ -9,4 +11,14 @@ export interface GetContactBalancesRequest {
|
|
|
9
11
|
pid: string;
|
|
10
12
|
/** Include balances tied to internal definitions. */
|
|
11
13
|
includeInternal?: boolean;
|
|
14
|
+
/** Limit the number of records returned */
|
|
15
|
+
limit?: number;
|
|
16
|
+
/** Skip a number of records */
|
|
17
|
+
offset?: number;
|
|
18
|
+
/** Sort order */
|
|
19
|
+
sort?: Brevo.GetContactBalancesRequestSort;
|
|
20
|
+
/** Field to sort by */
|
|
21
|
+
sortField?: Brevo.GetContactBalancesRequestSortField;
|
|
22
|
+
/** Balance Definition ID (required) */
|
|
23
|
+
balanceDefinitionId: string;
|
|
12
24
|
}
|
|
@@ -1,9 +1,10 @@
|
|
|
1
|
+
import type * as Brevo from "../../../../index.mjs";
|
|
1
2
|
/**
|
|
2
3
|
* @example
|
|
3
4
|
* {
|
|
4
5
|
* pid: "pid",
|
|
5
|
-
*
|
|
6
|
-
*
|
|
6
|
+
* contactId: 1000000,
|
|
7
|
+
* balanceDefinitionId: "balanceDefinitionId"
|
|
7
8
|
* }
|
|
8
9
|
*/
|
|
9
10
|
export interface GetLoyaltyBalanceProgramsPidActiveBalanceRequest {
|
|
@@ -14,13 +15,13 @@ export interface GetLoyaltyBalanceProgramsPidActiveBalanceRequest {
|
|
|
14
15
|
/** Offset */
|
|
15
16
|
offset?: number;
|
|
16
17
|
/** Sort Field */
|
|
17
|
-
|
|
18
|
+
sortField?: "createdAt";
|
|
18
19
|
/** Sort Order */
|
|
19
|
-
sort?:
|
|
20
|
+
sort?: Brevo.GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort;
|
|
20
21
|
/** Contact ID */
|
|
21
|
-
|
|
22
|
+
contactId: number;
|
|
22
23
|
/** Balance Definition ID */
|
|
23
|
-
|
|
24
|
+
balanceDefinitionId: string;
|
|
24
25
|
/** Include balances tied to internal definitions. */
|
|
25
26
|
includeInternal?: boolean;
|
|
26
27
|
}
|
|
@@ -3,7 +3,7 @@ import type * as Brevo from "../../../../index.mjs";
|
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
5
|
* pid: "pid",
|
|
6
|
-
* contactId:
|
|
6
|
+
* contactId: 1000000,
|
|
7
7
|
* balanceDefinitionId: "balanceDefinitionId"
|
|
8
8
|
* }
|
|
9
9
|
*/
|
|
@@ -16,16 +16,16 @@ export interface GetLoyaltyBalanceProgramsPidTransactionHistoryRequest {
|
|
|
16
16
|
offset?: number;
|
|
17
17
|
/** Field to sort by */
|
|
18
18
|
sortField?: "createdAt";
|
|
19
|
-
/** Sort order
|
|
19
|
+
/** Sort order */
|
|
20
20
|
sort?: Brevo.GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSort;
|
|
21
21
|
/** Contact ID */
|
|
22
22
|
contactId: number;
|
|
23
23
|
/** Balance Definition ID */
|
|
24
24
|
balanceDefinitionId: string;
|
|
25
|
-
/**
|
|
26
|
-
filters?: string | string[];
|
|
27
|
-
/** Transaction status filter. Allowed values: draft, completed, rejected, cancelled, expired */
|
|
25
|
+
/** Transaction status filter */
|
|
28
26
|
status?: Brevo.GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus;
|
|
29
|
-
/** Transaction type filter
|
|
27
|
+
/** Transaction type filter */
|
|
30
28
|
transactionType?: Brevo.GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType;
|
|
29
|
+
/** Loyalty Subscription ID filter */
|
|
30
|
+
loyaltySubscriptionId?: string;
|
|
31
31
|
}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
export
|
|
1
|
+
export { BeginTransactionRequest } from "./BeginTransactionRequest.mjs";
|
|
2
2
|
export type { CancelTransactionRequest } from "./CancelTransactionRequest.mjs";
|
|
3
3
|
export type { CompleteTransactionRequest } from "./CompleteTransactionRequest.mjs";
|
|
4
4
|
export { CreateBalanceLimitRequest } from "./CreateBalanceLimitRequest.mjs";
|
|
5
|
-
export
|
|
5
|
+
export { CreateBalanceOrderRequest } from "./CreateBalanceOrderRequest.mjs";
|
|
6
6
|
export type { DeleteBalanceDefinitionRequest } from "./DeleteBalanceDefinitionRequest.mjs";
|
|
7
7
|
export type { DeleteBalanceLimitRequest } from "./DeleteBalanceLimitRequest.mjs";
|
|
8
8
|
export type { GetBalanceDefinitionListRequest } from "./GetBalanceDefinitionListRequest.mjs";
|
|
@@ -1,4 +1,6 @@
|
|
|
1
|
+
export { BeginTransactionRequest } from "./BeginTransactionRequest.mjs";
|
|
1
2
|
export { CreateBalanceLimitRequest } from "./CreateBalanceLimitRequest.mjs";
|
|
3
|
+
export { CreateBalanceOrderRequest } from "./CreateBalanceOrderRequest.mjs";
|
|
2
4
|
export { PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest } from "./PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest.mjs";
|
|
3
5
|
export { UpdateBalanceDefinitionRequest } from "./UpdateBalanceDefinitionRequest.mjs";
|
|
4
6
|
export { UpdateBalanceLimitRequest } from "./UpdateBalanceLimitRequest.mjs";
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export declare const GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort: {
|
|
2
|
+
readonly Asc: "asc";
|
|
3
|
+
readonly Desc: "desc";
|
|
4
|
+
};
|
|
5
|
+
export type GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort = (typeof GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort)[keyof typeof GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort];
|