@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
|
@@ -11,6 +11,8 @@ export declare class TransactionalEmailsClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<TransactionalEmailsClient.Options>;
|
|
12
12
|
constructor(options: TransactionalEmailsClient.Options);
|
|
13
13
|
/**
|
|
14
|
+
* Retrieve a paginated list of transactional contacts that have been blocked or unsubscribed, along with the reason for blocking (e.g. hard bounce, admin blocked, spam complaint, or unsubscription via email/API/Marketing Automation). Both `startDate` and `endDate` must be provided together when filtering by date range, and neither date can be in the future. Results default to 50 per page (max 100) and are sorted in descending order of record creation unless overridden with the `sort` parameter.
|
|
15
|
+
*
|
|
14
16
|
* @param {Brevo.GetTransacBlockedContactsRequest} request
|
|
15
17
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
16
18
|
*
|
|
@@ -22,6 +24,8 @@ export declare class TransactionalEmailsClient {
|
|
|
22
24
|
getTransacBlockedContacts(request?: Brevo.GetTransacBlockedContactsRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetTransacBlockedContactsResponse>;
|
|
23
25
|
private __getTransacBlockedContacts;
|
|
24
26
|
/**
|
|
27
|
+
* Unblock or resubscribe a transactional contact by removing their email address from the blacklist. The email address must be URL-encoded in the path parameter and must be a valid email format. If the contact is not found in the blocklist, a 404 error is returned.
|
|
28
|
+
*
|
|
25
29
|
* @param {Brevo.DeleteSmtpBlockedContactsEmailRequest} request
|
|
26
30
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
27
31
|
*
|
|
@@ -40,6 +44,8 @@ export declare class TransactionalEmailsClient {
|
|
|
40
44
|
*
|
|
41
45
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
42
46
|
*
|
|
47
|
+
* @throws {@link Brevo.BadRequestError}
|
|
48
|
+
*
|
|
43
49
|
* @example
|
|
44
50
|
* await client.transactionalEmails.getBlockedDomains()
|
|
45
51
|
*/
|
|
@@ -90,6 +96,8 @@ export declare class TransactionalEmailsClient {
|
|
|
90
96
|
deleteHardbounces(request?: Brevo.DeleteHardbouncesRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
91
97
|
private __deleteHardbounces;
|
|
92
98
|
/**
|
|
99
|
+
* Send a transactional email to one or more recipients, either using inline HTML content or a pre-built template via `templateId`. You can schedule emails for future delivery using `scheduledAt` (UTC, up to 5-minute delay), send multiple personalized versions with `messageVersions` (max 2000 total recipients, 99 per version), and attach files via URL or base64-encoded content. A `sender` and `subject` are required when no `templateId` is provided; when a `templateId` is used, the template''s sender and subject are applied unless overridden.
|
|
100
|
+
*
|
|
93
101
|
* @param {Brevo.SendTransacEmailRequest} request
|
|
94
102
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
95
103
|
*
|
|
@@ -184,6 +192,9 @@ export declare class TransactionalEmailsClient {
|
|
|
184
192
|
* @param {Brevo.GetTransacEmailContentRequest} request
|
|
185
193
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
186
194
|
*
|
|
195
|
+
* @throws {@link Brevo.BadRequestError}
|
|
196
|
+
* @throws {@link Brevo.NotFoundError}
|
|
197
|
+
*
|
|
187
198
|
* @example
|
|
188
199
|
* await client.transactionalEmails.getTransacEmailContent({
|
|
189
200
|
* uuid: "uuid"
|
|
@@ -192,6 +203,8 @@ export declare class TransactionalEmailsClient {
|
|
|
192
203
|
getTransacEmailContent(request: Brevo.GetTransacEmailContentRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetTransacEmailContentResponse>;
|
|
193
204
|
private __getTransacEmailContent;
|
|
194
205
|
/**
|
|
206
|
+
* Delete SMTP transactional log entries identified by a message ID (enclosed in angle brackets with an @ sign) or a valid email address. Optionally narrow the deletion to a specific date range using `from_date` and `to_date` query parameters (YYYY-MM-DD format). The operation also removes any associated stored email preview content.
|
|
207
|
+
*
|
|
195
208
|
* @param {Brevo.DeleteSmtpLogIdentifierRequest} request
|
|
196
209
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
197
210
|
*
|
|
@@ -232,6 +245,8 @@ export declare class TransactionalEmailsClient {
|
|
|
232
245
|
getEmailEventReport(request?: Brevo.GetEmailEventReportRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetEmailEventReportResponse>;
|
|
233
246
|
private __getEmailEventReport;
|
|
234
247
|
/**
|
|
248
|
+
* This endpoint will show the aggregated stats per day for the past 10 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 30 days.
|
|
249
|
+
*
|
|
235
250
|
* @param {Brevo.GetSmtpReportRequest} request
|
|
236
251
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
237
252
|
*
|
|
@@ -243,7 +258,9 @@ export declare class TransactionalEmailsClient {
|
|
|
243
258
|
getSmtpReport(request?: Brevo.GetSmtpReportRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetSmtpReportResponse>;
|
|
244
259
|
private __getSmtpReport;
|
|
245
260
|
/**
|
|
246
|
-
*
|
|
261
|
+
* Generate a fully rendered preview of a transactional email template by resolving dynamic variables. Provide either an `email` address (to populate variables from the contact''s attributes) or a `params` object with key-value pairs for manual substitution; at least one of these is required alongside the mandatory `templateId`. The response includes the rendered HTML, subject, sender details, preview text, and any feed names used in the template.
|
|
262
|
+
*
|
|
263
|
+
* @param {Brevo.PostPreviewSmtpEmailTemplatesRequest} request
|
|
247
264
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
248
265
|
*
|
|
249
266
|
* @throws {@link Brevo.BadRequestError}
|
|
@@ -253,9 +270,11 @@ export declare class TransactionalEmailsClient {
|
|
|
253
270
|
* "key": "value"
|
|
254
271
|
* })
|
|
255
272
|
*/
|
|
256
|
-
postPreviewSmtpEmailTemplates(request
|
|
273
|
+
postPreviewSmtpEmailTemplates(request: Brevo.PostPreviewSmtpEmailTemplatesRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<Brevo.PostPreviewSmtpEmailTemplatesResponse>;
|
|
257
274
|
private __postPreviewSmtpEmailTemplates;
|
|
258
275
|
/**
|
|
276
|
+
* Retrieve a paginated list of all transactional email templates (including automation templates) with their details such as name, subject, sender, status, HTML content, and timestamps. Results default to 50 per page (max 1000) and are sorted in descending creation order unless overridden. You can filter by active/inactive status using `templateStatus` and by editor type using `editorType` (currently only `richTextEditor` is supported).
|
|
277
|
+
*
|
|
259
278
|
* @param {Brevo.GetSmtpTemplatesRequest} request
|
|
260
279
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
261
280
|
*
|
|
@@ -267,6 +286,8 @@ export declare class TransactionalEmailsClient {
|
|
|
267
286
|
getSmtpTemplates(request?: Brevo.GetSmtpTemplatesRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetSmtpTemplatesResponse>;
|
|
268
287
|
private __getSmtpTemplates;
|
|
269
288
|
/**
|
|
289
|
+
* Create a new transactional email template with the specified sender, subject, and content. The `sender`, `subject`, and `templateName` fields are required. Template content can be provided via `htmlContent` (minimum 10 characters) or `htmlUrl`; at least one must be supplied. Templates are created as inactive by default unless `isActive` is explicitly set to `true`.
|
|
290
|
+
*
|
|
270
291
|
* @param {Brevo.CreateSmtpTemplateRequest} request
|
|
271
292
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
272
293
|
*
|
|
@@ -282,6 +303,8 @@ export declare class TransactionalEmailsClient {
|
|
|
282
303
|
createSmtpTemplate(request: Brevo.CreateSmtpTemplateRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateSmtpTemplateResponse>;
|
|
283
304
|
private __createSmtpTemplate;
|
|
284
305
|
/**
|
|
306
|
+
* Retrieve the full details of a specific transactional email template by its numeric ID or custom template identifier string. The response includes the template name, subject, sender information, HTML content, active status, creation and modification timestamps, reply-to address, tag, and a `doiTemplate` flag indicating whether the template is a double opt-in template (detected by the presence of optin-related tags or variables in the content).
|
|
307
|
+
*
|
|
285
308
|
* @param {Brevo.GetSmtpTemplateRequest} request
|
|
286
309
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
287
310
|
*
|
|
@@ -296,6 +319,8 @@ export declare class TransactionalEmailsClient {
|
|
|
296
319
|
getSmtpTemplate(request: Brevo.GetSmtpTemplateRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetSmtpTemplateOverview>;
|
|
297
320
|
private __getSmtpTemplate;
|
|
298
321
|
/**
|
|
322
|
+
* Update an existing transactional email template by its numeric ID or custom template identifier string. All fields in the request body are optional; only the provided fields will be updated. You can update the template name, subject, sender, reply-to address, HTML content (via `htmlContent` or `htmlUrl`), active status, tag, attachment URL, and the personalized `toField`. Only one of sender email or sender ID should be provided per request.
|
|
323
|
+
*
|
|
299
324
|
* @param {Brevo.UpdateSmtpTemplateRequest} request
|
|
300
325
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
301
326
|
*
|
|
@@ -310,6 +335,8 @@ export declare class TransactionalEmailsClient {
|
|
|
310
335
|
updateSmtpTemplate(request: Brevo.UpdateSmtpTemplateRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
311
336
|
private __updateSmtpTemplate;
|
|
312
337
|
/**
|
|
338
|
+
* Permanently delete a transactional email template by its numeric ID. Only inactive templates can be deleted; attempting to delete an active template returns a 405 error. To deactivate a template before deletion, use `PUT /smtp/templates/{templateId}` with `isActive` set to `false`. Deletion also removes associated newsletter template data and triggers asynchronous cleanup of shared assets.
|
|
339
|
+
*
|
|
313
340
|
* @param {Brevo.DeleteSmtpTemplateRequest} request
|
|
314
341
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
315
342
|
*
|
|
@@ -324,6 +351,8 @@ export declare class TransactionalEmailsClient {
|
|
|
324
351
|
deleteSmtpTemplate(request: Brevo.DeleteSmtpTemplateRequest, requestOptions?: TransactionalEmailsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
325
352
|
private __deleteSmtpTemplate;
|
|
326
353
|
/**
|
|
354
|
+
* Send a test email of the specified transactional template to one or more recipients. Provide an array of email addresses in the `emailTo` field; if left empty, the test mail is sent to your entire test list. You can send a maximum of 50 test emails per day, and all provided email addresses must be valid.
|
|
355
|
+
*
|
|
327
356
|
* @param {Brevo.SendTestTemplateRequest} request
|
|
328
357
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
329
358
|
*
|
|
@@ -67,6 +67,8 @@ class TransactionalEmailsClient {
|
|
|
67
67
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
70
|
+
* Retrieve a paginated list of transactional contacts that have been blocked or unsubscribed, along with the reason for blocking (e.g. hard bounce, admin blocked, spam complaint, or unsubscription via email/API/Marketing Automation). Both `startDate` and `endDate` must be provided together when filtering by date range, and neither date can be in the future. Results default to 50 per page (max 100) and are sorted in descending order of record creation unless overridden with the `sort` parameter.
|
|
71
|
+
*
|
|
70
72
|
* @param {Brevo.GetTransacBlockedContactsRequest} request
|
|
71
73
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
72
74
|
*
|
|
@@ -96,7 +98,12 @@ class TransactionalEmailsClient {
|
|
|
96
98
|
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, "smtp/blockedContacts"),
|
|
97
99
|
method: "GET",
|
|
98
100
|
headers: _headers,
|
|
99
|
-
|
|
101
|
+
queryString: core.url
|
|
102
|
+
.queryBuilder()
|
|
103
|
+
.addMany(_queryParams)
|
|
104
|
+
.add("senders", _queryParams.senders, { style: "comma" })
|
|
105
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
106
|
+
.build(),
|
|
100
107
|
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,
|
|
101
108
|
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,
|
|
102
109
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -125,6 +132,8 @@ class TransactionalEmailsClient {
|
|
|
125
132
|
});
|
|
126
133
|
}
|
|
127
134
|
/**
|
|
135
|
+
* Unblock or resubscribe a transactional contact by removing their email address from the blacklist. The email address must be URL-encoded in the path parameter and must be a valid email format. If the contact is not found in the blocklist, a 404 error is returned.
|
|
136
|
+
*
|
|
128
137
|
* @param {Brevo.DeleteSmtpBlockedContactsEmailRequest} request
|
|
129
138
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
130
139
|
*
|
|
@@ -149,7 +158,7 @@ class TransactionalEmailsClient {
|
|
|
149
158
|
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, `smtp/blockedContacts/${core.url.encodePathParam(email)}`),
|
|
150
159
|
method: "DELETE",
|
|
151
160
|
headers: _headers,
|
|
152
|
-
|
|
161
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
153
162
|
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,
|
|
154
163
|
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,
|
|
155
164
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -181,6 +190,8 @@ class TransactionalEmailsClient {
|
|
|
181
190
|
*
|
|
182
191
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
183
192
|
*
|
|
193
|
+
* @throws {@link Brevo.BadRequestError}
|
|
194
|
+
*
|
|
184
195
|
* @example
|
|
185
196
|
* await client.transactionalEmails.getBlockedDomains()
|
|
186
197
|
*/
|
|
@@ -196,7 +207,7 @@ class TransactionalEmailsClient {
|
|
|
196
207
|
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, "smtp/blockedDomains"),
|
|
197
208
|
method: "GET",
|
|
198
209
|
headers: _headers,
|
|
199
|
-
|
|
210
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
200
211
|
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,
|
|
201
212
|
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,
|
|
202
213
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -207,11 +218,16 @@ class TransactionalEmailsClient {
|
|
|
207
218
|
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
208
219
|
}
|
|
209
220
|
if (_response.error.reason === "status-code") {
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
221
|
+
switch (_response.error.statusCode) {
|
|
222
|
+
case 400:
|
|
223
|
+
throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
|
|
224
|
+
default:
|
|
225
|
+
throw new errors.BrevoError({
|
|
226
|
+
statusCode: _response.error.statusCode,
|
|
227
|
+
body: _response.error.body,
|
|
228
|
+
rawResponse: _response.rawResponse,
|
|
229
|
+
});
|
|
230
|
+
}
|
|
215
231
|
}
|
|
216
232
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/smtp/blockedDomains");
|
|
217
233
|
});
|
|
@@ -242,7 +258,7 @@ class TransactionalEmailsClient {
|
|
|
242
258
|
method: "POST",
|
|
243
259
|
headers: _headers,
|
|
244
260
|
contentType: "application/json",
|
|
245
|
-
|
|
261
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
246
262
|
requestType: "json",
|
|
247
263
|
body: request,
|
|
248
264
|
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,
|
|
@@ -296,7 +312,7 @@ class TransactionalEmailsClient {
|
|
|
296
312
|
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, `smtp/blockedDomains/${core.url.encodePathParam(domain)}`),
|
|
297
313
|
method: "DELETE",
|
|
298
314
|
headers: _headers,
|
|
299
|
-
|
|
315
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
300
316
|
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,
|
|
301
317
|
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,
|
|
302
318
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -347,7 +363,7 @@ class TransactionalEmailsClient {
|
|
|
347
363
|
method: "POST",
|
|
348
364
|
headers: _headers,
|
|
349
365
|
contentType: "application/json",
|
|
350
|
-
|
|
366
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
351
367
|
requestType: "json",
|
|
352
368
|
body: request,
|
|
353
369
|
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,
|
|
@@ -375,6 +391,8 @@ class TransactionalEmailsClient {
|
|
|
375
391
|
});
|
|
376
392
|
}
|
|
377
393
|
/**
|
|
394
|
+
* Send a transactional email to one or more recipients, either using inline HTML content or a pre-built template via `templateId`. You can schedule emails for future delivery using `scheduledAt` (UTC, up to 5-minute delay), send multiple personalized versions with `messageVersions` (max 2000 total recipients, 99 per version), and attach files via URL or base64-encoded content. A `sender` and `subject` are required when no `templateId` is provided; when a `templateId` is used, the template''s sender and subject are applied unless overridden.
|
|
395
|
+
*
|
|
378
396
|
* @param {Brevo.SendTransacEmailRequest} request
|
|
379
397
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
380
398
|
*
|
|
@@ -425,7 +443,7 @@ class TransactionalEmailsClient {
|
|
|
425
443
|
method: "POST",
|
|
426
444
|
headers: _headers,
|
|
427
445
|
contentType: "application/json",
|
|
428
|
-
|
|
446
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
429
447
|
requestType: "json",
|
|
430
448
|
body: request,
|
|
431
449
|
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,
|
|
@@ -479,7 +497,7 @@ class TransactionalEmailsClient {
|
|
|
479
497
|
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, `smtp/email/${core.url.encodePathParam(identifier)}`),
|
|
480
498
|
method: "DELETE",
|
|
481
499
|
headers: _headers,
|
|
482
|
-
|
|
500
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
483
501
|
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,
|
|
484
502
|
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,
|
|
485
503
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -543,7 +561,11 @@ class TransactionalEmailsClient {
|
|
|
543
561
|
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, `smtp/emailStatus/${core.url.encodePathParam(identifier)}`),
|
|
544
562
|
method: "GET",
|
|
545
563
|
headers: _headers,
|
|
546
|
-
|
|
564
|
+
queryString: core.url
|
|
565
|
+
.queryBuilder()
|
|
566
|
+
.addMany(_queryParams)
|
|
567
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
568
|
+
.build(),
|
|
547
569
|
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,
|
|
548
570
|
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,
|
|
549
571
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -604,7 +626,11 @@ class TransactionalEmailsClient {
|
|
|
604
626
|
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, "smtp/emails"),
|
|
605
627
|
method: "GET",
|
|
606
628
|
headers: _headers,
|
|
607
|
-
|
|
629
|
+
queryString: core.url
|
|
630
|
+
.queryBuilder()
|
|
631
|
+
.addMany(_queryParams)
|
|
632
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
633
|
+
.build(),
|
|
608
634
|
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,
|
|
609
635
|
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,
|
|
610
636
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -637,6 +663,9 @@ class TransactionalEmailsClient {
|
|
|
637
663
|
* @param {Brevo.GetTransacEmailContentRequest} request
|
|
638
664
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
639
665
|
*
|
|
666
|
+
* @throws {@link Brevo.BadRequestError}
|
|
667
|
+
* @throws {@link Brevo.NotFoundError}
|
|
668
|
+
*
|
|
640
669
|
* @example
|
|
641
670
|
* await client.transactionalEmails.getTransacEmailContent({
|
|
642
671
|
* uuid: "uuid"
|
|
@@ -655,7 +684,7 @@ class TransactionalEmailsClient {
|
|
|
655
684
|
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, `smtp/emails/${core.url.encodePathParam(uuid)}`),
|
|
656
685
|
method: "GET",
|
|
657
686
|
headers: _headers,
|
|
658
|
-
|
|
687
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
659
688
|
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,
|
|
660
689
|
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,
|
|
661
690
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -666,16 +695,25 @@ class TransactionalEmailsClient {
|
|
|
666
695
|
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
667
696
|
}
|
|
668
697
|
if (_response.error.reason === "status-code") {
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
698
|
+
switch (_response.error.statusCode) {
|
|
699
|
+
case 400:
|
|
700
|
+
throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
|
|
701
|
+
case 404:
|
|
702
|
+
throw new Brevo.NotFoundError(_response.error.body, _response.rawResponse);
|
|
703
|
+
default:
|
|
704
|
+
throw new errors.BrevoError({
|
|
705
|
+
statusCode: _response.error.statusCode,
|
|
706
|
+
body: _response.error.body,
|
|
707
|
+
rawResponse: _response.rawResponse,
|
|
708
|
+
});
|
|
709
|
+
}
|
|
674
710
|
}
|
|
675
711
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/smtp/emails/{uuid}");
|
|
676
712
|
});
|
|
677
713
|
}
|
|
678
714
|
/**
|
|
715
|
+
* Delete SMTP transactional log entries identified by a message ID (enclosed in angle brackets with an @ sign) or a valid email address. Optionally narrow the deletion to a specific date range using `from_date` and `to_date` query parameters (YYYY-MM-DD format). The operation also removes any associated stored email preview content.
|
|
716
|
+
*
|
|
679
717
|
* @param {Brevo.DeleteSmtpLogIdentifierRequest} request
|
|
680
718
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
681
719
|
*
|
|
@@ -693,14 +731,22 @@ class TransactionalEmailsClient {
|
|
|
693
731
|
__deleteAnSmtpTransactionalLog(request, requestOptions) {
|
|
694
732
|
return __awaiter(this, void 0, void 0, function* () {
|
|
695
733
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
696
|
-
const { identifier } = request;
|
|
734
|
+
const { identifier, from_date: fromDate, to_date: toDate } = request;
|
|
735
|
+
const _queryParams = {
|
|
736
|
+
from_date: fromDate,
|
|
737
|
+
to_date: toDate,
|
|
738
|
+
};
|
|
697
739
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
698
740
|
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);
|
|
699
741
|
const _response = yield core.fetcher({
|
|
700
742
|
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, `smtp/log/${core.url.encodePathParam(identifier)}`),
|
|
701
743
|
method: "DELETE",
|
|
702
744
|
headers: _headers,
|
|
703
|
-
|
|
745
|
+
queryString: core.url
|
|
746
|
+
.queryBuilder()
|
|
747
|
+
.addMany(_queryParams)
|
|
748
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
749
|
+
.build(),
|
|
704
750
|
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
751
|
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
752
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -757,7 +803,11 @@ class TransactionalEmailsClient {
|
|
|
757
803
|
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, "smtp/statistics/aggregatedReport"),
|
|
758
804
|
method: "GET",
|
|
759
805
|
headers: _headers,
|
|
760
|
-
|
|
806
|
+
queryString: core.url
|
|
807
|
+
.queryBuilder()
|
|
808
|
+
.addMany(_queryParams)
|
|
809
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
810
|
+
.build(),
|
|
761
811
|
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,
|
|
762
812
|
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,
|
|
763
813
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -822,7 +872,11 @@ class TransactionalEmailsClient {
|
|
|
822
872
|
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, "smtp/statistics/events"),
|
|
823
873
|
method: "GET",
|
|
824
874
|
headers: _headers,
|
|
825
|
-
|
|
875
|
+
queryString: core.url
|
|
876
|
+
.queryBuilder()
|
|
877
|
+
.addMany(_queryParams)
|
|
878
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
879
|
+
.build(),
|
|
826
880
|
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,
|
|
827
881
|
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,
|
|
828
882
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -848,6 +902,8 @@ class TransactionalEmailsClient {
|
|
|
848
902
|
});
|
|
849
903
|
}
|
|
850
904
|
/**
|
|
905
|
+
* This endpoint will show the aggregated stats per day for the past 10 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 30 days.
|
|
906
|
+
*
|
|
851
907
|
* @param {Brevo.GetSmtpReportRequest} request
|
|
852
908
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
853
909
|
*
|
|
@@ -878,7 +934,11 @@ class TransactionalEmailsClient {
|
|
|
878
934
|
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, "smtp/statistics/reports"),
|
|
879
935
|
method: "GET",
|
|
880
936
|
headers: _headers,
|
|
881
|
-
|
|
937
|
+
queryString: core.url
|
|
938
|
+
.queryBuilder()
|
|
939
|
+
.addMany(_queryParams)
|
|
940
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
941
|
+
.build(),
|
|
882
942
|
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,
|
|
883
943
|
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,
|
|
884
944
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -904,7 +964,9 @@ class TransactionalEmailsClient {
|
|
|
904
964
|
});
|
|
905
965
|
}
|
|
906
966
|
/**
|
|
907
|
-
*
|
|
967
|
+
* Generate a fully rendered preview of a transactional email template by resolving dynamic variables. Provide either an `email` address (to populate variables from the contact''s attributes) or a `params` object with key-value pairs for manual substitution; at least one of these is required alongside the mandatory `templateId`. The response includes the rendered HTML, subject, sender details, preview text, and any feed names used in the template.
|
|
968
|
+
*
|
|
969
|
+
* @param {Brevo.PostPreviewSmtpEmailTemplatesRequest} request
|
|
908
970
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
909
971
|
*
|
|
910
972
|
* @throws {@link Brevo.BadRequestError}
|
|
@@ -927,7 +989,7 @@ class TransactionalEmailsClient {
|
|
|
927
989
|
method: "POST",
|
|
928
990
|
headers: _headers,
|
|
929
991
|
contentType: "application/json",
|
|
930
|
-
|
|
992
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
931
993
|
requestType: "json",
|
|
932
994
|
body: request,
|
|
933
995
|
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,
|
|
@@ -958,6 +1020,8 @@ class TransactionalEmailsClient {
|
|
|
958
1020
|
});
|
|
959
1021
|
}
|
|
960
1022
|
/**
|
|
1023
|
+
* Retrieve a paginated list of all transactional email templates (including automation templates) with their details such as name, subject, sender, status, HTML content, and timestamps. Results default to 50 per page (max 1000) and are sorted in descending creation order unless overridden. You can filter by active/inactive status using `templateStatus` and by editor type using `editorType` (currently only `richTextEditor` is supported).
|
|
1024
|
+
*
|
|
961
1025
|
* @param {Brevo.GetSmtpTemplatesRequest} request
|
|
962
1026
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
963
1027
|
*
|
|
@@ -972,12 +1036,13 @@ class TransactionalEmailsClient {
|
|
|
972
1036
|
__getSmtpTemplates() {
|
|
973
1037
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
974
1038
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
975
|
-
const { templateStatus, limit, offset, sort } = request;
|
|
1039
|
+
const { templateStatus, limit, offset, sort, editorType } = request;
|
|
976
1040
|
const _queryParams = {
|
|
977
1041
|
templateStatus,
|
|
978
1042
|
limit,
|
|
979
1043
|
offset,
|
|
980
1044
|
sort: sort != null ? sort : undefined,
|
|
1045
|
+
editorType: editorType != null ? editorType : undefined,
|
|
981
1046
|
};
|
|
982
1047
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
983
1048
|
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);
|
|
@@ -985,7 +1050,11 @@ class TransactionalEmailsClient {
|
|
|
985
1050
|
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, "smtp/templates"),
|
|
986
1051
|
method: "GET",
|
|
987
1052
|
headers: _headers,
|
|
988
|
-
|
|
1053
|
+
queryString: core.url
|
|
1054
|
+
.queryBuilder()
|
|
1055
|
+
.addMany(_queryParams)
|
|
1056
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
1057
|
+
.build(),
|
|
989
1058
|
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,
|
|
990
1059
|
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,
|
|
991
1060
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -1011,6 +1080,8 @@ class TransactionalEmailsClient {
|
|
|
1011
1080
|
});
|
|
1012
1081
|
}
|
|
1013
1082
|
/**
|
|
1083
|
+
* Create a new transactional email template with the specified sender, subject, and content. The `sender`, `subject`, and `templateName` fields are required. Template content can be provided via `htmlContent` (minimum 10 characters) or `htmlUrl`; at least one must be supplied. Templates are created as inactive by default unless `isActive` is explicitly set to `true`.
|
|
1084
|
+
*
|
|
1014
1085
|
* @param {Brevo.CreateSmtpTemplateRequest} request
|
|
1015
1086
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1016
1087
|
*
|
|
@@ -1036,7 +1107,7 @@ class TransactionalEmailsClient {
|
|
|
1036
1107
|
method: "POST",
|
|
1037
1108
|
headers: _headers,
|
|
1038
1109
|
contentType: "application/json",
|
|
1039
|
-
|
|
1110
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
1040
1111
|
requestType: "json",
|
|
1041
1112
|
body: request,
|
|
1042
1113
|
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,
|
|
@@ -1064,6 +1135,8 @@ class TransactionalEmailsClient {
|
|
|
1064
1135
|
});
|
|
1065
1136
|
}
|
|
1066
1137
|
/**
|
|
1138
|
+
* Retrieve the full details of a specific transactional email template by its numeric ID or custom template identifier string. The response includes the template name, subject, sender information, HTML content, active status, creation and modification timestamps, reply-to address, tag, and a `doiTemplate` flag indicating whether the template is a double opt-in template (detected by the presence of optin-related tags or variables in the content).
|
|
1139
|
+
*
|
|
1067
1140
|
* @param {Brevo.GetSmtpTemplateRequest} request
|
|
1068
1141
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1069
1142
|
*
|
|
@@ -1088,7 +1161,7 @@ class TransactionalEmailsClient {
|
|
|
1088
1161
|
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, `smtp/templates/${core.url.encodePathParam(templateId)}`),
|
|
1089
1162
|
method: "GET",
|
|
1090
1163
|
headers: _headers,
|
|
1091
|
-
|
|
1164
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
1092
1165
|
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,
|
|
1093
1166
|
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,
|
|
1094
1167
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -1116,6 +1189,8 @@ class TransactionalEmailsClient {
|
|
|
1116
1189
|
});
|
|
1117
1190
|
}
|
|
1118
1191
|
/**
|
|
1192
|
+
* Update an existing transactional email template by its numeric ID or custom template identifier string. All fields in the request body are optional; only the provided fields will be updated. You can update the template name, subject, sender, reply-to address, HTML content (via `htmlContent` or `htmlUrl`), active status, tag, attachment URL, and the personalized `toField`. Only one of sender email or sender ID should be provided per request.
|
|
1193
|
+
*
|
|
1119
1194
|
* @param {Brevo.UpdateSmtpTemplateRequest} request
|
|
1120
1195
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1121
1196
|
*
|
|
@@ -1141,7 +1216,7 @@ class TransactionalEmailsClient {
|
|
|
1141
1216
|
method: "PUT",
|
|
1142
1217
|
headers: _headers,
|
|
1143
1218
|
contentType: "application/json",
|
|
1144
|
-
|
|
1219
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
1145
1220
|
requestType: "json",
|
|
1146
1221
|
body: _body,
|
|
1147
1222
|
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,
|
|
@@ -1171,6 +1246,8 @@ class TransactionalEmailsClient {
|
|
|
1171
1246
|
});
|
|
1172
1247
|
}
|
|
1173
1248
|
/**
|
|
1249
|
+
* Permanently delete a transactional email template by its numeric ID. Only inactive templates can be deleted; attempting to delete an active template returns a 405 error. To deactivate a template before deletion, use `PUT /smtp/templates/{templateId}` with `isActive` set to `false`. Deletion also removes associated newsletter template data and triggers asynchronous cleanup of shared assets.
|
|
1250
|
+
*
|
|
1174
1251
|
* @param {Brevo.DeleteSmtpTemplateRequest} request
|
|
1175
1252
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1176
1253
|
*
|
|
@@ -1195,7 +1272,7 @@ class TransactionalEmailsClient {
|
|
|
1195
1272
|
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, `smtp/templates/${core.url.encodePathParam(templateId)}`),
|
|
1196
1273
|
method: "DELETE",
|
|
1197
1274
|
headers: _headers,
|
|
1198
|
-
|
|
1275
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
1199
1276
|
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,
|
|
1200
1277
|
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,
|
|
1201
1278
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -1223,6 +1300,8 @@ class TransactionalEmailsClient {
|
|
|
1223
1300
|
});
|
|
1224
1301
|
}
|
|
1225
1302
|
/**
|
|
1303
|
+
* Send a test email of the specified transactional template to one or more recipients. Provide an array of email addresses in the `emailTo` field; if left empty, the test mail is sent to your entire test list. You can send a maximum of 50 test emails per day, and all provided email addresses must be valid.
|
|
1304
|
+
*
|
|
1226
1305
|
* @param {Brevo.SendTestTemplateRequest} request
|
|
1227
1306
|
* @param {TransactionalEmailsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1228
1307
|
*
|
|
@@ -1249,7 +1328,7 @@ class TransactionalEmailsClient {
|
|
|
1249
1328
|
method: "POST",
|
|
1250
1329
|
headers: _headers,
|
|
1251
1330
|
contentType: "application/json",
|
|
1252
|
-
|
|
1331
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
1253
1332
|
requestType: "json",
|
|
1254
1333
|
body: _body,
|
|
1255
1334
|
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,
|
|
@@ -5,6 +5,6 @@
|
|
|
5
5
|
* }
|
|
6
6
|
*/
|
|
7
7
|
export interface DeleteScheduledEmailByIdRequest {
|
|
8
|
-
/** The `batchId` of scheduled emails batch (
|
|
8
|
+
/** The `batchId` of scheduled emails batch (must be a valid UUIDv4) or the `messageId` of scheduled email (enclosed in angle brackets with @ sign, e.g. `<...@domain>`). */
|
|
9
9
|
identifier: string;
|
|
10
10
|
}
|
|
@@ -5,6 +5,10 @@
|
|
|
5
5
|
* }
|
|
6
6
|
*/
|
|
7
7
|
export interface DeleteSmtpLogIdentifierRequest {
|
|
8
|
-
/** MessageId of the transactional log(s) to delete */
|
|
8
|
+
/** MessageId or email address of the transactional log(s) to delete. Must be a valid message ID (enclosed in angle brackets with @ sign) or a valid email address. */
|
|
9
9
|
identifier: string;
|
|
10
|
+
/** Starting date (YYYY-MM-DD) to narrow down logs for deletion */
|
|
11
|
+
from_date?: string;
|
|
12
|
+
/** Ending date (YYYY-MM-DD) to narrow down logs for deletion */
|
|
13
|
+
to_date?: string;
|
|
10
14
|
}
|
|
@@ -7,7 +7,7 @@ export interface GetAggregatedSmtpReportRequest {
|
|
|
7
7
|
startDate?: string;
|
|
8
8
|
/** **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate */
|
|
9
9
|
endDate?: string;
|
|
10
|
-
/** Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_ */
|
|
10
|
+
/** Number of days in the past including today (positive integer, maximum 90). _Not compatible with 'startDate' and 'endDate'_. Defaults to 90 if neither dates nor days are provided. */
|
|
11
11
|
days?: number;
|
|
12
12
|
/** Tag of the emails */
|
|
13
13
|
tag?: string;
|
package/dist/cjs/api/resources/transactionalEmails/client/requests/GetEmailEventReportRequest.d.ts
CHANGED
|
@@ -12,7 +12,7 @@ export interface GetEmailEventReportRequest {
|
|
|
12
12
|
startDate?: string;
|
|
13
13
|
/** **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate */
|
|
14
14
|
endDate?: string;
|
|
15
|
-
/** Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_ */
|
|
15
|
+
/** Number of days in the past including today (positive integer, maximum 90). _Not compatible with 'startDate' and 'endDate'_. Defaults to 30 if neither dates nor days are provided. */
|
|
16
16
|
days?: number;
|
|
17
17
|
/** Filter the report for a specific email addresses */
|
|
18
18
|
email?: string;
|
package/dist/cjs/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.ts
CHANGED
|
@@ -8,9 +8,9 @@ import type * as Brevo from "../../../../index.js";
|
|
|
8
8
|
* }
|
|
9
9
|
*/
|
|
10
10
|
export interface GetScheduledEmailByIdRequest {
|
|
11
|
-
/** The `batchId` of scheduled emails batch (
|
|
11
|
+
/** The `batchId` of scheduled emails batch (must be a valid UUIDv4) or the `messageId` of scheduled email (enclosed in angle brackets with @ sign, e.g. `<...@domain>`). When using `messageId`, the `limit`, `offset`, `sort`, and `status` query parameters are ignored. */
|
|
12
12
|
identifier: string;
|
|
13
|
-
/** Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list.
|
|
13
|
+
/** Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Cannot be more than 30 days older than the current date. */
|
|
14
14
|
startDate?: string;
|
|
15
15
|
/** Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. */
|
|
16
16
|
endDate?: string;
|