@getbrevo/brevo 5.0.3 → 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 +38 -1
- package/dist/cjs/api/resources/contacts/client/Client.js +129 -37
- package/dist/cjs/api/resources/contacts/client/requests/CreateContactRequest.d.ts +5 -1
- 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 +5 -3
- 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 +32 -3
- package/dist/cjs/api/resources/ecommerce/client/Client.js +81 -22
- 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 +5 -5
- 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 +22 -38
- package/dist/cjs/api/resources/process/types/GetProcessResponse.js +1 -0
- package/dist/cjs/api/resources/process/types/GetProcessesResponse.d.ts +22 -38
- package/dist/cjs/api/resources/process/types/GetProcessesResponse.js +1 -0
- 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/BasicAuth.d.ts +2 -2
- package/dist/cjs/core/auth/BasicAuth.js +7 -1
- 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 +8 -0
- package/dist/cjs/core/fetcher/Fetcher.js +13 -8
- package/dist/cjs/core/fetcher/requestWithRetries.js +4 -1
- package/dist/cjs/core/file/file.js +3 -2
- 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/errors/BrevoError.d.ts +3 -1
- package/dist/cjs/errors/BrevoError.js +4 -1
- package/dist/cjs/errors/BrevoTimeoutError.d.ts +4 -1
- package/dist/cjs/errors/BrevoTimeoutError.js +4 -1
- package/dist/cjs/errors/handleNonStatusCodeError.js +4 -1
- 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 +38 -1
- package/dist/esm/api/resources/contacts/client/Client.mjs +129 -37
- package/dist/esm/api/resources/contacts/client/requests/CreateContactRequest.d.mts +5 -1
- 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 +5 -3
- 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 +32 -3
- package/dist/esm/api/resources/ecommerce/client/Client.mjs +81 -22
- 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 +5 -5
- 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 +22 -38
- package/dist/esm/api/resources/process/types/GetProcessResponse.mjs +1 -0
- package/dist/esm/api/resources/process/types/GetProcessesResponse.d.mts +22 -38
- package/dist/esm/api/resources/process/types/GetProcessesResponse.mjs +1 -0
- 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/BasicAuth.d.mts +2 -2
- package/dist/esm/core/auth/BasicAuth.mjs +7 -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 +8 -0
- package/dist/esm/core/fetcher/Fetcher.mjs +13 -8
- package/dist/esm/core/fetcher/requestWithRetries.mjs +4 -1
- package/dist/esm/core/file/file.mjs +3 -2
- 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/errors/BrevoError.d.mts +3 -1
- package/dist/esm/errors/BrevoError.mjs +4 -1
- package/dist/esm/errors/BrevoTimeoutError.d.mts +4 -1
- package/dist/esm/errors/BrevoTimeoutError.mjs +4 -1
- package/dist/esm/errors/handleNonStatusCodeError.mjs +4 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +8 -8
- package/reference.md +1828 -99
- 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
|
@@ -81,8 +81,8 @@ class BalanceClient {
|
|
|
81
81
|
* @example
|
|
82
82
|
* await client.balance.getActiveBalancesApi({
|
|
83
83
|
* pid: "pid",
|
|
84
|
-
*
|
|
85
|
-
*
|
|
84
|
+
* contactId: 1000000,
|
|
85
|
+
* balanceDefinitionId: "balanceDefinitionId"
|
|
86
86
|
* })
|
|
87
87
|
*/
|
|
88
88
|
getActiveBalancesApi(request, requestOptions) {
|
|
@@ -91,14 +91,14 @@ class BalanceClient {
|
|
|
91
91
|
__getActiveBalancesApi(request, requestOptions) {
|
|
92
92
|
return __awaiter(this, void 0, void 0, function* () {
|
|
93
93
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
94
|
-
const { pid, limit, offset,
|
|
94
|
+
const { pid, limit, offset, sortField, sort, contactId, balanceDefinitionId, includeInternal } = request;
|
|
95
95
|
const _queryParams = {
|
|
96
96
|
limit,
|
|
97
97
|
offset,
|
|
98
|
-
|
|
99
|
-
sort,
|
|
100
|
-
|
|
101
|
-
|
|
98
|
+
sortField: sortField != null ? sortField : undefined,
|
|
99
|
+
sort: sort != null ? sort : undefined,
|
|
100
|
+
contactId,
|
|
101
|
+
balanceDefinitionId,
|
|
102
102
|
includeInternal,
|
|
103
103
|
};
|
|
104
104
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
@@ -107,7 +107,11 @@ class BalanceClient {
|
|
|
107
107
|
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`),
|
|
108
108
|
method: "GET",
|
|
109
109
|
headers: _headers,
|
|
110
|
-
|
|
110
|
+
queryString: core.url
|
|
111
|
+
.queryBuilder()
|
|
112
|
+
.addMany(_queryParams)
|
|
113
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
114
|
+
.build(),
|
|
111
115
|
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,
|
|
112
116
|
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,
|
|
113
117
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -115,7 +119,10 @@ class BalanceClient {
|
|
|
115
119
|
logging: this._options.logging,
|
|
116
120
|
});
|
|
117
121
|
if (_response.ok) {
|
|
118
|
-
return {
|
|
122
|
+
return {
|
|
123
|
+
data: _response.body,
|
|
124
|
+
rawResponse: _response.rawResponse,
|
|
125
|
+
};
|
|
119
126
|
}
|
|
120
127
|
if (_response.error.reason === "status-code") {
|
|
121
128
|
switch (_response.error.statusCode) {
|
|
@@ -176,7 +183,11 @@ class BalanceClient {
|
|
|
176
183
|
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`),
|
|
177
184
|
method: "GET",
|
|
178
185
|
headers: _headers,
|
|
179
|
-
|
|
186
|
+
queryString: core.url
|
|
187
|
+
.queryBuilder()
|
|
188
|
+
.addMany(_queryParams)
|
|
189
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
190
|
+
.build(),
|
|
180
191
|
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,
|
|
181
192
|
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,
|
|
182
193
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -243,7 +254,7 @@ class BalanceClient {
|
|
|
243
254
|
method: "POST",
|
|
244
255
|
headers: _headers,
|
|
245
256
|
contentType: "application/json",
|
|
246
|
-
|
|
257
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
247
258
|
requestType: "json",
|
|
248
259
|
body: _body,
|
|
249
260
|
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,
|
|
@@ -312,7 +323,11 @@ class BalanceClient {
|
|
|
312
323
|
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `loyalty/balance/programs/${core.url.encodePathParam(pid)}/balance-definitions/${core.url.encodePathParam(bdid)}`),
|
|
313
324
|
method: "GET",
|
|
314
325
|
headers: _headers,
|
|
315
|
-
|
|
326
|
+
queryString: core.url
|
|
327
|
+
.queryBuilder()
|
|
328
|
+
.addMany(_queryParams)
|
|
329
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
330
|
+
.build(),
|
|
316
331
|
timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
|
|
317
332
|
maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
|
|
318
333
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -380,7 +395,7 @@ class BalanceClient {
|
|
|
380
395
|
method: "PUT",
|
|
381
396
|
headers: _headers,
|
|
382
397
|
contentType: "application/json",
|
|
383
|
-
|
|
398
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
384
399
|
requestType: "json",
|
|
385
400
|
body: _body,
|
|
386
401
|
timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
|
|
@@ -448,7 +463,7 @@ class BalanceClient {
|
|
|
448
463
|
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)}`),
|
|
449
464
|
method: "DELETE",
|
|
450
465
|
headers: _headers,
|
|
451
|
-
|
|
466
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
452
467
|
timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
|
|
453
468
|
maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
|
|
454
469
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -518,7 +533,7 @@ class BalanceClient {
|
|
|
518
533
|
method: "POST",
|
|
519
534
|
headers: _headers,
|
|
520
535
|
contentType: "application/json",
|
|
521
|
-
|
|
536
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
522
537
|
requestType: "json",
|
|
523
538
|
body: _body,
|
|
524
539
|
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,
|
|
@@ -588,7 +603,11 @@ class BalanceClient {
|
|
|
588
603
|
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)}`),
|
|
589
604
|
method: "GET",
|
|
590
605
|
headers: _headers,
|
|
591
|
-
|
|
606
|
+
queryString: core.url
|
|
607
|
+
.queryBuilder()
|
|
608
|
+
.addMany(_queryParams)
|
|
609
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
610
|
+
.build(),
|
|
592
611
|
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,
|
|
593
612
|
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,
|
|
594
613
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -659,7 +678,7 @@ class BalanceClient {
|
|
|
659
678
|
method: "PUT",
|
|
660
679
|
headers: _headers,
|
|
661
680
|
contentType: "application/json",
|
|
662
|
-
|
|
681
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
663
682
|
requestType: "json",
|
|
664
683
|
body: _body,
|
|
665
684
|
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,
|
|
@@ -726,7 +745,7 @@ class BalanceClient {
|
|
|
726
745
|
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)}`),
|
|
727
746
|
method: "DELETE",
|
|
728
747
|
headers: _headers,
|
|
729
|
-
|
|
748
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
730
749
|
timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
|
|
731
750
|
maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
|
|
732
751
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -760,7 +779,7 @@ class BalanceClient {
|
|
|
760
779
|
});
|
|
761
780
|
}
|
|
762
781
|
/**
|
|
763
|
-
* Returns balance
|
|
782
|
+
* Returns contact balances for a given balance definition across all subscriptions.
|
|
764
783
|
*
|
|
765
784
|
* @param {Brevo.GetContactBalancesRequest} request
|
|
766
785
|
* @param {BalanceClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -773,7 +792,8 @@ class BalanceClient {
|
|
|
773
792
|
*
|
|
774
793
|
* @example
|
|
775
794
|
* await client.balance.getContactBalances({
|
|
776
|
-
* pid: "pid"
|
|
795
|
+
* pid: "pid",
|
|
796
|
+
* balanceDefinitionId: "balanceDefinitionId"
|
|
777
797
|
* })
|
|
778
798
|
*/
|
|
779
799
|
getContactBalances(request, requestOptions) {
|
|
@@ -782,9 +802,14 @@ class BalanceClient {
|
|
|
782
802
|
__getContactBalances(request, requestOptions) {
|
|
783
803
|
return __awaiter(this, void 0, void 0, function* () {
|
|
784
804
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
785
|
-
const { pid, includeInternal } = request;
|
|
805
|
+
const { pid, includeInternal, limit, offset, sort, sortField, balanceDefinitionId } = request;
|
|
786
806
|
const _queryParams = {
|
|
787
807
|
includeInternal,
|
|
808
|
+
limit,
|
|
809
|
+
offset,
|
|
810
|
+
sort: sort != null ? sort : undefined,
|
|
811
|
+
sortField: sortField != null ? sortField : undefined,
|
|
812
|
+
balanceDefinitionId,
|
|
788
813
|
};
|
|
789
814
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
790
815
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
@@ -792,7 +817,11 @@ class BalanceClient {
|
|
|
792
817
|
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`),
|
|
793
818
|
method: "GET",
|
|
794
819
|
headers: _headers,
|
|
795
|
-
|
|
820
|
+
queryString: core.url
|
|
821
|
+
.queryBuilder()
|
|
822
|
+
.addMany(_queryParams)
|
|
823
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
824
|
+
.build(),
|
|
796
825
|
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,
|
|
797
826
|
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,
|
|
798
827
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -843,7 +872,7 @@ class BalanceClient {
|
|
|
843
872
|
* balanceDefinitionId: "balanceDefinitionId",
|
|
844
873
|
* contactId: 1,
|
|
845
874
|
* dueAt: "dueAt",
|
|
846
|
-
* source: "
|
|
875
|
+
* source: "engine"
|
|
847
876
|
* })
|
|
848
877
|
*/
|
|
849
878
|
createBalanceOrder(request, requestOptions) {
|
|
@@ -860,7 +889,7 @@ class BalanceClient {
|
|
|
860
889
|
method: "POST",
|
|
861
890
|
headers: _headers,
|
|
862
891
|
contentType: "application/json",
|
|
863
|
-
|
|
892
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
864
893
|
requestType: "json",
|
|
865
894
|
body: _body,
|
|
866
895
|
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,
|
|
@@ -927,7 +956,11 @@ class BalanceClient {
|
|
|
927
956
|
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`),
|
|
928
957
|
method: "GET",
|
|
929
958
|
headers: _headers,
|
|
930
|
-
|
|
959
|
+
queryString: core.url
|
|
960
|
+
.queryBuilder()
|
|
961
|
+
.addMany(_queryParams)
|
|
962
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
963
|
+
.build(),
|
|
931
964
|
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,
|
|
932
965
|
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,
|
|
933
966
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -996,7 +1029,7 @@ class BalanceClient {
|
|
|
996
1029
|
method: "POST",
|
|
997
1030
|
headers: _headers,
|
|
998
1031
|
contentType: "application/json",
|
|
999
|
-
|
|
1032
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
1000
1033
|
requestType: "json",
|
|
1001
1034
|
body: _body,
|
|
1002
1035
|
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,
|
|
@@ -1049,7 +1082,7 @@ class BalanceClient {
|
|
|
1049
1082
|
* @example
|
|
1050
1083
|
* await client.balance.getTransactionHistoryApi({
|
|
1051
1084
|
* pid: "pid",
|
|
1052
|
-
* contactId:
|
|
1085
|
+
* contactId: 1000000,
|
|
1053
1086
|
* balanceDefinitionId: "balanceDefinitionId"
|
|
1054
1087
|
* })
|
|
1055
1088
|
*/
|
|
@@ -1059,7 +1092,7 @@ class BalanceClient {
|
|
|
1059
1092
|
__getTransactionHistoryApi(request, requestOptions) {
|
|
1060
1093
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1061
1094
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
1062
|
-
const { pid, limit, offset, sortField, sort, contactId, balanceDefinitionId,
|
|
1095
|
+
const { pid, limit, offset, sortField, sort, contactId, balanceDefinitionId, status, transactionType, loyaltySubscriptionId, } = request;
|
|
1063
1096
|
const _queryParams = {
|
|
1064
1097
|
limit,
|
|
1065
1098
|
offset,
|
|
@@ -1067,9 +1100,9 @@ class BalanceClient {
|
|
|
1067
1100
|
sort: sort != null ? sort : undefined,
|
|
1068
1101
|
contactId,
|
|
1069
1102
|
balanceDefinitionId,
|
|
1070
|
-
filters,
|
|
1071
1103
|
status: status != null ? status : undefined,
|
|
1072
1104
|
transactionType: transactionType != null ? transactionType : undefined,
|
|
1105
|
+
loyaltySubscriptionId,
|
|
1073
1106
|
};
|
|
1074
1107
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
1075
1108
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
@@ -1077,7 +1110,11 @@ class BalanceClient {
|
|
|
1077
1110
|
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`),
|
|
1078
1111
|
method: "GET",
|
|
1079
1112
|
headers: _headers,
|
|
1080
|
-
|
|
1113
|
+
queryString: core.url
|
|
1114
|
+
.queryBuilder()
|
|
1115
|
+
.addMany(_queryParams)
|
|
1116
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
1117
|
+
.build(),
|
|
1081
1118
|
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,
|
|
1082
1119
|
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,
|
|
1083
1120
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -1146,7 +1183,7 @@ class BalanceClient {
|
|
|
1146
1183
|
method: "POST",
|
|
1147
1184
|
headers: _headers,
|
|
1148
1185
|
contentType: "application/json",
|
|
1149
|
-
|
|
1186
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
1150
1187
|
requestType: "json",
|
|
1151
1188
|
body: _body,
|
|
1152
1189
|
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,
|
|
@@ -1212,7 +1249,7 @@ class BalanceClient {
|
|
|
1212
1249
|
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`),
|
|
1213
1250
|
method: "POST",
|
|
1214
1251
|
headers: _headers,
|
|
1215
|
-
|
|
1252
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
1216
1253
|
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,
|
|
1217
1254
|
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,
|
|
1218
1255
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -1276,7 +1313,7 @@ class BalanceClient {
|
|
|
1276
1313
|
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`),
|
|
1277
1314
|
method: "POST",
|
|
1278
1315
|
headers: _headers,
|
|
1279
|
-
|
|
1316
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
1280
1317
|
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,
|
|
1281
1318
|
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,
|
|
1282
1319
|
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,3 +1,12 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.BeginTransactionRequest = void 0;
|
|
5
|
+
var BeginTransactionRequest;
|
|
6
|
+
(function (BeginTransactionRequest) {
|
|
7
|
+
/** Explicit transaction type. If not provided, the type is inferred from the sign of the amount (positive = credit, negative = debit). */
|
|
8
|
+
BeginTransactionRequest.TransactionType = {
|
|
9
|
+
Credit: "credit",
|
|
10
|
+
Debit: "debit",
|
|
11
|
+
};
|
|
12
|
+
})(BeginTransactionRequest || (exports.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,3 +1,12 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.CreateBalanceOrderRequest = void 0;
|
|
5
|
+
var CreateBalanceOrderRequest;
|
|
6
|
+
(function (CreateBalanceOrderRequest) {
|
|
7
|
+
/** Specifies the origin of the order. */
|
|
8
|
+
CreateBalanceOrderRequest.Source = {
|
|
9
|
+
Engine: "engine",
|
|
10
|
+
User: "user",
|
|
11
|
+
};
|
|
12
|
+
})(CreateBalanceOrderRequest || (exports.CreateBalanceOrderRequest = CreateBalanceOrderRequest = {}));
|
|
@@ -1,7 +1,9 @@
|
|
|
1
|
+
import type * as Brevo from "../../../../index.js";
|
|
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.js";
|
|
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.js";
|
|
|
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.js";
|
|
2
2
|
export type { CancelTransactionRequest } from "./CancelTransactionRequest.js";
|
|
3
3
|
export type { CompleteTransactionRequest } from "./CompleteTransactionRequest.js";
|
|
4
4
|
export { CreateBalanceLimitRequest } from "./CreateBalanceLimitRequest.js";
|
|
5
|
-
export
|
|
5
|
+
export { CreateBalanceOrderRequest } from "./CreateBalanceOrderRequest.js";
|
|
6
6
|
export type { DeleteBalanceDefinitionRequest } from "./DeleteBalanceDefinitionRequest.js";
|
|
7
7
|
export type { DeleteBalanceLimitRequest } from "./DeleteBalanceLimitRequest.js";
|
|
8
8
|
export type { GetBalanceDefinitionListRequest } from "./GetBalanceDefinitionListRequest.js";
|
|
@@ -1,8 +1,12 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.UpdateBalanceLimitRequest = exports.UpdateBalanceDefinitionRequest = exports.PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest = exports.CreateBalanceLimitRequest = void 0;
|
|
3
|
+
exports.UpdateBalanceLimitRequest = exports.UpdateBalanceDefinitionRequest = exports.PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest = exports.CreateBalanceOrderRequest = exports.CreateBalanceLimitRequest = exports.BeginTransactionRequest = void 0;
|
|
4
|
+
var BeginTransactionRequest_js_1 = require("./BeginTransactionRequest.js");
|
|
5
|
+
Object.defineProperty(exports, "BeginTransactionRequest", { enumerable: true, get: function () { return BeginTransactionRequest_js_1.BeginTransactionRequest; } });
|
|
4
6
|
var CreateBalanceLimitRequest_js_1 = require("./CreateBalanceLimitRequest.js");
|
|
5
7
|
Object.defineProperty(exports, "CreateBalanceLimitRequest", { enumerable: true, get: function () { return CreateBalanceLimitRequest_js_1.CreateBalanceLimitRequest; } });
|
|
8
|
+
var CreateBalanceOrderRequest_js_1 = require("./CreateBalanceOrderRequest.js");
|
|
9
|
+
Object.defineProperty(exports, "CreateBalanceOrderRequest", { enumerable: true, get: function () { return CreateBalanceOrderRequest_js_1.CreateBalanceOrderRequest; } });
|
|
6
10
|
var PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest_js_1 = require("./PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest.js");
|
|
7
11
|
Object.defineProperty(exports, "PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest", { enumerable: true, get: function () { return PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest_js_1.PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest; } });
|
|
8
12
|
var UpdateBalanceDefinitionRequest_js_1 = require("./UpdateBalanceDefinitionRequest.js");
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.GetContactBalancesRequestSort = void 0;
|
|
5
|
+
exports.GetContactBalancesRequestSort = {
|
|
6
|
+
Asc: "asc",
|
|
7
|
+
Desc: "desc",
|
|
8
|
+
};
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.GetContactBalancesRequestSortField = void 0;
|
|
5
|
+
exports.GetContactBalancesRequestSortField = {
|
|
6
|
+
UpdatedAt: "updatedAt",
|
|
7
|
+
Value: "value",
|
|
8
|
+
};
|
|
@@ -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];
|
package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort.js
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort = void 0;
|
|
5
|
+
exports.GetLoyaltyBalanceProgramsPidActiveBalanceRequestSort = {
|
|
6
|
+
Asc: "asc",
|
|
7
|
+
Desc: "desc",
|
|
8
|
+
};
|
package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidActiveBalanceResponse.d.ts
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Active balance response for a specific contact and balance definition.
|
|
3
|
+
*/
|
|
4
|
+
export interface GetLoyaltyBalanceProgramsPidActiveBalanceResponse {
|
|
5
|
+
/** Total number of active balances. */
|
|
6
|
+
count?: number | undefined;
|
|
7
|
+
/** Unique identifier of the loyalty program. */
|
|
8
|
+
loyaltyProgramId?: string | undefined;
|
|
9
|
+
/** Unique identifier of the contact. */
|
|
10
|
+
contactId?: number | undefined;
|
|
11
|
+
/** Unique identifier of the balance definition. */
|
|
12
|
+
balanceDefinitionId?: string | undefined;
|
|
13
|
+
/** List of active balances. */
|
|
14
|
+
activeBalances?: GetLoyaltyBalanceProgramsPidActiveBalanceResponse.ActiveBalances.Item[] | undefined;
|
|
15
|
+
}
|
|
16
|
+
export declare namespace GetLoyaltyBalanceProgramsPidActiveBalanceResponse {
|
|
17
|
+
type ActiveBalances = ActiveBalances.Item[];
|
|
18
|
+
namespace ActiveBalances {
|
|
19
|
+
interface Item {
|
|
20
|
+
/** Unique identifier of the balance entry. */
|
|
21
|
+
id?: string | undefined;
|
|
22
|
+
/** Current balance amount. */
|
|
23
|
+
amount?: number | undefined;
|
|
24
|
+
/** Timestamp when the balance was created. */
|
|
25
|
+
createdAt?: string | undefined;
|
|
26
|
+
/** Timestamp when the balance expires (if applicable). */
|
|
27
|
+
expiresAt?: string | undefined;
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
}
|