lib

type APIClient struct {
	AccountApi *AccountApiService

	CompaniesApi *CompaniesApiService

	ContactsApi *ContactsApiService

	ConversationsApi *ConversationsApiService

	CouponsApi *CouponsApiService

	DealsApi *DealsApiService

	DomainsApi *DomainsApiService

	EcommerceApi *EcommerceApiService

	EmailCampaignsApi *EmailCampaignsApiService

	EventsApi *EventsApiService

	ExternalFeedsApi *ExternalFeedsApiService

	FilesApi *FilesApiService

	InboundParsingApi *InboundParsingApiService

	MasterAccountApi *MasterAccountApiService

	NotesApi *NotesApiService

	PaymentsApi *PaymentsApiService

	ProcessApi *ProcessApiService

	ResellerApi *ResellerApiService

	SMSCampaignsApi *SMSCampaignsApiService

	SendersApi *SendersApiService

	TasksApi *TasksApiService

	TransactionalEmailsApi *TransactionalEmailsApiService

	TransactionalSMSApi *TransactionalSMSApiService

	TransactionalWhatsAppApi *TransactionalWhatsAppApiService

	UserApi *UserApiService

	WebhooksApi *WebhooksApiService

	WhatsAppCampaignsApi *WhatsAppCampaignsApiService
	// contains filtered or unexported fields
}

type APIKey struct {
	Key    string
	Prefix string
}

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

type AbTestCampaignResult struct {
	// 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.
	WinningVersion string `json:"winningVersion,omitempty"`
	// Criteria choosen for winning version (Open/Click)
	WinningCriteria string `json:"winningCriteria,omitempty"`
	// Subject Line of current winning version
	WinningSubjectLine string `json:"winningSubjectLine,omitempty"`
	// Open rate for current winning version
	OpenRate string `json:"openRate,omitempty"`
	// Click rate for current winning version
	ClickRate string `json:"clickRate,omitempty"`
	// Open/Click rate for the winner version
	WinningVersionRate string                            `json:"winningVersionRate,omitempty"`
	Statistics         *AbTestCampaignResultStatistics   `json:"statistics,omitempty"`
	ClickedLinks       *AbTestCampaignResultClickedLinks `json:"clickedLinks,omitempty"`
}

type AbTestCampaignResultClickedLinks struct {
	VersionA *AbTestVersionClicks `json:"Version A"`
	VersionB *AbTestVersionClicks `json:"Version B"`
}

type AbTestCampaignResultStatistics struct {
	Openers      *AbTestVersionStats `json:"openers"`
	Clicks       *AbTestVersionStats `json:"clicks"`
	Unsubscribed *AbTestVersionStats `json:"unsubscribed"`
	HardBounces  *AbTestVersionStats `json:"hardBounces"`
	SoftBounces  *AbTestVersionStats `json:"softBounces"`
	Complaints   *AbTestVersionStats `json:"complaints"`
}

type AbTestVersionClicks struct {
}

type AbTestVersionClicksInner struct {
	// URL of the link
	Link string `json:"link"`
	// Number of times a link is clicked
	ClicksCount int64 `json:"clicksCount"`
	// Percentage of clicks of link with respect to total clicks
	ClickRate string `json:"clickRate"`
}

type AbTestVersionStats struct {
	// percentage of an event for version A
	VersionA string `json:"Version A"`
	// percentage of an event for version B
	VersionB string `json:"Version B"`
}

type AccountApiService service

type AddChildDomain struct {
	// Sender domain to add for a specific child account
	Domain string `json:"domain,omitempty"`
}

type AddContactToList struct {
	// Mandatory if IDs are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api.
	Emails []string `json:"emails,omitempty"`
	// Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api.
	Ids []int64 `json:"ids,omitempty"`
}

type AddCredits struct {
	// Required if email credits are empty. SMS credits to be added to the child account
	Sms int64 `json:"sms,omitempty"`
	// Required if sms credits are empty. Email credits to be added to the child account
	Email int64 `json:"email,omitempty"`
}

type AuthenticateDomainModel struct {
	// Domain
	DomainName string `json:"domain_name"`
	// Success message
	Message string `json:"message"`
}

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

type BlockDomain struct {
	// name of the domain to be blocked
	Domain string `json:"domain"`
}

type Body struct {
	// The name of the group of sub-accounts
	GroupName string `json:"groupName"`
	// Pass the list of sub-account Ids to be included in the group
	SubAccountIds []int64 `json:"subAccountIds,omitempty"`
}

type Body1 struct {
	// IP Address
	Ip string `json:"ip"`
	// Pass the list of sub-account Ids to be associated with the IP address
	Ids []int64 `json:"ids"`
}

type Body2 struct {
	// IP Address
	Ip string `json:"ip"`
	// Pass the list of sub-account Ids to be dissociated from the IP address
	Ids []int64 `json:"ids"`
}

type Body3 struct {
	// The name of the group of sub-accounts
	GroupName string `json:"groupName"`
	// Pass the list of sub-account Ids to be included in the group
	SubAccountIds []int64 `json:"subAccountIds,omitempty"`
}

type Body4 struct {
	// List of sub-account ids
	SubAccountIds []int64 `json:"subAccountIds"`
}

type Body5 struct {
	// Name of company
	Name string `json:"name"`
	// Attributes for company creation
	Attributes map[string]interface{} `json:"attributes,omitempty"`
	// Country code if phone_number is passed in attributes.
	CountryCode int64 `json:"countryCode,omitempty"`
	// Contact ids to be linked with company
	LinkedContactsIds []int64 `json:"linkedContactsIds,omitempty"`
	// Deal ids to be linked with company
	LinkedDealsIds []string `json:"linkedDealsIds,omitempty"`
}

type Body6 struct {
	// Name of company
	Name string `json:"name,omitempty"`
	// Attributes for company update
	Attributes map[string]interface{} `json:"attributes,omitempty"`
	// Country code if phone_number is passed in attributes.
	CountryCode int64 `json:"countryCode,omitempty"`
}

type Body7 struct {
	// Contact ids for contacts to be linked with company
	LinkContactIds []int64 `json:"linkContactIds,omitempty"`
	// Contact ids for contacts to be unlinked from company
	UnlinkContactIds []int64 `json:"unlinkContactIds,omitempty"`
	// Deals ids for deals to be linked with company
	LinkDealsIds []string `json:"linkDealsIds,omitempty"`
	// Deals ids for deals to be unlinked from company
	UnlinkDealsIds []string `json:"unlinkDealsIds,omitempty"`
}

type Body8 struct {
	// Name of deal
	Name string `json:"name"`
	// Attributes for deal creation  To assign owner of a Deal you can send attributes.deal_owner and utilize the account email or ID.  If you want to create a deal on a specific pipeline and stage you can use the following attributes `pipeline` and `deal_stage`.  Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}`
	Attributes map[string]interface{} `json:"attributes,omitempty"`
	// Contact ids to be linked with deal
	LinkedContactsIds []int64 `json:"linkedContactsIds,omitempty"`
	// Company ids to be linked with deal
	LinkedCompaniesIds []string `json:"linkedCompaniesIds,omitempty"`
}

type Body9 struct {
	// Name of deal
	Name string `json:"name,omitempty"`
	// Attributes for deal update  To assign owner of a Deal you can send attributes.deal_owner and utilize the account email or ID.  If you wish to update the pipeline of a deal you need to provide the `pipeline` and the `deal_stage`.  Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}`
	Attributes map[string]interface{} `json:"attributes,omitempty"`
}

type Body10 struct {
	// Contact ids for contacts to be linked with deal
	LinkContactIds []int64 `json:"linkContactIds,omitempty"`
	// Contact ids for contacts to be unlinked from deal
	UnlinkContactIds []int64 `json:"unlinkContactIds,omitempty"`
	// Company ids to be linked with deal
	LinkCompanyIds []string `json:"linkCompanyIds,omitempty"`
	// Company ids to be unlinked from deal
	UnlinkCompanyIds []string `json:"unlinkCompanyIds,omitempty"`
}

type Body11 struct {
	// Name of task
	Name string `json:"name"`
	// Duration of task in milliseconds [1 minute = 60000 ms]
	Duration int64 `json:"duration,omitempty"`
	// Id for type of task e.g Call / Email / Meeting etc.
	TaskTypeId string `json:"taskTypeId"`
	// Task due date and time
	Date time.Time `json:"date"`
	// Notes added to a task
	Notes string `json:"notes,omitempty"`
	// Task marked as done
	Done bool `json:"done,omitempty"`
	// To assign a task to a user you can use either the account email or ID.
	AssignToId string `json:"assignToId,omitempty"`
	// Contact ids for contacts linked to this task
	ContactsIds []int32 `json:"contactsIds,omitempty"`
	// Deal ids for deals a task is linked to
	DealsIds []string `json:"dealsIds,omitempty"`
	// Companies ids for companies a task is linked to
	CompaniesIds []string      `json:"companiesIds,omitempty"`
	Reminder     *TaskReminder `json:"reminder,omitempty"`
}

type Body12 struct {
	// Name of task
	Name string `json:"name,omitempty"`
	// Duration of task in milliseconds [1 minute = 60000 ms]
	Duration int32 `json:"duration,omitempty"`
	// Id for type of task e.g Call / Email / Meeting etc.
	TaskTypeId string `json:"taskTypeId,omitempty"`
	// Task date/time
	Date time.Time `json:"date,omitempty"`
	// Notes added to a task
	Notes string `json:"notes,omitempty"`
	// Task marked as done
	Done bool `json:"done,omitempty"`
	// To assign a task to a user you can use either the account email or ID.
	AssignToId string `json:"assignToId,omitempty"`
	// Contact ids for contacts linked to this task
	ContactsIds []int32 `json:"contactsIds,omitempty"`
	// Deal ids for deals a task is linked to
	DealsIds []string `json:"dealsIds,omitempty"`
	// Companies ids for companies a task is linked to
	CompaniesIds []string `json:"companiesIds,omitempty"`
}

type Body13 struct {
	// visitor’s ID received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a>
	VisitorId string `json:"visitorId"`
	// message text
	Text string `json:"text"`
	// agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required).
	AgentId string `json:"agentId,omitempty"`
	// mark your messages to distinguish messages created by you from the others.
	ReceivedFrom string `json:"receivedFrom,omitempty"`
	// agent email. When sending messages from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address.
	AgentEmail string `json:"agentEmail,omitempty"`
	// agent name
	AgentName string `json:"agentName,omitempty"`
}

type Body14 struct {
	// edited message text
	Text string `json:"text"`
}

type Body15 struct {
	// visitor’s ID received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a>
	VisitorId string `json:"visitorId"`
	// message text
	Text string `json:"text"`
	// agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Optional if `groupId` is set.
	AgentId string `json:"agentId,omitempty"`
	// group ID. It can be found on group’s page. Optional if `agentId` is set.
	GroupId string `json:"groupId,omitempty"`
}

type Body16 struct {
	// edited message text
	Text string `json:"text"`
}

type Body17 struct {
	// agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required).
	AgentId string `json:"agentId,omitempty"`
	// mark your messages to distinguish messages created by you from the others.
	ReceivedFrom string `json:"receivedFrom,omitempty"`
	// agent email. When sending online pings from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. If there’s no agent with the specified email address in your Brevo organization, a dummy agent will be created automatically.
	AgentEmail string `json:"agentEmail,omitempty"`
	// agent name.
	AgentName string `json:"agentName,omitempty"`
}

type BodyVariablesItems struct {
}

type Cart struct {
	// Currency code for the payment amount.
	Currency string `json:"currency"`
	// Payment amount, in cents.  e.g. if you want to request €12.00, then the amount in cents is 1200.
	SpecificAmount int64 `json:"specificAmount"`
}

type CompaniesApiService service

type CompaniesGetOpts struct {
	Filters           optional.String
	LinkedContactsIds optional.Int64
	LinkedDealsIds    optional.String
	Page              optional.Int64
	Limit             optional.Int64
	Sort              optional.String
	SortBy            optional.String
}

type CompaniesList struct {
	// List of compaies
	Items []Company `json:"items,omitempty"`
}

type Company struct {
	// Unique company id
	Id string `json:"id,omitempty"`
	// Company attributes with values
	Attributes map[string]interface{} `json:"attributes,omitempty"`
	// Contact ids for contacts linked to this company
	LinkedContactsIds []int32 `json:"linkedContactsIds,omitempty"`
	// Deals ids for companies linked to this company
	LinkedDealsIds []string `json:"linkedDealsIds,omitempty"`
}

type CompanyAttributes struct {
}

type CompanyAttributesInner struct {
	InternalName      string        `json:"internalName,omitempty"`
	Label             string        `json:"label,omitempty"`
	AttributeTypeName string        `json:"attributeTypeName,omitempty"`
	AttributeOptions  []interface{} `json:"attributeOptions,omitempty"`
	IsRequired        bool          `json:"isRequired,omitempty"`
}

type ComponentItems struct {
	Type_ string `json:"type,omitempty"`
	Text  string `json:"text,omitempty"`
}

type Configuration struct {
	BasePath         string            `json:"basePath,omitempty"`
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	CustomSuccessUrl string            `json:"customSuccessUrl"`
	HTTPClient       *http.Client
}

type ContactsApiService service

type ConversationsApiService service

type ConversationsMessage struct {
	// Message ID. It can be used for further manipulations with the message.
	Id string `json:"id,omitempty"`
	// `\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages.
	Type_ string `json:"type,omitempty"`
	// Message text or name of the attached file
	Text string `json:"text,omitempty"`
	// visitor’s ID
	VisitorId string `json:"visitorId,omitempty"`
	// ID of the agent on whose behalf the message was sent (only in messages sent by an agent).
	AgentId string `json:"agentId,omitempty"`
	// Agent’s name as displayed to the visitor. Only in the messages sent by an agent.
	AgentName string `json:"agentName,omitempty"`
	// Timestamp in milliseconds.
	CreatedAt int64 `json:"createdAt,omitempty"`
	// `true` for pushed messages
	IsPushed bool `json:"isPushed,omitempty"`
	// In two-way integrations, messages sent via REST API can be marked with receivedFrom property and then filtered out when received in a webhook to avoid infinite loop.
	ReceivedFrom string                    `json:"receivedFrom,omitempty"`
	File         *ConversationsMessageFile `json:"file,omitempty"`
}

type ConversationsMessageFile struct {
	// Name of the file
	Filename string `json:"filename,omitempty"`
	// Size in bytes
	Size int64 `json:"size,omitempty"`
	// Whether the file is an image
	IsImage bool `json:"isImage,omitempty"`
	// URL of the file
	Url       string                             `json:"url,omitempty"`
	ImageInfo *ConversationsMessageFileImageInfo `json:"imageInfo,omitempty"`
}

type ConversationsMessageFileImageInfo struct {
	// Width of the image
	Width int64 `json:"width,omitempty"`
	// height of the image
	Height int64 `json:"height,omitempty"`
	// URL of the preview
	PreviewUrl string `json:"previewUrl,omitempty"`
}

type ConversationsMessagesIdPutOpts struct {
	Body optional.Interface
}

type ConversionSourceMetrics struct {
	Id               float32 `json:"id"`
	ConversionSource string  `json:"conversionSource"`
	OrdersCount      float32 `json:"ordersCount"`
	Revenue          float32 `json:"revenue"`
	AverageBasket    float32 `json:"averageBasket"`
}

type ConversionSourceProduct struct {
	Id          string  `json:"id"`
	Name        string  `json:"name,omitempty"`
	Sku         string  `json:"sku,omitempty"`
	Price       float32 `json:"price,omitempty"`
	Url         string  `json:"url,omitempty"`
	ImageUrl    string  `json:"imageUrl,omitempty"`
	OrdersCount int32   `json:"ordersCount,omitempty"`
	Revenue     float32 `json:"revenue,omitempty"`
}

type CorporateGroupDetailsResponse struct {
	Group       *CorporateGroupDetailsResponseGroup        `json:"group,omitempty"`
	SubAccounts []CorporateGroupDetailsResponseSubaccounts `json:"sub-accounts,omitempty"`
	Users       []CorporateGroupDetailsResponseUsers       `json:"users,omitempty"`
}

type CorporateGroupDetailsResponseGroup struct {
	// Group id
	Id string `json:"id,omitempty"`
	// Name of the group
	GroupName string `json:"groupName,omitempty"`
	// Group creation date
	CreatedAt string `json:"createdAt,omitempty"`
}

type CorporateGroupDetailsResponseSubaccounts struct {
	// Id of the sub-account organzation
	Id int64 `json:"id,omitempty"`
	// Name of the sub-account organzation
	CompanyName string `json:"companyName,omitempty"`
	// Creation date of the sub-account organzation
	CreatedAt string `json:"createdAt,omitempty"`
}

type CorporateGroupDetailsResponseUsers struct {
	// Email address of the user
	Email string `json:"email,omitempty"`
	// Last name of the user
	LastName string `json:"lastName,omitempty"`
	// First name of the user
	FirstName string `json:"firstName,omitempty"`
}

type CouponsApiService service

type CreateApiKeyRequest struct {
	// Id of the sub-account organization
	Id int64 `json:"id"`
	// Name of the API key
	Name string `json:"name,omitempty"`
}

type CreateApiKeyResponse struct {
	// Status of the API operation.
	Status string `json:"status,omitempty"`
	// API Key
	Key string `json:"key,omitempty"`
}

type CreateAttribute struct {
	// Value of the attribute. Use only if the attribute's category is 'calculated' or 'global'
	Value string `json:"value,omitempty"`
	// Type of the attribute. Use only if the attribute's category is 'calculated' or 'global'
	IsRecurring bool `json:"isRecurring,omitempty"`
	// List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}]
	Enumeration []CreateAttributeEnumeration `json:"enumeration,omitempty"`
	// List of options you want to add for multiple-choice attribute. **Use only if the attribute's category is \"normal\" and attribute's type is \"multiple-choice\".** For example: **[\"USA\",\"INDIA\"]**
	MultiCategoryOptions []string `json:"multiCategoryOptions,omitempty"`
	// Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' and 'multiple-choice' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute )
	Type_ string `json:"type,omitempty"`
}

type CreateAttributeEnumeration struct {
	// Id of the value
	Value int32 `json:"value"`
	// Label of the value
	Label string `json:"label"`
}

type CreateCategoryModel struct {
	// ID of the category when a new category is created
	Id int64 `json:"id,omitempty"`
}

type CreateChild struct {
	// Email address to create the child account
	Email string `json:"email"`
	// First name to use to create the child account
	FirstName string `json:"firstName"`
	// Last name to use to create the child account
	LastName string `json:"lastName"`
	// Company name to use to create the child account
	CompanyName string `json:"companyName"`
	// Password for the child account to login
	Password string `json:"password"`
	// Language of the child account
	Language string `json:"language,omitempty"`
}

type CreateContact struct {
	// Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"}
	Email string `json:"email,omitempty"`
	// Pass your own Id to create a contact.
	ExtId string `json:"ext_id,omitempty"`
	// Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored.These attributes must be present in your Brevo account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"}
	Attributes map[string]interface{} `json:"attributes,omitempty"`
	// Set this field to blacklist the contact for emails (emailBlacklisted = true)
	EmailBlacklisted bool `json:"emailBlacklisted"`
	// Set this field to blacklist the contact for SMS (smsBlacklisted = true)
	SmsBlacklisted bool `json:"smsBlacklisted"`
	// Ids of the lists to add the contact to
	ListIds []int64 `json:"listIds,omitempty"`
	// Facilitate to update the existing contact in the same request (updateEnabled = true)
	UpdateEnabled bool `json:"updateEnabled,omitempty"`
	// transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true )
	SmtpBlacklistSender []string `json:"smtpBlacklistSender,omitempty"`
}

type CreateCouponCollection struct {
	// Name of the coupons collection
	Name string `json:"name"`
	// Default coupons collection name
	DefaultCoupon string `json:"defaultCoupon"`
	// Specify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date.
	ExpirationDate time.Time `json:"expirationDate,omitempty"`
	// Send a notification alert (email) when the remaining days until the expiration date are equal or fall bellow this number. Use null to disable alerts.
	RemainingDaysAlert int32 `json:"remainingDaysAlert,omitempty"`
	// Send a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts.
	RemainingCouponsAlert int32 `json:"remainingCouponsAlert,omitempty"`
}

type CreateCoupons struct {
	// The id of the coupon collection for which the coupons will be created
	CollectionId string   `json:"collectionId"`
	Coupons      []string `json:"coupons"`
}

type CreateDoiContact struct {
	// Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes.
	Email string `json:"email"`
	// Pass the set of attributes and their values. These attributes must be present in your Brevo account. For eg. {'FNAME':'Elly', 'LNAME':'Roger', 'COUNTRIES':['India','China']}
	Attributes map[string]interface{} `json:"attributes,omitempty"`
	// Lists under user account where contact should be added
	IncludeListIds []int64 `json:"includeListIds"`
	// Lists under user account where contact should not be added
	ExcludeListIds []int64 `json:"excludeListIds,omitempty"`
	// Id of the Double opt-in (DOI) template
	TemplateId int64 `json:"templateId"`
	// URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}.
	RedirectionUrl string `json:"redirectionUrl"`
}

type CreateDomain struct {
	// Domain name
	Name string `json:"name"`
}

type CreateDomainModel struct {
	// ID of the Domain created
	Id int64 `json:"id"`
	// Domain
	DomainName string `json:"domain_name,omitempty"`
	// Domain Provider
	DomainProvider string `json:"domain_provider,omitempty"`
	// Success message
	Message    string                       `json:"message,omitempty"`
	DnsRecords *CreateDomainModelDnsRecords `json:"dns_records,omitempty"`
}

type CreateDomainModelDnsRecords struct {
	DkimRecord  *CreateDomainModelDnsRecordsDkimRecord `json:"dkim_record,omitempty"`
	BrevoCode   *CreateDomainModelDnsRecordsDkimRecord `json:"brevo_code,omitempty"`
	DmarcRecord *CreateDomainModelDnsRecordsDkimRecord `json:"dmarc_record,omitempty"`
}

type CreateDomainModelDnsRecordsDkimRecord struct {
	Type_    string `json:"type,omitempty"`
	Value    string `json:"value,omitempty"`
	HostName string `json:"host_name,omitempty"`
	Status   bool   `json:"status,omitempty"`
}

type CreateDomainOpts struct {
	DomainName optional.Interface
}

type CreateEmailCampaign struct {
	// Tag of the campaign
	Tag    string                     `json:"tag,omitempty"`
	Sender *CreateEmailCampaignSender `json:"sender"`
	// Name of the campaign
	Name string `json:"name"`
	// Mandatory if htmlUrl and templateId are empty. Body of the message (HTML)
	HtmlContent string `json:"htmlContent,omitempty"`
	// Mandatory if htmlContent and templateId are empty. Url to the message (HTML)
	HtmlUrl string `json:"htmlUrl,omitempty"`
	// Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature.
	TemplateId int64 `json:"templateId,omitempty"`
	// Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part).
	ScheduledAt string `json:"scheduledAt,omitempty"`
	// Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true.
	Subject string `json:"subject,omitempty"`
	// Preview text or preheader of the email campaign
	PreviewText string `json:"previewText,omitempty"`
	// Email on which the campaign recipients will be able to reply to
	ReplyTo string `json:"replyTo,omitempty"`
	// To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
	ToField    string                         `json:"toField,omitempty"`
	Recipients *CreateEmailCampaignRecipients `json:"recipients,omitempty"`
	// Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps
	AttachmentUrl string `json:"attachmentUrl,omitempty"`
	// Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts
	InlineImageActivation bool `json:"inlineImageActivation,omitempty"`
	// Use true to enable the mirror link
	MirrorActive bool `json:"mirrorActive,omitempty"`
	// Footer of the email campaign
	Footer string `json:"footer,omitempty"`
	// Header of the email campaign
	Header string `json:"header,omitempty"`
	// Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed
	UtmCampaign string `json:"utmCampaign,omitempty"`
	// Pass the set of attributes to customize the type classic campaign. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField'
	Params map[string]interface{} `json:"params,omitempty"`
	// Set this to true if you want to send your campaign at best time.
	SendAtBestTime bool `json:"sendAtBestTime,omitempty"`
	// Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B
	AbTesting bool `json:"abTesting,omitempty"`
	// Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value
	SubjectA string `json:"subjectA,omitempty"`
	// Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value
	SubjectB string `json:"subjectB,omitempty"`
	// Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else
	SplitRule int64 `json:"splitRule,omitempty"`
	// Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed
	WinnerCriteria string `json:"winnerCriteria,omitempty"`
	// Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed
	WinnerDelay int64 `json:"winnerDelay,omitempty"`
	// Available for dedicated ip clients. Set this to true if you wish to warm up your ip.
	IpWarmupEnable bool `json:"ipWarmupEnable,omitempty"`
	// Mandatory if ipWarmupEnable is set to true. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000.
	InitialQuota int64 `json:"initialQuota,omitempty"`
	// Mandatory if ipWarmupEnable is set to true. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%.
	IncreaseRate int64 `json:"increaseRate,omitempty"`
	// Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. If not entered, then the default unsubscription page will be used.
	UnsubscriptionPageId string `json:"unsubscriptionPageId,omitempty"`
	// Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. If not entered, then the default update profile form will be used.
	UpdateFormId string `json:"updateFormId,omitempty"`
}

type CreateEmailCampaignRecipients struct {
	// List ids to exclude from the campaign
	ExclusionListIds []int64 `json:"exclusionListIds,omitempty"`
	// Mandatory if scheduledAt is not empty. List Ids to send the campaign to
	ListIds []int64 `json:"listIds,omitempty"`
	// Mandatory if listIds are not used. Segment ids to send the campaign to.
	SegmentIds []int64 `json:"segmentIds,omitempty"`
}

type CreateEmailCampaignSender struct {
	// Sender Name
	Name string `json:"name,omitempty"`
	// Sender email
	Email string `json:"email"`
	// Select the sender for the campaign on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email).
	Id int64 `json:"id,omitempty"`
}

type CreateExternalFeed struct {
	// Name of the feed
	Name string `json:"name"`
	// URL of the feed
	Url string `json:"url"`
	// Auth type of the feed:   * `basic`   * `token`   * `noAuth`
	AuthType string `json:"authType,omitempty"`
	// Username for authType `basic`
	Username string `json:"username,omitempty"`
	// Password for authType `basic`
	Password string `json:"password,omitempty"`
	// Token for authType `token`
	Token string `json:"token,omitempty"`
	// Custom headers for the feed
	Headers []GetExternalFeedByUuidHeaders `json:"headers,omitempty"`
	// Maximum number of retries on the feed url
	MaxRetries int32 `json:"maxRetries,omitempty"`
	// Toggle caching of feed url response
	Cache bool `json:"cache,omitempty"`
}

type CreateList struct {
	// Name of the list
	Name string `json:"name"`
	// Id of the parent folder in which this list is to be created
	FolderId int64 `json:"folderId"`
}

type CreateModel struct {
	// ID of the object created
	Id int64 `json:"id"`
}

type CreatePaymentRequest struct {
	// Reference of the payment request, it will appear on the payment page.
	Reference string `json:"reference"`
	Cart      *Cart  `json:"cart"`
	// Brevo ID of the contact requested to pay.
	ContactId int64 `json:"contactId"`
	// description of payment request.
	Description   string         `json:"description,omitempty"`
	Notification  *Notification  `json:"notification,omitempty"`
	Configuration *Configuration `json:"configuration,omitempty"`
}

type CreatePaymentResponse struct {
	// ID of the object created
	Id string `json:"id"`
	// URL of the payment request created
	Url string `json:"url,omitempty"`
}

type CreateProductModel struct {
	// ID of the Product when a new product is created
	Id int64 `json:"id,omitempty"`
}

type CreateReseller struct {
	// AuthKey of Reseller child created
	AuthKey string `json:"authKey"`
	// Id of Reseller child created
	Id int64 `json:"id,omitempty"`
}

type CreateResellerChildOpts struct {
	ResellerChild optional.Interface
}

type CreateSender struct {
	// From Name to use for the sender
	Name string `json:"name"`
	// From email to use for the sender. A verification email will be sent to this address.
	Email string `json:"email"`
	// Mandatory in case of dedicated IP, IPs to associate to the sender
	Ips []CreateSenderIps `json:"ips,omitempty"`
}

type CreateSenderIps struct {
	// Dedicated IP available in your account
	Ip string `json:"ip"`
	// Domain of the IP
	Domain string `json:"domain"`
	// Weight to apply to the IP. Sum of all IP weights must be 100. Should be passed for either ALL or NONE of the IPs. If it's not passed, the sending will be equally balanced on all IPs.
	Weight int64 `json:"weight,omitempty"`
}

type CreateSenderModel struct {
	// ID of the Sender created
	Id int64 `json:"id"`
	// Status of SPF configuration for the sender (true = SPF not well configured, false = SPF well configured)
	SpfError bool `json:"spfError,omitempty"`
	// Status of DKIM configuration for the sender (true = DKIM not well configured, false = DKIM well configured)
	DkimError bool `json:"dkimError,omitempty"`
}

type CreateSenderOpts struct {
	Sender optional.Interface
}

type CreateSmsCampaign struct {
	// Name of the campaign
	Name string `json:"name"`
	// Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters**
	Sender string `json:"sender"`
	// Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS
	Content    string                       `json:"content"`
	Recipients *CreateSmsCampaignRecipients `json:"recipients,omitempty"`
	// UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
	ScheduledAt string `json:"scheduledAt,omitempty"`
	// Format of the message. It indicates whether the content should be treated as unicode or not.
	UnicodeEnabled bool `json:"unicodeEnabled,omitempty"`
	// A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.**
	OrganisationPrefix string `json:"organisationPrefix,omitempty"`
	// Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include **STOP** keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.**
	UnsubscribeInstruction string `json:"unsubscribeInstruction,omitempty"`
}

type CreateSmsCampaignRecipients struct {
	// Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty
	ListIds []int64 `json:"listIds"`
	// List ids which have to be excluded from a campaign
	ExclusionListIds []int64 `json:"exclusionListIds,omitempty"`
}

type CreateSmtpEmail struct {
	// Message ID of the transactional email sent
	MessageId  string   `json:"messageId,omitempty"`
	MessageIds []string `json:"messageIds,omitempty"`
}

type CreateSmtpTemplate struct {
	// Tag of the template
	Tag    string                    `json:"tag,omitempty"`
	Sender *CreateSmtpTemplateSender `json:"sender"`
	// Name of the template
	TemplateName string `json:"templateName"`
	// Body of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty
	HtmlContent string `json:"htmlContent,omitempty"`
	// Url which contents the body of the email message. REQUIRED if htmlContent is empty
	HtmlUrl string `json:"htmlUrl,omitempty"`
	// Subject of the template
	Subject string `json:"subject"`
	// Email on which campaign recipients will be able to reply to
	ReplyTo string `json:"replyTo,omitempty"`
	// To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
	ToField string `json:"toField,omitempty"`
	// Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps
	AttachmentUrl string `json:"attachmentUrl,omitempty"`
	// Status of template. isActive = true means template is active and isActive = false means template is inactive
	IsActive bool `json:"isActive,omitempty"`
}

type CreateSmtpTemplateSender struct {
	// Name of the sender. If not passed, will be set to default
	Name string `json:"name,omitempty"`
	// Email of the sender
	Email string `json:"email,omitempty"`
	// Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email).
	Id int64 `json:"id,omitempty"`
}

type CreateSubAccount struct {
	// Set the name of the sub-account company
	CompanyName string `json:"companyName"`
	// Email address for the organization
	Email string `json:"email"`
	// Set the language of the sub-account
	Language string `json:"language,omitempty"`
	// Set the timezone of the sub-account
	Timezone string `json:"timezone,omitempty"`
	// Set the group(s) for the sub-account
	GroupIds []string `json:"groupIds,omitempty"`
}

type CreateSubAccountResponse struct {
	// ID of the sub-account created
	Id int64 `json:"id"`
}

type CreateUpdateBatchCategory struct {
	// array of categories objects
	Categories []CreateUpdateCategories `json:"categories"`
	// Facilitate to update the existing categories in the same request (updateEnabled = true)
	UpdateEnabled bool `json:"updateEnabled,omitempty"`
}

type CreateUpdateBatchCategoryModel struct {
	// Number of the new created categories
	CreatedCount int64 `json:"createdCount,omitempty"`
	// Number of the existing categories updated
	UpdatedCount int64 `json:"updatedCount,omitempty"`
}

type CreateUpdateBatchProducts struct {
	// array of products objects
	Products []CreateUpdateProducts `json:"products"`
	// Facilitate to update the existing categories in the same request (updateEnabled = true)
	UpdateEnabled bool `json:"updateEnabled,omitempty"`
}

type CreateUpdateBatchProductsModel struct {
	// Number of the new created products
	CreatedCount int64 `json:"createdCount,omitempty"`
	// Number of the existing products updated
	UpdatedCount int64 `json:"updatedCount,omitempty"`
}

type CreateUpdateCategories struct {
	// Unique Category ID as saved in the shop
	Id string `json:"id"`
	// **Mandatory in case of creation**. Name of the Category, as displayed in the shop
	Name string `json:"name,omitempty"`
	// URL to the category
	Url string `json:"url,omitempty"`
	// UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop's database
	DeletedAt string `json:"deletedAt,omitempty"`
	// category deleted from the shop's database
	IsDeleted bool `json:"isDeleted,omitempty"`
}

type CreateUpdateCategory struct {
	// Unique Category ID as saved in the shop
	Id string `json:"id"`
	// **Mandatory in case of creation**. Name of the Category, as displayed in the shop
	Name string `json:"name,omitempty"`
	// URL to the category
	Url string `json:"url,omitempty"`
	// Facilitate to update the existing category in the same request (updateEnabled = true)
	UpdateEnabled bool `json:"updateEnabled,omitempty"`
	// UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop's database
	DeletedAt string `json:"deletedAt,omitempty"`
	// category deleted from the shop's database
	IsDeleted bool `json:"isDeleted,omitempty"`
}

type CreateUpdateContactModel struct {
	// ID of the contact when a new contact is created
	Id int64 `json:"id,omitempty"`
}

type CreateUpdateFolder struct {
	// Name of the folder
	Name string `json:"name,omitempty"`
}

type CreateUpdateProduct struct {
	// Product ID for which you requested the details
	Id string `json:"id"`
	// Mandatory in case of creation**. Name of the product for which you requested the details
	Name string `json:"name"`
	// URL to the product
	Url string `json:"url,omitempty"`
	// Absolute URL to the cover image of the product
	ImageUrl string `json:"imageUrl,omitempty"`
	// Product identifier from the shop
	Sku string `json:"sku,omitempty"`
	// Price of the product
	Price float32 `json:"price,omitempty"`
	// Category ID-s of the product
	Categories []string `json:"categories,omitempty"`
	// Parent product id of the product
	ParentId string `json:"parentId,omitempty"`
	// Meta data of product such as description, vendor, producer, stock level. The size of cumulative metaInfo shall not exceed **1000 KB**. Maximum length of metaInfo object can be 10.
	MetaInfo map[string]string `json:"metaInfo,omitempty"`
	// Facilitate to update the existing category in the same request (updateEnabled = true)
	UpdateEnabled bool `json:"updateEnabled,omitempty"`
	// UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop's database
	DeletedAt string `json:"deletedAt,omitempty"`
	// product deleted from the shop's database
	IsDeleted bool `json:"isDeleted,omitempty"`
}

type CreateUpdateProducts struct {
	// Product ID for which you requested the details
	Id string `json:"id"`
	// Mandatory in case of creation**. Name of the product for which you requested the details
	Name string `json:"name"`
	// URL to the product
	Url string `json:"url,omitempty"`
	// Absolute URL to the cover image of the product
	ImageUrl string `json:"imageUrl,omitempty"`
	// Product identifier from the shop
	Sku string `json:"sku,omitempty"`
	// Price of the product
	Price float32 `json:"price,omitempty"`
	// Category ID-s of the product
	Categories []string `json:"categories,omitempty"`
	// Parent product id of the product
	ParentId string `json:"parentId,omitempty"`
	// Meta data of product such as description, vendor, producer, stock level. The size of cumulative metaInfo shall not exceed **1000 KB**. Maximum length of metaInfo object can be 10.
	MetaInfo map[string]string `json:"metaInfo,omitempty"`
	// UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop's database
	DeletedAt string `json:"deletedAt,omitempty"`
	// product deleted from the shop's database
	IsDeleted bool `json:"isDeleted,omitempty"`
}

type CreateWebhook struct {
	// URL of the webhook
	Url string `json:"url"`
	// Description of the webhook
	Description string `json:"description,omitempty"`
	// - Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed`
	Events []string `json:"events"`
	// Type of the webhook
	Type_ string `json:"type,omitempty"`
	// Inbound domain of webhook, required in case of event type `inbound`
	Domain string `json:"domain,omitempty"`
	// To send batched webhooks
	Batched bool            `json:"batched,omitempty"`
	Auth    *GetWebhookAuth `json:"auth,omitempty"`
	// Custom headers to be send with webhooks
	Headers []GetWebhookHeaders `json:"headers,omitempty"`
}

type CreateWhatsAppCampaign struct {
	// Name of the WhatsApp campaign creation
	Name string `json:"name"`
	// Id of the WhatsApp template in **approved** state
	TemplateId int32 `json:"templateId"`
	// Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.For example: **2017-06-01T12:30:00+02:00**
	ScheduledAt string                            `json:"scheduledAt"`
	Recipients  *CreateWhatsAppCampaignRecipients `json:"recipients"`
}

type CreateWhatsAppCampaignRecipients struct {
	// List ids to exclude from the campaign
	ExcludedListIds []int64 `json:"excludedListIds,omitempty"`
	// **Mandatory if scheduledAt is not empty**. List Ids to send the campaign to
	ListIds []int64 `json:"listIds,omitempty"`
	// **Mandatory if listIds are not used**. Segment ids to send the campaign to.
	Segments []int64 `json:"segments,omitempty"`
}

type CreateWhatsAppTemplate struct {
	// Name of the template
	Name string `json:"name"`
	// Language of the template. For Example : **en** for English
	Language string `json:"language"`
	// Category of the template
	Category string `json:"category"`
	// Absolute url of the media file **(no local file)** for the header. **Use this field in you want to add media in Template header and headerText is empty.** Allowed extensions for media files are: #### jpeg | png | mp4 | pdf
	MediaUrl string `json:"mediaUrl,omitempty"`
	// Body of the template. **Maximum allowed characters are 1024**
	BodyText string `json:"bodyText"`
	// Text content of the header in the template.  **Maximum allowed characters are 45** **Use this field to add text content in template header and if mediaUrl is empty**
	HeaderText string `json:"headerText,omitempty"`
	// source of the template
	Source string `json:"source,omitempty"`
}

type CreatedBatchId struct {
	// Batch ID of the request
	BatchId float32 `json:"batchId"`
}

type CreatedProcessId struct {
	// Id of the process created
	ProcessId int64 `json:"processId"`
}

type CrmDealsGetOpts struct {
	FiltersAttributesDealName optional.String
	FiltersLinkedCompaniesIds optional.String
	FiltersLinkedContactsIds  optional.String
	Offset                    optional.Int64
	Limit                     optional.Int64
	Sort                      optional.String
	SortBy                    optional.String
}

type CrmFilesGetOpts struct {
	Entity    optional.String
	EntityIds optional.String
	DateFrom  optional.Int32
	DateTo    optional.Int32
	Offset    optional.Int64
	Limit     optional.Int64
	Sort      optional.String
}

type CrmFilesPostOpts struct {
	DealId    optional.String
	ContactId optional.Int64
	CompanyId optional.String
}

type CrmNotesGetOpts struct {
	Entity    optional.String
	EntityIds optional.String
	DateFrom  optional.Int32
	DateTo    optional.Int32
	Offset    optional.Int64
	Limit     optional.Int64
	Sort      optional.String
}

type CrmTasksGetOpts struct {
	FilterType      optional.String
	FilterStatus    optional.String
	FilterDate      optional.String
	FilterAssignTo  optional.String
	FilterContacts  optional.String
	FilterDeals     optional.String
	FilterCompanies optional.String
	DateFrom        optional.Int32
	DateTo          optional.Int32
	Offset          optional.Int64
	Limit           optional.Int64
	Sort            optional.String
	SortBy          optional.String
}

type Deal struct {
	// Unique deal id
	Id string `json:"id,omitempty"`
	// Deal attributes with values
	Attributes map[string]interface{} `json:"attributes,omitempty"`
	// Contact ids for contacts linked to this deal
	LinkedContactsIds []int32 `json:"linkedContactsIds,omitempty"`
	// Companies ids for companies linked to this deal
	LinkedCompaniesIds []string `json:"linkedCompaniesIds,omitempty"`
}

type DealAttributes struct {
}

type DealAttributesInner struct {
	InternalName      string        `json:"internalName,omitempty"`
	Label             string        `json:"label,omitempty"`
	AttributeTypeName string        `json:"attributeTypeName,omitempty"`
	AttributeOptions  []interface{} `json:"attributeOptions,omitempty"`
	IsRequired        bool          `json:"isRequired,omitempty"`
}

type DealsApiService service

type DealsList struct {
	// List of deals
	Items []Deal `json:"items,omitempty"`
}

type DeleteHardbounces struct {
	// Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate
	StartDate string `json:"startDate,omitempty"`
	// Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate
	EndDate string `json:"endDate,omitempty"`
	// Target a specific email address
	ContactEmail string `json:"contactEmail,omitempty"`
}

type DeleteHardbouncesOpts struct {
	DeleteHardbounces optional.Interface
}

type DomainsApiService service

type EcommerceApiService service

type EcommerceAttributionMetricsGetOpts struct {
	PeriodFrom      optional.Time
	PeriodTo        optional.Time
	EmailCampaignId optional.Interface
}

type EmailCampaignsApiService service

type EmailExportRecipients struct {
	// Webhook called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479
	NotifyURL string `json:"notifyURL,omitempty"`
	// Type of recipients to export for a campaign
	RecipientsType string `json:"recipientsType"`
}

type EmailExportRecipientsOpts struct {
	RecipientExport optional.Interface
}

type ErrorModel struct {
	// Error code displayed in case of a failure
	Code string `json:"code"`
	// Readable message associated to the failure
	Message string `json:"message"`
}

type Event struct {
	// The name of the event that occurred. This is how you will find your event in Brevo. Limited to 255 characters, alphanumerical characters and - _ only.
	EventName string `json:"event_name"`
	// Timestamp of when the event occurred (e.g. \"2024-01-24T17:39:57+01:00\"). If no value is passed, the timestamp of the event creation is used.
	EventDate   string            `json:"event_date,omitempty"`
	Identifiers *EventIdentifiers `json:"identifiers"`
	// Properties defining the state of the contact associated to this event. Useful to update contact attributes defined in your contacts database while passing the event. For example: **\"FIRSTNAME\": \"Jane\" , \"AGE\": 37**
	ContactProperties map[string]interface{} `json:"contact_properties,omitempty"`
	// Properties of the event. Top level properties and nested properties can be used to better segment contacts and personalise workflow conditions. The following field type are supported: string, number, boolean (true/false), date (Timestamp e.g. \"2024-01-24T17:39:57+01:00\"). Keys are limited to 255 characters, alphanumerical characters and - _ only. Size is limited to 50Kb.
	EventProperties map[string]interface{} `json:"event_properties,omitempty"`
}

type EventIdentifiers struct {
	// Email Id associated with the event
	EmailId string `json:"email_id,omitempty"`
	// SMS associated with the event
	PhoneId string `json:"phone_id,omitempty"`
	// whatsapp associated with the event
	WhatsappId string `json:"whatsapp_id,omitempty"`
	// landline_number associated with the event
	LandlineNumberId string `json:"landline_number_id,omitempty"`
	// ext_id associated with the event
	ExtId string `json:"ext_id,omitempty"`
}

type EventsApiService service

type ExportWebhooksHistory struct {
	// Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_
	Days int32 `json:"days,omitempty"`
	// Mandatory if endDate is used. Starting date of the history (YYYY-MM-DD). Must be lower than equal to endDate
	StartDate string `json:"startDate,omitempty"`
	// Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
	EndDate string `json:"endDate,omitempty"`
	// Sorting order of records (asc or desc)
	Sort string `json:"sort,omitempty"`
	// Filter the history based on webhook type
	Type_ string `json:"type"`
	// Filter the history for a specific event type
	Event string `json:"event"`
	// Webhook URL to receive CSV file link
	NotifyURL string `json:"notifyURL"`
	// Filter the history for a specific webhook id
	WebhookId int32 `json:"webhookId,omitempty"`
	// Filter the history for a specific email
	Email string `json:"email,omitempty"`
	// Filter the history for a specific message id. Applicable only for transactional webhooks.
	MessageId int32 `json:"messageId,omitempty"`
}

type ExternalFeedsApiService service

type FileData struct {
	// Name of uploaded file
	Name string `json:"name,omitempty"`
	// Account id of user which created the file
	AuthorId string `json:"authorId,omitempty"`
	// Contact id of contact on which file is uploaded
	ContactId int64 `json:"contactId,omitempty"`
	// Deal id linked to a file
	DealId string `json:"dealId,omitempty"`
	// Company id linked to a file
	CompanyId string `json:"companyId,omitempty"`
	// Size of file in bytes
	Size int64 `json:"size,omitempty"`
	// File created date/time
	CreatedAt time.Time `json:"createdAt,omitempty"`
}

type FileDownloadableLink struct {
	// A unique link to download the requested file.
	FileUrl string `json:"fileUrl"`
}

type FileList struct {
}

type FilesApiService service

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

type GetAccount struct {
	// Login Email
	Email string `json:"email"`
	// First Name
	FirstName string `json:"firstName"`
	// Last Name
	LastName string `json:"lastName"`
	// Name of the company
	CompanyName string                    `json:"companyName"`
	Address     *GetExtendedClientAddress `json:"address"`
	// Information about your plans and credits
	Plan                []GetAccountPlan               `json:"plan"`
	Relay               *GetAccountRelay               `json:"relay"`
	MarketingAutomation *GetAccountMarketingAutomation `json:"marketingAutomation,omitempty"`
}

type GetAccountActivity struct {
	// Get user activity logs
	Logs []GetAccountActivityLogs `json:"logs,omitempty"`
}

type GetAccountActivityLogs struct {
	// Type of activity in the account.
	Action string `json:"action"`
	// Time of the activity.
	Date string `json:"date"`
	// Email address of the user who performed activity in the account.
	UserEmail string `json:"user_email"`
	// IP address of the user who performed activity in the account.
	UserIp string `json:"user_ip"`
	// Browser details of the user who performed the activity.
	UserAgent string `json:"user_agent"`
}

type GetAccountActivityOpts struct {
	StartDate optional.String
	EndDate   optional.String
	Limit     optional.Int64
	Offset    optional.Int64
}

type GetAccountMarketingAutomation struct {
	// Marketing Automation Tracker ID
	Key string `json:"key,omitempty"`
	// Status of Marketing Automation Plateform activation for your account (true=enabled, false=disabled)
	Enabled bool `json:"enabled"`
}

type GetAccountPlan struct {
	// Displays the plan type of the user
	Type_ string `json:"type"`
	// This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account.
	CreditsType string `json:"creditsType"`
	// Remaining credits of the user
	Credits float32 `json:"credits"`
	// Date of the period from which the plan will start (only available for \"subscription\" and \"reseller\" plan type)
	StartDate string `json:"startDate,omitempty"`
	// Date of the period from which the plan will end (only available for \"subscription\" and \"reseller\" plan type)
	EndDate string `json:"endDate,omitempty"`
	// Only in case of reseller account. It implies the total number of child accounts you can add to your account.
	UserLimit int32 `json:"userLimit,omitempty"`
}

type GetAccountRelay struct {
	// Status of your transactional email Account (true=Enabled, false=Disabled)
	Enabled bool                 `json:"enabled"`
	Data    *GetAccountRelayData `json:"data"`
}

type GetAccountRelayData struct {
	// Email to use as login on transactional platform
	UserName string `json:"userName"`
	// URL of the SMTP Relay
	Relay string `json:"relay"`
	// Port used for SMTP Relay
	Port int32 `json:"port"`
}

type GetAggregatedReport struct {
	// Time frame of the report
	Range_ string `json:"range,omitempty"`
	// Number of requests for the timeframe
	Requests int64 `json:"requests,omitempty"`
	// Number of delivered emails for the timeframe
	Delivered int64 `json:"delivered,omitempty"`
	// Number of hardbounces for the timeframe
	HardBounces int64 `json:"hardBounces,omitempty"`
	// Number of softbounces for the timeframe
	SoftBounces int64 `json:"softBounces,omitempty"`
	// Number of clicks for the timeframe
	Clicks int64 `json:"clicks,omitempty"`
	// Number of unique clicks for the timeframe
	UniqueClicks int64 `json:"uniqueClicks,omitempty"`
	// Number of openings for the timeframe
	Opens int64 `json:"opens,omitempty"`
	// Number of unique openings for the timeframe
	UniqueOpens int64 `json:"uniqueOpens,omitempty"`
	// Number of complaint (spam report) for the timeframe
	SpamReports int64 `json:"spamReports,omitempty"`
	// Number of blocked contact emails for the timeframe
	Blocked int64 `json:"blocked,omitempty"`
	// Number of invalid emails for the timeframe
	Invalid int64 `json:"invalid,omitempty"`
	// Number of unsubscribed emails for the timeframe
	Unsubscribed int64 `json:"unsubscribed,omitempty"`
}

type GetAggregatedSmtpReportOpts struct {
	StartDate optional.String
	EndDate   optional.String
	Days      optional.Int64
	Tag       optional.String
}

type GetAllExternalFeeds struct {
	// Total number of batches
	Count int32                      `json:"count,omitempty"`
	Feeds []GetAllExternalFeedsFeeds `json:"feeds,omitempty"`
}

type GetAllExternalFeedsFeeds struct {
	// ID of the feed
	Id string `json:"id"`
	// Name of the feed
	Name string `json:"name"`
	// URL of the feed
	Url string `json:"url"`
	// Auth type of the feed: * `basic` * `token` * `noAuth`
	AuthType string `json:"authType"`
	// Username for authType `basic`
	Username string `json:"username,omitempty"`
	// Password for authType `basic`
	Password string `json:"password,omitempty"`
	// Token for authType `token`
	Token string `json:"token,omitempty"`
	// Custom headers for the feed
	Headers []GetExternalFeedByUuidHeaders `json:"headers"`
	// Maximum number of retries on the feed url
	MaxRetries int32 `json:"maxRetries"`
	// Toggle caching of feed url response
	Cache bool `json:"cache"`
	// Datetime on which the feed was created
	CreatedAt time.Time `json:"createdAt"`
	// Datetime on which the feed was modified
	ModifiedAt time.Time `json:"modifiedAt"`
}

type GetAllExternalFeedsOpts struct {
	Search    optional.String
	StartDate optional.String
	EndDate   optional.String
	Sort      optional.String
	AuthType  optional.String
	Limit     optional.Int64
	Offset    optional.Int64
}

type GetAttributes struct {
	// Listing of available contact attributes in your account
	Attributes []GetAttributesAttributes `json:"attributes"`
}

type GetAttributesAttributes struct {
	// Name of the attribute
	Name string `json:"name"`
	// Category of the attribute
	Category string `json:"category"`
	// Type of the attribute
	Type_ string `json:"type,omitempty"`
	// Parameter only available for \"category\" type attributes.
	Enumeration []GetAttributesEnumeration `json:"enumeration,omitempty"`
	// Calculated value formula
	CalculatedValue string `json:"calculatedValue,omitempty"`
}

type GetAttributesEnumeration struct {
	// ID of Value of the \"category\" type attribute
	Value int64 `json:"value"`
	// Label of the \"category\" type attribute
	Label string `json:"label"`
}

type GetBlockedDomains struct {
	// List of all blocked domains
	Domains []string `json:"domains"`
}

type GetCampaignOverview struct {
	// ID of the campaign
	Id int64 `json:"id"`
	// Name of the campaign
	Name string `json:"name"`
	// Subject of the campaign. Only available if `abTesting` flag of the campaign is `false`
	Subject string `json:"subject,omitempty"`
	// Preview text or preheader of the email campaign
	PreviewText string `json:"previewText,omitempty"`
	// Type of campaign
	Type_ string `json:"type"`
	// Status of the campaign
	Status string `json:"status"`
	// UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ)
	ScheduledAt string `json:"scheduledAt,omitempty"`
	// Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled.
	AbTesting bool `json:"abTesting,omitempty"`
	// Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
	SubjectA string `json:"subjectA,omitempty"`
	// Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
	SubjectB string `json:"subjectB,omitempty"`
	// The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true`
	SplitRule int32 `json:"splitRule,omitempty"`
	// Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true`
	WinnerCriteria string `json:"winnerCriteria,omitempty"`
	// The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true`
	WinnerDelay int32 `json:"winnerDelay,omitempty"`
	// It is true if you have chosen to send your campaign at best time, otherwise it is false
	SendAtBestTime bool `json:"sendAtBestTime,omitempty"`
}

type GetCampaignRecipients struct {
	Lists          []int64 `json:"lists"`
	ExclusionLists []int64 `json:"exclusionLists"`
}

type GetCampaignStats struct {
	// List Id of email campaign (only in case of get email campaign(s)(not for global stats))
	ListId int64 `json:"listId,omitempty"`
	// Number of unique clicks for the campaign
	UniqueClicks int64 `json:"uniqueClicks"`
	// Number of total clicks for the campaign
	Clickers int64 `json:"clickers"`
	// Number of complaints (Spam reports) for the campaign
	Complaints int64 `json:"complaints"`
	// Number of delivered emails for the campaign
	Delivered int64 `json:"delivered"`
	// Number of sent emails for the campaign
	Sent int64 `json:"sent"`
	// Number of softbounce for the campaign
	SoftBounces int64 `json:"softBounces"`
	// Number of harbounce for the campaign
	HardBounces int64 `json:"hardBounces"`
	// Number of unique openings for the campaign
	UniqueViews int64 `json:"uniqueViews"`
	// Recipients without any privacy protection option enabled in their email client
	TrackableViews int64 `json:"trackableViews"`
	// Rate of recipients without any privacy protection option enabled in their email client
	TrackableViewsRate float32 `json:"trackableViewsRate,omitempty"`
	// Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails
	EstimatedViews int64 `json:"estimatedViews,omitempty"`
	// Number of unsubscription for the campaign
	Unsubscriptions int64 `json:"unsubscriptions"`
	// Number of openings for the campaign
	Viewed int64 `json:"viewed"`
	// Number of deferred emails for the campaign
	Deferred int64 `json:"deferred,omitempty"`
	// Total number of non-delivered campaigns for a particular campaign id.
	ReturnBounce int64 `json:"returnBounce,omitempty"`
}

type GetCategories struct {
	Categories []interface{} `json:"categories"`
	// Number of categories
	Count int64 `json:"count"`
}

type GetCategoriesOpts struct {
	Limit         optional.Int64
	Offset        optional.Int64
	Sort          optional.String
	Ids           optional.Interface
	Name          optional.String
	ModifiedSince optional.String
	CreatedSince  optional.String
}

type GetCategoryDetails struct {
	// Category ID for which you requested the details
	Id string `json:"id"`
	// Name of the category for which you requested the details
	Name string `json:"name"`
	// Creation UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ)
	CreatedAt string `json:"createdAt"`
	// Last modification UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ)
	ModifiedAt string `json:"modifiedAt"`
	// URL to the category
	Url string `json:"url,omitempty"`
	// category deleted from the shop's database
	IsDeleted bool `json:"isDeleted,omitempty"`
}

type GetChildAccountCreationStatus struct {
	// Status of child account creation whether it is successfully created (exists) or not.
	ChildAccountCreated bool `json:"childAccountCreated"`
}

type GetChildDomain struct {
	// Sender domain
	Domain string `json:"domain,omitempty"`
	// indicates whether a domain is verified or not
	Active bool `json:"active,omitempty"`
}

type GetChildDomains struct {
}

type GetChildInfo struct {
	// Login Email
	Email string `json:"email"`
	// First Name
	FirstName string `json:"firstName"`
	// Last Name
	LastName string `json:"lastName"`
	// Name of the company
	CompanyName string                  `json:"companyName"`
	Credits     *GetChildInfoCredits    `json:"credits,omitempty"`
	Statistics  *GetChildInfoStatistics `json:"statistics,omitempty"`
	// The encrypted password of child account
	Password string `json:"password"`
	// IP(s) associated to a child account user
	Ips     []string             `json:"ips,omitempty"`
	ApiKeys *GetChildInfoApiKeys `json:"apiKeys,omitempty"`
}

type GetChildInfoApiKeys struct {
	V2 []GetChildInfoApiKeysV2 `json:"v2"`
	V3 []GetChildInfoApiKeysV3 `json:"v3,omitempty"`
}

type GetChildInfoApiKeysV2 struct {
	// Name of the key for version 2
	Name string `json:"name"`
	// API Key for version 2
	Key string `json:"key"`
}

type GetChildInfoApiKeysV3 struct {
	// Name of the key for version 3
	Name string `json:"name"`
	// API Key for version 3
	Key string `json:"key"`
}

type GetChildInfoCredits struct {
	// Email credits available for your child
	EmailCredits int64 `json:"emailCredits,omitempty"`
	// SMS credits available for your child
	SmsCredits int64 `json:"smsCredits,omitempty"`
}

type GetChildInfoStatistics struct {
	// Overall emails sent for the previous month
	PreviousMonthTotalSent int64 `json:"previousMonthTotalSent,omitempty"`
	// Overall emails sent for current month
	CurrentMonthTotalSent int64 `json:"currentMonthTotalSent,omitempty"`
	// Overall emails sent for since the account exists
	TotalSent int64 `json:"totalSent,omitempty"`
}

type GetChildrenList struct {
	// Your children's account information
	Children []interface{} `json:"children,omitempty"`
	// Number of child accounts
	Count int64 `json:"count,omitempty"`
}

type GetClient struct {
	// Login Email
	Email string `json:"email"`
	// First Name
	FirstName string `json:"firstName"`
	// Last Name
	LastName string `json:"lastName"`
	// Name of the company
	CompanyName string `json:"companyName"`
}

type GetContactCampaignStats struct {
	MessagesSent      []GetExtendedContactDetailsStatisticsMessagesSent `json:"messagesSent,omitempty"`
	HardBounces       []GetExtendedContactDetailsStatisticsMessagesSent `json:"hardBounces,omitempty"`
	SoftBounces       []GetExtendedContactDetailsStatisticsMessagesSent `json:"softBounces,omitempty"`
	Complaints        []GetExtendedContactDetailsStatisticsMessagesSent `json:"complaints,omitempty"`
	Unsubscriptions   *GetContactCampaignStatsUnsubscriptions           `json:"unsubscriptions,omitempty"`
	Opened            []GetContactCampaignStatsOpened                   `json:"opened,omitempty"`
	Clicked           []GetContactCampaignStatsClicked                  `json:"clicked,omitempty"`
	TransacAttributes []GetContactCampaignStatsTransacAttributes        `json:"transacAttributes,omitempty"`
	Delivered         []GetExtendedContactDetailsStatisticsMessagesSent `json:"delivered,omitempty"`
}

type GetContactCampaignStatsClicked struct {
	// ID of the campaign which generated the event
	CampaignId int64                                      `json:"campaignId"`
	Links      []GetExtendedContactDetailsStatisticsLinks `json:"links"`
}

type GetContactCampaignStatsOpened struct {
	// ID of the campaign which generated the event
	CampaignId int64 `json:"campaignId"`
	// Number of openings of the campaign
	Count int64 `json:"count"`
	// UTC date-time of the event
	EventTime string `json:"eventTime"`
	// IP from which the user has opened the campaign
	Ip string `json:"ip"`
}

type GetContactCampaignStatsTransacAttributes struct {
	// Date of the order
	OrderDate string `json:"orderDate"`
	// Price of the order
	OrderPrice float32 `json:"orderPrice"`
	// ID of the order
	OrderId int64 `json:"orderId"`
}

type GetContactCampaignStatsUnsubscriptions struct {
	// Contact has unsubscribed via the unsubscription link in the email
	UserUnsubscription []GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription `json:"userUnsubscription"`
	// Contact has been unsubscribed from the administrator
	AdminUnsubscription []GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription `json:"adminUnsubscription"`
}

type GetContactDetails struct {
	// Email address of the contact for which you requested the details
	Email string `json:"email,omitempty"`
	// ID of the contact for which you requested the details
	Id int64 `json:"id"`
	// Blacklist status for email campaigns (true=blacklisted, false=not blacklisted)
	EmailBlacklisted bool `json:"emailBlacklisted"`
	// Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted)
	SmsBlacklisted bool `json:"smsBlacklisted"`
	// Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ)
	CreatedAt string `json:"createdAt"`
	// Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ)
	ModifiedAt       string  `json:"modifiedAt"`
	ListIds          []int64 `json:"listIds"`
	ListUnsubscribed []int64 `json:"listUnsubscribed,omitempty"`
	// Set of attributes of the contact
	Attributes map[string]interface{} `json:"attributes"`
}

type GetContactInfoOpts struct {
	StartDate optional.String
	EndDate   optional.String
}

type GetContactStatsOpts struct {
	StartDate optional.String
	EndDate   optional.String
}

type GetContacts struct {
	Contacts []interface{} `json:"contacts"`
	// Number of contacts
	Count int64 `json:"count"`
}

type GetContactsFromListOpts struct {
	ModifiedSince optional.String
	Limit         optional.Int64
	Offset        optional.Int64
	Sort          optional.String
}

type GetContactsOpts struct {
	Limit         optional.Int64
	Offset        optional.Int64
	ModifiedSince optional.String
	CreatedSince  optional.String
	Sort          optional.String
	SegmentId     optional.Int64
	ListIds       optional.Interface
	Filter        optional.String
}

type GetCorporateInvitedUsersList struct {
	// Get invited users list
	Users []GetCorporateInvitedUsersListUsers `json:"users,omitempty"`
}

type GetCorporateInvitedUsersListFeatureAccess struct {
	// User management accessiblity.
	UserManagement []string `json:"user_management,omitempty"`
	// Api keys accessiblity.
	ApiKeys []string `json:"api_keys,omitempty"`
	// My plan accessiblity.
	MyPlan []string `json:"my_plan,omitempty"`
	// Apps management accessiblity | Not available in ENTv2
	AppsManagement []string `json:"apps_management,omitempty"`
}

type GetCorporateInvitedUsersListGroups struct {
	// group id
	Id string `json:"id,omitempty"`
	// group name
	Name string `json:"name,omitempty"`
}

type GetCorporateInvitedUsersListUsers struct {
	Groups *GetCorporateInvitedUsersListGroups `json:"groups"`
	// Email address of the user.
	Email string `json:"email"`
	// Flag for indicating is user owner of the organization.
	IsOwner string `json:"is_owner"`
	// Status of the invited user.
	Status        string                                     `json:"status"`
	FeatureAccess *GetCorporateInvitedUsersListFeatureAccess `json:"feature_access"`
}

type GetCorporateUserPermission struct {
	// Email address of the user.
	Email string `json:"email"`
	// Status of the invited user.
	Status        string                                   `json:"status"`
	Groups        []GetCorporateUserPermissionGroups       `json:"groups"`
	FeatureAccess *GetCorporateUserPermissionFeatureAccess `json:"feature_access"`
}

type GetCorporateUserPermissionFeatureAccess struct {
	// Permission on api keys
	ApiKeys []string `json:"api_keys,omitempty"`
	// Permission on my plan
	MyPlan []string `json:"my_plan,omitempty"`
	// Permission on user management
	UserManagement []string `json:"user_management,omitempty"`
	// Permission on apps management
	AppsManagement []string `json:"apps_management,omitempty"`
}

type GetCorporateUserPermissionGroups struct {
	// group identifier
	Id string `json:"id,omitempty"`
	// Group name
	Name string `json:"name,omitempty"`
}

type GetCouponCollection struct {
	// The id of the collection.
	Id string `json:"id"`
	// The name of the collection.
	Name string `json:"name"`
	// The default coupon of the collection.
	DefaultCoupon string `json:"defaultCoupon"`
	// Datetime on which the collection was created.
	CreatedAt time.Time `json:"createdAt"`
	// Total number of coupons in the collection.
	TotalCoupons int64 `json:"totalCoupons"`
	// Number of coupons that have not been sent yet.
	RemainingCoupons int64 `json:"remainingCoupons"`
	// Expiration date for the coupon collection in RFC3339 format.
	ExpirationDate time.Time `json:"expirationDate,omitempty"`
	// If present, an email notification is going to be sent the defined amount of days before the expiration date.
	RemainingDaysAlert int32 `json:"remainingDaysAlert,omitempty"`
	// If present, an email notification is going to be sent when the total number of available coupons falls below the defined threshold.
	RemainingCouponsAlert int32 `json:"remainingCouponsAlert,omitempty"`
}

type GetCouponCollectionsOpts struct {
	Limit  optional.Int64
	Offset optional.Int64
	Sort   optional.String
	SortBy optional.String
}

type GetDeviceBrowserStats struct {
	// Number of total clicks for the campaign using the particular browser
	Clickers int64 `json:"clickers"`
	// Number of unique clicks for the campaign using the particular browser
	UniqueClicks int64 `json:"uniqueClicks"`
	// Number of openings for the campaign using the particular browser
	Viewed int64 `json:"viewed"`
	// Number of unique openings for the campaign using the particular browser
	UniqueViews int64 `json:"uniqueViews"`
}

type GetDomainConfigurationModel struct {
	// Domain
	Domain string `json:"domain"`
	// Status of domain verification (true=verified, false=non verified)
	Verified bool `json:"verified"`
	// Status of domain authentication (true=authenticated, false=non authenticated)
	Authenticated bool                         `json:"authenticated"`
	DnsRecords    *CreateDomainModelDnsRecords `json:"dns_records"`
}

type GetDomainsList struct {
	// List of the domains available in your account
	Domains []GetDomainsListDomains `json:"domains,omitempty"`
}

type GetDomainsListDomains struct {
	// Id of the domain
	Id int64 `json:"id"`
	// Domain name
	DomainName string `json:"domain_name"`
	// Status of domain authentication (true=authenticated, false=non authenticated)
	Authenticated bool `json:"authenticated"`
	// Status of domain verification (true=verified, false=non verified)
	Verified bool `json:"verified"`
	// Dedicated IP associated with domain
	Ip string `json:"ip,omitempty"`
}

type GetEmailCampaign struct {
	// ID of the campaign
	Id int64 `json:"id"`
	// Name of the campaign
	Name string `json:"name"`
	// Subject of the campaign. Only available if `abTesting` flag of the campaign is `false`
	Subject string `json:"subject,omitempty"`
	// Preview text or preheader of the email campaign
	PreviewText string `json:"previewText,omitempty"`
	// Type of campaign
	Type_ string `json:"type"`
	// Status of the campaign
	Status string `json:"status"`
	// UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ)
	ScheduledAt string `json:"scheduledAt,omitempty"`
	// Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled.
	AbTesting bool `json:"abTesting,omitempty"`
	// Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
	SubjectA string `json:"subjectA,omitempty"`
	// Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
	SubjectB string `json:"subjectB,omitempty"`
	// The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true`
	SplitRule int32 `json:"splitRule,omitempty"`
	// Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true`
	WinnerCriteria string `json:"winnerCriteria,omitempty"`
	// The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true`
	WinnerDelay int32 `json:"winnerDelay,omitempty"`
	// It is true if you have chosen to send your campaign at best time, otherwise it is false
	SendAtBestTime bool `json:"sendAtBestTime,omitempty"`
	// utm parameter associated with campaign
	UtmCampaignValue string `json:"utmCampaignValue,omitempty"`
	// source of utm parameter
	UtmSource string `json:"utmSource,omitempty"`
	// medium parameter
	UtmMedium string `json:"utmMedium,omitempty"`
	// utm id
	UtmID int32 `json:"utmID,omitempty"`
	// Retrieved the status of test email sending. (true=Test email has been sent  false=Test email has not been sent)
	TestSent bool `json:"testSent"`
	// Header of the campaign
	Header string `json:"header"`
	// Footer of the campaign
	Footer string                             `json:"footer"`
	Sender *GetExtendedCampaignOverviewSender `json:"sender"`
	// Email defined as the \"Reply to\" of the campaign
	ReplyTo string `json:"replyTo"`
	// Customisation of the \"to\" field of the campaign
	ToField string `json:"toField,omitempty"`
	// HTML content of the campaign
	HtmlContent string `json:"htmlContent"`
	// Link to share the campaign on social medias
	ShareLink string `json:"shareLink,omitempty"`
	// Tag of the campaign
	Tag string `json:"tag,omitempty"`
	// Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
	CreatedAt string `json:"createdAt"`
	// UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
	ModifiedAt string `json:"modifiedAt"`
	// Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email.
	InlineImageActivation bool `json:"inlineImageActivation,omitempty"`
	// Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign
	MirrorActive bool `json:"mirrorActive,omitempty"`
	// FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times
	Recurring bool `json:"recurring,omitempty"`
	// Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent'
	SentDate string `json:"sentDate,omitempty"`
	// Total number of non-delivered campaigns for a particular campaign id.
	ReturnBounce int64                  `json:"returnBounce,omitempty"`
	Recipients   map[string]interface{} `json:"recipients"`
	Statistics   map[string]interface{} `json:"statistics"`
}

type GetEmailCampaignOpts struct {
	Statistics optional.String
}

type GetEmailCampaigns struct {
	Campaigns []interface{} `json:"campaigns,omitempty"`
	// Number of Email campaigns retrieved
	Count int64 `json:"count,omitempty"`
}

type GetEmailCampaignsOpts struct {
	Type_              optional.String
	Status             optional.String
	Statistics         optional.String
	StartDate          optional.String
	EndDate            optional.String
	Limit              optional.Int64
	Offset             optional.Int64
	Sort               optional.String
	ExcludeHtmlContent optional.Bool
}

type GetEmailEventReport struct {
	Events []GetEmailEventReportEvents `json:"events,omitempty"`
}

type GetEmailEventReportEvents struct {
	// Email address which generates the event
	Email string `json:"email"`
	// UTC date-time on which the event has been generated
	Date string `json:"date"`
	// Subject of the event
	Subject string `json:"subject,omitempty"`
	// Message ID which generated the event
	MessageId string `json:"messageId"`
	// Event which occurred
	Event string `json:"event"`
	// Reason of bounce (only available if the event is hardbounce or softbounce)
	Reason string `json:"reason,omitempty"`
	// Tag of the email which generated the event
	Tag string `json:"tag,omitempty"`
	// IP from which the user has opened the email or clicked on the link (only available if the event is opened or clicks)
	Ip string `json:"ip,omitempty"`
	// The link which is sent to the user (only available if the event is requests or opened or clicks)
	Link string `json:"link,omitempty"`
	// Sender email from which the emails are sent
	From string `json:"from,omitempty"`
	// ID of the template (only available if the email is template based)
	TemplateId int64 `json:"templateId,omitempty"`
}

type GetEmailEventReportOpts struct {
	Limit      optional.Int64
	Offset     optional.Int64
	StartDate  optional.String
	EndDate    optional.String
	Days       optional.Int64
	Email      optional.String
	Event      optional.String
	Tags       optional.String
	MessageId  optional.String
	TemplateId optional.Int64
	Sort       optional.String
}

type GetExtendedCampaignOverview struct {
	// ID of the campaign
	Id int64 `json:"id"`
	// Name of the campaign
	Name string `json:"name"`
	// Subject of the campaign. Only available if `abTesting` flag of the campaign is `false`
	Subject string `json:"subject,omitempty"`
	// Preview text or preheader of the email campaign
	PreviewText string `json:"previewText,omitempty"`
	// Type of campaign
	Type_ string `json:"type"`
	// Status of the campaign
	Status string `json:"status"`
	// UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ)
	ScheduledAt string `json:"scheduledAt,omitempty"`
	// Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled.
	AbTesting bool `json:"abTesting,omitempty"`
	// Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
	SubjectA string `json:"subjectA,omitempty"`
	// Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
	SubjectB string `json:"subjectB,omitempty"`
	// The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true`
	SplitRule int32 `json:"splitRule,omitempty"`
	// Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true`
	WinnerCriteria string `json:"winnerCriteria,omitempty"`
	// The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true`
	WinnerDelay int32 `json:"winnerDelay,omitempty"`
	// It is true if you have chosen to send your campaign at best time, otherwise it is false
	SendAtBestTime bool `json:"sendAtBestTime,omitempty"`
	// utm parameter associated with campaign
	UtmCampaignValue string `json:"utmCampaignValue,omitempty"`
	// source of utm parameter
	UtmSource string `json:"utmSource,omitempty"`
	// medium parameter
	UtmMedium string `json:"utmMedium,omitempty"`
	// utm id
	UtmID int32 `json:"utmID,omitempty"`
	// Retrieved the status of test email sending. (true=Test email has been sent  false=Test email has not been sent)
	TestSent bool `json:"testSent"`
	// Header of the campaign
	Header string `json:"header"`
	// Footer of the campaign
	Footer string                             `json:"footer"`
	Sender *GetExtendedCampaignOverviewSender `json:"sender"`
	// Email defined as the \"Reply to\" of the campaign
	ReplyTo string `json:"replyTo"`
	// Customisation of the \"to\" field of the campaign
	ToField string `json:"toField,omitempty"`
	// HTML content of the campaign
	HtmlContent string `json:"htmlContent"`
	// Link to share the campaign on social medias
	ShareLink string `json:"shareLink,omitempty"`
	// Tag of the campaign
	Tag string `json:"tag,omitempty"`
	// Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
	CreatedAt string `json:"createdAt"`
	// UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
	ModifiedAt string `json:"modifiedAt"`
	// Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email.
	InlineImageActivation bool `json:"inlineImageActivation,omitempty"`
	// Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign
	MirrorActive bool `json:"mirrorActive,omitempty"`
	// FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times
	Recurring bool `json:"recurring,omitempty"`
	// Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent'
	SentDate string `json:"sentDate,omitempty"`
	// Total number of non-delivered campaigns for a particular campaign id.
	ReturnBounce int64 `json:"returnBounce,omitempty"`
}