@getbrevo/brevo 5.0.4 → 6.0.2
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 +13 -0
- package/dist/cjs/BaseClient.js +17 -2
- package/dist/cjs/Client.d.ts +6 -0
- package/dist/cjs/Client.js +68 -58
- package/dist/cjs/api/errors/BadRequestError.js +1 -1
- package/dist/cjs/api/errors/ConflictError.js +1 -1
- package/dist/cjs/api/errors/ExpectationFailedError.js +1 -1
- package/dist/cjs/api/errors/FailedDependencyError.js +1 -1
- package/dist/cjs/api/errors/ForbiddenError.js +1 -1
- package/dist/cjs/api/errors/InternalServerError.js +1 -1
- package/dist/cjs/api/errors/MethodNotAllowedError.js +1 -1
- package/dist/cjs/api/errors/NotFoundError.js +1 -1
- package/dist/cjs/api/errors/PaymentRequiredError.js +1 -1
- package/dist/cjs/api/errors/PreconditionFailedError.js +1 -1
- package/dist/cjs/api/errors/TooEarlyError.js +1 -1
- package/dist/cjs/api/errors/TooManyRequestsError.js +1 -1
- package/dist/cjs/api/errors/UnauthorizedError.js +1 -1
- package/dist/cjs/api/errors/UnprocessableEntityError.js +1 -1
- package/dist/cjs/api/errors/UnsupportedMediaTypeError.js +1 -1
- 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 +9 -8
- 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/consentGroups/client/Client.d.ts +108 -0
- package/dist/cjs/api/resources/consentGroups/client/Client.js +383 -0
- package/dist/cjs/api/resources/consentGroups/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/{event/types → consentGroups/client}/index.js +1 -1
- package/dist/cjs/api/resources/consentGroups/client/requests/CreateConsentGroupRequest.d.ts +25 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/CreateConsentGroupRequest.js +12 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/DeleteConsentGroupRequest.d.ts +10 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/GetConsentGroupRequest.d.ts +10 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/GetConsentGroupRequest.js +3 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/GetConsentGroupsRequest.d.ts +17 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/GetConsentGroupsRequest.js +3 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/UpdateConsentGroupRequest.d.ts +24 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/UpdateConsentGroupRequest.js +12 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/index.d.ts +5 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/index.js +7 -0
- package/dist/cjs/api/resources/consentGroups/exports.d.ts +2 -0
- package/dist/cjs/api/resources/consentGroups/exports.js +21 -0
- package/dist/cjs/api/resources/consentGroups/index.d.ts +2 -0
- package/dist/cjs/api/resources/consentGroups/index.js +18 -0
- package/dist/cjs/api/resources/consentGroups/types/GetConsentGroupsRequestSignupMode.d.ts +5 -0
- package/dist/cjs/api/resources/consentGroups/types/GetConsentGroupsRequestSignupMode.js +8 -0
- package/dist/cjs/api/resources/consentGroups/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/consentGroups/types/index.js +17 -0
- package/dist/cjs/api/resources/contacts/client/Client.d.ts +37 -0
- package/dist/cjs/api/resources/contacts/client/Client.js +125 -36
- package/dist/cjs/api/resources/contacts/client/requests/CreateContactRequest.d.ts +4 -0
- package/dist/cjs/api/resources/contacts/client/requests/GetContactInfoRequest.d.ts +2 -2
- package/dist/cjs/api/resources/contacts/client/requests/GetContactStatsRequest.d.ts +2 -2
- package/dist/cjs/api/resources/contacts/client/requests/GetContactsRequest.d.ts +3 -1
- package/dist/cjs/api/resources/contacts/client/requests/GetListRequest.d.ts +1 -1
- package/dist/cjs/api/resources/contacts/client/requests/ImportContactsRequest.d.ts +2 -0
- package/dist/cjs/api/resources/contacts/client/requests/UpdateContactRequest.d.ts +4 -2
- package/dist/cjs/api/resources/contacts/types/GetAttributesResponse.d.ts +3 -1
- package/dist/cjs/api/resources/contacts/types/GetContactInfoResponse.d.ts +8 -3
- package/dist/cjs/api/resources/contacts/types/GetContactStatsResponse.d.ts +1 -1
- 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 +62 -22
- package/dist/cjs/api/resources/deals/client/requests/GetCrmDealsRequest.d.ts +11 -3
- package/dist/cjs/api/resources/deals/client/requests/PatchCrmDealsIdRequest.d.ts +1 -1
- package/dist/cjs/api/resources/deals/client/requests/PostCrmDealsImportRequest.d.ts +1 -1
- package/dist/cjs/api/resources/deals/types/GetCrmAttributesDealsResponseItem.d.ts +20 -4
- package/dist/cjs/api/resources/domains/client/Client.js +5 -5
- package/dist/cjs/api/resources/ecommerce/client/Client.d.ts +30 -1
- package/dist/cjs/api/resources/ecommerce/client/Client.js +73 -20
- package/dist/cjs/api/resources/ecommerce/client/requests/CreateBatchOrderRequest.d.ts +2 -2
- package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.ts +4 -2
- package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateProductRequest.d.ts +4 -2
- package/dist/cjs/api/resources/ecommerce/client/requests/GetEcommerceAttributionMetricsRequest.d.ts +2 -1
- package/dist/cjs/api/resources/ecommerce/client/requests/GetProductsRequest.d.ts +18 -2
- package/dist/cjs/api/resources/ecommerce/types/CreateBatchOrderResponse.d.ts +2 -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/CreateBatchEventsRequest.js +3 -0
- package/dist/cjs/api/resources/event/client/requests/CreateEventRequest.d.ts +3 -3
- package/dist/cjs/api/resources/event/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/event/index.d.ts +0 -1
- package/dist/cjs/api/resources/event/index.js +0 -1
- package/dist/cjs/api/resources/externalFeeds/client/Client.js +9 -5
- package/dist/cjs/api/resources/externalFeeds/types/GetAllExternalFeedsResponse.d.ts +3 -7
- package/dist/cjs/api/resources/externalFeeds/types/GetExternalFeedByUuidResponse.d.ts +3 -9
- package/dist/cjs/api/resources/files/client/Client.d.ts +10 -0
- package/dist/cjs/api/resources/files/client/Client.js +19 -5
- package/dist/cjs/api/resources/inboundParsing/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/inboundParsing/client/Client.js +11 -4
- package/dist/cjs/api/resources/inboundParsing/client/requests/GetInboundEmailEventsRequest.d.ts +2 -2
- package/dist/cjs/api/resources/inboundParsing/types/GetInboundEmailEventsByUuidResponse.d.ts +2 -2
- package/dist/cjs/api/resources/index.d.ts +5 -1
- package/dist/cjs/api/resources/index.js +6 -2
- package/dist/cjs/api/resources/masterAccount/client/Client.d.ts +10 -0
- package/dist/cjs/api/resources/masterAccount/client/Client.js +84 -46
- package/dist/cjs/api/resources/notes/client/Client.d.ts +12 -2
- package/dist/cjs/api/resources/notes/client/Client.js +21 -7
- package/dist/cjs/api/resources/notes/client/requests/PatchCrmNotesIdRequest.d.ts +1 -1
- package/dist/cjs/api/resources/notes/types/PostCrmNotesResponse.d.ts +1 -1
- package/dist/cjs/api/resources/payments/client/Client.d.ts +6 -0
- package/dist/cjs/api/resources/payments/client/Client.js +9 -3
- package/dist/cjs/api/resources/process/client/Client.d.ts +13 -18
- package/dist/cjs/api/resources/process/client/Client.js +19 -20
- package/dist/cjs/api/resources/process/types/GetProcessResponse.d.ts +19 -36
- package/dist/cjs/api/resources/process/types/GetProcessesResponse.d.ts +19 -36
- package/dist/cjs/api/resources/program/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/program/client/Client.js +26 -14
- package/dist/cjs/api/resources/program/client/requests/GetLpListRequest.d.ts +2 -2
- package/dist/cjs/api/resources/program/client/requests/SubscribeToLoyaltyProgramRequest.d.ts +5 -3
- package/dist/cjs/api/resources/program/types/GetLpListRequestSort.d.ts +5 -0
- package/dist/cjs/api/resources/program/types/GetLpListRequestSort.js +8 -0
- package/dist/cjs/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.ts +2 -0
- package/dist/cjs/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.ts +4 -4
- package/dist/cjs/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.ts +10 -8
- package/dist/cjs/api/resources/program/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/program/types/index.js +1 -0
- package/dist/cjs/api/resources/reward/client/Client.js +26 -10
- package/dist/cjs/api/resources/reward/client/requests/CreateVoucherRequest.d.ts +2 -0
- package/dist/cjs/api/resources/reward/client/requests/RedeemVoucherRequest.d.ts +2 -0
- package/dist/cjs/api/resources/reward/types/CreateRewardResponse.d.ts +7 -7
- package/dist/cjs/api/resources/reward/types/CreateVoucherResponse.d.ts +2 -0
- package/dist/cjs/api/resources/reward/types/GetLoyaltyOfferProgramsPidVouchersResponse.d.ts +2 -0
- package/dist/cjs/api/resources/senders/client/Client.js +11 -7
- package/dist/cjs/api/resources/senders/types/GetIpsResponse.d.ts +2 -2
- package/dist/cjs/api/resources/smsCampaigns/client/Client.d.ts +16 -0
- package/dist/cjs/api/resources/smsCampaigns/client/Client.js +30 -10
- package/dist/cjs/api/resources/smsCampaigns/client/requests/GetSmsCampaignsRequest.d.ts +3 -3
- package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.ts +38 -2
- package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.ts +7 -1
- package/dist/cjs/api/resources/smsTemplates/client/Client.js +5 -1
- package/dist/cjs/api/resources/tasks/client/Client.d.ts +16 -2
- package/dist/cjs/api/resources/tasks/client/Client.js +35 -12
- package/dist/cjs/api/resources/tasks/client/requests/PostCrmTasksRequest.d.ts +1 -1
- package/dist/cjs/api/resources/tasks/types/{GetCrmTasktypesResponse.d.ts → GetCrmTasktypesResponseItem.d.ts} +1 -4
- package/dist/cjs/api/resources/tasks/types/GetCrmTasktypesResponseItem.js +3 -0
- package/dist/cjs/api/resources/tasks/types/index.d.ts +1 -1
- package/dist/cjs/api/resources/tasks/types/index.js +1 -1
- package/dist/cjs/api/resources/tier/client/Client.js +22 -10
- package/dist/cjs/api/resources/tier/client/requests/CreateTierGroupRequest.d.ts +62 -0
- package/dist/cjs/api/resources/tier/client/requests/CreateTierGroupRequest.js +30 -0
- package/dist/cjs/api/resources/transactionalEmails/client/Client.d.ts +31 -2
- package/dist/cjs/api/resources/transactionalEmails/client/Client.js +114 -35
- package/dist/cjs/api/resources/transactionalEmails/client/requests/DeleteScheduledEmailByIdRequest.d.ts +1 -1
- package/dist/cjs/api/resources/transactionalEmails/client/requests/DeleteSmtpLogIdentifierRequest.d.ts +5 -1
- package/dist/cjs/api/resources/transactionalEmails/client/requests/GetAggregatedSmtpReportRequest.d.ts +1 -1
- package/dist/cjs/api/resources/transactionalEmails/client/requests/GetEmailEventReportRequest.d.ts +1 -1
- package/dist/cjs/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.ts +2 -2
- package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpReportRequest.d.ts +1 -1
- package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpTemplateRequest.d.ts +3 -2
- package/dist/cjs/api/resources/transactionalEmails/client/requests/GetSmtpTemplatesRequest.d.ts +2 -0
- package/dist/cjs/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.ts +3 -2
- package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.d.ts +1 -0
- package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.js +3 -0
- package/dist/cjs/api/resources/transactionalEmails/types/GetTransacBlockedContactsResponse.d.ts +1 -1
- 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/wallet/client/Client.d.ts +34 -0
- package/dist/cjs/api/resources/wallet/client/Client.js +126 -0
- package/dist/cjs/api/resources/wallet/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/wallet/client/index.js +17 -0
- package/dist/cjs/api/resources/wallet/client/requests/GetWalletPassInstallUrlRequest.d.ts +13 -0
- package/dist/cjs/api/resources/wallet/client/requests/GetWalletPassInstallUrlRequest.js +3 -0
- package/dist/cjs/api/resources/wallet/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/wallet/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/wallet/exports.d.ts +2 -0
- package/dist/cjs/api/resources/wallet/exports.js +21 -0
- package/dist/cjs/api/resources/wallet/index.d.ts +1 -0
- package/dist/cjs/api/resources/wallet/index.js +17 -0
- 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/ConsentGroup.d.ts +29 -0
- package/dist/cjs/api/types/ConsentGroup.js +12 -0
- package/dist/cjs/api/types/ConsentGroupItem.d.ts +17 -0
- package/dist/cjs/api/types/ConsentGroupItem.js +12 -0
- package/dist/cjs/api/types/ConsentGroupsListResponse.d.ts +14 -0
- package/dist/cjs/api/types/ConsentGroupsListResponse.js +3 -0
- 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 +15 -15
- package/dist/cjs/api/types/GetContactDetails.d.ts +5 -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/api/types/WalletPassInstallUrl.d.ts +4 -0
- package/dist/cjs/api/types/WalletPassInstallUrl.js +3 -0
- package/dist/cjs/api/types/index.d.ts +4 -0
- package/dist/cjs/api/types/index.js +4 -0
- package/dist/cjs/core/auth/AuthProvider.d.ts +1 -0
- package/dist/cjs/core/auth/AuthProvider.js +7 -0
- package/dist/cjs/core/auth/index.d.ts +1 -1
- package/dist/cjs/core/auth/index.js +3 -1
- package/dist/cjs/core/fetcher/Fetcher.d.ts +6 -0
- package/dist/cjs/core/fetcher/Fetcher.js +9 -8
- package/dist/cjs/core/fetcher/getResponseBody.js +11 -0
- package/dist/cjs/core/fetcher/requestWithRetries.js +4 -1
- package/dist/cjs/core/fetcher/signals.js +9 -1
- package/dist/cjs/core/url/QueryStringBuilder.d.ts +47 -0
- package/dist/cjs/core/url/QueryStringBuilder.js +83 -0
- package/dist/cjs/core/url/index.d.ts +1 -0
- package/dist/cjs/core/url/index.js +3 -1
- package/dist/cjs/core/url/qs.d.ts +2 -1
- package/dist/cjs/core/url/qs.js +25 -13
- package/dist/cjs/errors/BrevoError.d.ts +1 -0
- package/dist/cjs/errors/BrevoError.js +5 -1
- package/dist/cjs/errors/BrevoTimeoutError.d.ts +2 -2
- package/dist/cjs/errors/BrevoTimeoutError.js +40 -6
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.d.mts +13 -0
- package/dist/esm/BaseClient.mjs +17 -2
- package/dist/esm/Client.d.mts +6 -0
- package/dist/esm/Client.mjs +10 -0
- package/dist/esm/api/errors/BadRequestError.mjs +1 -1
- package/dist/esm/api/errors/ConflictError.mjs +1 -1
- package/dist/esm/api/errors/ExpectationFailedError.mjs +1 -1
- package/dist/esm/api/errors/FailedDependencyError.mjs +1 -1
- package/dist/esm/api/errors/ForbiddenError.mjs +1 -1
- package/dist/esm/api/errors/InternalServerError.mjs +1 -1
- package/dist/esm/api/errors/MethodNotAllowedError.mjs +1 -1
- package/dist/esm/api/errors/NotFoundError.mjs +1 -1
- package/dist/esm/api/errors/PaymentRequiredError.mjs +1 -1
- package/dist/esm/api/errors/PreconditionFailedError.mjs +1 -1
- package/dist/esm/api/errors/TooEarlyError.mjs +1 -1
- package/dist/esm/api/errors/TooManyRequestsError.mjs +1 -1
- package/dist/esm/api/errors/UnauthorizedError.mjs +1 -1
- package/dist/esm/api/errors/UnprocessableEntityError.mjs +1 -1
- package/dist/esm/api/errors/UnsupportedMediaTypeError.mjs +1 -1
- 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 +9 -8
- 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/consentGroups/client/Client.d.mts +108 -0
- package/dist/esm/api/resources/consentGroups/client/Client.mjs +346 -0
- package/dist/esm/api/resources/consentGroups/client/index.d.mts +1 -0
- package/dist/esm/api/resources/consentGroups/client/index.mjs +1 -0
- package/dist/esm/api/resources/consentGroups/client/requests/CreateConsentGroupRequest.d.mts +25 -0
- package/dist/esm/api/resources/consentGroups/client/requests/CreateConsentGroupRequest.mjs +9 -0
- package/dist/esm/api/resources/consentGroups/client/requests/DeleteConsentGroupRequest.d.mts +10 -0
- package/dist/esm/api/resources/consentGroups/client/requests/GetConsentGroupRequest.d.mts +10 -0
- package/dist/esm/api/resources/consentGroups/client/requests/GetConsentGroupRequest.mjs +2 -0
- package/dist/esm/api/resources/consentGroups/client/requests/GetConsentGroupsRequest.d.mts +17 -0
- package/dist/esm/api/resources/consentGroups/client/requests/GetConsentGroupsRequest.mjs +2 -0
- package/dist/esm/api/resources/consentGroups/client/requests/UpdateConsentGroupRequest.d.mts +24 -0
- package/dist/esm/api/resources/consentGroups/client/requests/UpdateConsentGroupRequest.mjs +9 -0
- package/dist/esm/api/resources/consentGroups/client/requests/index.d.mts +5 -0
- package/dist/esm/api/resources/consentGroups/client/requests/index.mjs +2 -0
- package/dist/esm/api/resources/consentGroups/exports.d.mts +2 -0
- package/dist/esm/api/resources/consentGroups/exports.mjs +3 -0
- package/dist/esm/api/resources/consentGroups/index.d.mts +2 -0
- package/dist/esm/api/resources/consentGroups/index.mjs +2 -0
- package/dist/esm/api/resources/consentGroups/types/GetConsentGroupsRequestSignupMode.d.mts +5 -0
- package/dist/esm/api/resources/consentGroups/types/GetConsentGroupsRequestSignupMode.mjs +5 -0
- package/dist/esm/api/resources/consentGroups/types/index.d.mts +1 -0
- package/dist/esm/api/resources/consentGroups/types/index.mjs +1 -0
- package/dist/esm/api/resources/contacts/client/Client.d.mts +37 -0
- package/dist/esm/api/resources/contacts/client/Client.mjs +125 -36
- package/dist/esm/api/resources/contacts/client/requests/CreateContactRequest.d.mts +4 -0
- package/dist/esm/api/resources/contacts/client/requests/GetContactInfoRequest.d.mts +2 -2
- package/dist/esm/api/resources/contacts/client/requests/GetContactStatsRequest.d.mts +2 -2
- package/dist/esm/api/resources/contacts/client/requests/GetContactsRequest.d.mts +3 -1
- package/dist/esm/api/resources/contacts/client/requests/GetListRequest.d.mts +1 -1
- package/dist/esm/api/resources/contacts/client/requests/ImportContactsRequest.d.mts +2 -0
- package/dist/esm/api/resources/contacts/client/requests/UpdateContactRequest.d.mts +4 -2
- package/dist/esm/api/resources/contacts/types/GetAttributesResponse.d.mts +3 -1
- package/dist/esm/api/resources/contacts/types/GetContactInfoResponse.d.mts +8 -3
- package/dist/esm/api/resources/contacts/types/GetContactStatsResponse.d.mts +1 -1
- 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 +62 -22
- package/dist/esm/api/resources/deals/client/requests/GetCrmDealsRequest.d.mts +11 -3
- package/dist/esm/api/resources/deals/client/requests/PatchCrmDealsIdRequest.d.mts +1 -1
- package/dist/esm/api/resources/deals/client/requests/PostCrmDealsImportRequest.d.mts +1 -1
- package/dist/esm/api/resources/deals/types/GetCrmAttributesDealsResponseItem.d.mts +20 -4
- package/dist/esm/api/resources/domains/client/Client.mjs +5 -5
- package/dist/esm/api/resources/ecommerce/client/Client.d.mts +30 -1
- package/dist/esm/api/resources/ecommerce/client/Client.mjs +73 -20
- package/dist/esm/api/resources/ecommerce/client/requests/CreateBatchOrderRequest.d.mts +2 -2
- package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.mts +4 -2
- package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateProductRequest.d.mts +4 -2
- package/dist/esm/api/resources/ecommerce/client/requests/GetEcommerceAttributionMetricsRequest.d.mts +2 -1
- package/dist/esm/api/resources/ecommerce/client/requests/GetProductsRequest.d.mts +18 -2
- package/dist/esm/api/resources/ecommerce/types/CreateBatchOrderResponse.d.mts +2 -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/CreateBatchEventsRequest.mjs +2 -0
- package/dist/esm/api/resources/event/client/requests/CreateEventRequest.d.mts +3 -3
- package/dist/esm/api/resources/event/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/event/index.d.mts +0 -1
- package/dist/esm/api/resources/event/index.mjs +0 -1
- package/dist/esm/api/resources/externalFeeds/client/Client.mjs +9 -5
- package/dist/esm/api/resources/externalFeeds/types/GetAllExternalFeedsResponse.d.mts +3 -7
- package/dist/esm/api/resources/externalFeeds/types/GetExternalFeedByUuidResponse.d.mts +3 -9
- package/dist/esm/api/resources/files/client/Client.d.mts +10 -0
- package/dist/esm/api/resources/files/client/Client.mjs +19 -5
- package/dist/esm/api/resources/inboundParsing/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/inboundParsing/client/Client.mjs +11 -4
- package/dist/esm/api/resources/inboundParsing/client/requests/GetInboundEmailEventsRequest.d.mts +2 -2
- package/dist/esm/api/resources/inboundParsing/types/GetInboundEmailEventsByUuidResponse.d.mts +2 -2
- package/dist/esm/api/resources/index.d.mts +5 -1
- package/dist/esm/api/resources/index.mjs +5 -1
- package/dist/esm/api/resources/masterAccount/client/Client.d.mts +10 -0
- package/dist/esm/api/resources/masterAccount/client/Client.mjs +84 -46
- package/dist/esm/api/resources/notes/client/Client.d.mts +12 -2
- package/dist/esm/api/resources/notes/client/Client.mjs +21 -7
- package/dist/esm/api/resources/notes/client/requests/PatchCrmNotesIdRequest.d.mts +1 -1
- package/dist/esm/api/resources/notes/types/PostCrmNotesResponse.d.mts +1 -1
- package/dist/esm/api/resources/payments/client/Client.d.mts +6 -0
- package/dist/esm/api/resources/payments/client/Client.mjs +9 -3
- package/dist/esm/api/resources/process/client/Client.d.mts +13 -18
- package/dist/esm/api/resources/process/client/Client.mjs +19 -20
- package/dist/esm/api/resources/process/types/GetProcessResponse.d.mts +19 -36
- package/dist/esm/api/resources/process/types/GetProcessesResponse.d.mts +19 -36
- package/dist/esm/api/resources/program/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/program/client/Client.mjs +26 -14
- package/dist/esm/api/resources/program/client/requests/GetLpListRequest.d.mts +2 -2
- package/dist/esm/api/resources/program/client/requests/SubscribeToLoyaltyProgramRequest.d.mts +5 -3
- package/dist/esm/api/resources/program/types/GetLpListRequestSort.d.mts +5 -0
- package/dist/esm/api/resources/program/types/GetLpListRequestSort.mjs +5 -0
- package/dist/esm/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.mts +2 -0
- package/dist/esm/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.mts +4 -4
- package/dist/esm/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.mts +10 -8
- package/dist/esm/api/resources/program/types/index.d.mts +1 -0
- package/dist/esm/api/resources/program/types/index.mjs +1 -0
- package/dist/esm/api/resources/reward/client/Client.mjs +26 -10
- package/dist/esm/api/resources/reward/client/requests/CreateVoucherRequest.d.mts +2 -0
- package/dist/esm/api/resources/reward/client/requests/RedeemVoucherRequest.d.mts +2 -0
- package/dist/esm/api/resources/reward/types/CreateRewardResponse.d.mts +7 -7
- package/dist/esm/api/resources/reward/types/CreateVoucherResponse.d.mts +2 -0
- package/dist/esm/api/resources/reward/types/GetLoyaltyOfferProgramsPidVouchersResponse.d.mts +2 -0
- package/dist/esm/api/resources/senders/client/Client.mjs +11 -7
- package/dist/esm/api/resources/senders/types/GetIpsResponse.d.mts +2 -2
- package/dist/esm/api/resources/smsCampaigns/client/Client.d.mts +16 -0
- package/dist/esm/api/resources/smsCampaigns/client/Client.mjs +30 -10
- package/dist/esm/api/resources/smsCampaigns/client/requests/GetSmsCampaignsRequest.d.mts +3 -3
- package/dist/esm/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.mts +38 -2
- package/dist/esm/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.mts +7 -1
- package/dist/esm/api/resources/smsTemplates/client/Client.mjs +5 -1
- package/dist/esm/api/resources/tasks/client/Client.d.mts +16 -2
- package/dist/esm/api/resources/tasks/client/Client.mjs +35 -12
- package/dist/esm/api/resources/tasks/client/requests/PostCrmTasksRequest.d.mts +1 -1
- package/dist/esm/api/resources/tasks/types/{GetCrmTasktypesResponse.d.mts → GetCrmTasktypesResponseItem.d.mts} +1 -4
- package/dist/esm/api/resources/tasks/types/GetCrmTasktypesResponseItem.mjs +2 -0
- package/dist/esm/api/resources/tasks/types/index.d.mts +1 -1
- package/dist/esm/api/resources/tasks/types/index.mjs +1 -1
- package/dist/esm/api/resources/tier/client/Client.mjs +22 -10
- package/dist/esm/api/resources/tier/client/requests/CreateTierGroupRequest.d.mts +62 -0
- package/dist/esm/api/resources/tier/client/requests/CreateTierGroupRequest.mjs +30 -0
- package/dist/esm/api/resources/transactionalEmails/client/Client.d.mts +31 -2
- package/dist/esm/api/resources/transactionalEmails/client/Client.mjs +114 -35
- package/dist/esm/api/resources/transactionalEmails/client/requests/DeleteScheduledEmailByIdRequest.d.mts +1 -1
- package/dist/esm/api/resources/transactionalEmails/client/requests/DeleteSmtpLogIdentifierRequest.d.mts +5 -1
- package/dist/esm/api/resources/transactionalEmails/client/requests/GetAggregatedSmtpReportRequest.d.mts +1 -1
- package/dist/esm/api/resources/transactionalEmails/client/requests/GetEmailEventReportRequest.d.mts +1 -1
- package/dist/esm/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.mts +2 -2
- package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpReportRequest.d.mts +1 -1
- package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpTemplateRequest.d.mts +3 -2
- package/dist/esm/api/resources/transactionalEmails/client/requests/GetSmtpTemplatesRequest.d.mts +2 -0
- package/dist/esm/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.mts +3 -2
- package/dist/esm/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.d.mts +1 -0
- package/dist/esm/api/resources/transactionalEmails/types/GetSmtpTemplateRequestTemplateId.mjs +2 -0
- package/dist/esm/api/resources/transactionalEmails/types/GetTransacBlockedContactsResponse.d.mts +1 -1
- 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/wallet/client/Client.d.mts +34 -0
- package/dist/esm/api/resources/wallet/client/Client.mjs +89 -0
- package/dist/esm/api/resources/wallet/client/index.d.mts +1 -0
- package/dist/esm/api/resources/wallet/client/index.mjs +1 -0
- package/dist/esm/api/resources/wallet/client/requests/GetWalletPassInstallUrlRequest.d.mts +13 -0
- package/dist/esm/api/resources/wallet/client/requests/GetWalletPassInstallUrlRequest.mjs +2 -0
- package/dist/esm/api/resources/wallet/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/wallet/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/wallet/exports.d.mts +2 -0
- package/dist/esm/api/resources/wallet/exports.mjs +3 -0
- package/dist/esm/api/resources/wallet/index.d.mts +1 -0
- package/dist/esm/api/resources/wallet/index.mjs +1 -0
- 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/ConsentGroup.d.mts +29 -0
- package/dist/esm/api/types/ConsentGroup.mjs +9 -0
- package/dist/esm/api/types/ConsentGroupItem.d.mts +17 -0
- package/dist/esm/api/types/ConsentGroupItem.mjs +9 -0
- package/dist/esm/api/types/ConsentGroupsListResponse.d.mts +14 -0
- package/dist/esm/api/types/ConsentGroupsListResponse.mjs +2 -0
- 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 +15 -15
- package/dist/esm/api/types/GetContactDetails.d.mts +5 -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/api/types/WalletPassInstallUrl.d.mts +4 -0
- package/dist/esm/api/types/WalletPassInstallUrl.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +4 -0
- package/dist/esm/api/types/index.mjs +4 -0
- package/dist/esm/core/auth/AuthProvider.d.mts +1 -0
- package/dist/esm/core/auth/AuthProvider.mjs +6 -1
- package/dist/esm/core/auth/index.d.mts +1 -1
- package/dist/esm/core/auth/index.mjs +1 -0
- package/dist/esm/core/fetcher/Fetcher.d.mts +6 -0
- package/dist/esm/core/fetcher/Fetcher.mjs +9 -8
- package/dist/esm/core/fetcher/getResponseBody.mjs +11 -0
- package/dist/esm/core/fetcher/requestWithRetries.mjs +4 -1
- package/dist/esm/core/fetcher/signals.mjs +9 -1
- package/dist/esm/core/url/QueryStringBuilder.d.mts +47 -0
- package/dist/esm/core/url/QueryStringBuilder.mjs +80 -0
- package/dist/esm/core/url/index.d.mts +1 -0
- package/dist/esm/core/url/index.mjs +1 -0
- package/dist/esm/core/url/qs.d.mts +2 -1
- package/dist/esm/core/url/qs.mjs +25 -13
- package/dist/esm/errors/BrevoError.d.mts +1 -0
- package/dist/esm/errors/BrevoError.mjs +5 -1
- package/dist/esm/errors/BrevoTimeoutError.d.mts +2 -2
- package/dist/esm/errors/BrevoTimeoutError.mjs +7 -6
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +24 -2
- package/reference.md +2301 -170
- 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/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 → consentGroups/client/requests/DeleteConsentGroupRequest.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 → consentGroups/client/requests/DeleteConsentGroupRequest.mjs} +0 -0
|
@@ -12,7 +12,7 @@ export interface PatchCompaniesIdRequest {
|
|
|
12
12
|
countryCode?: number;
|
|
13
13
|
/** Warning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed. */
|
|
14
14
|
linkedContactsIds?: number[];
|
|
15
|
-
/** Warning - Using PATCH on linkedDealsIds replaces the list of linked
|
|
15
|
+
/** Warning - Using PATCH on linkedDealsIds replaces the list of linked deals. Omitted IDs will be removed. */
|
|
16
16
|
linkedDealsIds?: string[];
|
|
17
17
|
/** Name of company */
|
|
18
18
|
name?: string;
|
|
@@ -4,7 +4,7 @@ import type * as core from "../../../../../core/index.mjs";
|
|
|
4
4
|
* {}
|
|
5
5
|
*/
|
|
6
6
|
export interface PostCompaniesImportRequest {
|
|
7
|
-
/** The CSV file to upload.The file should have the first row as the mapping attribute. Some default attribute names are (a) company_id [brevo mongoID to update
|
|
7
|
+
/** The CSV file to upload.The file should have the first row as the mapping attribute. Some default attribute names are (a) company_id [brevo mongoID to update companies] (b) associated_contact (c) associated_deal (f) any other attribute with internal name */
|
|
8
8
|
file?: core.file.Uploadable | undefined;
|
|
9
9
|
/**
|
|
10
10
|
* The mapping options in JSON format. Here is an example of the JSON structure: ```json {
|
|
@@ -13,7 +13,7 @@ export interface PostCrmAttributesRequest {
|
|
|
13
13
|
description?: string;
|
|
14
14
|
/** The label for the attribute (max 50 characters, cannot be empty) */
|
|
15
15
|
label: string;
|
|
16
|
-
/** The type of object the attribute belongs to
|
|
16
|
+
/** The type of object the attribute belongs to. Must be either `companies` or `deals`. */
|
|
17
17
|
objectType: PostCrmAttributesRequest.ObjectType;
|
|
18
18
|
/** Options for multi-choice or single-select attributes */
|
|
19
19
|
optionsLabels?: string[];
|
|
@@ -30,7 +30,7 @@ export declare namespace PostCrmAttributesRequest {
|
|
|
30
30
|
readonly MultiChoice: "multi-choice";
|
|
31
31
|
};
|
|
32
32
|
type AttributeType = (typeof AttributeType)[keyof typeof AttributeType];
|
|
33
|
-
/** The type of object the attribute belongs to
|
|
33
|
+
/** The type of object the attribute belongs to. Must be either `companies` or `deals`. */
|
|
34
34
|
const ObjectType: {
|
|
35
35
|
readonly Companies: "companies";
|
|
36
36
|
readonly Deals: "deals";
|
|
@@ -11,7 +11,7 @@ export var PostCrmAttributesRequest;
|
|
|
11
11
|
Boolean: "boolean",
|
|
12
12
|
MultiChoice: "multi-choice",
|
|
13
13
|
};
|
|
14
|
-
/** The type of object the attribute belongs to
|
|
14
|
+
/** The type of object the attribute belongs to. Must be either `companies` or `deals`. */
|
|
15
15
|
PostCrmAttributesRequest.ObjectType = {
|
|
16
16
|
Companies: "companies",
|
|
17
17
|
Deals: "deals",
|
|
@@ -1,10 +1,26 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* Company attribute details
|
|
3
3
|
*/
|
|
4
4
|
export interface GetCrmAttributesCompaniesResponseItem {
|
|
5
|
-
|
|
6
|
-
attributeTypeName?: string | undefined;
|
|
5
|
+
/** Internal name of the attribute */
|
|
7
6
|
internalName?: string | undefined;
|
|
8
|
-
|
|
7
|
+
/** Type of the attribute */
|
|
8
|
+
attributeTypeName?: string | undefined;
|
|
9
|
+
/** Display label of the attribute */
|
|
9
10
|
label?: string | undefined;
|
|
11
|
+
/** Options for single-select or multi-choice attributes */
|
|
12
|
+
attributeOptions?: GetCrmAttributesCompaniesResponseItem.AttributeOptions.Item[] | undefined;
|
|
13
|
+
/** Whether this attribute is required */
|
|
14
|
+
isRequired?: boolean | undefined;
|
|
15
|
+
/** Whether this attribute value is read-only */
|
|
16
|
+
isValueReadonly?: boolean | undefined;
|
|
17
|
+
}
|
|
18
|
+
export declare namespace GetCrmAttributesCompaniesResponseItem {
|
|
19
|
+
type AttributeOptions = AttributeOptions.Item[];
|
|
20
|
+
namespace AttributeOptions {
|
|
21
|
+
interface Item {
|
|
22
|
+
key?: string | undefined;
|
|
23
|
+
value?: string | undefined;
|
|
24
|
+
}
|
|
25
|
+
}
|
|
10
26
|
}
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
|
|
2
|
+
import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
|
|
3
|
+
import * as core from "../../../../core/index.mjs";
|
|
4
|
+
import * as Brevo from "../../../index.mjs";
|
|
5
|
+
export declare namespace ConsentGroupsClient {
|
|
6
|
+
type Options = BaseClientOptions;
|
|
7
|
+
interface RequestOptions extends BaseRequestOptions {
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
export declare class ConsentGroupsClient {
|
|
11
|
+
protected readonly _options: NormalizedClientOptionsWithAuth<ConsentGroupsClient.Options>;
|
|
12
|
+
constructor(options: ConsentGroupsClient.Options);
|
|
13
|
+
/**
|
|
14
|
+
* Returns a paginated list of consent groups for the account.
|
|
15
|
+
*
|
|
16
|
+
* <Note>This endpoint is only available when the Consent Groups feature is enabled for your account. Returns `403` if the feature is not activated.</Note>
|
|
17
|
+
*
|
|
18
|
+
* @param {Brevo.GetConsentGroupsRequest} request
|
|
19
|
+
* @param {ConsentGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
20
|
+
*
|
|
21
|
+
* @throws {@link Brevo.BadRequestError}
|
|
22
|
+
* @throws {@link Brevo.ForbiddenError}
|
|
23
|
+
* @throws {@link Brevo.TooManyRequestsError}
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* await client.consentGroups.getConsentGroups()
|
|
27
|
+
*/
|
|
28
|
+
getConsentGroups(request?: Brevo.GetConsentGroupsRequest, requestOptions?: ConsentGroupsClient.RequestOptions): core.HttpResponsePromise<Brevo.ConsentGroupsListResponse>;
|
|
29
|
+
private __getConsentGroups;
|
|
30
|
+
/**
|
|
31
|
+
* Creates a new consent group for the account.
|
|
32
|
+
*
|
|
33
|
+
* <Note>This endpoint is only available when the Consent Groups feature is enabled for your account.</Note>
|
|
34
|
+
*
|
|
35
|
+
* @param {Brevo.CreateConsentGroupRequest} request
|
|
36
|
+
* @param {ConsentGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link Brevo.BadRequestError}
|
|
39
|
+
* @throws {@link Brevo.ForbiddenError}
|
|
40
|
+
* @throws {@link Brevo.ConflictError}
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* await client.consentGroups.createConsentGroup({
|
|
44
|
+
* name: "Newsletter EU",
|
|
45
|
+
* signupMode: "manual"
|
|
46
|
+
* })
|
|
47
|
+
*/
|
|
48
|
+
createConsentGroup(request: Brevo.CreateConsentGroupRequest, requestOptions?: ConsentGroupsClient.RequestOptions): core.HttpResponsePromise<Brevo.ConsentGroup>;
|
|
49
|
+
private __createConsentGroup;
|
|
50
|
+
/**
|
|
51
|
+
* Returns a single consent group by ID for the account.
|
|
52
|
+
*
|
|
53
|
+
* <Note>This endpoint is only available when the Consent Groups feature is enabled for your account.</Note>
|
|
54
|
+
*
|
|
55
|
+
* @param {Brevo.GetConsentGroupRequest} request
|
|
56
|
+
* @param {ConsentGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link Brevo.BadRequestError}
|
|
59
|
+
* @throws {@link Brevo.ForbiddenError}
|
|
60
|
+
* @throws {@link Brevo.NotFoundError}
|
|
61
|
+
*
|
|
62
|
+
* @example
|
|
63
|
+
* await client.consentGroups.getConsentGroup({
|
|
64
|
+
* id: 1000000
|
|
65
|
+
* })
|
|
66
|
+
*/
|
|
67
|
+
getConsentGroup(request: Brevo.GetConsentGroupRequest, requestOptions?: ConsentGroupsClient.RequestOptions): core.HttpResponsePromise<Brevo.ConsentGroup>;
|
|
68
|
+
private __getConsentGroup;
|
|
69
|
+
/**
|
|
70
|
+
* Updates name, description, or signupMode of a consent group. At least one field must be provided.
|
|
71
|
+
*
|
|
72
|
+
* <Note>This endpoint is only available when the Consent Groups feature is enabled for your account.</Note>
|
|
73
|
+
*
|
|
74
|
+
* @param {Brevo.UpdateConsentGroupRequest} request
|
|
75
|
+
* @param {ConsentGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link Brevo.BadRequestError}
|
|
78
|
+
* @throws {@link Brevo.ForbiddenError}
|
|
79
|
+
* @throws {@link Brevo.NotFoundError}
|
|
80
|
+
* @throws {@link Brevo.ConflictError}
|
|
81
|
+
*
|
|
82
|
+
* @example
|
|
83
|
+
* await client.consentGroups.updateConsentGroup({
|
|
84
|
+
* id: 1000000
|
|
85
|
+
* })
|
|
86
|
+
*/
|
|
87
|
+
updateConsentGroup(request: Brevo.UpdateConsentGroupRequest, requestOptions?: ConsentGroupsClient.RequestOptions): core.HttpResponsePromise<Brevo.ConsentGroup>;
|
|
88
|
+
private __updateConsentGroup;
|
|
89
|
+
/**
|
|
90
|
+
* Deletes a consent group by ID and removes it from all associated contacts.
|
|
91
|
+
*
|
|
92
|
+
* <Note>This endpoint is only available when the Consent Groups feature is enabled for your account.</Note>
|
|
93
|
+
*
|
|
94
|
+
* @param {Brevo.DeleteConsentGroupRequest} request
|
|
95
|
+
* @param {ConsentGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link Brevo.BadRequestError}
|
|
98
|
+
* @throws {@link Brevo.ForbiddenError}
|
|
99
|
+
* @throws {@link Brevo.NotFoundError}
|
|
100
|
+
*
|
|
101
|
+
* @example
|
|
102
|
+
* await client.consentGroups.deleteConsentGroup({
|
|
103
|
+
* id: 1000000
|
|
104
|
+
* })
|
|
105
|
+
*/
|
|
106
|
+
deleteConsentGroup(request: Brevo.DeleteConsentGroupRequest, requestOptions?: ConsentGroupsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
107
|
+
private __deleteConsentGroup;
|
|
108
|
+
}
|
|
@@ -0,0 +1,346 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
var __rest = (this && this.__rest) || function (s, e) {
|
|
12
|
+
var t = {};
|
|
13
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
|
|
14
|
+
t[p] = s[p];
|
|
15
|
+
if (s != null && typeof Object.getOwnPropertySymbols === "function")
|
|
16
|
+
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
|
|
17
|
+
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
|
|
18
|
+
t[p[i]] = s[p[i]];
|
|
19
|
+
}
|
|
20
|
+
return t;
|
|
21
|
+
};
|
|
22
|
+
import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
|
|
23
|
+
import { mergeHeaders } from "../../../../core/headers.mjs";
|
|
24
|
+
import * as core from "../../../../core/index.mjs";
|
|
25
|
+
import * as environments from "../../../../environments.mjs";
|
|
26
|
+
import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
|
|
27
|
+
import * as errors from "../../../../errors/index.mjs";
|
|
28
|
+
import * as Brevo from "../../../index.mjs";
|
|
29
|
+
export class ConsentGroupsClient {
|
|
30
|
+
constructor(options) {
|
|
31
|
+
this._options = normalizeClientOptionsWithAuth(options);
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Returns a paginated list of consent groups for the account.
|
|
35
|
+
*
|
|
36
|
+
* <Note>This endpoint is only available when the Consent Groups feature is enabled for your account. Returns `403` if the feature is not activated.</Note>
|
|
37
|
+
*
|
|
38
|
+
* @param {Brevo.GetConsentGroupsRequest} request
|
|
39
|
+
* @param {ConsentGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link Brevo.BadRequestError}
|
|
42
|
+
* @throws {@link Brevo.ForbiddenError}
|
|
43
|
+
* @throws {@link Brevo.TooManyRequestsError}
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* await client.consentGroups.getConsentGroups()
|
|
47
|
+
*/
|
|
48
|
+
getConsentGroups(request = {}, requestOptions) {
|
|
49
|
+
return core.HttpResponsePromise.fromPromise(this.__getConsentGroups(request, requestOptions));
|
|
50
|
+
}
|
|
51
|
+
__getConsentGroups() {
|
|
52
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
53
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
54
|
+
const { limit, offset, id, name, signupMode } = request;
|
|
55
|
+
const _queryParams = {
|
|
56
|
+
limit,
|
|
57
|
+
offset,
|
|
58
|
+
id,
|
|
59
|
+
name,
|
|
60
|
+
signupMode: signupMode != null ? signupMode : undefined,
|
|
61
|
+
};
|
|
62
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
63
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
64
|
+
const _response = yield core.fetcher({
|
|
65
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, "contacts/consent-groups"),
|
|
66
|
+
method: "GET",
|
|
67
|
+
headers: _headers,
|
|
68
|
+
queryString: core.url
|
|
69
|
+
.queryBuilder()
|
|
70
|
+
.addMany(_queryParams)
|
|
71
|
+
.mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
|
|
72
|
+
.build(),
|
|
73
|
+
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,
|
|
74
|
+
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,
|
|
75
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
76
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
77
|
+
logging: this._options.logging,
|
|
78
|
+
});
|
|
79
|
+
if (_response.ok) {
|
|
80
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
81
|
+
}
|
|
82
|
+
if (_response.error.reason === "status-code") {
|
|
83
|
+
switch (_response.error.statusCode) {
|
|
84
|
+
case 400:
|
|
85
|
+
throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
|
|
86
|
+
case 403:
|
|
87
|
+
throw new Brevo.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
88
|
+
case 429:
|
|
89
|
+
throw new Brevo.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
90
|
+
default:
|
|
91
|
+
throw new errors.BrevoError({
|
|
92
|
+
statusCode: _response.error.statusCode,
|
|
93
|
+
body: _response.error.body,
|
|
94
|
+
rawResponse: _response.rawResponse,
|
|
95
|
+
});
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/contacts/consent-groups");
|
|
99
|
+
});
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* Creates a new consent group for the account.
|
|
103
|
+
*
|
|
104
|
+
* <Note>This endpoint is only available when the Consent Groups feature is enabled for your account.</Note>
|
|
105
|
+
*
|
|
106
|
+
* @param {Brevo.CreateConsentGroupRequest} request
|
|
107
|
+
* @param {ConsentGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link Brevo.BadRequestError}
|
|
110
|
+
* @throws {@link Brevo.ForbiddenError}
|
|
111
|
+
* @throws {@link Brevo.ConflictError}
|
|
112
|
+
*
|
|
113
|
+
* @example
|
|
114
|
+
* await client.consentGroups.createConsentGroup({
|
|
115
|
+
* name: "Newsletter EU",
|
|
116
|
+
* signupMode: "manual"
|
|
117
|
+
* })
|
|
118
|
+
*/
|
|
119
|
+
createConsentGroup(request, requestOptions) {
|
|
120
|
+
return core.HttpResponsePromise.fromPromise(this.__createConsentGroup(request, requestOptions));
|
|
121
|
+
}
|
|
122
|
+
__createConsentGroup(request, requestOptions) {
|
|
123
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
124
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
125
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
126
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
127
|
+
const _response = yield core.fetcher({
|
|
128
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, "contacts/consent-groups"),
|
|
129
|
+
method: "POST",
|
|
130
|
+
headers: _headers,
|
|
131
|
+
contentType: "application/json",
|
|
132
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
133
|
+
requestType: "json",
|
|
134
|
+
body: request,
|
|
135
|
+
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,
|
|
136
|
+
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,
|
|
137
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
138
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
139
|
+
logging: this._options.logging,
|
|
140
|
+
});
|
|
141
|
+
if (_response.ok) {
|
|
142
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
143
|
+
}
|
|
144
|
+
if (_response.error.reason === "status-code") {
|
|
145
|
+
switch (_response.error.statusCode) {
|
|
146
|
+
case 400:
|
|
147
|
+
throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
|
|
148
|
+
case 403:
|
|
149
|
+
throw new Brevo.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
150
|
+
case 409:
|
|
151
|
+
throw new Brevo.ConflictError(_response.error.body, _response.rawResponse);
|
|
152
|
+
default:
|
|
153
|
+
throw new errors.BrevoError({
|
|
154
|
+
statusCode: _response.error.statusCode,
|
|
155
|
+
body: _response.error.body,
|
|
156
|
+
rawResponse: _response.rawResponse,
|
|
157
|
+
});
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/contacts/consent-groups");
|
|
161
|
+
});
|
|
162
|
+
}
|
|
163
|
+
/**
|
|
164
|
+
* Returns a single consent group by ID for the account.
|
|
165
|
+
*
|
|
166
|
+
* <Note>This endpoint is only available when the Consent Groups feature is enabled for your account.</Note>
|
|
167
|
+
*
|
|
168
|
+
* @param {Brevo.GetConsentGroupRequest} request
|
|
169
|
+
* @param {ConsentGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
170
|
+
*
|
|
171
|
+
* @throws {@link Brevo.BadRequestError}
|
|
172
|
+
* @throws {@link Brevo.ForbiddenError}
|
|
173
|
+
* @throws {@link Brevo.NotFoundError}
|
|
174
|
+
*
|
|
175
|
+
* @example
|
|
176
|
+
* await client.consentGroups.getConsentGroup({
|
|
177
|
+
* id: 1000000
|
|
178
|
+
* })
|
|
179
|
+
*/
|
|
180
|
+
getConsentGroup(request, requestOptions) {
|
|
181
|
+
return core.HttpResponsePromise.fromPromise(this.__getConsentGroup(request, requestOptions));
|
|
182
|
+
}
|
|
183
|
+
__getConsentGroup(request, requestOptions) {
|
|
184
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
185
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
186
|
+
const { id } = request;
|
|
187
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
188
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
189
|
+
const _response = yield core.fetcher({
|
|
190
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `contacts/consent-groups/${core.url.encodePathParam(id)}`),
|
|
191
|
+
method: "GET",
|
|
192
|
+
headers: _headers,
|
|
193
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
194
|
+
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,
|
|
195
|
+
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,
|
|
196
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
197
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
198
|
+
logging: this._options.logging,
|
|
199
|
+
});
|
|
200
|
+
if (_response.ok) {
|
|
201
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
202
|
+
}
|
|
203
|
+
if (_response.error.reason === "status-code") {
|
|
204
|
+
switch (_response.error.statusCode) {
|
|
205
|
+
case 400:
|
|
206
|
+
throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
|
|
207
|
+
case 403:
|
|
208
|
+
throw new Brevo.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
209
|
+
case 404:
|
|
210
|
+
throw new Brevo.NotFoundError(_response.error.body, _response.rawResponse);
|
|
211
|
+
default:
|
|
212
|
+
throw new errors.BrevoError({
|
|
213
|
+
statusCode: _response.error.statusCode,
|
|
214
|
+
body: _response.error.body,
|
|
215
|
+
rawResponse: _response.rawResponse,
|
|
216
|
+
});
|
|
217
|
+
}
|
|
218
|
+
}
|
|
219
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/contacts/consent-groups/{id}");
|
|
220
|
+
});
|
|
221
|
+
}
|
|
222
|
+
/**
|
|
223
|
+
* Updates name, description, or signupMode of a consent group. At least one field must be provided.
|
|
224
|
+
*
|
|
225
|
+
* <Note>This endpoint is only available when the Consent Groups feature is enabled for your account.</Note>
|
|
226
|
+
*
|
|
227
|
+
* @param {Brevo.UpdateConsentGroupRequest} request
|
|
228
|
+
* @param {ConsentGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
229
|
+
*
|
|
230
|
+
* @throws {@link Brevo.BadRequestError}
|
|
231
|
+
* @throws {@link Brevo.ForbiddenError}
|
|
232
|
+
* @throws {@link Brevo.NotFoundError}
|
|
233
|
+
* @throws {@link Brevo.ConflictError}
|
|
234
|
+
*
|
|
235
|
+
* @example
|
|
236
|
+
* await client.consentGroups.updateConsentGroup({
|
|
237
|
+
* id: 1000000
|
|
238
|
+
* })
|
|
239
|
+
*/
|
|
240
|
+
updateConsentGroup(request, requestOptions) {
|
|
241
|
+
return core.HttpResponsePromise.fromPromise(this.__updateConsentGroup(request, requestOptions));
|
|
242
|
+
}
|
|
243
|
+
__updateConsentGroup(request, requestOptions) {
|
|
244
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
245
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
246
|
+
const { id } = request, _body = __rest(request, ["id"]);
|
|
247
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
248
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
249
|
+
const _response = yield core.fetcher({
|
|
250
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `contacts/consent-groups/${core.url.encodePathParam(id)}`),
|
|
251
|
+
method: "PUT",
|
|
252
|
+
headers: _headers,
|
|
253
|
+
contentType: "application/json",
|
|
254
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
255
|
+
requestType: "json",
|
|
256
|
+
body: _body,
|
|
257
|
+
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,
|
|
258
|
+
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,
|
|
259
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
260
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
261
|
+
logging: this._options.logging,
|
|
262
|
+
});
|
|
263
|
+
if (_response.ok) {
|
|
264
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
265
|
+
}
|
|
266
|
+
if (_response.error.reason === "status-code") {
|
|
267
|
+
switch (_response.error.statusCode) {
|
|
268
|
+
case 400:
|
|
269
|
+
throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
|
|
270
|
+
case 403:
|
|
271
|
+
throw new Brevo.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
272
|
+
case 404:
|
|
273
|
+
throw new Brevo.NotFoundError(_response.error.body, _response.rawResponse);
|
|
274
|
+
case 409:
|
|
275
|
+
throw new Brevo.ConflictError(_response.error.body, _response.rawResponse);
|
|
276
|
+
default:
|
|
277
|
+
throw new errors.BrevoError({
|
|
278
|
+
statusCode: _response.error.statusCode,
|
|
279
|
+
body: _response.error.body,
|
|
280
|
+
rawResponse: _response.rawResponse,
|
|
281
|
+
});
|
|
282
|
+
}
|
|
283
|
+
}
|
|
284
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/contacts/consent-groups/{id}");
|
|
285
|
+
});
|
|
286
|
+
}
|
|
287
|
+
/**
|
|
288
|
+
* Deletes a consent group by ID and removes it from all associated contacts.
|
|
289
|
+
*
|
|
290
|
+
* <Note>This endpoint is only available when the Consent Groups feature is enabled for your account.</Note>
|
|
291
|
+
*
|
|
292
|
+
* @param {Brevo.DeleteConsentGroupRequest} request
|
|
293
|
+
* @param {ConsentGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
294
|
+
*
|
|
295
|
+
* @throws {@link Brevo.BadRequestError}
|
|
296
|
+
* @throws {@link Brevo.ForbiddenError}
|
|
297
|
+
* @throws {@link Brevo.NotFoundError}
|
|
298
|
+
*
|
|
299
|
+
* @example
|
|
300
|
+
* await client.consentGroups.deleteConsentGroup({
|
|
301
|
+
* id: 1000000
|
|
302
|
+
* })
|
|
303
|
+
*/
|
|
304
|
+
deleteConsentGroup(request, requestOptions) {
|
|
305
|
+
return core.HttpResponsePromise.fromPromise(this.__deleteConsentGroup(request, requestOptions));
|
|
306
|
+
}
|
|
307
|
+
__deleteConsentGroup(request, requestOptions) {
|
|
308
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
309
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
310
|
+
const { id } = request;
|
|
311
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
312
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
313
|
+
const _response = yield core.fetcher({
|
|
314
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.BrevoEnvironment.Default, `contacts/consent-groups/${core.url.encodePathParam(id)}`),
|
|
315
|
+
method: "DELETE",
|
|
316
|
+
headers: _headers,
|
|
317
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
318
|
+
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,
|
|
319
|
+
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,
|
|
320
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
321
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
322
|
+
logging: this._options.logging,
|
|
323
|
+
});
|
|
324
|
+
if (_response.ok) {
|
|
325
|
+
return { data: undefined, rawResponse: _response.rawResponse };
|
|
326
|
+
}
|
|
327
|
+
if (_response.error.reason === "status-code") {
|
|
328
|
+
switch (_response.error.statusCode) {
|
|
329
|
+
case 400:
|
|
330
|
+
throw new Brevo.BadRequestError(_response.error.body, _response.rawResponse);
|
|
331
|
+
case 403:
|
|
332
|
+
throw new Brevo.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
333
|
+
case 404:
|
|
334
|
+
throw new Brevo.NotFoundError(_response.error.body, _response.rawResponse);
|
|
335
|
+
default:
|
|
336
|
+
throw new errors.BrevoError({
|
|
337
|
+
statusCode: _response.error.statusCode,
|
|
338
|
+
body: _response.error.body,
|
|
339
|
+
rawResponse: _response.rawResponse,
|
|
340
|
+
});
|
|
341
|
+
}
|
|
342
|
+
}
|
|
343
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/contacts/consent-groups/{id}");
|
|
344
|
+
});
|
|
345
|
+
}
|
|
346
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./requests/index.mjs";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./requests/index.mjs";
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* name: "Newsletter EU",
|
|
5
|
+
* signupMode: "manual"
|
|
6
|
+
* }
|
|
7
|
+
*/
|
|
8
|
+
export interface CreateConsentGroupRequest {
|
|
9
|
+
/** Unique name for the consent group (max 255 characters) */
|
|
10
|
+
name: string;
|
|
11
|
+
/** Optional description (max 500 characters) */
|
|
12
|
+
description?: string;
|
|
13
|
+
/** Controls how contacts are added to the group. `manual` — contacts are added explicitly via the API. `automatic` — contacts are added automatically at signup. */
|
|
14
|
+
signupMode: CreateConsentGroupRequest.SignupMode;
|
|
15
|
+
/** Optional list of contact list IDs. Contacts from these lists will be copied once into this consent group at creation time. */
|
|
16
|
+
listIds?: number[];
|
|
17
|
+
}
|
|
18
|
+
export declare namespace CreateConsentGroupRequest {
|
|
19
|
+
/** Controls how contacts are added to the group. `manual` — contacts are added explicitly via the API. `automatic` — contacts are added automatically at signup. */
|
|
20
|
+
const SignupMode: {
|
|
21
|
+
readonly Manual: "manual";
|
|
22
|
+
readonly Automatic: "automatic";
|
|
23
|
+
};
|
|
24
|
+
type SignupMode = (typeof SignupMode)[keyof typeof SignupMode];
|
|
25
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
export var CreateConsentGroupRequest;
|
|
3
|
+
(function (CreateConsentGroupRequest) {
|
|
4
|
+
/** Controls how contacts are added to the group. `manual` — contacts are added explicitly via the API. `automatic` — contacts are added automatically at signup. */
|
|
5
|
+
CreateConsentGroupRequest.SignupMode = {
|
|
6
|
+
Manual: "manual",
|
|
7
|
+
Automatic: "automatic",
|
|
8
|
+
};
|
|
9
|
+
})(CreateConsentGroupRequest || (CreateConsentGroupRequest = {}));
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type * as Brevo from "../../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {}
|
|
5
|
+
*/
|
|
6
|
+
export interface GetConsentGroupsRequest {
|
|
7
|
+
/** Maximum number of results to return (default 10, max 50) */
|
|
8
|
+
limit?: number;
|
|
9
|
+
/** Number of results to skip (default 0) */
|
|
10
|
+
offset?: number;
|
|
11
|
+
/** Filter by consent group ID */
|
|
12
|
+
id?: number;
|
|
13
|
+
/** Filter by name (case-insensitive partial match) */
|
|
14
|
+
name?: string;
|
|
15
|
+
/** Filter by signup mode */
|
|
16
|
+
signupMode?: Brevo.GetConsentGroupsRequestSignupMode;
|
|
17
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* id: 1000000
|
|
5
|
+
* }
|
|
6
|
+
*/
|
|
7
|
+
export interface UpdateConsentGroupRequest {
|
|
8
|
+
/** ID of the consent group to update */
|
|
9
|
+
id: number;
|
|
10
|
+
/** New name for the consent group (max 255 characters) */
|
|
11
|
+
name?: string;
|
|
12
|
+
/** New description (max 500 characters) */
|
|
13
|
+
description?: string;
|
|
14
|
+
/** New signup mode */
|
|
15
|
+
signupMode?: UpdateConsentGroupRequest.SignupMode;
|
|
16
|
+
}
|
|
17
|
+
export declare namespace UpdateConsentGroupRequest {
|
|
18
|
+
/** New signup mode */
|
|
19
|
+
const SignupMode: {
|
|
20
|
+
readonly Manual: "manual";
|
|
21
|
+
readonly Automatic: "automatic";
|
|
22
|
+
};
|
|
23
|
+
type SignupMode = (typeof SignupMode)[keyof typeof SignupMode];
|
|
24
|
+
}
|