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 versionsAddContactToListByEmailsAddContactToListByExtIDsAddContactToListByIDsAddContactToListRequestAddSubscriptionMemberPayloadAggregateBalanceAuthenticateDomainModelBalanceBalanceDataPerContactBalanceDefinitionstartOfPeriod depicts the balancy expiry on start of day/week/month/year. endOfPeriod depicts the balancy expiry on end of day/week/month/yearBalanceDefinitionPageBalanceLimitRepresents an order linked to a balance definition, including amount, due date, and transaction details.BlockDomainSpecify the payment currency and amount.Currency code for the payment amount.CompaniesIdPatchRequestCompaniesImportPost200ResponseCompaniesImportPost400ResponseCompaniesLinkUnlinkIdPatchRequestList of companiesCreated company idCompaniesPostRequestCompany DetailsList of attributesComponentItemsContactBalancesRespContactErrorModelError code displayed in case of a failureConversationsAgentOnlinePingPostRequesta Conversations message`\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages.ConversationsMessageAttachmentsInnerConversationsMessageFileimage info is passed in case the file is an imageStatus of the message forwarding to the source.An object containing details about the email sender (applicable only to messages in email threads).An object containing details of the reply-to email address (applicable only to messages in email threads).ConversationsMessagesIdPutRequestConversationsMessagesPostRequestConversationsMessageToInnerConversationsPushedMessagesPostRequestConversionSourceMetricsGets or Sets conversionSourceConversionSourceProductCorporateGroupDetailsResponseCorporateGroupDetailsResponseGroupCorporateGroupDetailsResponseSubAccountsInnerCorporateGroupDetailsResponseUsersInnerCorporateGroupIdPutRequestCorporateGroupPost201ResponseCorporateGroupPostRequestCorporateGroupUnlinkGroupIdSubAccountsPutRequestCorporateIpGet200ResponseInnerCorporateSsoTokenPostRequestCorporateSubAccountIpAssociatePostRequestCorporateSubAccountIpDissociatePutRequestCorporateSubAccountKeyPostRequestCorporateSubAccountSsoTokenPostRequest**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 loginCorporateUserEmailPermissionsPutRequestPermission on featuresfeature nameGets or Sets permissionsCorporateUserInvitationActionEmailPut200ResponseCreateApiKeyResponseCreateAttributeType of the attribute.CreateAttributeEnumerationInnerPayload for creating a new balance definition, specifying expiration rules, rounding strategies, and constraints.Defines when the balance expires within the selected duration.Unit of time for balance validity.Defines whether partial credit is allowed when reaching max balance.Defines rounding strategy for credit transactions.Defines rounding strategy for debit transactions.Unit of balance measurement.Payload for setting transaction or amount-based limits on a balance.Defines whether the limit applies to transaction count or amount.Unit of time for which the limit is applicable.Specifies whether the limit applies to credit or debit transactions.Payload for creating a new balance linked to a specific balance definition.CreateCategoryModelCreateContactCreateCouponCollection201ResponseCreateCouponCollectionRequestCreateCouponsRequestCreatedBatchIdCreateDoiContactCreateDomainCreateDomainModelCreateDomainModelDnsRecordsCreateDomainModelDnsRecordsDkimRecordCreatedProcessIdCreateEmailCampaignChoose the metrics that will determinate the winning version.To reduce your carbon footprint, set an expiration date for your email.unit of the durationSegment 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`CreateExternalFeed201ResponseCreateListCreateLoyaltyProgramPayloadCreateModelPayload for creating an order linked to a balance definition.CreatePaymentRequestCreatePaymentResponseCreateProductModelCreateSenderCreateSenderIpsInnerCreateSenderModelCreateSmsCampaignCreateSmsCampaignRecipientsCreateSmtpEmailCreateSmtpTemplateSender details including id or email and name (_optional_).CreateSubAccountSet the language of the sub-accountCreateSubAccountResponseCreateSubscriptionPayloadCreateSubscriptionResponseCreateTierGroupRequestSelect real_time to downgrade tier on real time balance updates.Select real_time to upgrade tier on real time balance updates.Payload for creating a transaction, specifying balance details and optional expiration.CreateUpdateBatchCategoryCreateUpdateBatchCategoryModelCreateUpdateBatchProductsCreateUpdateBatchProductsModelCreateUpdateCategoriesCreateUpdateCategoryCreateUpdateContactModelCreateUpdateFolderCreateUpdateProductCreateUpdateProductsCreateWebhookchannel of webhookGets or Sets eventsType of the webhookCreateWhatsAppCampaignSegment ids and List ids to include/exclude from campaignCreateWhatsAppTemplateCategory of the templatesource of the templateCrmAttributesPost200ResponseCrmAttributesPostRequestThe type of attribute (must be one of the defined enums)The type of object the attribute belongs to (prefilled with `companies` or `deal`, mandatory)CrmDealsIdPatchRequestCrmDealsLinkUnlinkIdPatchRequestCreated deal idCrmDealsPostRequestCrmTasksIdPatchRequestTask DetailsCrmTasksPostRequestDeal DetailsList of attributesList of DealsDeleteHardbouncesEcommerceAttributionMetricsConversionSourceConversionSourceIdGet200ResponseGets or Sets conversionSourceEcommerceAttributionMetricsGet200ResponseAttribution list aggregated totalsEcommerceAttributionProductsConversionSourceConversionSourceIdGet200ResponseEcommerceConfigDisplayCurrencyGet200ResponseEmailExportRecipientsType of recipients to export for a campaignErrorModelError code displayed in case of a failureErrorResponseEventEventContactPropertiesValueEventEventPropertiesValueIdentifies the contact associated with the event.ExportWebhooksHistoryFilter 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 campaignGetCampaignRecipientsGetCampaignStatsGetCategoriesGetCategoryDetailsGetClientCampaign Statistics for the contactGetContactCampaignStatsClickedInnerGetContactCampaignStatsOpenedInnerGetContactCampaignStatsTransacAttributesInnerGetContactCampaignStatsUnsubscriptionsGetContactDetailsGetContactInfoIdentifierParameterGetContactsGetCorporateInvitedUsersListGetCorporateInvitedUsersListUsersInnerFeature accessiblity given to the user.Admin user groups listCheck admin user permissionsGranular feature permissions given to the user.Groups detailsGetCouponCollectionGetDeviceBrowserStatsGetDomainConfigurationModelGetDomainsListGetDomainsListDomainsInnerGetEmailCampaignStatus 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.GetIpGetIpFromSenderGetIpsGetIpsFromSenderGetListGetListsGetListsListsInnerGetPaymentRequestStatus of the payment request.GetProcessStatus of the processGetProcessesGetProductDetailsGetProductsGetrecords200ResponseGetrecords200ResponseRecordsInnerGetrecords200ResponseRecordsInnerAssociationsInnerGetrecords200ResponseRecordsInnerAssociationsInnerOneOfGetrecords200ResponseRecordsInnerAssociationsInnerOneOf1Getrecords200ResponseRecordsInnerAssociationsInnerOneOf1RecordsInnerGetrecords200ResponseRecordsInnerAssociationsInnerOneOf1RecordsInnerOneOfGetrecords200ResponseRecordsInnerAssociationsInnerOneOf1RecordsInnerOneOf1Identifiers attached with the associated object record.Identifiers attached with the associated object record.Getrecords200ResponseRecordsInnerAssociationsInnerOneOfRecordsInnerGetrecords200ResponseRecordsInnerAssociationsInnerOneOfRecordsInnerOneOfGetrecords200ResponseRecordsInnerAssociationsInnerOneOfRecordsInnerOneOf1Identifiers attached with the associated object record.Identifiers attached with the associated object record.Identifiers attached with the object record.GetReportsGetReportsReportsInnerGetScheduledEmailByBatchIdGetScheduledEmailByBatchIdBatchesInnerCurrent 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 permissionGetUserPermissionPrivilegesInnerGetWebhookchannel of webhookType 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 permissionsInviteuserResponseLoyaltyProgramLoyalty Program stateLoyaltyProgramPageLoyaltyProgramValidationErrorLoyaltyTierPageMainAttributeRewardPayloadMainBillingPayloadMainCodeCountHttpResponseMainCreateRedeemPayloadMainCreateRewardPayloadMainCreateRewardResponseMainErrorResponseMainFilterMainGeneratorMainGetContactRewardsPayloadSort the documents in ascending or descending orderSort documents by fieldMainIdentifiersPayloadMainLimitMainModelContactRewardMainModelContactRewardsRespMainNodeResponseMainOrderPayloadMainProductMainProductPayloadMainRedeemMainResultParameterResponseMainRewardSelect startOfPeriod to configure rewards expiry on start of day/week/month/year.MainRewardAttributionMainRewardConfigurationsMainRewardPageMainRewardPageObjMainRewardValidateMainRuleMainRuleConditionResponseMainRuleEventResponseMainRuleResultResponseMainValidateRewardPayloadMainValueResponseMainVoucherRevokePayloadMasterDetailsResponseBilling details of the master account organizationBilling address of master accountBilling name of master account holderPlan detailsPlan period typeMasterDetailsResponsePlanInfoFeaturesInnerMemberContactOptional.ModelSubscriptionBalanceRespNote DetailsNote data to be savedUpdated Note IDOptional.Channel used to send the notifications.OrderOrderBatchBilling details of an order.Identifies the contact associated with the order.OrderMetaInfoValueDetails for the Products in an order.OtpPatchLoyaltyProgramPayloadList of stagesList of stagesPostContactInfoPostContactInfoContactsPostContactInfoContactsFailurePostContactInfoContactsSuccessPostSendFailedPostSendSmsTestFailedRevoke user permissionPutresendcancelinvitationResponseRevoke user permissionPutRevokeUserPermissionResponseRemoveContactFromListByAllRemoveContactFromListByEmailsRemoveContactFromListByExtIDsRemoveContactFromListByIDsRemoveContactFromListRequestRequestContactExportSet 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.SendSmsSendSmsAsyncSendSmtpEmailSendSmtpEmailAttachmentInnerSendSmtpEmailBccInnerSendSmtpEmailCcInnerSendSmtpEmailMessageVersionsInnerEmail (**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-accountSubAccountDetailsResponseSubAccountDetailsResponseGroupsInnerSub-account plan detailsCredits quota and remaining credits on the sub-accountEmail credits remaining on the sub-accountexternalFeeds credits remaining on the sub-accountSMS credits remaining on the sub-accountWhatsapp credits remaining on the sub-accountPush credits remaining on the sub-accountFeatures available on the sub-accountInbox details / Not available on ENTv2Landing page details / Not available on ENTv2Sales and service users to use phone, sales and conversationsMarketing users to manage the marketing channelsSubAccountsResponseSubAccountsResponseSubAccountsInnerSubAccountsResponseSubAccountsInnerGroupsInnerDetails of the plan to be changedFeatures details to updateDetails of the plan to be changedCredit details to updateFeatures details to updateSubscriptionSubscriptionAggregateBalanceSubscriptionAttributedRewardSubscriptionBalancesSubscriptionHandlerInfoSubscriptionMemberSubscriptionTierTask DetailsList of tasksTask reminder date/time for a taskGets or Sets typesUnit of time before reminder is to be sentTask types detailsTemplatePreviewModelTemplatePreviewRequestBodyTierTierAccessConditionsInnerTierForContactTierGroupSelect real_time to downgrade tier on real time balance updates.Select real_time to upgrade tier on real time balance updates.TierGroupPageTierRequestTierRequestAccessConditionsInnerTierRequestPutPayloadTierRequestTierRewardsInnerTierTierRewardsInnerRepresents a transaction involving a balance, including status and timestamps.Represents a record of a past transaction, including status and key timestamps.Response containing transaction history details for a specific balance and contact.UnauthorizedResponseUpdateAttributeUpdateAttributeEnumerationInnerPayload for updating an existing balance definition, including expiry rules, rounding strategies, and constraints.Defines when the balance expires within the selected duration.Unit of time for balance validity.Defines whether partial credit is allowed when reaching max balance.Rounding strategy for credit transactions.Rounding strategy for debit transactions.Unit of balance measurement.Payload for updating an existing balance limit, specifying constraints on transactions or amounts.Defines whether the limit applies to transaction count or amount.Unit of time for which the limit is applicable.Specifies whether the limit applies to credit or debit transactions.UpdateBatchContactsUpdateBatchContactsContactsInnerUpdateBatchContactsModelStatus of the campaignNote:- **replicateTemplate** status will be available **only for template type campaignsUpdateContactUpdateCouponCollection200ResponseUpdateCouponCollectionRequestUpdateEmailCampaignChoose the metrics that will determinate the winning version.To reduce your carbon footprint, set an expiration date for your email.unit of the durationSegment 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`UpdateListUpdateLoyaltyProgramPayloadUpdateSenderUpdateSmsCampaignUpdateSmtpTemplateSender details including id or email and name (_optional_).UpdateTierGroupRequestSelect real_time to downgrade tier on real time balance updates.Select real_time to upgrade tier on real time balance updates.UpdateUserResponseUpdateWebhookGets or Sets eventsUpdateWhatsAppCampaignStatus of the campaignUploadImageModelUploadImageToGalleryUpsertrecords202ResponseUpsertrecordsRequestUpsertrecordsRequestRecordsInnerUpsertrecordsRequestRecordsInnerOneOfUpsertrecordsRequestRecordsInnerOneOf1UpsertrecordsRequestRecordsInnerOneOf1AssociationsInnerUpsertrecordsRequestRecordsInnerOneOf1AssociationsInnerOneOfUpsertrecordsRequestRecordsInnerOneOf1AssociationsInnerOneOf1UpsertrecordsRequestRecordsInnerOneOf1AssociationsInnerOneOf1RecordsInnerUpsertrecordsRequestRecordsInnerOneOf1AssociationsInnerOneOf1RecordsInnerOneOfUpsertrecordsRequestRecordsInnerOneOf1AssociationsInnerOneOf1RecordsInnerOneOf1Identifiers attached with the associated object record.UpsertrecordsRequestRecordsInnerOneOf1AssociationsInnerOneOfRecordsInnerUpsertrecordsRequestRecordsInnerOneOf1AssociationsInnerOneOfRecordsInnerIdentifiersIdentifiers attached with the object record.UpsertrecordsRequestRecordsInnerOneOfAssociationsInnerUpsertrecordsRequestRecordsInnerOneOfAssociationsInnerRecordsInnerIdentifiers attached with the associated object record.UpsertrecordsRequestRecordsInnerOneOfAssociationsInnerRecordsInnerOneOfUpsertrecordsRequestRecordsInnerOneOfAssociationsInnerRecordsInnerOneOfIdentifiersIdentifiers attached with the object record.VariablesItemsWhatsappCampStatsWhatsappCampTemplate