@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
|
@@ -31,6 +31,8 @@ export class ContactsClient {
|
|
|
31
31
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
32
32
|
}
|
|
33
33
|
/**
|
|
34
|
+
* Retrieve all contacts from your Brevo account with support for pagination, filtering, and sorting. Results default to 50 contacts per page (maximum 1000) sorted in descending order of creation, and can be filtered by modification date, creation date, contact IDs (up to 20), list IDs, segment ID, or contact attributes using the equals operator. Note that either listIds or segmentId can be passed but not both simultaneously.
|
|
35
|
+
*
|
|
34
36
|
* @param {Brevo.GetContactsRequest} request
|
|
35
37
|
* @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
36
38
|
*
|
|
@@ -46,13 +48,14 @@ export class ContactsClient {
|
|
|
46
48
|
__getContacts() {
|
|
47
49
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
48
50
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
49
|
-
const { limit, offset, modifiedSince, createdSince, sort, segmentId, listIds, filter } = request;
|
|
51
|
+
const { limit, offset, modifiedSince, createdSince, sort, ids, segmentId, listIds, filter } = request;
|
|
50
52
|
const _queryParams = {
|
|
51
53
|
limit,
|
|
52
54
|
offset,
|
|
53
55
|
modifiedSince,
|
|
54
56
|
createdSince,
|
|
55
57
|
sort: sort != null ? sort : undefined,
|
|
58
|
+
ids,
|
|
56
59
|
segmentId,
|
|
57
60
|
listIds,
|
|
58
61
|
filter,
|
|
@@ -63,7 +66,11 @@ export class ContactsClient {
|
|
|
63
66
|
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, "contacts"),
|
|
64
67
|
method: "GET",
|
|
65
68
|
headers: _headers,
|
|
66
|
-
|
|
69
|
+
queryString: core.url
|
|
70
|
+
.queryBuilder()
|
|
71
|
+
.addMany(_queryParams)
|
|
72
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
73
|
+
.build(),
|
|
67
74
|
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,
|
|
68
75
|
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,
|
|
69
76
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -117,7 +124,7 @@ export class ContactsClient {
|
|
|
117
124
|
method: "POST",
|
|
118
125
|
headers: _headers,
|
|
119
126
|
contentType: "application/json",
|
|
120
|
-
|
|
127
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
121
128
|
requestType: "json",
|
|
122
129
|
body: request,
|
|
123
130
|
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,
|
|
@@ -150,8 +157,12 @@ export class ContactsClient {
|
|
|
150
157
|
});
|
|
151
158
|
}
|
|
152
159
|
/**
|
|
160
|
+
* Retrieve all contact attributes defined in your Brevo account, grouped by category (normal, transactional, category, calculated, global). Each attribute includes its name, type, and category, along with enumeration values for category-type attributes and options for multiple-choice-type attributes.
|
|
161
|
+
*
|
|
153
162
|
* @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
154
163
|
*
|
|
164
|
+
* @throws {@link Brevo.BadRequestError}
|
|
165
|
+
*
|
|
155
166
|
* @example
|
|
156
167
|
* await client.contacts.getAttributes()
|
|
157
168
|
*/
|
|
@@ -167,7 +178,7 @@ export class ContactsClient {
|
|
|
167
178
|
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, "contacts/attributes"),
|
|
168
179
|
method: "GET",
|
|
169
180
|
headers: _headers,
|
|
170
|
-
|
|
181
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
171
182
|
timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
|
|
172
183
|
maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
|
|
173
184
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -178,16 +189,23 @@ export class ContactsClient {
|
|
|
178
189
|
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
179
190
|
}
|
|
180
191
|
if (_response.error.reason === "status-code") {
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
192
|
+
switch (_response.error.statusCode) {
|
|
193
|
+
case 400:
|
|
194
|
+
throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
|
|
195
|
+
default:
|
|
196
|
+
throw new errors.BrevoError({
|
|
197
|
+
statusCode: _response.error.statusCode,
|
|
198
|
+
body: _response.error.body,
|
|
199
|
+
rawResponse: _response.rawResponse,
|
|
200
|
+
});
|
|
201
|
+
}
|
|
186
202
|
}
|
|
187
203
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/contacts/attributes");
|
|
188
204
|
});
|
|
189
205
|
}
|
|
190
206
|
/**
|
|
207
|
+
* Create a new contact attribute under the specified category and name. The required body properties depend on the category: use "type" for normal, transactional, or category attributes; use "value" for calculated or global attributes; use "enumeration" for category attributes; and use "multiCategoryOptions" for normal multiple-choice attributes. None of the category or multicategory option values can exceed 200 characters.
|
|
208
|
+
*
|
|
191
209
|
* @param {Brevo.CreateAttributeRequest} request
|
|
192
210
|
* @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
193
211
|
*
|
|
@@ -213,7 +231,7 @@ export class ContactsClient {
|
|
|
213
231
|
method: "POST",
|
|
214
232
|
headers: _headers,
|
|
215
233
|
contentType: "application/json",
|
|
216
|
-
|
|
234
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
217
235
|
requestType: "json",
|
|
218
236
|
body: _body,
|
|
219
237
|
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,
|
|
@@ -241,6 +259,8 @@ export class ContactsClient {
|
|
|
241
259
|
});
|
|
242
260
|
}
|
|
243
261
|
/**
|
|
262
|
+
* Update an existing contact attribute identified by its category and name. For category-type attributes, you can update the enumeration values; for calculated or global attributes, update the computed value formula; and for normal multiple-choice attributes, update the multicategory options. None of the category or multicategory option values can exceed 200 characters.
|
|
263
|
+
*
|
|
244
264
|
* @param {Brevo.UpdateAttributeRequest} request
|
|
245
265
|
* @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
246
266
|
*
|
|
@@ -267,7 +287,7 @@ export class ContactsClient {
|
|
|
267
287
|
method: "PUT",
|
|
268
288
|
headers: _headers,
|
|
269
289
|
contentType: "application/json",
|
|
270
|
-
|
|
290
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
271
291
|
requestType: "json",
|
|
272
292
|
body: _body,
|
|
273
293
|
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,
|
|
@@ -297,6 +317,8 @@ export class ContactsClient {
|
|
|
297
317
|
});
|
|
298
318
|
}
|
|
299
319
|
/**
|
|
320
|
+
* Permanently delete an existing contact attribute by its category and name. The attribute must exist in the specified category (normal, transactional, category, calculated, or global), otherwise a 404 error is returned.
|
|
321
|
+
*
|
|
300
322
|
* @param {Brevo.DeleteAttributeRequest} request
|
|
301
323
|
* @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
302
324
|
*
|
|
@@ -322,7 +344,7 @@ export class ContactsClient {
|
|
|
322
344
|
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, `contacts/attributes/${core.url.encodePathParam(attributeCategory)}/${core.url.encodePathParam(attributeName)}`),
|
|
323
345
|
method: "DELETE",
|
|
324
346
|
headers: _headers,
|
|
325
|
-
|
|
347
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
326
348
|
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,
|
|
327
349
|
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,
|
|
328
350
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -350,6 +372,8 @@ export class ContactsClient {
|
|
|
350
372
|
});
|
|
351
373
|
}
|
|
352
374
|
/**
|
|
375
|
+
* Delete a specific option from an existing multiple-choice contact attribute. The attribute type must be "multiple-choice", and both the attribute name and the option to delete must already exist in your account.
|
|
376
|
+
*
|
|
353
377
|
* @param {Brevo.DeleteMultiAttributeOptionsRequest} request
|
|
354
378
|
* @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
355
379
|
*
|
|
@@ -376,7 +400,7 @@ export class ContactsClient {
|
|
|
376
400
|
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, `contacts/attributes/${core.url.encodePathParam(attributeType)}/${core.url.encodePathParam(multipleChoiceAttribute)}/${core.url.encodePathParam(multipleChoiceAttributeOption)}`),
|
|
377
401
|
method: "DELETE",
|
|
378
402
|
headers: _headers,
|
|
379
|
-
|
|
403
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
380
404
|
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,
|
|
381
405
|
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,
|
|
382
406
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -404,6 +428,8 @@ export class ContactsClient {
|
|
|
404
428
|
});
|
|
405
429
|
}
|
|
406
430
|
/**
|
|
431
|
+
* Update multiple contacts in a single API call by passing an array of contact objects. Each contact in the array must be identified by one of: email, id, or sms (only one identifier per contact). You can update attributes, blacklist status, list memberships, ext_id, and transactional email forbidden senders for each contact in the batch.
|
|
432
|
+
*
|
|
407
433
|
* @param {Brevo.UpdateBatchContactsRequest} request
|
|
408
434
|
* @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
409
435
|
*
|
|
@@ -425,7 +451,7 @@ export class ContactsClient {
|
|
|
425
451
|
method: "POST",
|
|
426
452
|
headers: _headers,
|
|
427
453
|
contentType: "application/json",
|
|
428
|
-
|
|
454
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
429
455
|
requestType: "json",
|
|
430
456
|
body: request,
|
|
431
457
|
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,
|
|
@@ -481,7 +507,7 @@ export class ContactsClient {
|
|
|
481
507
|
method: "POST",
|
|
482
508
|
headers: _headers,
|
|
483
509
|
contentType: "application/json",
|
|
484
|
-
|
|
510
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
485
511
|
requestType: "json",
|
|
486
512
|
body: request,
|
|
487
513
|
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,
|
|
@@ -535,7 +561,7 @@ export class ContactsClient {
|
|
|
535
561
|
method: "POST",
|
|
536
562
|
headers: _headers,
|
|
537
563
|
contentType: "application/json",
|
|
538
|
-
|
|
564
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
539
565
|
requestType: "json",
|
|
540
566
|
body: request,
|
|
541
567
|
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,
|
|
@@ -597,7 +623,11 @@ export class ContactsClient {
|
|
|
597
623
|
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, "contacts/folders"),
|
|
598
624
|
method: "GET",
|
|
599
625
|
headers: _headers,
|
|
600
|
-
|
|
626
|
+
queryString: core.url
|
|
627
|
+
.queryBuilder()
|
|
628
|
+
.addMany(_queryParams)
|
|
629
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
630
|
+
.build(),
|
|
601
631
|
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,
|
|
602
632
|
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,
|
|
603
633
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -623,6 +653,8 @@ export class ContactsClient {
|
|
|
623
653
|
});
|
|
624
654
|
}
|
|
625
655
|
/**
|
|
656
|
+
* Create a new folder to organize your contact lists. Folders serve as containers for grouping related lists together. The folder name is required and must be provided in the request body.
|
|
657
|
+
*
|
|
626
658
|
* @param {Brevo.CreateUpdateFolder} request
|
|
627
659
|
* @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
628
660
|
*
|
|
@@ -644,7 +676,7 @@ export class ContactsClient {
|
|
|
644
676
|
method: "POST",
|
|
645
677
|
headers: _headers,
|
|
646
678
|
contentType: "application/json",
|
|
647
|
-
|
|
679
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
648
680
|
requestType: "json",
|
|
649
681
|
body: request,
|
|
650
682
|
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,
|
|
@@ -700,7 +732,7 @@ export class ContactsClient {
|
|
|
700
732
|
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, `contacts/folders/${core.url.encodePathParam(folderId)}`),
|
|
701
733
|
method: "GET",
|
|
702
734
|
headers: _headers,
|
|
703
|
-
|
|
735
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
704
736
|
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,
|
|
705
737
|
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,
|
|
706
738
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -728,6 +760,8 @@ export class ContactsClient {
|
|
|
728
760
|
});
|
|
729
761
|
}
|
|
730
762
|
/**
|
|
763
|
+
* Update the name of an existing folder identified by its ID. The new folder name must be provided in the request body. Returns a 404 error if the folder ID does not exist.
|
|
764
|
+
*
|
|
731
765
|
* @param {Brevo.UpdateFolderRequest} request
|
|
732
766
|
* @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
733
767
|
*
|
|
@@ -754,7 +788,7 @@ export class ContactsClient {
|
|
|
754
788
|
method: "PUT",
|
|
755
789
|
headers: _headers,
|
|
756
790
|
contentType: "application/json",
|
|
757
|
-
|
|
791
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
758
792
|
requestType: "json",
|
|
759
793
|
body: _body,
|
|
760
794
|
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,
|
|
@@ -784,6 +818,8 @@ export class ContactsClient {
|
|
|
784
818
|
});
|
|
785
819
|
}
|
|
786
820
|
/**
|
|
821
|
+
* Permanently delete a folder identified by its ID. Deleting a folder will also delete all the contact lists contained within it. This action cannot be undone.
|
|
822
|
+
*
|
|
787
823
|
* @param {Brevo.DeleteFolderRequest} request
|
|
788
824
|
* @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
789
825
|
*
|
|
@@ -808,7 +844,7 @@ export class ContactsClient {
|
|
|
808
844
|
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, `contacts/folders/${core.url.encodePathParam(folderId)}`),
|
|
809
845
|
method: "DELETE",
|
|
810
846
|
headers: _headers,
|
|
811
|
-
|
|
847
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
812
848
|
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,
|
|
813
849
|
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,
|
|
814
850
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -869,7 +905,11 @@ export class ContactsClient {
|
|
|
869
905
|
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, `contacts/folders/${core.url.encodePathParam(folderId)}/lists`),
|
|
870
906
|
method: "GET",
|
|
871
907
|
headers: _headers,
|
|
872
|
-
|
|
908
|
+
queryString: core.url
|
|
909
|
+
.queryBuilder()
|
|
910
|
+
.addMany(_queryParams)
|
|
911
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
912
|
+
.build(),
|
|
873
913
|
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,
|
|
874
914
|
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,
|
|
875
915
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -920,7 +960,7 @@ export class ContactsClient {
|
|
|
920
960
|
method: "POST",
|
|
921
961
|
headers: _headers,
|
|
922
962
|
contentType: "application/json",
|
|
923
|
-
|
|
963
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
924
964
|
requestType: "json",
|
|
925
965
|
body: request,
|
|
926
966
|
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,
|
|
@@ -978,7 +1018,11 @@ export class ContactsClient {
|
|
|
978
1018
|
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, "contacts/lists"),
|
|
979
1019
|
method: "GET",
|
|
980
1020
|
headers: _headers,
|
|
981
|
-
|
|
1021
|
+
queryString: core.url
|
|
1022
|
+
.queryBuilder()
|
|
1023
|
+
.addMany(_queryParams)
|
|
1024
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
1025
|
+
.build(),
|
|
982
1026
|
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,
|
|
983
1027
|
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,
|
|
984
1028
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -1004,6 +1048,8 @@ export class ContactsClient {
|
|
|
1004
1048
|
});
|
|
1005
1049
|
}
|
|
1006
1050
|
/**
|
|
1051
|
+
* Create a new contact list inside a specified folder. Both the list name and the parent folder ID are required. The newly created list will be empty and ready to receive contacts via the add contacts endpoint.
|
|
1052
|
+
*
|
|
1007
1053
|
* @param {Brevo.CreateListRequest} request
|
|
1008
1054
|
* @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1009
1055
|
*
|
|
@@ -1028,7 +1074,7 @@ export class ContactsClient {
|
|
|
1028
1074
|
method: "POST",
|
|
1029
1075
|
headers: _headers,
|
|
1030
1076
|
contentType: "application/json",
|
|
1031
|
-
|
|
1077
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
1032
1078
|
requestType: "json",
|
|
1033
1079
|
body: request,
|
|
1034
1080
|
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,
|
|
@@ -1056,6 +1102,8 @@ export class ContactsClient {
|
|
|
1056
1102
|
});
|
|
1057
1103
|
}
|
|
1058
1104
|
/**
|
|
1105
|
+
* Retrieve the details of a specific contact list by its ID, including its name, folder ID, creation date, subscriber counts, and campaign statistics. You can optionally filter campaign statistics by providing startDate and endDate parameters (both must be used together in YYYY-MM-DD format).
|
|
1106
|
+
*
|
|
1059
1107
|
* @param {Brevo.GetListRequest} request
|
|
1060
1108
|
* @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1061
1109
|
*
|
|
@@ -1084,7 +1132,11 @@ export class ContactsClient {
|
|
|
1084
1132
|
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, `contacts/lists/${core.url.encodePathParam(listId)}`),
|
|
1085
1133
|
method: "GET",
|
|
1086
1134
|
headers: _headers,
|
|
1087
|
-
|
|
1135
|
+
queryString: core.url
|
|
1136
|
+
.queryBuilder()
|
|
1137
|
+
.addMany(_queryParams)
|
|
1138
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
1139
|
+
.build(),
|
|
1088
1140
|
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,
|
|
1089
1141
|
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,
|
|
1090
1142
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -1112,6 +1164,8 @@ export class ContactsClient {
|
|
|
1112
1164
|
});
|
|
1113
1165
|
}
|
|
1114
1166
|
/**
|
|
1167
|
+
* Update an existing contact list identified by its ID. You can update the list name, move it to a different folder by providing a new folderId, or both. Only one of the two parameters (name, folderId) needs to be provided per request.
|
|
1168
|
+
*
|
|
1115
1169
|
* @param {Brevo.UpdateListRequest} request
|
|
1116
1170
|
* @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1117
1171
|
*
|
|
@@ -1137,7 +1191,7 @@ export class ContactsClient {
|
|
|
1137
1191
|
method: "PUT",
|
|
1138
1192
|
headers: _headers,
|
|
1139
1193
|
contentType: "application/json",
|
|
1140
|
-
|
|
1194
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
1141
1195
|
requestType: "json",
|
|
1142
1196
|
body: _body,
|
|
1143
1197
|
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,
|
|
@@ -1167,6 +1221,8 @@ export class ContactsClient {
|
|
|
1167
1221
|
});
|
|
1168
1222
|
}
|
|
1169
1223
|
/**
|
|
1224
|
+
* Permanently delete a contact list identified by its ID. The contacts in the list are not deleted; they are only removed from this list. Returns a 404 error if the list ID does not exist.
|
|
1225
|
+
*
|
|
1170
1226
|
* @param {Brevo.DeleteListRequest} request
|
|
1171
1227
|
* @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1172
1228
|
*
|
|
@@ -1191,7 +1247,7 @@ export class ContactsClient {
|
|
|
1191
1247
|
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, `contacts/lists/${core.url.encodePathParam(listId)}`),
|
|
1192
1248
|
method: "DELETE",
|
|
1193
1249
|
headers: _headers,
|
|
1194
|
-
|
|
1250
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
1195
1251
|
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,
|
|
1196
1252
|
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,
|
|
1197
1253
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -1219,11 +1275,14 @@ export class ContactsClient {
|
|
|
1219
1275
|
});
|
|
1220
1276
|
}
|
|
1221
1277
|
/**
|
|
1278
|
+
* Retrieve all contacts belonging to a specific list, identified by its list ID. Results are paginated with a default of 50 contacts per page (maximum 500) and sorted in descending order of creation. You can optionally filter contacts by their modification date using the modifiedSince parameter.
|
|
1279
|
+
*
|
|
1222
1280
|
* @param {Brevo.GetContactsFromListRequest} request
|
|
1223
1281
|
* @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1224
1282
|
*
|
|
1225
1283
|
* @throws {@link Brevo.BadRequestError}
|
|
1226
1284
|
* @throws {@link Brevo.NotFoundError}
|
|
1285
|
+
* @throws {@link Brevo.TooManyRequestsError}
|
|
1227
1286
|
*
|
|
1228
1287
|
* @example
|
|
1229
1288
|
* await client.contacts.getContactsFromList({
|
|
@@ -1249,7 +1308,11 @@ export class ContactsClient {
|
|
|
1249
1308
|
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, `contacts/lists/${core.url.encodePathParam(listId)}/contacts`),
|
|
1250
1309
|
method: "GET",
|
|
1251
1310
|
headers: _headers,
|
|
1252
|
-
|
|
1311
|
+
queryString: core.url
|
|
1312
|
+
.queryBuilder()
|
|
1313
|
+
.addMany(_queryParams)
|
|
1314
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
1315
|
+
.build(),
|
|
1253
1316
|
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,
|
|
1254
1317
|
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,
|
|
1255
1318
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -1265,6 +1328,8 @@ export class ContactsClient {
|
|
|
1265
1328
|
throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
|
|
1266
1329
|
case 404:
|
|
1267
1330
|
throw new Brevo.NotFoundError(_response.error.body, _response.rawResponse);
|
|
1331
|
+
case 429:
|
|
1332
|
+
throw new Brevo.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
1268
1333
|
default:
|
|
1269
1334
|
throw new errors.BrevoError({
|
|
1270
1335
|
statusCode: _response.error.statusCode,
|
|
@@ -1321,7 +1386,7 @@ export class ContactsClient {
|
|
|
1321
1386
|
method: "POST",
|
|
1322
1387
|
headers: _headers,
|
|
1323
1388
|
contentType: "application/json",
|
|
1324
|
-
|
|
1389
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
1325
1390
|
requestType: "json",
|
|
1326
1391
|
body: _body,
|
|
1327
1392
|
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,
|
|
@@ -1403,7 +1468,7 @@ export class ContactsClient {
|
|
|
1403
1468
|
method: "POST",
|
|
1404
1469
|
headers: _headers,
|
|
1405
1470
|
contentType: "application/json",
|
|
1406
|
-
|
|
1471
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
1407
1472
|
requestType: "json",
|
|
1408
1473
|
body: _body,
|
|
1409
1474
|
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,
|
|
@@ -1433,6 +1498,8 @@ export class ContactsClient {
|
|
|
1433
1498
|
});
|
|
1434
1499
|
}
|
|
1435
1500
|
/**
|
|
1501
|
+
* Retrieve all contact segments defined in your Brevo account with support for pagination and sorting. Results default to 10 segments per page (maximum 50) sorted in descending order of creation. Each segment includes its ID, name, category name, and last update timestamp.
|
|
1502
|
+
*
|
|
1436
1503
|
* @param {Brevo.GetSegmentsRequest} request
|
|
1437
1504
|
* @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1438
1505
|
*
|
|
@@ -1459,7 +1526,11 @@ export class ContactsClient {
|
|
|
1459
1526
|
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, "contacts/segments"),
|
|
1460
1527
|
method: "GET",
|
|
1461
1528
|
headers: _headers,
|
|
1462
|
-
|
|
1529
|
+
queryString: core.url
|
|
1530
|
+
.queryBuilder()
|
|
1531
|
+
.addMany(_queryParams)
|
|
1532
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
1533
|
+
.build(),
|
|
1463
1534
|
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,
|
|
1464
1535
|
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,
|
|
1465
1536
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -1518,7 +1589,11 @@ export class ContactsClient {
|
|
|
1518
1589
|
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, `contacts/${core.url.encodePathParam(identifier)}`),
|
|
1519
1590
|
method: "GET",
|
|
1520
1591
|
headers: _headers,
|
|
1521
|
-
|
|
1592
|
+
queryString: core.url
|
|
1593
|
+
.queryBuilder()
|
|
1594
|
+
.addMany(_queryParams)
|
|
1595
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
1596
|
+
.build(),
|
|
1522
1597
|
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,
|
|
1523
1598
|
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,
|
|
1524
1599
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -1579,7 +1654,11 @@ export class ContactsClient {
|
|
|
1579
1654
|
method: "PUT",
|
|
1580
1655
|
headers: _headers,
|
|
1581
1656
|
contentType: "application/json",
|
|
1582
|
-
|
|
1657
|
+
queryString: core.url
|
|
1658
|
+
.queryBuilder()
|
|
1659
|
+
.addMany(_queryParams)
|
|
1660
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
1661
|
+
.build(),
|
|
1583
1662
|
requestType: "json",
|
|
1584
1663
|
body: _body,
|
|
1585
1664
|
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,
|
|
@@ -1641,7 +1720,11 @@ export class ContactsClient {
|
|
|
1641
1720
|
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, `contacts/${core.url.encodePathParam(identifier)}`),
|
|
1642
1721
|
method: "DELETE",
|
|
1643
1722
|
headers: _headers,
|
|
1644
|
-
|
|
1723
|
+
queryString: core.url
|
|
1724
|
+
.queryBuilder()
|
|
1725
|
+
.addMany(_queryParams)
|
|
1726
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
1727
|
+
.build(),
|
|
1645
1728
|
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,
|
|
1646
1729
|
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,
|
|
1647
1730
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -1671,6 +1754,8 @@ export class ContactsClient {
|
|
|
1671
1754
|
});
|
|
1672
1755
|
}
|
|
1673
1756
|
/**
|
|
1757
|
+
* Retrieve email campaign statistics for a specific contact identified by email address or numeric ID. Statistics include messages sent, opens, clicks, hard/soft bounces, deliveries, unsubscriptions, complaints, and transactional attributes. By default, data covers the last 90 days; use startDate and endDate parameters (YYYY-MM-DD) to specify a custom range with a maximum span of 90 days.
|
|
1758
|
+
*
|
|
1674
1759
|
* @param {Brevo.GetContactStatsRequest} request
|
|
1675
1760
|
* @param {ContactsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1676
1761
|
*
|
|
@@ -1699,7 +1784,11 @@ export class ContactsClient {
|
|
|
1699
1784
|
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, `contacts/${core.url.encodePathParam(identifier)}/campaignStats`),
|
|
1700
1785
|
method: "GET",
|
|
1701
1786
|
headers: _headers,
|
|
1702
|
-
|
|
1787
|
+
queryString: core.url
|
|
1788
|
+
.queryBuilder()
|
|
1789
|
+
.addMany(_queryParams)
|
|
1790
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
1791
|
+
.build(),
|
|
1703
1792
|
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,
|
|
1704
1793
|
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,
|
|
1705
1794
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -19,6 +19,10 @@ export interface CreateContactRequest {
|
|
|
19
19
|
smtpBlacklistSender?: string[];
|
|
20
20
|
/** Facilitate to update the existing contact in the same request (updateEnabled = true) */
|
|
21
21
|
updateEnabled?: boolean;
|
|
22
|
+
/** When true, if the contact being created shares an identifier (email, SMS, ext_id, whatsapp, landline) with an existing contact, the two contacts are force-merged. The contact with the most recent `last_modified` timestamp is retained; the other is deleted. When false (default), a 4xx error is returned on identifier conflict. */
|
|
23
|
+
forceMerge?: boolean;
|
|
24
|
+
/** When true, the response returns the `id` of the surviving contact after merge. */
|
|
25
|
+
getId?: boolean;
|
|
22
26
|
}
|
|
23
27
|
export declare namespace CreateContactRequest {
|
|
24
28
|
namespace Attributes {
|
|
@@ -10,8 +10,8 @@ export interface GetContactInfoRequest {
|
|
|
10
10
|
identifier: Brevo.GetContactInfoRequestIdentifier;
|
|
11
11
|
/** email_id for Email, phone_id for SMS attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute */
|
|
12
12
|
identifierType?: Brevo.GetContactInfoRequestIdentifierType;
|
|
13
|
-
/** **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate */
|
|
13
|
+
/** **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate. Must not be greater than the current date. */
|
|
14
14
|
startDate?: string;
|
|
15
|
-
/** **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. */
|
|
15
|
+
/** **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Must not be greater than the current date. */
|
|
16
16
|
endDate?: string;
|
|
17
17
|
}
|
|
@@ -8,8 +8,8 @@ import type * as Brevo from "../../../../index.mjs";
|
|
|
8
8
|
export interface GetContactStatsRequest {
|
|
9
9
|
/** Email (urlencoded) OR ID of the contact */
|
|
10
10
|
identifier: Brevo.GetContactStatsRequestIdentifier;
|
|
11
|
-
/** **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate */
|
|
11
|
+
/** **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate. Must not be greater than the current date. */
|
|
12
12
|
startDate?: string;
|
|
13
|
-
/** **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days */
|
|
13
|
+
/** **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Must not be greater than the current date. Maximum difference between startDate and endDate should not be greater than 90 days. */
|
|
14
14
|
endDate?: string;
|
|
15
15
|
}
|
|
@@ -14,7 +14,9 @@ export interface GetContactsRequest {
|
|
|
14
14
|
createdSince?: string;
|
|
15
15
|
/** Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed */
|
|
16
16
|
sort?: Brevo.GetContactsRequestSort;
|
|
17
|
-
/**
|
|
17
|
+
/** Filter by a list of contact IDs. You can pass a **maximum of 20 IDs**. All elements must be integers. */
|
|
18
|
+
ids?: number | number[];
|
|
19
|
+
/** Id of the segment. **Either listIds or segmentId can be passed.** Must be a positive integer (minimum value of 1). */
|
|
18
20
|
segmentId?: number;
|
|
19
21
|
/** Ids of the list. **Either listIds or segmentId can be passed.** */
|
|
20
22
|
listIds?: number | number[];
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
export interface GetListRequest {
|
|
8
8
|
/** Id of the list */
|
|
9
9
|
listId: number;
|
|
10
|
-
/** **Mandatory if endDate is used**.
|
|
10
|
+
/** **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. **Prefer to pass your timezone in date-time format for accurate result** */
|
|
11
11
|
startDate?: string;
|
|
12
12
|
/** **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. **Prefer to pass your timezone in date-time format for accurate result** */
|
|
13
13
|
endDate?: string;
|
|
@@ -6,9 +6,9 @@ import type * as Brevo from "../../../../index.mjs";
|
|
|
6
6
|
* }
|
|
7
7
|
*/
|
|
8
8
|
export interface UpdateContactRequest {
|
|
9
|
-
/** Email (urlencoded) OR ID of the contact OR EXT_ID attribute (urlencoded) OR its SMS attribute value OR its WHATSAPP attribute value OR its
|
|
9
|
+
/** Email (urlencoded) OR ID of the contact OR EXT_ID attribute (urlencoded) OR its SMS attribute value OR its WHATSAPP attribute value OR its LANDLINE_NUMBER attribute value */
|
|
10
10
|
identifier: Brevo.UpdateContactRequestIdentifier;
|
|
11
|
-
/** email_id for Email, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for
|
|
11
|
+
/** email_id for Email, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute */
|
|
12
12
|
identifierType?: Brevo.UpdateContactRequestIdentifierType;
|
|
13
13
|
/** Pass the set of attributes to be updated. **These attributes must be present in your account**. To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, **{ "EMAIL":"newemail@domain.com", "FNAME":"Ellie", "LNAME":"Roger", "COUNTRIES":["India","China"]}**. The attribute's parameter should be passed in capital letter while updating a contact. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored .Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in **SMS** field should be passed with proper country code. For example: **{"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"}** */
|
|
14
14
|
attributes?: Record<string, UpdateContactRequest.Attributes.Value>;
|
|
@@ -24,6 +24,8 @@ export interface UpdateContactRequest {
|
|
|
24
24
|
smtpBlacklistSender?: string[];
|
|
25
25
|
/** Ids of the lists to remove the contact from */
|
|
26
26
|
unlinkListIds?: number[];
|
|
27
|
+
/** When true, if the contact being updated shares an identifier (email, SMS, ext_id, whatsapp, landline) with an existing contact, the two contacts are force-merged. The contact with the most recent `last_modified` timestamp is retained; the other is deleted. When false (default), a 4xx error is returned on identifier conflict. */
|
|
28
|
+
forceMerge?: boolean;
|
|
27
29
|
}
|
|
28
30
|
export declare namespace UpdateContactRequest {
|
|
29
31
|
namespace Attributes {
|
|
@@ -34,8 +34,10 @@ export declare namespace GetAttributesResponse {
|
|
|
34
34
|
interface Item {
|
|
35
35
|
/** Label of the "category" type attribute */
|
|
36
36
|
label: string;
|
|
37
|
-
/** ID of
|
|
37
|
+
/** Numeric ID of the "category" type attribute value. Set to 0 when the raw value cannot be converted to an integer (for example non-numeric values such as "en" or "fr"). Refer to `valueStr` for the original string representation. */
|
|
38
38
|
value: number;
|
|
39
|
+
/** String representation of the "category" type attribute value. Always contains the original value as stored. Use this field when the attribute value is non-numeric (e.g. "en", "fr") or when you need the exact string form alongside the numeric `value`. */
|
|
40
|
+
valueStr: string;
|
|
39
41
|
}
|
|
40
42
|
}
|
|
41
43
|
/** Type of the attribute */
|