Package software.xdev.brevo.model
package software.xdev.brevo.model
-
ClassDescriptionAbTestCampaignResultCriteria choosen for winning version (Open/Click)Winning Campaign Info. pending = Campaign has been picked for sending and winning version is yet to be decided, tie = A tie happened between both the versions, notAvailable = Campaign has not yet been picked for sending.AbTestCampaignResultClickedLinksAbTestCampaignResultStatisticsAbTestVersionClicksInnerPercentage of a particular event for both versionsAddChildDomainAddContactToListByEmailsAddContactToListByIDsAddContactToListRequestAddCreditsAuthenticateDomainModelBlockDomainCompaniesIdPatchRequestCompaniesLinkUnlinkIdPatchRequestList of companiesCreated company idCompaniesPostRequestCompany DetailsList of attributesComponentItemsConversationsAgentOnlinePingPostRequesta Conversations message`\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages.ConversationsMessageFileimage info is passed in case the file is an imageConversationsMessagesIdPutRequestConversationsMessagesPostRequestConversationsPushedMessagesPostRequestCorporateGroupDetailsResponseCorporateGroupDetailsResponseGroupCorporateGroupDetailsResponseSubAccountsInnerCorporateGroupDetailsResponseUsersInnerCorporateGroupIdPutRequestCorporateGroupPost201ResponseCorporateGroupPostRequestCorporateGroupUnlinkGroupIdSubAccountsPutRequestCorporateSubAccountKeyPostRequestCorporateSubAccountSsoTokenPostRequest**Set target after login success** * **automation** - Redirect to Automation after login * **email_campaign** - Redirect to Email Campaign after login * **contacts** - Redirect to Contacts after login * **landing_pages** - Redirect to Landing Pages after login * **email_transactional** - Redirect to Email Transactional after login * **senders** - Redirect to Senders after login * **sms_campaign** - Redirect to Sms Campaign after login * **sms_transactional** - Redirect to Sms Transactional after loginCorporateUserInvitationActionEmailPut200ResponseCreateApiKeyResponseCreateAttributeType of the attribute.CreateAttributeEnumerationInnerCreateCategoryModelCreateChildLanguage of the child accountCreateContactCreateCouponCollection201ResponseCreateCouponCollectionRequestCreateCouponsRequestCreatedBatchIdCreateDoiContactCreateDomainCreateDomainModelCreateDomainModelDnsRecordsCreateDomainModelDnsRecordsDkimRecordCreatedProcessIdCreateEmailCampaignChoose the metrics that will determinate the winning version.Segment ids and List ids to include/exclude from campaignSender details including id or email and name (_optional_).CreateExternalFeedAuth type of the feed: * `basic` * `token` * `noAuth`CreateExternalFeed201ResponseCreateListCreateModelCreateProductModelCreateResellerCreateSenderCreateSenderIpsInnerCreateSenderModelCreateSmsCampaignCreateSmsCampaignRecipientsCreateSmtpEmailCreateSmtpTemplateSender details including id or email and name (_optional_).CreateSubAccountSet the language of the sub-accountCreateSubAccountResponseCreateUpdateBatchCategoryCreateUpdateBatchCategoryModelCreateUpdateBatchProductsCreateUpdateBatchProductsModelCreateUpdateCategoriesCreateUpdateCategoryCreateUpdateContactModelCreateUpdateFolderCreateUpdateProductCreateUpdateProductsCreateWebhookGets or Sets eventsType of the webhookCreateWhatsAppCampaignSegment ids and List ids to include/exclude from campaignCreateWhatsAppTemplateCategory of the templatesource of the templateCrmDealsIdPatchRequestCrmDealsLinkUnlinkIdPatchRequestCreated deal idCrmDealsPostRequestCrmTasksIdPatchRequestTask DetailsCrmTasksPostRequestDeal DetailsList of attributesList of DealsDeleteHardbouncesEmailExportRecipientsType of recipients to export for a campaignErrorModelError code displayed in case of a failureExportWebhooksHistoryFilter the history for a specific event typeFilter the history based on webhook typeExportWebhooksHistoryRequestFilter the history for a specific event typeFilter the history based on webhook typeFile data that is uploadedDownloadable file linkGetAccountGetAccountActivityGetAccountActivityLogsInnerGetAccountAllOfMarketingAutomationGetAccountAllOfPlanThis is the type of the credit, \"Send Limit\" is one of the possible types of credit of a userDisplays the plan type of the userInformation about your transactional email accountData regarding the transactional email accountGetAggregatedReportGetAllExternalFeedsGetAllExternalFeedsFeedsInnerAuth type of the feed: * `basic` * `token` * `noAuth`GetAttributesGetAttributesAttributesInnerCategory of the attributeType of the attributeGetAttributesAttributesInnerEnumerationInnerGetBlockedDomainsGetCampaignOverviewStatus of the campaignType of campaignGetCampaignRecipientsGetCampaignStatsGetCategoriesGetCategoryDetailsGetChildAccountCreationStatusGetChildDomainGetChildInfoAPI Keys associated to child accountGetChildInfoAllOfApiKeysV2GetChildInfoAllOfApiKeysV3Credits available for your childStatistics about your child account activityGetChildrenListGetChildrenListChildrenInnerGetClientCampaign Statistics for the contactGetContactCampaignStatsClickedInnerGetContactCampaignStatsOpenedInnerGetContactCampaignStatsTransacAttributesInnerGetContactCampaignStatsUnsubscriptionsGetContactDetailsGetContactInfoIdentifierParameterGetContactsGetCorporateInvitedUsersListGetCorporateInvitedUsersListUsersInnerFeature accessiblity given to the user.Admin user groups listGetCouponCollectionGetDeviceBrowserStatsGetDomainConfigurationModelGetDomainsListGetDomainsListDomainsInnerGetEmailCampaignStatus of the campaignType of campaignGetEmailCampaignsGetEmailCampaignsCampaignsInnerStatus of the campaignType of campaignGetEmailEventReportGetEmailEventReportEventsInnerEvent which occurredGetExtendedCampaignOverviewStatus of the campaignType of campaignGetExtendedCampaignOverviewAllOfSenderGetExtendedCampaignStatsGetExtendedClientAddress informationsGetExtendedContactDetailsCampaign statistics of the contactGetExtendedContactDetailsAllOfStatisticsClickedGetExtendedContactDetailsAllOfStatisticsLinksGetExtendedContactDetailsAllOfStatisticsMessagesSentGetExtendedContactDetailsAllOfStatisticsOpenedListing of the unsubscription for the contactGetExtendedContactDetailsAllOfStatisticsUnsubscriptionsAdminUnsubscriptionGetExtendedContactDetailsAllOfStatisticsUnsubscriptionsUserUnsubscriptionGetExtendedListGetExtendedListAllOfCampaignStatsGetExternalFeedByUUIDAuth type of the feed: * `basic` * `token` * `noAuth`GetExternalFeedByUUIDHeadersInnerGetFolderGetFolderListsGetFoldersGetInboundEmailEventsGetInboundEmailEventsByUuidGetInboundEmailEventsByUuidAttachmentsInnerGetInboundEmailEventsByUuidLogsInnerType of the eventGetInboundEmailEventsEventsInnerGetInvitedUsersListGetInvitedUsersListUsersInnerFeature accessiblity given to the user.GetIpGetIpFromSenderGetIpsGetIpsFromSenderGetListGetListsGetListsListsInnerGetProcessStatus of the processGetProcessesGetProductDetailsGetProductsGetReportsGetReportsReportsInnerGetScheduledEmailByBatchIdGetScheduledEmailByBatchIdBatchesInnerCurrent status of the scheduled batchGetScheduledEmailById200ResponseCurrent status of the scheduled emailGetScheduledEmailByMessageIdCurrent status of the scheduled emailGetSegmentsGetSendersListGetSendersListSendersInnerGetSendersListSendersInnerIpsInnerGetSharedTemplateUrlGetSmsCampaignStatus of the SMS CampaignGetSmsCampaignOverviewStatus of the SMS CampaignGetSmsCampaignsGetSmsCampaignsCampaignsInnerStatus of the SMS CampaignGetSmsCampaignStatsGetSmsEventReportGetSmsEventReportEventsInnerEvent which occurredGetSmtpTemplateOverviewGetSmtpTemplateOverviewSenderGetSmtpTemplatesGetSsoTokenGetStatsByDeviceGetSubAccountGroups200ResponseInnerGetTransacAggregatedSmsReportGetTransacBlockedContactsGetTransacBlockedContactsContactsInnerReason for blocking / unsubscribingReason code for blocking / unsubscribing (This code is safe for comparison)GetTransacEmailContentGetTransacEmailContentEventsInnerGetTransacEmailsListGetTransacEmailsListTransactionalEmailsInnerGetTransacSmsReportGetTransacSmsReportReportsInnerCheck user permissionGetUserPermissionPrivilegesInnerGetWebhookType of webhook (marketing or transactional)GetWebhooksGetWhatsappCampaignOverviewStatus of the WhatsApp CampaignGetWhatsappCampaignsGetWhatsappCampaignsCampaignsInnerStatus of the WhatsApp CampaignGetWhatsAppConfigStatus of the name associated with WhatsApp Phone numberQuality status of phone number associated with WhatsApp account.Status information related to WhatsApp API accountGetWhatsappEventReportGetWhatsappEventReportEventsInnerEvent which occurredGetWhatsappTemplatesGetWhatsappTemplatesTemplatesInnerInviteAdminUserPrivileges given to the userFeature nameGets or Sets permissionsInviteuserPrivileges given to the userFeature nameGets or Sets permissionsInviteuserResponseManageIpMasterDetailsResponseBilling details of the master account organizationBilling address of master accountBilling name of master account holderPlan detailsPlan period typeMasterDetailsResponsePlanInfoFeaturesInnerNote DetailsNote data to be savedUpdated Note IDOrderOrderBatchBilling details of an order.Details for the Products in an order.OtpList of stagesList of stagesPostContactInfoPostContactInfoContactsPostContactInfoContactsFailurePostContactInfoContactsSuccessPostSendFailedPostSendSmsTestFailedRevoke user permissionPutresendcancelinvitationResponseRevoke user permissionPutRevokeUserPermissionResponseRemainingCreditModelCredits remaining for child accountRemainingCreditModelResellerRemoveContactFromListByAllRemoveContactFromListByEmailsRemoveContactFromListByIDsRemoveContactFromListRequestRemoveCreditsRequestContactExportSet the filter for the contacts to be exported.**Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed.** This will export the contacts on the basis of provided action applied on contacts as per the list id. * **allContacts** - Fetch the list of all contacts for a particular list. * **subscribed & unsubscribed** - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * **unsubscribedPerList** - Fetch the list of contacts that are unsubscribed from a particular list only.**Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed.** This will export the contacts on the basis of provided action applied on email campaigns. * **openers & nonOpeners** - emailCampaignId is mandatory.**Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed.** This will export the contacts on the basis of provided action applied on sms campaigns. * **unsubscribed** - Fetch the list of all unsubscribed (blacklisted via any means) contacts for all / particular sms campaigns. * **hardBounces & softBounces** - Fetch the list of hard bounces / soft bounces for all / particular sms campaigns.RequestContactImportRequestContactImportJsonBodyInnerTo create a new list and import the contacts into it, pass the listName and an optional folderId.RequestSmsRecipientExportFilter the recipients based on how they interacted with the campaignScheduleSmtpEmailSendReportLanguage of email content for campaign report sending.Custom attributes for the report email.SendSmsSendSmtpEmailSendSmtpEmailAttachmentInnerSendSmtpEmailBccInnerSendSmtpEmailCcInnerSendSmtpEmailMessageVersionsInnerEmail (**required**), along with name (_optional_), on which transactional mail recipients will be able to reply back.**Mandatory if `templateId` is not passed**.SendSmtpEmailToInnerSendTestEmailSendTestSmsSendTransacSmsType of the SMS.SendWhatsappMessage201ResponseSendWhatsappMessageRequestSendWhatsappMessageTemplateSendWhatsappMessageTextList of enable/disable applications on the sub-accountSubAccountDetailsResponseSub-account plan detailsCredits quota and remaining credits on the sub-accountEmail credits remaining on the sub-accountFeatures available on the sub-accountInbox details / Not available on ENTv2Landing page details / Not available on ENTv2Multi-account detailsSubAccountsResponseSubAccountsResponseSubAccountsInnerDetails of the plan to be changedCredit details to updateFeatures details to updateTask DetailsList of tasksTask reminder date/time for a taskGets or Sets typesUnit of time before reminder is to be sentTask types detailsUpdateAttributeUpdateAttributeEnumerationInnerUpdateBatchContactsUpdateBatchContactsContactsInnerUpdateBatchContactsModelStatus of the campaignNote:- **replicateTemplate** status will be available **only for template type campaignsUpdateChildUpdateChildAccountStatusUpdateChildDomainUpdateContactUpdateCouponCollection200ResponseUpdateCouponCollectionRequestUpdateEmailCampaignChoose the metrics that will determinate the winning version.Segment ids and List ids to include/exclude from campaignSender details including id or email and name (optional).UpdateExternalFeedAuth type of the feed: * `basic` * `token` * `noAuth`UpdateListUpdateSenderUpdateSmsCampaignUpdateSmtpTemplateSender details including id or email and name (_optional_).UpdateUserResponseUpdateWebhookGets or Sets eventsUpdateWhatsAppCampaignStatus of the campaignUploadImageModelUploadImageToGalleryVariablesItemsWhatsappCampStatsWhatsappCampTemplate