@getbrevo/brevo 5.0.0 → 5.0.3
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 +4 -4
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +12 -0
- package/dist/cjs/Client.js +67 -0
- package/dist/cjs/api/resources/account/exports.d.ts +2 -0
- package/dist/cjs/api/resources/account/exports.js +21 -0
- package/dist/cjs/api/resources/account/types/GetAccountActivityResponse.d.ts +1 -1
- package/dist/cjs/api/resources/account/types/GetAccountResponse.d.ts +7 -7
- package/dist/cjs/api/resources/balance/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/balance/client/Client.js +20 -11
- package/dist/cjs/api/resources/balance/client/requests/GetContactBalancesRequest.d.ts +2 -0
- package/dist/cjs/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidActiveBalanceRequest.d.ts +2 -0
- package/dist/cjs/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidTransactionHistoryRequest.d.ts +10 -6
- package/dist/cjs/api/resources/balance/client/requests/GetSubscriptionBalancesRequest.d.ts +2 -0
- package/dist/cjs/api/resources/balance/client/requests/PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest.d.ts +10 -1
- package/dist/cjs/api/resources/balance/client/requests/UpdateBalanceDefinitionRequest.d.ts +10 -1
- package/dist/cjs/api/resources/balance/exports.d.ts +2 -0
- package/dist/cjs/api/resources/balance/exports.js +21 -0
- package/dist/cjs/api/resources/balance/types/CreateBalanceOrderResponse.d.ts +6 -6
- package/dist/cjs/api/resources/balance/types/GetBalanceDefinitionListResponse.d.ts +1 -1
- package/dist/cjs/api/resources/balance/types/GetContactBalancesResponse.d.ts +8 -8
- package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus.d.ts +8 -0
- package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus.js +11 -0
- package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType.d.ts +5 -0
- package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType.js +8 -0
- package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.d.ts +15 -15
- package/dist/cjs/api/resources/balance/types/GetSubscriptionBalancesResponse.d.ts +3 -3
- package/dist/cjs/api/resources/balance/types/PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse.d.ts +9 -9
- package/dist/cjs/api/resources/balance/types/index.d.ts +2 -1
- package/dist/cjs/api/resources/balance/types/index.js +2 -1
- package/dist/cjs/api/resources/companies/client/Client.d.ts +28 -0
- package/dist/cjs/api/resources/companies/client/Client.js +107 -0
- package/dist/cjs/api/resources/companies/client/requests/DeleteCrmAttributesIdRequest.d.ts +10 -0
- package/dist/cjs/api/resources/companies/client/requests/DeleteCrmAttributesIdRequest.js +3 -0
- package/dist/cjs/api/resources/companies/client/requests/PatchCrmAttributesIdRequest.d.ts +33 -0
- package/dist/cjs/api/resources/companies/client/requests/PatchCrmAttributesIdRequest.js +12 -0
- package/dist/cjs/api/resources/companies/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/companies/client/requests/index.js +3 -1
- package/dist/cjs/api/resources/companies/exports.d.ts +2 -0
- package/dist/cjs/api/resources/companies/exports.js +21 -0
- package/dist/cjs/api/resources/companies/types/GetCompaniesResponse.d.ts +1 -1
- package/dist/cjs/api/resources/companies/types/GetCrmAttributesCompaniesResponseItem.d.ts +5 -5
- package/dist/cjs/api/resources/companies/types/PostCompaniesImportResponse.d.ts +1 -1
- package/dist/cjs/api/resources/contacts/client/Client.d.ts +15 -45
- package/dist/cjs/api/resources/contacts/client/Client.js +15 -45
- package/dist/cjs/api/resources/contacts/client/requests/AddContactToListRequest.d.ts +0 -24
- package/dist/cjs/api/resources/contacts/client/requests/ImportContactsRequest.d.ts +4 -4
- package/dist/cjs/api/resources/contacts/client/requests/RemoveContactFromListRequest.d.ts +0 -32
- package/dist/cjs/api/resources/contacts/client/requests/RequestContactExportRequest.d.ts +7 -7
- package/dist/cjs/api/resources/contacts/client/requests/UpdateBatchContactsRequest.d.ts +10 -10
- package/dist/cjs/api/resources/contacts/exports.d.ts +2 -0
- package/dist/cjs/api/resources/contacts/exports.js +21 -0
- package/dist/cjs/api/resources/contacts/types/CreateContactResponse.d.ts +1 -1
- package/dist/cjs/api/resources/contacts/types/GetAttributesResponse.d.ts +4 -4
- package/dist/cjs/api/resources/contacts/types/GetContactInfoResponse.d.ts +13 -13
- package/dist/cjs/api/resources/contacts/types/GetContactStatsResponse.d.ts +11 -11
- package/dist/cjs/api/resources/contacts/types/GetFolderListsResponse.d.ts +2 -2
- package/dist/cjs/api/resources/contacts/types/GetFoldersResponse.d.ts +2 -2
- package/dist/cjs/api/resources/contacts/types/GetListResponse.d.ts +2 -2
- package/dist/cjs/api/resources/contacts/types/GetListsResponse.d.ts +2 -2
- package/dist/cjs/api/resources/contacts/types/GetSegmentsResponse.d.ts +3 -3
- package/dist/cjs/api/resources/conversations/exports.d.ts +2 -0
- package/dist/cjs/api/resources/conversations/exports.js +21 -0
- package/dist/cjs/api/resources/conversations/types/PutConversationsVisitorGroupResponse.d.ts +2 -2
- package/dist/cjs/api/resources/coupons/exports.d.ts +2 -0
- package/dist/cjs/api/resources/coupons/exports.js +21 -0
- package/dist/cjs/api/resources/customObjects/client/Client.d.ts +6 -14
- package/dist/cjs/api/resources/customObjects/client/Client.js +6 -14
- package/dist/cjs/api/resources/customObjects/client/requests/UpsertrecordsRequest.d.ts +6 -6
- package/dist/cjs/api/resources/customObjects/exports.d.ts +2 -0
- package/dist/cjs/api/resources/customObjects/exports.js +21 -0
- package/dist/cjs/api/resources/customObjects/types/BatchDeleteObjectRecordsResponse.d.ts +2 -2
- package/dist/cjs/api/resources/customObjects/types/GetrecordsResponse.d.ts +9 -9
- package/dist/cjs/api/resources/customObjects/types/UpsertrecordsResponse.d.ts +3 -3
- package/dist/cjs/api/resources/deals/client/Client.d.ts +2 -0
- package/dist/cjs/api/resources/deals/client/Client.js +2 -0
- package/dist/cjs/api/resources/deals/exports.d.ts +2 -0
- package/dist/cjs/api/resources/deals/exports.js +21 -0
- package/dist/cjs/api/resources/deals/types/GetCrmAttributesDealsResponseItem.d.ts +5 -5
- package/dist/cjs/api/resources/deals/types/GetCrmDealsResponse.d.ts +1 -1
- package/dist/cjs/api/resources/deals/types/PostCrmDealsImportResponse.d.ts +1 -1
- package/dist/cjs/api/resources/domains/client/requests/AuthenticateDomainRequest.d.ts +0 -5
- package/dist/cjs/api/resources/domains/client/requests/CreateDomainRequest.d.ts +0 -10
- package/dist/cjs/api/resources/domains/client/requests/GetDomainConfigurationRequest.d.ts +0 -5
- package/dist/cjs/api/resources/domains/exports.d.ts +2 -0
- package/dist/cjs/api/resources/domains/exports.js +21 -0
- package/dist/cjs/api/resources/domains/types/CreateDomainResponse.d.ts +2 -2
- package/dist/cjs/api/resources/domains/types/GetDomainsResponse.d.ts +1 -1
- package/dist/cjs/api/resources/ecommerce/client/Client.d.ts +2 -4
- package/dist/cjs/api/resources/ecommerce/client/Client.js +2 -4
- package/dist/cjs/api/resources/ecommerce/client/requests/CreateBatchOrderRequest.d.ts +1 -2
- package/dist/cjs/api/resources/ecommerce/client/requests/CreateProductAlertRequest.d.ts +3 -3
- package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateBatchCategoryRequest.d.ts +4 -4
- package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.ts +15 -11
- package/dist/cjs/api/resources/ecommerce/client/requests/CreateUpdateProductRequest.d.ts +5 -1
- package/dist/cjs/api/resources/ecommerce/exports.d.ts +2 -0
- package/dist/cjs/api/resources/ecommerce/exports.js +21 -0
- package/dist/cjs/api/resources/ecommerce/types/CreateBatchOrderResponse.d.ts +1 -1
- package/dist/cjs/api/resources/ecommerce/types/CreateUpdateBatchCategoryResponse.d.ts +2 -2
- package/dist/cjs/api/resources/ecommerce/types/CreateUpdateBatchProductsResponse.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 +1 -1
- package/dist/cjs/api/resources/ecommerce/types/GetEcommerceAttributionProductsConversionSourceConversionSourceIdResponse.d.ts +7 -7
- package/dist/cjs/api/resources/emailCampaigns/client/Client.d.ts +2 -5
- package/dist/cjs/api/resources/emailCampaigns/client/Client.js +4 -6
- package/dist/cjs/api/resources/emailCampaigns/client/requests/CreateEmailCampaignRequest.d.ts +9 -9
- package/dist/cjs/api/resources/emailCampaigns/client/requests/GetEmailCampaignRequest.d.ts +2 -0
- package/dist/cjs/api/resources/emailCampaigns/client/requests/UpdateEmailCampaignRequest.d.ts +9 -9
- package/dist/cjs/api/resources/emailCampaigns/exports.d.ts +2 -0
- package/dist/cjs/api/resources/emailCampaigns/exports.js +21 -0
- package/dist/cjs/api/resources/emailCampaigns/types/GetAbTestCampaignResultResponse.d.ts +8 -8
- package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignResponse.d.ts +32 -25
- package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignResponse.js +3 -0
- package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsRequestStatus.d.ts +2 -0
- package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsRequestStatus.js +2 -0
- package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.d.ts +34 -27
- package/dist/cjs/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.js +3 -0
- package/dist/cjs/api/resources/emailCampaigns/types/UploadImageToGalleryResponse.d.ts +1 -1
- package/dist/cjs/api/resources/event/client/Client.d.ts +36 -0
- package/dist/cjs/api/resources/event/client/Client.js +125 -0
- package/dist/cjs/api/resources/event/client/requests/CreateEventRequest.d.ts +10 -10
- package/dist/cjs/api/resources/event/client/requests/GetEventsRequest.d.ts +20 -0
- package/dist/cjs/api/resources/event/client/requests/GetEventsRequest.js +3 -0
- package/dist/cjs/api/resources/event/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/event/exports.d.ts +2 -0
- package/dist/cjs/api/resources/event/exports.js +21 -0
- package/dist/cjs/api/resources/event/index.d.ts +1 -0
- package/dist/cjs/api/resources/event/index.js +1 -0
- package/dist/cjs/api/resources/event/types/CreateBatchEventsRequestItem.d.ts +59 -0
- package/dist/cjs/api/resources/event/types/CreateBatchEventsRequestItem.js +3 -0
- package/dist/cjs/api/resources/event/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/event/types/index.js +17 -0
- package/dist/cjs/api/resources/externalFeeds/client/requests/GetExternalFeedByUuidRequest.d.ts +0 -10
- package/dist/cjs/api/resources/externalFeeds/exports.d.ts +2 -0
- package/dist/cjs/api/resources/externalFeeds/exports.js +21 -0
- package/dist/cjs/api/resources/externalFeeds/types/GetAllExternalFeedsResponse.d.ts +4 -4
- package/dist/cjs/api/resources/externalFeeds/types/GetExternalFeedByUuidResponse.d.ts +4 -4
- package/dist/cjs/api/resources/files/exports.d.ts +2 -0
- package/dist/cjs/api/resources/files/exports.js +21 -0
- package/dist/cjs/api/resources/files/types/GetCrmFilesIdResponse.d.ts +1 -1
- package/dist/cjs/api/resources/inboundParsing/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/inboundParsing/client/Client.js +1 -0
- package/dist/cjs/api/resources/inboundParsing/exports.d.ts +2 -0
- package/dist/cjs/api/resources/inboundParsing/exports.js +21 -0
- package/dist/cjs/api/resources/inboundParsing/types/GetInboundEmailEventsByUuidResponse.d.ts +14 -14
- package/dist/cjs/api/resources/inboundParsing/types/GetInboundEmailEventsResponse.d.ts +1 -1
- package/dist/cjs/api/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/index.js +1 -0
- package/dist/cjs/api/resources/masterAccount/client/requests/InviteAdminUserRequest.d.ts +2 -2
- package/dist/cjs/api/resources/masterAccount/client/requests/PutCorporateSubAccountIdPlanRequest.d.ts +9 -9
- package/dist/cjs/api/resources/masterAccount/client/requests/PutCorporateSubAccountsPlanRequest.d.ts +8 -8
- package/dist/cjs/api/resources/masterAccount/client/requests/PutCorporateUserEmailPermissionsRequest.d.ts +2 -2
- package/dist/cjs/api/resources/masterAccount/exports.d.ts +2 -0
- package/dist/cjs/api/resources/masterAccount/exports.js +21 -0
- package/dist/cjs/api/resources/masterAccount/types/GetCorporateGroupIdResponse.d.ts +12 -12
- package/dist/cjs/api/resources/masterAccount/types/GetCorporateInvitedUsersListResponse.d.ts +11 -11
- package/dist/cjs/api/resources/masterAccount/types/GetCorporateIpResponseItem.d.ts +3 -3
- package/dist/cjs/api/resources/masterAccount/types/GetCorporateMasterAccountResponse.d.ts +31 -31
- package/dist/cjs/api/resources/masterAccount/types/GetCorporateSubAccountIdResponse.d.ts +37 -37
- package/dist/cjs/api/resources/masterAccount/types/GetCorporateSubAccountResponse.d.ts +4 -4
- package/dist/cjs/api/resources/masterAccount/types/GetCorporateUserPermissionResponse.d.ts +10 -10
- package/dist/cjs/api/resources/masterAccount/types/GetSubAccountGroupsResponseItem.d.ts +2 -2
- package/dist/cjs/api/resources/masterAccount/types/InviteAdminUserResponse.d.ts +1 -1
- package/dist/cjs/api/resources/masterAccount/types/PostCorporateGroupResponse.d.ts +1 -1
- package/dist/cjs/api/resources/masterAccount/types/PutCorporateUserInvitationActionEmailResponse.d.ts +1 -1
- package/dist/cjs/api/resources/notes/exports.d.ts +2 -0
- package/dist/cjs/api/resources/notes/exports.js +21 -0
- package/dist/cjs/api/resources/notes/types/PostCrmNotesResponse.d.ts +1 -1
- package/dist/cjs/api/resources/payments/exports.d.ts +2 -0
- package/dist/cjs/api/resources/payments/exports.js +21 -0
- package/dist/cjs/api/resources/payments/types/CreatePaymentRequestResponse.d.ts +1 -1
- package/dist/cjs/api/resources/payments/types/GetPaymentRequestResponse.d.ts +3 -3
- package/dist/cjs/api/resources/process/client/requests/GetProcessRequest.d.ts +0 -15
- package/dist/cjs/api/resources/process/exports.d.ts +2 -0
- package/dist/cjs/api/resources/process/exports.js +21 -0
- package/dist/cjs/api/resources/process/types/GetProcessResponse.d.ts +16 -16
- package/dist/cjs/api/resources/process/types/GetProcessesResponse.d.ts +16 -16
- package/dist/cjs/api/resources/program/client/Client.d.ts +21 -0
- package/dist/cjs/api/resources/program/client/Client.js +69 -1
- package/dist/cjs/api/resources/program/client/requests/DeleteContactSubscriptionRequest.d.ts +13 -0
- package/dist/cjs/api/resources/program/client/requests/DeleteContactSubscriptionRequest.js +3 -0
- package/dist/cjs/api/resources/program/client/requests/GetParameterSubscriptionInfoRequest.d.ts +2 -0
- package/dist/cjs/api/resources/program/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/program/exports.d.ts +2 -0
- package/dist/cjs/api/resources/program/exports.js +21 -0
- package/dist/cjs/api/resources/program/types/GetLpListResponse.d.ts +1 -1
- package/dist/cjs/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.ts +28 -28
- package/dist/cjs/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.ts +5 -5
- package/dist/cjs/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.ts +7 -7
- package/dist/cjs/api/resources/reward/client/requests/RedeemVoucherRequest.d.ts +26 -26
- package/dist/cjs/api/resources/reward/exports.d.ts +2 -0
- package/dist/cjs/api/resources/reward/exports.js +21 -0
- package/dist/cjs/api/resources/reward/types/CreateRewardResponse.d.ts +8 -8
- package/dist/cjs/api/resources/reward/types/CreateVoucherResponse.d.ts +11 -11
- package/dist/cjs/api/resources/reward/types/GetCodeCountResponse.d.ts +1 -1
- package/dist/cjs/api/resources/reward/types/GetLoyaltyOfferProgramsPidOffersResponse.d.ts +11 -11
- package/dist/cjs/api/resources/reward/types/GetLoyaltyOfferProgramsPidRewardsRidResponse.d.ts +81 -81
- package/dist/cjs/api/resources/reward/types/GetLoyaltyOfferProgramsPidVouchersResponse.d.ts +15 -15
- package/dist/cjs/api/resources/reward/types/ValidateRewardResponse.d.ts +1 -1
- package/dist/cjs/api/resources/senders/client/requests/CreateSenderRequest.d.ts +1 -13
- package/dist/cjs/api/resources/senders/client/requests/GetIpsFromSenderRequest.d.ts +0 -5
- package/dist/cjs/api/resources/senders/client/requests/GetSendersRequest.d.ts +0 -3
- package/dist/cjs/api/resources/senders/client/requests/UpdateSenderRequest.d.ts +1 -1
- package/dist/cjs/api/resources/senders/exports.d.ts +2 -0
- package/dist/cjs/api/resources/senders/exports.js +21 -0
- package/dist/cjs/api/resources/senders/types/CreateSenderResponse.d.ts +2 -2
- package/dist/cjs/api/resources/senders/types/GetSendersResponse.d.ts +1 -1
- package/dist/cjs/api/resources/smsCampaigns/client/requests/CreateSmsCampaignRequest.d.ts +1 -1
- package/dist/cjs/api/resources/smsCampaigns/client/requests/UpdateSmsCampaignRequest.d.ts +1 -1
- package/dist/cjs/api/resources/smsCampaigns/exports.d.ts +2 -0
- package/dist/cjs/api/resources/smsCampaigns/exports.js +21 -0
- package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.ts +1 -1
- package/dist/cjs/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.ts +3 -3
- package/dist/cjs/api/resources/smsTemplates/exports.d.ts +2 -0
- package/dist/cjs/api/resources/smsTemplates/exports.js +21 -0
- package/dist/cjs/api/resources/smsTemplates/types/GetSmsTemplatesResponse.d.ts +17 -17
- package/dist/cjs/api/resources/tasks/exports.d.ts +2 -0
- package/dist/cjs/api/resources/tasks/exports.js +21 -0
- package/dist/cjs/api/resources/tasks/types/GetCrmTasksResponse.d.ts +1 -1
- package/dist/cjs/api/resources/tasks/types/GetCrmTasktypesResponse.d.ts +2 -2
- package/dist/cjs/api/resources/tier/client/requests/CreateTierForTierGroupRequest.d.ts +3 -3
- package/dist/cjs/api/resources/tier/client/requests/CreateTierGroupRequest.d.ts +11 -0
- package/dist/cjs/api/resources/tier/client/requests/UpdateTierGroupRequest.d.ts +11 -0
- package/dist/cjs/api/resources/tier/client/requests/UpdateTierRequest.d.ts +3 -3
- package/dist/cjs/api/resources/tier/exports.d.ts +2 -0
- package/dist/cjs/api/resources/tier/exports.js +21 -0
- package/dist/cjs/api/resources/tier/types/AddSubscriptionToTierResponse.d.ts +7 -7
- package/dist/cjs/api/resources/tier/types/GetListOfTierGroupsResponse.d.ts +1 -1
- package/dist/cjs/api/resources/tier/types/GetLoyaltyProgramTierResponse.d.ts +1 -1
- package/dist/cjs/api/resources/transactionalEmails/client/Client.d.ts +2 -6
- package/dist/cjs/api/resources/transactionalEmails/client/Client.js +2 -6
- package/dist/cjs/api/resources/transactionalEmails/client/requests/CreateSmtpTemplateRequest.d.ts +3 -3
- package/dist/cjs/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.ts +0 -7
- package/dist/cjs/api/resources/transactionalEmails/client/requests/SendTransacEmailRequest.d.ts +21 -21
- package/dist/cjs/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.ts +3 -3
- package/dist/cjs/api/resources/transactionalEmails/exports.d.ts +2 -0
- package/dist/cjs/api/resources/transactionalEmails/exports.js +21 -0
- package/dist/cjs/api/resources/transactionalEmails/types/GetAggregatedSmtpReportResponse.d.ts +13 -13
- package/dist/cjs/api/resources/transactionalEmails/types/GetEmailEventReportResponse.d.ts +8 -8
- package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpReportResponse.d.ts +1 -1
- package/dist/cjs/api/resources/transactionalEmails/types/GetSmtpTemplatesResponse.d.ts +2 -2
- package/dist/cjs/api/resources/transactionalEmails/types/GetTransacBlockedContactsResponse.d.ts +4 -4
- package/dist/cjs/api/resources/transactionalEmails/types/GetTransacEmailContentResponse.d.ts +1 -1
- package/dist/cjs/api/resources/transactionalEmails/types/GetTransacEmailsListResponse.d.ts +5 -5
- package/dist/cjs/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesResponse.d.ts +6 -6
- package/dist/cjs/api/resources/transactionalEmails/types/SendTransacEmailResponse.d.ts +2 -2
- package/dist/cjs/api/resources/transactionalSms/client/Client.d.ts +5 -9
- package/dist/cjs/api/resources/transactionalSms/client/Client.js +5 -9
- package/dist/cjs/api/resources/transactionalSms/exports.d.ts +2 -0
- package/dist/cjs/api/resources/transactionalSms/exports.js +21 -0
- package/dist/cjs/api/resources/transactionalSms/types/GetSmsEventsResponse.d.ts +8 -8
- package/dist/cjs/api/resources/transactionalSms/types/GetTransacAggregatedSmsReportResponse.d.ts +11 -11
- package/dist/cjs/api/resources/transactionalSms/types/GetTransacSmsReportResponse.d.ts +12 -12
- package/dist/cjs/api/resources/transactionalSms/types/SendTransacSmsResponse.d.ts +3 -3
- package/dist/cjs/api/resources/transactionalWhatsApp/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/transactionalWhatsApp/client/Client.js +2 -1
- package/dist/cjs/api/resources/transactionalWhatsApp/exports.d.ts +2 -0
- package/dist/cjs/api/resources/transactionalWhatsApp/exports.js +21 -0
- package/dist/cjs/api/resources/transactionalWhatsApp/types/GetWhatsappEventReportResponse.d.ts +4 -4
- package/dist/cjs/api/resources/user/exports.d.ts +2 -0
- package/dist/cjs/api/resources/user/exports.js +21 -0
- package/dist/cjs/api/resources/user/types/EditUserPermissionResponse.d.ts +2 -2
- package/dist/cjs/api/resources/user/types/GetInvitedUsersListResponse.d.ts +4 -4
- package/dist/cjs/api/resources/user/types/InviteuserResponse.d.ts +1 -1
- package/dist/cjs/api/resources/user/types/PutRevokeUserPermissionResponse.d.ts +1 -1
- package/dist/cjs/api/resources/user/types/PutresendcancelinvitationResponse.d.ts +1 -1
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +7 -13
- package/dist/cjs/api/resources/webhooks/client/Client.js +7 -13
- package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequest.d.ts +6 -4
- package/dist/cjs/api/resources/webhooks/client/requests/CreateWebhookRequest.js +1 -0
- package/dist/cjs/api/resources/webhooks/client/requests/UpdateWebhookRequest.d.ts +6 -4
- package/dist/cjs/api/resources/webhooks/client/requests/UpdateWebhookRequest.js +1 -0
- package/dist/cjs/api/resources/webhooks/exports.d.ts +2 -0
- package/dist/cjs/api/resources/webhooks/exports.js +21 -0
- package/dist/cjs/api/resources/whatsAppCampaigns/client/Client.d.ts +19 -44
- package/dist/cjs/api/resources/whatsAppCampaigns/client/Client.js +19 -44
- package/dist/cjs/api/resources/whatsAppCampaigns/client/requests/CreateWhatsAppCampaignRequest.d.ts +3 -3
- package/dist/cjs/api/resources/whatsAppCampaigns/client/requests/UpdateWhatsAppCampaignRequest.d.ts +3 -3
- package/dist/cjs/api/resources/whatsAppCampaigns/exports.d.ts +2 -0
- package/dist/cjs/api/resources/whatsAppCampaigns/exports.js +21 -0
- package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.ts +15 -15
- package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignsResponse.d.ts +6 -6
- package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppConfigResponse.d.ts +6 -6
- package/dist/cjs/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.ts +3 -3
- package/dist/cjs/api/types/BalanceDefinition.d.ts +20 -20
- package/dist/cjs/api/types/BalanceLimit.d.ts +8 -8
- package/dist/cjs/api/types/BatchAcceptedResponse.d.ts +9 -0
- package/dist/cjs/api/types/BatchAcceptedResponse.js +3 -0
- package/dist/cjs/api/types/BatchEventsResponse.d.ts +26 -0
- package/dist/cjs/api/types/BatchEventsResponse.js +3 -0
- package/dist/cjs/api/types/Company.d.ts +4 -4
- package/dist/cjs/api/types/ContactErrorModel.d.ts +1 -1
- package/dist/cjs/api/types/ConversationsMessage.d.ts +53 -53
- package/dist/cjs/api/types/CreateUpdateFolder.d.ts +1 -1
- package/dist/cjs/api/types/Deal.d.ts +4 -4
- package/dist/cjs/api/types/ErrorModel.d.ts +1 -1
- package/dist/cjs/api/types/FileData.d.ts +7 -7
- package/dist/cjs/api/types/GetCampaignStats.d.ts +7 -7
- package/dist/cjs/api/types/GetCategoryDetails.d.ts +1 -1
- package/dist/cjs/api/types/GetContactDetails.d.ts +2 -2
- package/dist/cjs/api/types/GetCouponCollection.d.ts +3 -3
- package/dist/cjs/api/types/GetEventsList.d.ts +32 -0
- package/dist/cjs/api/types/GetEventsList.js +3 -0
- package/dist/cjs/api/types/GetExtendedCampaignOverview.d.ts +32 -25
- package/dist/cjs/api/types/GetExtendedCampaignOverview.js +3 -0
- package/dist/cjs/api/types/GetExtendedCampaignStats.d.ts +4 -4
- package/dist/cjs/api/types/GetProductDetails.d.ts +14 -10
- package/dist/cjs/api/types/GetSmsCampaignOverview.d.ts +1 -1
- package/dist/cjs/api/types/GetSmtpTemplateOverview.d.ts +4 -4
- package/dist/cjs/api/types/GetWebhook.d.ts +4 -4
- package/dist/cjs/api/types/InternalServerErrorBody.d.ts +48 -0
- package/dist/cjs/api/types/InternalServerErrorBody.js +46 -0
- package/dist/cjs/api/types/Inviteuser.d.ts +2 -2
- package/dist/cjs/api/types/LoyaltyProgram.d.ts +12 -12
- package/dist/cjs/api/types/NodeResponse.d.ts +8 -8
- package/dist/cjs/api/types/Note.d.ts +6 -6
- package/dist/cjs/api/types/NoteData.d.ts +3 -3
- package/dist/cjs/api/types/Order.d.ts +30 -20
- package/dist/cjs/api/types/Pipeline.d.ts +5 -5
- package/dist/cjs/api/types/PostContactInfo.d.ts +4 -4
- package/dist/cjs/api/types/PostSendFailed.d.ts +3 -3
- package/dist/cjs/api/types/Redeem.d.ts +14 -14
- package/dist/cjs/api/types/RuleConditionResponse.d.ts +5 -5
- package/dist/cjs/api/types/SendReport.d.ts +1 -1
- package/dist/cjs/api/types/SendTestEmail.d.ts +1 -1
- package/dist/cjs/api/types/SendTransacSms.d.ts +10 -6
- package/dist/cjs/api/types/Task.d.ts +4 -4
- package/dist/cjs/api/types/Tier.d.ts +16 -16
- package/dist/cjs/api/types/TierGroup.d.ts +8 -8
- package/dist/cjs/api/types/Transaction.d.ts +15 -15
- package/dist/cjs/api/types/UpdateCampaignStatus.d.ts +2 -1
- package/dist/cjs/api/types/UpdateCampaignStatus.js +1 -0
- package/dist/cjs/api/types/ValueResponse.d.ts +8 -8
- package/dist/cjs/api/types/VariablesItems.d.ts +3 -3
- package/dist/cjs/api/types/index.d.ts +4 -0
- package/dist/cjs/api/types/index.js +4 -0
- package/dist/cjs/core/fetcher/BinaryResponse.d.ts +1 -1
- package/dist/cjs/core/fetcher/Fetcher.js +8 -2
- package/dist/cjs/core/fetcher/index.d.ts +2 -0
- package/dist/cjs/core/fetcher/index.js +3 -1
- package/dist/cjs/core/fetcher/makePassthroughRequest.d.ts +49 -0
- package/dist/cjs/core/fetcher/makePassthroughRequest.js +135 -0
- package/dist/cjs/core/fetcher/makeRequest.d.ts +6 -1
- package/dist/cjs/core/fetcher/makeRequest.js +30 -9
- package/dist/cjs/core/runtime/runtime.js +8 -7
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +12 -0
- package/dist/esm/Client.mjs +34 -0
- package/dist/esm/api/resources/account/exports.d.mts +2 -0
- package/dist/esm/api/resources/account/exports.mjs +3 -0
- package/dist/esm/api/resources/account/types/GetAccountActivityResponse.d.mts +1 -1
- package/dist/esm/api/resources/account/types/GetAccountResponse.d.mts +7 -7
- package/dist/esm/api/resources/balance/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/balance/client/Client.mjs +20 -11
- package/dist/esm/api/resources/balance/client/requests/GetContactBalancesRequest.d.mts +2 -0
- package/dist/esm/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidActiveBalanceRequest.d.mts +2 -0
- package/dist/esm/api/resources/balance/client/requests/GetLoyaltyBalanceProgramsPidTransactionHistoryRequest.d.mts +10 -6
- package/dist/esm/api/resources/balance/client/requests/GetSubscriptionBalancesRequest.d.mts +2 -0
- package/dist/esm/api/resources/balance/client/requests/PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequest.d.mts +10 -1
- package/dist/esm/api/resources/balance/client/requests/UpdateBalanceDefinitionRequest.d.mts +10 -1
- package/dist/esm/api/resources/balance/exports.d.mts +2 -0
- package/dist/esm/api/resources/balance/exports.mjs +3 -0
- package/dist/esm/api/resources/balance/types/CreateBalanceOrderResponse.d.mts +6 -6
- package/dist/esm/api/resources/balance/types/GetBalanceDefinitionListResponse.d.mts +1 -1
- package/dist/esm/api/resources/balance/types/GetContactBalancesResponse.d.mts +8 -8
- package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus.d.mts +8 -0
- package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestStatus.mjs +8 -0
- package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType.d.mts +5 -0
- package/dist/esm/api/resources/balance/types/{GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSortField.mjs → GetLoyaltyBalanceProgramsPidTransactionHistoryRequestTransactionType.mjs} +3 -4
- package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryResponse.d.mts +15 -15
- package/dist/esm/api/resources/balance/types/GetSubscriptionBalancesResponse.d.mts +3 -3
- package/dist/esm/api/resources/balance/types/PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse.d.mts +9 -9
- package/dist/esm/api/resources/balance/types/index.d.mts +2 -1
- package/dist/esm/api/resources/balance/types/index.mjs +2 -1
- package/dist/esm/api/resources/companies/client/Client.d.mts +28 -0
- package/dist/esm/api/resources/companies/client/Client.mjs +107 -0
- package/dist/esm/api/resources/companies/client/requests/DeleteCrmAttributesIdRequest.d.mts +10 -0
- package/dist/esm/api/resources/companies/client/requests/DeleteCrmAttributesIdRequest.mjs +2 -0
- package/dist/esm/api/resources/companies/client/requests/PatchCrmAttributesIdRequest.d.mts +33 -0
- package/dist/esm/api/resources/companies/client/requests/PatchCrmAttributesIdRequest.mjs +9 -0
- package/dist/esm/api/resources/companies/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/companies/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/companies/exports.d.mts +2 -0
- package/dist/esm/api/resources/companies/exports.mjs +3 -0
- package/dist/esm/api/resources/companies/types/GetCompaniesResponse.d.mts +1 -1
- package/dist/esm/api/resources/companies/types/GetCrmAttributesCompaniesResponseItem.d.mts +5 -5
- package/dist/esm/api/resources/companies/types/PostCompaniesImportResponse.d.mts +1 -1
- package/dist/esm/api/resources/contacts/client/Client.d.mts +15 -45
- package/dist/esm/api/resources/contacts/client/Client.mjs +15 -45
- package/dist/esm/api/resources/contacts/client/requests/AddContactToListRequest.d.mts +0 -24
- package/dist/esm/api/resources/contacts/client/requests/ImportContactsRequest.d.mts +4 -4
- package/dist/esm/api/resources/contacts/client/requests/RemoveContactFromListRequest.d.mts +0 -32
- package/dist/esm/api/resources/contacts/client/requests/RequestContactExportRequest.d.mts +7 -7
- package/dist/esm/api/resources/contacts/client/requests/UpdateBatchContactsRequest.d.mts +10 -10
- package/dist/esm/api/resources/contacts/exports.d.mts +2 -0
- package/dist/esm/api/resources/contacts/exports.mjs +3 -0
- package/dist/esm/api/resources/contacts/types/CreateContactResponse.d.mts +1 -1
- package/dist/esm/api/resources/contacts/types/GetAttributesResponse.d.mts +4 -4
- package/dist/esm/api/resources/contacts/types/GetContactInfoResponse.d.mts +13 -13
- package/dist/esm/api/resources/contacts/types/GetContactStatsResponse.d.mts +11 -11
- package/dist/esm/api/resources/contacts/types/GetFolderListsResponse.d.mts +2 -2
- package/dist/esm/api/resources/contacts/types/GetFoldersResponse.d.mts +2 -2
- package/dist/esm/api/resources/contacts/types/GetListResponse.d.mts +2 -2
- package/dist/esm/api/resources/contacts/types/GetListsResponse.d.mts +2 -2
- package/dist/esm/api/resources/contacts/types/GetSegmentsResponse.d.mts +3 -3
- package/dist/esm/api/resources/conversations/exports.d.mts +2 -0
- package/dist/esm/api/resources/conversations/exports.mjs +3 -0
- package/dist/esm/api/resources/conversations/types/PutConversationsVisitorGroupResponse.d.mts +2 -2
- package/dist/esm/api/resources/coupons/exports.d.mts +2 -0
- package/dist/esm/api/resources/coupons/exports.mjs +3 -0
- package/dist/esm/api/resources/customObjects/client/Client.d.mts +6 -14
- package/dist/esm/api/resources/customObjects/client/Client.mjs +6 -14
- package/dist/esm/api/resources/customObjects/client/requests/UpsertrecordsRequest.d.mts +6 -6
- package/dist/esm/api/resources/customObjects/exports.d.mts +2 -0
- package/dist/esm/api/resources/customObjects/exports.mjs +3 -0
- package/dist/esm/api/resources/customObjects/types/BatchDeleteObjectRecordsResponse.d.mts +2 -2
- package/dist/esm/api/resources/customObjects/types/GetrecordsResponse.d.mts +9 -9
- package/dist/esm/api/resources/customObjects/types/UpsertrecordsResponse.d.mts +3 -3
- package/dist/esm/api/resources/deals/client/Client.d.mts +2 -0
- package/dist/esm/api/resources/deals/client/Client.mjs +2 -0
- package/dist/esm/api/resources/deals/exports.d.mts +2 -0
- package/dist/esm/api/resources/deals/exports.mjs +3 -0
- package/dist/esm/api/resources/deals/types/GetCrmAttributesDealsResponseItem.d.mts +5 -5
- package/dist/esm/api/resources/deals/types/GetCrmDealsResponse.d.mts +1 -1
- package/dist/esm/api/resources/deals/types/PostCrmDealsImportResponse.d.mts +1 -1
- package/dist/esm/api/resources/domains/client/requests/AuthenticateDomainRequest.d.mts +0 -5
- package/dist/esm/api/resources/domains/client/requests/CreateDomainRequest.d.mts +0 -10
- package/dist/esm/api/resources/domains/client/requests/GetDomainConfigurationRequest.d.mts +0 -5
- package/dist/esm/api/resources/domains/exports.d.mts +2 -0
- package/dist/esm/api/resources/domains/exports.mjs +3 -0
- package/dist/esm/api/resources/domains/types/CreateDomainResponse.d.mts +2 -2
- package/dist/esm/api/resources/domains/types/GetDomainsResponse.d.mts +1 -1
- package/dist/esm/api/resources/ecommerce/client/Client.d.mts +2 -4
- package/dist/esm/api/resources/ecommerce/client/Client.mjs +2 -4
- package/dist/esm/api/resources/ecommerce/client/requests/CreateBatchOrderRequest.d.mts +1 -2
- package/dist/esm/api/resources/ecommerce/client/requests/CreateProductAlertRequest.d.mts +3 -3
- package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateBatchCategoryRequest.d.mts +4 -4
- package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateBatchProductsRequest.d.mts +15 -11
- package/dist/esm/api/resources/ecommerce/client/requests/CreateUpdateProductRequest.d.mts +5 -1
- package/dist/esm/api/resources/ecommerce/exports.d.mts +2 -0
- package/dist/esm/api/resources/ecommerce/exports.mjs +3 -0
- package/dist/esm/api/resources/ecommerce/types/CreateBatchOrderResponse.d.mts +1 -1
- package/dist/esm/api/resources/ecommerce/types/CreateUpdateBatchCategoryResponse.d.mts +2 -2
- package/dist/esm/api/resources/ecommerce/types/CreateUpdateBatchProductsResponse.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 +1 -1
- package/dist/esm/api/resources/ecommerce/types/GetEcommerceAttributionProductsConversionSourceConversionSourceIdResponse.d.mts +7 -7
- package/dist/esm/api/resources/emailCampaigns/client/Client.d.mts +2 -5
- package/dist/esm/api/resources/emailCampaigns/client/Client.mjs +4 -6
- package/dist/esm/api/resources/emailCampaigns/client/requests/CreateEmailCampaignRequest.d.mts +9 -9
- package/dist/esm/api/resources/emailCampaigns/client/requests/GetEmailCampaignRequest.d.mts +2 -0
- package/dist/esm/api/resources/emailCampaigns/client/requests/UpdateEmailCampaignRequest.d.mts +9 -9
- package/dist/esm/api/resources/emailCampaigns/exports.d.mts +2 -0
- package/dist/esm/api/resources/emailCampaigns/exports.mjs +3 -0
- package/dist/esm/api/resources/emailCampaigns/types/GetAbTestCampaignResultResponse.d.mts +8 -8
- package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignResponse.d.mts +32 -25
- package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignResponse.mjs +3 -0
- package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsRequestStatus.d.mts +2 -0
- package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsRequestStatus.mjs +2 -0
- package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.d.mts +34 -27
- package/dist/esm/api/resources/emailCampaigns/types/GetEmailCampaignsResponse.mjs +3 -0
- package/dist/esm/api/resources/emailCampaigns/types/UploadImageToGalleryResponse.d.mts +1 -1
- package/dist/esm/api/resources/event/client/Client.d.mts +36 -0
- package/dist/esm/api/resources/event/client/Client.mjs +125 -0
- package/dist/esm/api/resources/event/client/requests/CreateEventRequest.d.mts +10 -10
- package/dist/esm/api/resources/event/client/requests/GetEventsRequest.d.mts +20 -0
- package/dist/esm/api/resources/event/client/requests/GetEventsRequest.mjs +2 -0
- package/dist/esm/api/resources/event/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/event/exports.d.mts +2 -0
- package/dist/esm/api/resources/event/exports.mjs +3 -0
- package/dist/esm/api/resources/event/index.d.mts +1 -0
- package/dist/esm/api/resources/event/index.mjs +1 -0
- package/dist/esm/api/resources/event/types/CreateBatchEventsRequestItem.d.mts +59 -0
- package/dist/esm/api/resources/event/types/CreateBatchEventsRequestItem.mjs +2 -0
- package/dist/esm/api/resources/event/types/index.d.mts +1 -0
- package/dist/esm/api/resources/event/types/index.mjs +1 -0
- package/dist/esm/api/resources/externalFeeds/client/requests/GetExternalFeedByUuidRequest.d.mts +0 -10
- package/dist/esm/api/resources/externalFeeds/exports.d.mts +2 -0
- package/dist/esm/api/resources/externalFeeds/exports.mjs +3 -0
- package/dist/esm/api/resources/externalFeeds/types/GetAllExternalFeedsResponse.d.mts +4 -4
- package/dist/esm/api/resources/externalFeeds/types/GetExternalFeedByUuidResponse.d.mts +4 -4
- package/dist/esm/api/resources/files/exports.d.mts +2 -0
- package/dist/esm/api/resources/files/exports.mjs +3 -0
- package/dist/esm/api/resources/files/types/GetCrmFilesIdResponse.d.mts +1 -1
- package/dist/esm/api/resources/inboundParsing/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/inboundParsing/client/Client.mjs +1 -0
- package/dist/esm/api/resources/inboundParsing/exports.d.mts +2 -0
- package/dist/esm/api/resources/inboundParsing/exports.mjs +3 -0
- package/dist/esm/api/resources/inboundParsing/types/GetInboundEmailEventsByUuidResponse.d.mts +14 -14
- package/dist/esm/api/resources/inboundParsing/types/GetInboundEmailEventsResponse.d.mts +1 -1
- package/dist/esm/api/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/index.mjs +1 -0
- package/dist/esm/api/resources/masterAccount/client/requests/InviteAdminUserRequest.d.mts +2 -2
- package/dist/esm/api/resources/masterAccount/client/requests/PutCorporateSubAccountIdPlanRequest.d.mts +9 -9
- package/dist/esm/api/resources/masterAccount/client/requests/PutCorporateSubAccountsPlanRequest.d.mts +8 -8
- package/dist/esm/api/resources/masterAccount/client/requests/PutCorporateUserEmailPermissionsRequest.d.mts +2 -2
- package/dist/esm/api/resources/masterAccount/exports.d.mts +2 -0
- package/dist/esm/api/resources/masterAccount/exports.mjs +3 -0
- package/dist/esm/api/resources/masterAccount/types/GetCorporateGroupIdResponse.d.mts +12 -12
- package/dist/esm/api/resources/masterAccount/types/GetCorporateInvitedUsersListResponse.d.mts +11 -11
- package/dist/esm/api/resources/masterAccount/types/GetCorporateIpResponseItem.d.mts +3 -3
- package/dist/esm/api/resources/masterAccount/types/GetCorporateMasterAccountResponse.d.mts +31 -31
- package/dist/esm/api/resources/masterAccount/types/GetCorporateSubAccountIdResponse.d.mts +37 -37
- package/dist/esm/api/resources/masterAccount/types/GetCorporateSubAccountResponse.d.mts +4 -4
- package/dist/esm/api/resources/masterAccount/types/GetCorporateUserPermissionResponse.d.mts +10 -10
- package/dist/esm/api/resources/masterAccount/types/GetSubAccountGroupsResponseItem.d.mts +2 -2
- package/dist/esm/api/resources/masterAccount/types/InviteAdminUserResponse.d.mts +1 -1
- package/dist/esm/api/resources/masterAccount/types/PostCorporateGroupResponse.d.mts +1 -1
- package/dist/esm/api/resources/masterAccount/types/PutCorporateUserInvitationActionEmailResponse.d.mts +1 -1
- package/dist/esm/api/resources/notes/exports.d.mts +2 -0
- package/dist/esm/api/resources/notes/exports.mjs +3 -0
- package/dist/esm/api/resources/notes/types/PostCrmNotesResponse.d.mts +1 -1
- package/dist/esm/api/resources/payments/exports.d.mts +2 -0
- package/dist/esm/api/resources/payments/exports.mjs +3 -0
- package/dist/esm/api/resources/payments/types/CreatePaymentRequestResponse.d.mts +1 -1
- package/dist/esm/api/resources/payments/types/GetPaymentRequestResponse.d.mts +3 -3
- package/dist/esm/api/resources/process/client/requests/GetProcessRequest.d.mts +0 -15
- package/dist/esm/api/resources/process/exports.d.mts +2 -0
- package/dist/esm/api/resources/process/exports.mjs +3 -0
- package/dist/esm/api/resources/process/types/GetProcessResponse.d.mts +16 -16
- package/dist/esm/api/resources/process/types/GetProcessesResponse.d.mts +16 -16
- package/dist/esm/api/resources/program/client/Client.d.mts +21 -0
- package/dist/esm/api/resources/program/client/Client.mjs +69 -1
- package/dist/esm/api/resources/program/client/requests/DeleteContactSubscriptionRequest.d.mts +13 -0
- package/dist/esm/api/resources/program/client/requests/DeleteContactSubscriptionRequest.mjs +2 -0
- package/dist/esm/api/resources/program/client/requests/GetParameterSubscriptionInfoRequest.d.mts +2 -0
- package/dist/esm/api/resources/program/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/program/exports.d.mts +2 -0
- package/dist/esm/api/resources/program/exports.mjs +3 -0
- package/dist/esm/api/resources/program/types/GetLpListResponse.d.mts +1 -1
- package/dist/esm/api/resources/program/types/GetParameterSubscriptionInfoResponse.d.mts +28 -28
- package/dist/esm/api/resources/program/types/SubscribeMemberToASubscriptionResponse.d.mts +5 -5
- package/dist/esm/api/resources/program/types/SubscribeToLoyaltyProgramResponse.d.mts +7 -7
- package/dist/esm/api/resources/reward/client/requests/RedeemVoucherRequest.d.mts +26 -26
- package/dist/esm/api/resources/reward/exports.d.mts +2 -0
- package/dist/esm/api/resources/reward/exports.mjs +3 -0
- package/dist/esm/api/resources/reward/types/CreateRewardResponse.d.mts +8 -8
- package/dist/esm/api/resources/reward/types/CreateVoucherResponse.d.mts +11 -11
- package/dist/esm/api/resources/reward/types/GetCodeCountResponse.d.mts +1 -1
- package/dist/esm/api/resources/reward/types/GetLoyaltyOfferProgramsPidOffersResponse.d.mts +11 -11
- package/dist/esm/api/resources/reward/types/GetLoyaltyOfferProgramsPidRewardsRidResponse.d.mts +81 -81
- package/dist/esm/api/resources/reward/types/GetLoyaltyOfferProgramsPidVouchersResponse.d.mts +15 -15
- package/dist/esm/api/resources/reward/types/ValidateRewardResponse.d.mts +1 -1
- package/dist/esm/api/resources/senders/client/requests/CreateSenderRequest.d.mts +1 -13
- package/dist/esm/api/resources/senders/client/requests/GetIpsFromSenderRequest.d.mts +0 -5
- package/dist/esm/api/resources/senders/client/requests/GetSendersRequest.d.mts +0 -3
- package/dist/esm/api/resources/senders/client/requests/UpdateSenderRequest.d.mts +1 -1
- package/dist/esm/api/resources/senders/exports.d.mts +2 -0
- package/dist/esm/api/resources/senders/exports.mjs +3 -0
- package/dist/esm/api/resources/senders/types/CreateSenderResponse.d.mts +2 -2
- package/dist/esm/api/resources/senders/types/GetSendersResponse.d.mts +1 -1
- package/dist/esm/api/resources/smsCampaigns/client/requests/CreateSmsCampaignRequest.d.mts +1 -1
- package/dist/esm/api/resources/smsCampaigns/client/requests/UpdateSmsCampaignRequest.d.mts +1 -1
- package/dist/esm/api/resources/smsCampaigns/exports.d.mts +2 -0
- package/dist/esm/api/resources/smsCampaigns/exports.mjs +3 -0
- package/dist/esm/api/resources/smsCampaigns/types/GetSmsCampaignResponse.d.mts +1 -1
- package/dist/esm/api/resources/smsCampaigns/types/GetSmsCampaignsResponse.d.mts +3 -3
- package/dist/esm/api/resources/smsTemplates/exports.d.mts +2 -0
- package/dist/esm/api/resources/smsTemplates/exports.mjs +3 -0
- package/dist/esm/api/resources/smsTemplates/types/GetSmsTemplatesResponse.d.mts +17 -17
- package/dist/esm/api/resources/tasks/exports.d.mts +2 -0
- package/dist/esm/api/resources/tasks/exports.mjs +3 -0
- package/dist/esm/api/resources/tasks/types/GetCrmTasksResponse.d.mts +1 -1
- package/dist/esm/api/resources/tasks/types/GetCrmTasktypesResponse.d.mts +2 -2
- package/dist/esm/api/resources/tier/client/requests/CreateTierForTierGroupRequest.d.mts +3 -3
- package/dist/esm/api/resources/tier/client/requests/CreateTierGroupRequest.d.mts +11 -0
- package/dist/esm/api/resources/tier/client/requests/UpdateTierGroupRequest.d.mts +11 -0
- package/dist/esm/api/resources/tier/client/requests/UpdateTierRequest.d.mts +3 -3
- package/dist/esm/api/resources/tier/exports.d.mts +2 -0
- package/dist/esm/api/resources/tier/exports.mjs +3 -0
- package/dist/esm/api/resources/tier/types/AddSubscriptionToTierResponse.d.mts +7 -7
- package/dist/esm/api/resources/tier/types/GetListOfTierGroupsResponse.d.mts +1 -1
- package/dist/esm/api/resources/tier/types/GetLoyaltyProgramTierResponse.d.mts +1 -1
- package/dist/esm/api/resources/transactionalEmails/client/Client.d.mts +2 -6
- package/dist/esm/api/resources/transactionalEmails/client/Client.mjs +2 -6
- package/dist/esm/api/resources/transactionalEmails/client/requests/CreateSmtpTemplateRequest.d.mts +3 -3
- package/dist/esm/api/resources/transactionalEmails/client/requests/GetScheduledEmailByIdRequest.d.mts +0 -7
- package/dist/esm/api/resources/transactionalEmails/client/requests/SendTransacEmailRequest.d.mts +21 -21
- package/dist/esm/api/resources/transactionalEmails/client/requests/UpdateSmtpTemplateRequest.d.mts +3 -3
- package/dist/esm/api/resources/transactionalEmails/exports.d.mts +2 -0
- package/dist/esm/api/resources/transactionalEmails/exports.mjs +3 -0
- package/dist/esm/api/resources/transactionalEmails/types/GetAggregatedSmtpReportResponse.d.mts +13 -13
- package/dist/esm/api/resources/transactionalEmails/types/GetEmailEventReportResponse.d.mts +8 -8
- package/dist/esm/api/resources/transactionalEmails/types/GetSmtpReportResponse.d.mts +1 -1
- package/dist/esm/api/resources/transactionalEmails/types/GetSmtpTemplatesResponse.d.mts +2 -2
- package/dist/esm/api/resources/transactionalEmails/types/GetTransacBlockedContactsResponse.d.mts +4 -4
- package/dist/esm/api/resources/transactionalEmails/types/GetTransacEmailContentResponse.d.mts +1 -1
- package/dist/esm/api/resources/transactionalEmails/types/GetTransacEmailsListResponse.d.mts +5 -5
- package/dist/esm/api/resources/transactionalEmails/types/PostPreviewSmtpEmailTemplatesResponse.d.mts +6 -6
- package/dist/esm/api/resources/transactionalEmails/types/SendTransacEmailResponse.d.mts +2 -2
- package/dist/esm/api/resources/transactionalSms/client/Client.d.mts +5 -9
- package/dist/esm/api/resources/transactionalSms/client/Client.mjs +5 -9
- package/dist/esm/api/resources/transactionalSms/exports.d.mts +2 -0
- package/dist/esm/api/resources/transactionalSms/exports.mjs +3 -0
- package/dist/esm/api/resources/transactionalSms/types/GetSmsEventsResponse.d.mts +8 -8
- package/dist/esm/api/resources/transactionalSms/types/GetTransacAggregatedSmsReportResponse.d.mts +11 -11
- package/dist/esm/api/resources/transactionalSms/types/GetTransacSmsReportResponse.d.mts +12 -12
- package/dist/esm/api/resources/transactionalSms/types/SendTransacSmsResponse.d.mts +3 -3
- package/dist/esm/api/resources/transactionalWhatsApp/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/transactionalWhatsApp/client/Client.mjs +2 -1
- package/dist/esm/api/resources/transactionalWhatsApp/exports.d.mts +2 -0
- package/dist/esm/api/resources/transactionalWhatsApp/exports.mjs +3 -0
- package/dist/esm/api/resources/transactionalWhatsApp/types/GetWhatsappEventReportResponse.d.mts +4 -4
- package/dist/esm/api/resources/user/exports.d.mts +2 -0
- package/dist/esm/api/resources/user/exports.mjs +3 -0
- package/dist/esm/api/resources/user/types/EditUserPermissionResponse.d.mts +2 -2
- package/dist/esm/api/resources/user/types/GetInvitedUsersListResponse.d.mts +4 -4
- package/dist/esm/api/resources/user/types/InviteuserResponse.d.mts +1 -1
- package/dist/esm/api/resources/user/types/PutRevokeUserPermissionResponse.d.mts +1 -1
- package/dist/esm/api/resources/user/types/PutresendcancelinvitationResponse.d.mts +1 -1
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +7 -13
- package/dist/esm/api/resources/webhooks/client/Client.mjs +7 -13
- package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequest.d.mts +6 -4
- package/dist/esm/api/resources/webhooks/client/requests/CreateWebhookRequest.mjs +1 -0
- package/dist/esm/api/resources/webhooks/client/requests/UpdateWebhookRequest.d.mts +6 -4
- package/dist/esm/api/resources/webhooks/client/requests/UpdateWebhookRequest.mjs +1 -0
- package/dist/esm/api/resources/webhooks/exports.d.mts +2 -0
- package/dist/esm/api/resources/webhooks/exports.mjs +3 -0
- package/dist/esm/api/resources/whatsAppCampaigns/client/Client.d.mts +19 -44
- package/dist/esm/api/resources/whatsAppCampaigns/client/Client.mjs +19 -44
- package/dist/esm/api/resources/whatsAppCampaigns/client/requests/CreateWhatsAppCampaignRequest.d.mts +3 -3
- package/dist/esm/api/resources/whatsAppCampaigns/client/requests/UpdateWhatsAppCampaignRequest.d.mts +3 -3
- package/dist/esm/api/resources/whatsAppCampaigns/exports.d.mts +2 -0
- package/dist/esm/api/resources/whatsAppCampaigns/exports.mjs +3 -0
- package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignResponse.d.mts +15 -15
- package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppCampaignsResponse.d.mts +6 -6
- package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppConfigResponse.d.mts +6 -6
- package/dist/esm/api/resources/whatsAppCampaigns/types/GetWhatsAppTemplatesResponse.d.mts +3 -3
- package/dist/esm/api/types/BalanceDefinition.d.mts +20 -20
- package/dist/esm/api/types/BalanceLimit.d.mts +8 -8
- package/dist/esm/api/types/BatchAcceptedResponse.d.mts +9 -0
- package/dist/esm/api/types/BatchAcceptedResponse.mjs +2 -0
- package/dist/esm/api/types/BatchEventsResponse.d.mts +26 -0
- package/dist/esm/api/types/BatchEventsResponse.mjs +2 -0
- package/dist/esm/api/types/Company.d.mts +4 -4
- package/dist/esm/api/types/ContactErrorModel.d.mts +1 -1
- package/dist/esm/api/types/ConversationsMessage.d.mts +53 -53
- package/dist/esm/api/types/CreateUpdateFolder.d.mts +1 -1
- package/dist/esm/api/types/Deal.d.mts +4 -4
- package/dist/esm/api/types/ErrorModel.d.mts +1 -1
- package/dist/esm/api/types/FileData.d.mts +7 -7
- package/dist/esm/api/types/GetCampaignStats.d.mts +7 -7
- package/dist/esm/api/types/GetCategoryDetails.d.mts +1 -1
- package/dist/esm/api/types/GetContactDetails.d.mts +2 -2
- package/dist/esm/api/types/GetCouponCollection.d.mts +3 -3
- package/dist/esm/api/types/GetEventsList.d.mts +32 -0
- package/dist/esm/api/types/GetEventsList.mjs +2 -0
- package/dist/esm/api/types/GetExtendedCampaignOverview.d.mts +32 -25
- package/dist/esm/api/types/GetExtendedCampaignOverview.mjs +3 -0
- package/dist/esm/api/types/GetExtendedCampaignStats.d.mts +4 -4
- package/dist/esm/api/types/GetProductDetails.d.mts +14 -10
- package/dist/esm/api/types/GetSmsCampaignOverview.d.mts +1 -1
- package/dist/esm/api/types/GetSmtpTemplateOverview.d.mts +4 -4
- package/dist/esm/api/types/GetWebhook.d.mts +4 -4
- package/dist/esm/api/types/InternalServerErrorBody.d.mts +48 -0
- package/dist/esm/api/types/InternalServerErrorBody.mjs +43 -0
- package/dist/esm/api/types/Inviteuser.d.mts +2 -2
- package/dist/esm/api/types/LoyaltyProgram.d.mts +12 -12
- package/dist/esm/api/types/NodeResponse.d.mts +8 -8
- package/dist/esm/api/types/Note.d.mts +6 -6
- package/dist/esm/api/types/NoteData.d.mts +3 -3
- package/dist/esm/api/types/Order.d.mts +30 -20
- package/dist/esm/api/types/Pipeline.d.mts +5 -5
- package/dist/esm/api/types/PostContactInfo.d.mts +4 -4
- package/dist/esm/api/types/PostSendFailed.d.mts +3 -3
- package/dist/esm/api/types/Redeem.d.mts +14 -14
- package/dist/esm/api/types/RuleConditionResponse.d.mts +5 -5
- package/dist/esm/api/types/SendReport.d.mts +1 -1
- package/dist/esm/api/types/SendTestEmail.d.mts +1 -1
- package/dist/esm/api/types/SendTransacSms.d.mts +10 -6
- package/dist/esm/api/types/Task.d.mts +4 -4
- package/dist/esm/api/types/Tier.d.mts +16 -16
- package/dist/esm/api/types/TierGroup.d.mts +8 -8
- package/dist/esm/api/types/Transaction.d.mts +15 -15
- package/dist/esm/api/types/UpdateCampaignStatus.d.mts +2 -1
- package/dist/esm/api/types/UpdateCampaignStatus.mjs +1 -0
- package/dist/esm/api/types/ValueResponse.d.mts +8 -8
- package/dist/esm/api/types/VariablesItems.d.mts +3 -3
- package/dist/esm/api/types/index.d.mts +4 -0
- package/dist/esm/api/types/index.mjs +4 -0
- package/dist/esm/core/fetcher/BinaryResponse.d.mts +1 -1
- package/dist/esm/core/fetcher/Fetcher.mjs +8 -2
- package/dist/esm/core/fetcher/index.d.mts +2 -0
- package/dist/esm/core/fetcher/index.mjs +1 -0
- package/dist/esm/core/fetcher/makePassthroughRequest.d.mts +49 -0
- package/dist/esm/core/fetcher/makePassthroughRequest.mjs +132 -0
- package/dist/esm/core/fetcher/makeRequest.d.mts +6 -1
- package/dist/esm/core/fetcher/makeRequest.mjs +28 -9
- package/dist/esm/core/runtime/runtime.mjs +8 -7
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +356 -4
- package/reference.md +362 -155
- package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSortField.d.ts +0 -6
- package/dist/cjs/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSortField.js +0 -9
- package/dist/esm/api/resources/balance/types/GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSortField.d.mts +0 -6
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
15
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
16
|
+
};
|
|
17
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
+
exports.WebhooksClient = void 0;
|
|
19
|
+
var Client_js_1 = require("./client/Client.js");
|
|
20
|
+
Object.defineProperty(exports, "WebhooksClient", { enumerable: true, get: function () { return Client_js_1.WebhooksClient; } });
|
|
21
|
+
__exportStar(require("./client/index.js"), exports);
|
|
@@ -22,19 +22,11 @@ export declare class WhatsAppCampaignsClient {
|
|
|
22
22
|
getWhatsAppCampaigns(request?: Brevo.GetWhatsAppCampaignsRequest, requestOptions?: WhatsAppCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetWhatsAppCampaignsResponse>;
|
|
23
23
|
private __getWhatsAppCampaigns;
|
|
24
24
|
/**
|
|
25
|
-
* <Note>
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
* [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
|
|
29
|
-
* </Note>
|
|
30
|
-
*
|
|
31
|
-
* <Note>
|
|
32
|
-
* This API requires the List and Segment ids as recipients in Body params. You can use the below Contact endpoints to get the required information.
|
|
33
|
-
*
|
|
25
|
+
* <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
|
|
26
|
+
* [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
|
|
27
|
+
* <Note>This API requires the List and Segment ids as recipients in Body params.You can use the below Contact endpoints to get the required information.
|
|
34
28
|
* [Get all the Lists](https://developers.brevo.com/reference/getlists-1)
|
|
35
|
-
*
|
|
36
|
-
* [Get all the Segments](https://developers.brevo.com/reference/getsegments)
|
|
37
|
-
* </Note>
|
|
29
|
+
* [Get all the Segments](https://developers.brevo.com/reference/getsegments)</Note>
|
|
38
30
|
*
|
|
39
31
|
* @param {Brevo.CreateWhatsAppCampaignRequest} request
|
|
40
32
|
* @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -52,11 +44,8 @@ export declare class WhatsAppCampaignsClient {
|
|
|
52
44
|
createWhatsAppCampaign(request: Brevo.CreateWhatsAppCampaignRequest, requestOptions?: WhatsAppCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.CreateWhatsAppCampaignResponse>;
|
|
53
45
|
private __createWhatsAppCampaign;
|
|
54
46
|
/**
|
|
55
|
-
* <Note>
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
* [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
|
|
59
|
-
* </Note>
|
|
47
|
+
* <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
|
|
48
|
+
* [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
|
|
60
49
|
*
|
|
61
50
|
* @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
62
51
|
*
|
|
@@ -68,11 +57,8 @@ export declare class WhatsAppCampaignsClient {
|
|
|
68
57
|
getWhatsAppConfig(requestOptions?: WhatsAppCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetWhatsAppConfigResponse>;
|
|
69
58
|
private __getWhatsAppConfig;
|
|
70
59
|
/**
|
|
71
|
-
* <Note>
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
* [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
|
|
75
|
-
* </Note>
|
|
60
|
+
* <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
|
|
61
|
+
* [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
|
|
76
62
|
*
|
|
77
63
|
* @param {Brevo.CreateWhatsAppTemplateRequest} request
|
|
78
64
|
* @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -101,11 +87,8 @@ export declare class WhatsAppCampaignsClient {
|
|
|
101
87
|
getWhatsAppTemplates(request?: Brevo.GetWhatsAppTemplatesRequest, requestOptions?: WhatsAppCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetWhatsAppTemplatesResponse>;
|
|
102
88
|
private __getWhatsAppTemplates;
|
|
103
89
|
/**
|
|
104
|
-
* <Note>
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
* [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
|
|
108
|
-
* </Note>
|
|
90
|
+
* <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
|
|
91
|
+
* [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
|
|
109
92
|
*
|
|
110
93
|
* @param {Brevo.SendWhatsAppTemplateApprovalRequest} request
|
|
111
94
|
* @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -120,11 +103,11 @@ export declare class WhatsAppCampaignsClient {
|
|
|
120
103
|
sendWhatsAppTemplateApproval(request: Brevo.SendWhatsAppTemplateApprovalRequest, requestOptions?: WhatsAppCampaignsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
121
104
|
private __sendWhatsAppTemplateApproval;
|
|
122
105
|
/**
|
|
123
|
-
* <Note>
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
* [
|
|
127
|
-
* </Note>
|
|
106
|
+
* <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
|
|
107
|
+
* [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
|
|
108
|
+
* <Note>This API requires the List and Segment ids as recipients in Body params.You can use the below Contact endpoints to get the required information.
|
|
109
|
+
* [Get all the Lists](https://developers.brevo.com/reference/getlists-1)
|
|
110
|
+
* [Get all the Segments](https://developers.brevo.com/reference/getsegments)</Note>
|
|
128
111
|
*
|
|
129
112
|
* @param {Brevo.GetWhatsAppCampaignRequest} request
|
|
130
113
|
* @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -140,19 +123,11 @@ export declare class WhatsAppCampaignsClient {
|
|
|
140
123
|
getWhatsAppCampaign(request: Brevo.GetWhatsAppCampaignRequest, requestOptions?: WhatsAppCampaignsClient.RequestOptions): core.HttpResponsePromise<Brevo.GetWhatsAppCampaignResponse>;
|
|
141
124
|
private __getWhatsAppCampaign;
|
|
142
125
|
/**
|
|
143
|
-
* <Note>
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
* [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
|
|
147
|
-
* </Note>
|
|
148
|
-
*
|
|
149
|
-
* <Note>
|
|
150
|
-
* This API requires the List and Segment ids as recipients in Body params. You can use the below Contact endpoints to get the required information.
|
|
151
|
-
*
|
|
126
|
+
* <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
|
|
127
|
+
* [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
|
|
128
|
+
* <Note>This API requires the List and Segment ids as recipients in Body params.You can use the below Contact endpoints to get the required information.
|
|
152
129
|
* [Get all the Lists](https://developers.brevo.com/reference/getlists-1)
|
|
153
|
-
*
|
|
154
|
-
* [Get all the Segments](https://developers.brevo.com/reference/getsegments)
|
|
155
|
-
* </Note>
|
|
130
|
+
* [Get all the Segments](https://developers.brevo.com/reference/getsegments)</Note>
|
|
156
131
|
*
|
|
157
132
|
* @param {Brevo.UpdateWhatsAppCampaignRequest} request
|
|
158
133
|
* @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -121,19 +121,11 @@ class WhatsAppCampaignsClient {
|
|
|
121
121
|
});
|
|
122
122
|
}
|
|
123
123
|
/**
|
|
124
|
-
* <Note>
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
* [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
|
|
128
|
-
* </Note>
|
|
129
|
-
*
|
|
130
|
-
* <Note>
|
|
131
|
-
* This API requires the List and Segment ids as recipients in Body params. You can use the below Contact endpoints to get the required information.
|
|
132
|
-
*
|
|
124
|
+
* <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
|
|
125
|
+
* [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
|
|
126
|
+
* <Note>This API requires the List and Segment ids as recipients in Body params.You can use the below Contact endpoints to get the required information.
|
|
133
127
|
* [Get all the Lists](https://developers.brevo.com/reference/getlists-1)
|
|
134
|
-
*
|
|
135
|
-
* [Get all the Segments](https://developers.brevo.com/reference/getsegments)
|
|
136
|
-
* </Note>
|
|
128
|
+
* [Get all the Segments](https://developers.brevo.com/reference/getsegments)</Note>
|
|
137
129
|
*
|
|
138
130
|
* @param {Brevo.CreateWhatsAppCampaignRequest} request
|
|
139
131
|
* @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -189,11 +181,8 @@ class WhatsAppCampaignsClient {
|
|
|
189
181
|
});
|
|
190
182
|
}
|
|
191
183
|
/**
|
|
192
|
-
* <Note>
|
|
193
|
-
*
|
|
194
|
-
*
|
|
195
|
-
* [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
|
|
196
|
-
* </Note>
|
|
184
|
+
* <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
|
|
185
|
+
* [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
|
|
197
186
|
*
|
|
198
187
|
* @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
199
188
|
*
|
|
@@ -240,11 +229,8 @@ class WhatsAppCampaignsClient {
|
|
|
240
229
|
});
|
|
241
230
|
}
|
|
242
231
|
/**
|
|
243
|
-
* <Note>
|
|
244
|
-
*
|
|
245
|
-
*
|
|
246
|
-
* [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
|
|
247
|
-
* </Note>
|
|
232
|
+
* <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
|
|
233
|
+
* [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
|
|
248
234
|
*
|
|
249
235
|
* @param {Brevo.CreateWhatsAppTemplateRequest} request
|
|
250
236
|
* @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -355,11 +341,8 @@ class WhatsAppCampaignsClient {
|
|
|
355
341
|
});
|
|
356
342
|
}
|
|
357
343
|
/**
|
|
358
|
-
* <Note>
|
|
359
|
-
*
|
|
360
|
-
*
|
|
361
|
-
* [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
|
|
362
|
-
* </Note>
|
|
344
|
+
* <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
|
|
345
|
+
* [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
|
|
363
346
|
*
|
|
364
347
|
* @param {Brevo.SendWhatsAppTemplateApprovalRequest} request
|
|
365
348
|
* @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -410,11 +393,11 @@ class WhatsAppCampaignsClient {
|
|
|
410
393
|
});
|
|
411
394
|
}
|
|
412
395
|
/**
|
|
413
|
-
* <Note>
|
|
414
|
-
*
|
|
415
|
-
*
|
|
416
|
-
* [
|
|
417
|
-
* </Note>
|
|
396
|
+
* <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
|
|
397
|
+
* [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
|
|
398
|
+
* <Note>This API requires the List and Segment ids as recipients in Body params.You can use the below Contact endpoints to get the required information.
|
|
399
|
+
* [Get all the Lists](https://developers.brevo.com/reference/getlists-1)
|
|
400
|
+
* [Get all the Segments](https://developers.brevo.com/reference/getsegments)</Note>
|
|
418
401
|
*
|
|
419
402
|
* @param {Brevo.GetWhatsAppCampaignRequest} request
|
|
420
403
|
* @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -468,19 +451,11 @@ class WhatsAppCampaignsClient {
|
|
|
468
451
|
});
|
|
469
452
|
}
|
|
470
453
|
/**
|
|
471
|
-
* <Note>
|
|
472
|
-
*
|
|
473
|
-
*
|
|
474
|
-
* [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
|
|
475
|
-
* </Note>
|
|
476
|
-
*
|
|
477
|
-
* <Note>
|
|
478
|
-
* This API requires the List and Segment ids as recipients in Body params. You can use the below Contact endpoints to get the required information.
|
|
479
|
-
*
|
|
454
|
+
* <Note>You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
|
|
455
|
+
* [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account</Note>
|
|
456
|
+
* <Note>This API requires the List and Segment ids as recipients in Body params.You can use the below Contact endpoints to get the required information.
|
|
480
457
|
* [Get all the Lists](https://developers.brevo.com/reference/getlists-1)
|
|
481
|
-
*
|
|
482
|
-
* [Get all the Segments](https://developers.brevo.com/reference/getsegments)
|
|
483
|
-
* </Note>
|
|
458
|
+
* [Get all the Segments](https://developers.brevo.com/reference/getsegments)</Note>
|
|
484
459
|
*
|
|
485
460
|
* @param {Brevo.UpdateWhatsAppCampaignRequest} request
|
|
486
461
|
* @param {WhatsAppCampaignsClient.RequestOptions} requestOptions - Request-specific configuration.
|
package/dist/cjs/api/resources/whatsAppCampaigns/client/requests/CreateWhatsAppCampaignRequest.d.ts
CHANGED
|
@@ -23,10 +23,10 @@ export declare namespace CreateWhatsAppCampaignRequest {
|
|
|
23
23
|
*/
|
|
24
24
|
interface Recipients {
|
|
25
25
|
/** List ids to exclude from the campaign */
|
|
26
|
-
excludedListIds?: number[];
|
|
26
|
+
excludedListIds?: number[] | undefined;
|
|
27
27
|
/** **Mandatory if scheduledAt is not empty**. List Ids to send the campaign to */
|
|
28
|
-
listIds?: number[];
|
|
28
|
+
listIds?: number[] | undefined;
|
|
29
29
|
/** **Mandatory if listIds are not used**. Segment ids to send the campaign to. */
|
|
30
|
-
segments?: number[];
|
|
30
|
+
segments?: number[] | undefined;
|
|
31
31
|
}
|
|
32
32
|
}
|
package/dist/cjs/api/resources/whatsAppCampaigns/client/requests/UpdateWhatsAppCampaignRequest.d.ts
CHANGED
|
@@ -28,10 +28,10 @@ export declare namespace UpdateWhatsAppCampaignRequest {
|
|
|
28
28
|
*/
|
|
29
29
|
interface Recipients {
|
|
30
30
|
/** List ids to exclude from the campaign */
|
|
31
|
-
excludedListIds?: number[];
|
|
31
|
+
excludedListIds?: number[] | undefined;
|
|
32
32
|
/** **Mandatory if scheduledAt is not empty**. List Ids to send the campaign to */
|
|
33
|
-
listIds?: number[];
|
|
33
|
+
listIds?: number[] | undefined;
|
|
34
34
|
/** **Mandatory if listIds are not used**. Segment ids to send the campaign to. */
|
|
35
|
-
segments?: number[];
|
|
35
|
+
segments?: number[] | undefined;
|
|
36
36
|
}
|
|
37
37
|
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
15
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
16
|
+
};
|
|
17
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
+
exports.WhatsAppCampaignsClient = void 0;
|
|
19
|
+
var Client_js_1 = require("./client/Client.js");
|
|
20
|
+
Object.defineProperty(exports, "WhatsAppCampaignsClient", { enumerable: true, get: function () { return Client_js_1.WhatsAppCampaignsClient; } });
|
|
21
|
+
__exportStar(require("./client/index.js"), exports);
|
|
@@ -11,10 +11,10 @@ export interface GetWhatsAppCampaignResponse {
|
|
|
11
11
|
/** UTC date-time of last modification of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) */
|
|
12
12
|
modifiedAt: string;
|
|
13
13
|
/** UTC date-time on which WhatsApp campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format */
|
|
14
|
-
scheduledAt?: string;
|
|
14
|
+
scheduledAt?: string | undefined;
|
|
15
15
|
/** Sender of the WhatsApp Campaign */
|
|
16
16
|
senderNumber: string;
|
|
17
|
-
stats?: Brevo.WhatsappCampStats;
|
|
17
|
+
stats?: Brevo.WhatsappCampStats | undefined;
|
|
18
18
|
template: GetWhatsAppCampaignResponse.Template;
|
|
19
19
|
}
|
|
20
20
|
export declare namespace GetWhatsAppCampaignResponse {
|
|
@@ -32,30 +32,30 @@ export declare namespace GetWhatsAppCampaignResponse {
|
|
|
32
32
|
type CampaignStatus = (typeof CampaignStatus)[keyof typeof CampaignStatus];
|
|
33
33
|
interface Template {
|
|
34
34
|
/** array of variables item variables */
|
|
35
|
-
body_variables?: Brevo.VariablesItems[];
|
|
36
|
-
button_type?: string;
|
|
35
|
+
body_variables?: Brevo.VariablesItems[] | undefined;
|
|
36
|
+
button_type?: string | undefined;
|
|
37
37
|
/** description of the template */
|
|
38
|
-
category?: string;
|
|
38
|
+
category?: string | undefined;
|
|
39
39
|
/** array of component item objects */
|
|
40
|
-
components?: Template.Components.Item[];
|
|
41
|
-
contains_button?: boolean;
|
|
42
|
-
display_header?: boolean;
|
|
40
|
+
components?: Template.Components.Item[] | undefined;
|
|
41
|
+
contains_button?: boolean | undefined;
|
|
42
|
+
display_header?: boolean | undefined;
|
|
43
43
|
/** type of header */
|
|
44
|
-
header_type?: string;
|
|
44
|
+
header_type?: string | undefined;
|
|
45
45
|
/** array of variables item object */
|
|
46
|
-
header_variables?: Brevo.VariablesItems[];
|
|
47
|
-
hide_footer?: boolean;
|
|
46
|
+
header_variables?: Brevo.VariablesItems[] | undefined;
|
|
47
|
+
hide_footer?: boolean | undefined;
|
|
48
48
|
/** language of the template */
|
|
49
|
-
language?: string;
|
|
49
|
+
language?: string | undefined;
|
|
50
50
|
/** name of the template */
|
|
51
|
-
name?: string;
|
|
51
|
+
name?: string | undefined;
|
|
52
52
|
}
|
|
53
53
|
namespace Template {
|
|
54
54
|
type Components = Components.Item[];
|
|
55
55
|
namespace Components {
|
|
56
56
|
interface Item {
|
|
57
|
-
text?: string;
|
|
58
|
-
type?: string;
|
|
57
|
+
text?: string | undefined;
|
|
58
|
+
type?: string | undefined;
|
|
59
59
|
}
|
|
60
60
|
}
|
|
61
61
|
}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import type * as Brevo from "../../../index.js";
|
|
2
2
|
export interface GetWhatsAppCampaignsResponse {
|
|
3
|
-
campaigns?: GetWhatsAppCampaignsResponse.Campaigns.Item[];
|
|
3
|
+
campaigns?: GetWhatsAppCampaignsResponse.Campaigns.Item[] | undefined;
|
|
4
4
|
/** Number of WhatsApp campaigns retrieved */
|
|
5
|
-
count?: number;
|
|
5
|
+
count?: number | undefined;
|
|
6
6
|
}
|
|
7
7
|
export declare namespace GetWhatsAppCampaignsResponse {
|
|
8
8
|
type Campaigns = Campaigns.Item[];
|
|
@@ -15,18 +15,18 @@ export declare namespace GetWhatsAppCampaignsResponse {
|
|
|
15
15
|
/** Creation UTC date-time of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) */
|
|
16
16
|
createdAt: string;
|
|
17
17
|
/** Error Reason associated with the WhatsApp campaign sending */
|
|
18
|
-
errorReason?: string;
|
|
18
|
+
errorReason?: string | undefined;
|
|
19
19
|
/** ID of the WhatsApp Campaign */
|
|
20
20
|
id: number;
|
|
21
21
|
/** Count of invalidated contacts */
|
|
22
|
-
invalidatedContacts?: number;
|
|
22
|
+
invalidatedContacts?: number | undefined;
|
|
23
23
|
/** UTC date-time of last modification of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) */
|
|
24
24
|
modifiedAt: string;
|
|
25
25
|
/** Read percentage of the the whatsapp campaign created */
|
|
26
|
-
readPercentage?: number;
|
|
26
|
+
readPercentage?: number | undefined;
|
|
27
27
|
/** UTC date-time on which WhatsApp campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format */
|
|
28
28
|
scheduledAt: string;
|
|
29
|
-
stats?: Brevo.WhatsappCampStats;
|
|
29
|
+
stats?: Brevo.WhatsappCampStats | undefined;
|
|
30
30
|
/** Id of the WhatsApp template */
|
|
31
31
|
templateId: string;
|
|
32
32
|
}
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
export interface GetWhatsAppConfigResponse {
|
|
2
2
|
/** Verification status information of the Business account */
|
|
3
|
-
businessStatus?: string;
|
|
3
|
+
businessStatus?: string | undefined;
|
|
4
4
|
/** Status of the name associated with WhatsApp Phone number */
|
|
5
|
-
phoneNumberNameStatus?: GetWhatsAppConfigResponse.PhoneNumberNameStatus;
|
|
5
|
+
phoneNumberNameStatus?: GetWhatsAppConfigResponse.PhoneNumberNameStatus | undefined;
|
|
6
6
|
/** Quality status of phone number associated with WhatsApp account. There are three quality ratings. example - **High (GREEN) , Medium (YELLOW) and Low(RED)** */
|
|
7
|
-
phoneNumberQuality?: GetWhatsAppConfigResponse.PhoneNumberQuality;
|
|
7
|
+
phoneNumberQuality?: GetWhatsAppConfigResponse.PhoneNumberQuality | undefined;
|
|
8
8
|
/** Sending limit of the WhatsApp account */
|
|
9
|
-
sendingLimit?: string;
|
|
9
|
+
sendingLimit?: string | undefined;
|
|
10
10
|
/** Id of the WhatsApp business account */
|
|
11
|
-
whatsappBusinessAccountId?: string;
|
|
11
|
+
whatsappBusinessAccountId?: string | undefined;
|
|
12
12
|
/** Status information related to WhatsApp Api account */
|
|
13
|
-
whatsappBusinessAccountStatus?: GetWhatsAppConfigResponse.WhatsappBusinessAccountStatus;
|
|
13
|
+
whatsappBusinessAccountStatus?: GetWhatsAppConfigResponse.WhatsappBusinessAccountStatus | undefined;
|
|
14
14
|
}
|
|
15
15
|
export declare namespace GetWhatsAppConfigResponse {
|
|
16
16
|
/** Status of the name associated with WhatsApp Phone number */
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export interface GetWhatsAppTemplatesResponse {
|
|
2
2
|
/** Number of whatsApp templates retrieved */
|
|
3
|
-
count?: number;
|
|
4
|
-
templates?: GetWhatsAppTemplatesResponse.Templates.Item[];
|
|
3
|
+
count?: number | undefined;
|
|
4
|
+
templates?: GetWhatsAppTemplatesResponse.Templates.Item[] | undefined;
|
|
5
5
|
}
|
|
6
6
|
export declare namespace GetWhatsAppTemplatesResponse {
|
|
7
7
|
type Templates = Templates.Item[];
|
|
@@ -12,7 +12,7 @@ export declare namespace GetWhatsAppTemplatesResponse {
|
|
|
12
12
|
/** Creation UTC date-time of the whatsApp template (YYYY-MM-DDTHH:mm:ss.SSSZ) */
|
|
13
13
|
createdAt: string;
|
|
14
14
|
/** Error reason in the template creation */
|
|
15
|
-
errorReason?: string;
|
|
15
|
+
errorReason?: string | undefined;
|
|
16
16
|
/** ID of the whatsApp template */
|
|
17
17
|
id: number;
|
|
18
18
|
/** Language in which template exists */
|
|
@@ -1,44 +1,44 @@
|
|
|
1
1
|
export interface BalanceDefinition {
|
|
2
2
|
/** startOfPeriod depicts the balancy expiry on start of day/week/month/year. endOfPeriod depicts the balancy expiry on end of day/week/month/year */
|
|
3
|
-
balanceAvailabilityDurationModifier?: BalanceDefinition.BalanceAvailabilityDurationModifier;
|
|
3
|
+
balanceAvailabilityDurationModifier?: BalanceDefinition.BalanceAvailabilityDurationModifier | undefined;
|
|
4
4
|
/** Unit of time for the balance's availability (e.g., day/week/month/year). */
|
|
5
|
-
balanceAvailabilityDurationUnit?: string;
|
|
5
|
+
balanceAvailabilityDurationUnit?: string | undefined;
|
|
6
6
|
/** Number of days/weeks/month/year for balance expiry */
|
|
7
|
-
balanceAvailabilityDurationValue?: number;
|
|
7
|
+
balanceAvailabilityDurationValue?: number | undefined;
|
|
8
8
|
/** Date when the balance expires and can no longer be used, in dd/mm format. The balance will be expired when this date appears next in the calendar and only one of balanceExpirationDate or balance availability fields can be used. */
|
|
9
|
-
balanceExpirationDate?: string;
|
|
9
|
+
balanceExpirationDate?: string | undefined;
|
|
10
10
|
/** Partial enables partial credit of balance if maximum balance limit is reaching. Strict enables rejection of transaction if it will breach the max credit amount limit. */
|
|
11
|
-
balanceOptionAmountOvertakingStrategy?: string;
|
|
11
|
+
balanceOptionAmountOvertakingStrategy?: string | undefined;
|
|
12
12
|
/** Rounding strategy for credit transactions. */
|
|
13
|
-
balanceOptionCreditRounding?: string;
|
|
13
|
+
balanceOptionCreditRounding?: string | undefined;
|
|
14
14
|
/** Rounding strategy for debit transactions. */
|
|
15
|
-
balanceOptionDebitRounding?: string;
|
|
15
|
+
balanceOptionDebitRounding?: string | undefined;
|
|
16
16
|
/** Timestamp of balance definition creation. */
|
|
17
|
-
createdAt?: string;
|
|
17
|
+
createdAt?: string | undefined;
|
|
18
18
|
/** Timestamp of balance definition deletion (nullable). */
|
|
19
|
-
deletedAt?: string;
|
|
19
|
+
deletedAt?: string | undefined;
|
|
20
20
|
/** Short description of the balance definition. */
|
|
21
|
-
description?: string;
|
|
21
|
+
description?: string | undefined;
|
|
22
22
|
/** Unique identifier for the balance definition. */
|
|
23
|
-
id?: string;
|
|
23
|
+
id?: string | undefined;
|
|
24
24
|
/** Optional image reference URL. */
|
|
25
|
-
imageRef?: string;
|
|
25
|
+
imageRef?: string | undefined;
|
|
26
26
|
/** Maximum allowable balance. */
|
|
27
|
-
maxAmount?: number;
|
|
27
|
+
maxAmount?: number | undefined;
|
|
28
28
|
/** Max credit allowed per operation. */
|
|
29
|
-
maxCreditAmountLimit?: number;
|
|
29
|
+
maxCreditAmountLimit?: number | undefined;
|
|
30
30
|
/** Max debit allowed per operation. */
|
|
31
|
-
maxDebitAmountLimit?: number;
|
|
31
|
+
maxDebitAmountLimit?: number | undefined;
|
|
32
32
|
/** Additional metadata for the balance definition. */
|
|
33
|
-
meta?: Record<string, unknown
|
|
33
|
+
meta?: Record<string, unknown> | undefined;
|
|
34
34
|
/** Minimum allowable balance. */
|
|
35
|
-
minAmount?: number;
|
|
35
|
+
minAmount?: number | undefined;
|
|
36
36
|
/** Name of the balance definition. */
|
|
37
|
-
name?: string;
|
|
37
|
+
name?: string | undefined;
|
|
38
38
|
/** Unit of balance (e.g., points, currency). */
|
|
39
|
-
unit?: string;
|
|
39
|
+
unit?: string | undefined;
|
|
40
40
|
/** Timestamp of the last update. */
|
|
41
|
-
updatedAt?: string;
|
|
41
|
+
updatedAt?: string | undefined;
|
|
42
42
|
}
|
|
43
43
|
export declare namespace BalanceDefinition {
|
|
44
44
|
/** startOfPeriod depicts the balancy expiry on start of day/week/month/year. endOfPeriod depicts the balancy expiry on end of day/week/month/year */
|
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
export interface BalanceLimit {
|
|
2
2
|
/** balance definition ID */
|
|
3
|
-
balanceDefinitionId?: string;
|
|
3
|
+
balanceDefinitionId?: string | undefined;
|
|
4
4
|
/** Defines the type of constraint (e.g., transaction-based or amount-based). */
|
|
5
|
-
constraintType?: string;
|
|
5
|
+
constraintType?: string | undefined;
|
|
6
6
|
/** Timestamp of when the balance limit was created. */
|
|
7
7
|
createdAt: string;
|
|
8
8
|
/** Time unit for the balance limit (day, week, month, year). */
|
|
9
|
-
durationUnit?: string;
|
|
9
|
+
durationUnit?: string | undefined;
|
|
10
10
|
/** Number of time units the balance limit applies to. */
|
|
11
|
-
durationValue?: number;
|
|
11
|
+
durationValue?: number | undefined;
|
|
12
12
|
/** Unique identifier for the balance limit. */
|
|
13
|
-
id?: string;
|
|
13
|
+
id?: string | undefined;
|
|
14
14
|
/** Indicates if the limit resets periodically based on a sliding schedule. */
|
|
15
|
-
slidingSchedule?: boolean;
|
|
15
|
+
slidingSchedule?: boolean | undefined;
|
|
16
16
|
/** Specifies whether the limit applies to credit or debit transactions. */
|
|
17
|
-
transactionType?: string;
|
|
17
|
+
transactionType?: string | undefined;
|
|
18
18
|
/** Timestamp of the last update to the balance limit. */
|
|
19
19
|
updatedAt: string;
|
|
20
20
|
/** The maximum allowed value for the defined constraint. */
|
|
21
|
-
value?: number;
|
|
21
|
+
value?: number | undefined;
|
|
22
22
|
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Response returned when all events in the batch are accepted for async processing
|
|
3
|
+
*/
|
|
4
|
+
export interface BatchAcceptedResponse {
|
|
5
|
+
/** Confirmation message indicating the batch was accepted */
|
|
6
|
+
message: string;
|
|
7
|
+
/** Number of events queued for processing */
|
|
8
|
+
count: number;
|
|
9
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Response returned when a batch of events is processed
|
|
3
|
+
*/
|
|
4
|
+
export interface BatchEventsResponse {
|
|
5
|
+
/** Status of the batch request */
|
|
6
|
+
status: string;
|
|
7
|
+
/** Total number of events submitted in the batch */
|
|
8
|
+
total_events: number;
|
|
9
|
+
/** Number of events that were successfully processed */
|
|
10
|
+
successful_events: number;
|
|
11
|
+
/** Number of events that failed to be processed */
|
|
12
|
+
failed_events: number;
|
|
13
|
+
/** List of errors for the failed events */
|
|
14
|
+
errors: BatchEventsResponse.Errors.Item[];
|
|
15
|
+
}
|
|
16
|
+
export declare namespace BatchEventsResponse {
|
|
17
|
+
type Errors = Errors.Item[];
|
|
18
|
+
namespace Errors {
|
|
19
|
+
interface Item {
|
|
20
|
+
/** Index positions (0-based) of the events that caused the error */
|
|
21
|
+
eventIndex?: number[] | undefined;
|
|
22
|
+
/** Description of the error */
|
|
23
|
+
message?: string | undefined;
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
}
|
|
@@ -3,11 +3,11 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface Company {
|
|
5
5
|
/** Company attributes with values */
|
|
6
|
-
attributes?: Record<string, unknown
|
|
6
|
+
attributes?: Record<string, unknown> | undefined;
|
|
7
7
|
/** Unique company id */
|
|
8
|
-
id?: string;
|
|
8
|
+
id?: string | undefined;
|
|
9
9
|
/** Contact ids for contacts linked to this company */
|
|
10
|
-
linkedContactsIds?: number[];
|
|
10
|
+
linkedContactsIds?: number[] | undefined;
|
|
11
11
|
/** Deals ids for companies linked to this company */
|
|
12
|
-
linkedDealsIds?: string[];
|
|
12
|
+
linkedDealsIds?: string[] | undefined;
|
|
13
13
|
}
|
|
@@ -4,7 +4,7 @@ export interface ContactErrorModel {
|
|
|
4
4
|
/** Readable message associated to the failure */
|
|
5
5
|
message: string;
|
|
6
6
|
/** Additional information about the error */
|
|
7
|
-
metadata?: Record<string, unknown
|
|
7
|
+
metadata?: Record<string, unknown> | undefined;
|
|
8
8
|
}
|
|
9
9
|
export declare namespace ContactErrorModel {
|
|
10
10
|
/** Error code displayed in case of a failure */
|