lib

package

v2.0.0+incompatible Latest Latest Go to latest Published: Feb 12, 2021 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/adesokanayo/apiv3-go-library

Links

Open Source Insights

Documentation ¶

Overview ¶

* SendinBlue API * * SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * API version: 3.0.0 * Contact: contact@sendinblue.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type AbTestCampaignResult
type AbTestCampaignResultClickedLinks
type AbTestCampaignResultStatistics
type AbTestVersionClicksInner
type AbTestVersionStats
type AccountApiService
- func (a *AccountApiService) GetAccount(ctx context.Context) (GetAccount, *http.Response, error)
type AddChildDomain
type AddContactToList
type AddCredits
type AllOfgetChildrenListChildrenItems
type AllOfgetContactsContactsItems
type AllOfgetEmailCampaignsCampaignsItems
type AllOfgetExtendedCampaignStatsCampaignStatsItems
type AllOfgetExtendedCampaignStatsGlobalStats
type AllOfgetFolderListsListsItems
type AllOfgetFoldersFoldersItems
type AllOfgetListsListsItems
type AllOfgetSmsCampaignsCampaignsItems
type AllOfgetWebhooksWebhooksItems
type AttributesApiService
- func (a *AttributesApiService) CreateAttribute(ctx context.Context, body CreateAttribute, attributeCategory string, ...) (*http.Response, error)
- func (a *AttributesApiService) DeleteAttribute(ctx context.Context, attributeCategory string, attributeName string) (*http.Response, error)
- func (a *AttributesApiService) GetAttributes(ctx context.Context) (GetAttributes, *http.Response, error)
- func (a *AttributesApiService) UpdateAttribute(ctx context.Context, body UpdateAttribute, attributeCategory string, ...) (*http.Response, error)
type BasicAuth
type BlockDomain
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type ContactsApiGetContactStatsOpts
type ContactsApiGetContactsFromListOpts
type ContactsApiGetContactsOpts
type ContactsApiGetFolderListsOpts
type ContactsApiGetFoldersOpts
type ContactsApiGetListsOpts
type ContactsApiService
- func (a *ContactsApiService) AddContactToList(ctx context.Context, body AddContactToList, listId int64) (PostContactInfo, *http.Response, error)
- func (a *ContactsApiService) CreateAttribute(ctx context.Context, body CreateAttribute, attributeCategory string, ...) (*http.Response, error)
- func (a *ContactsApiService) CreateContact(ctx context.Context, body CreateContact) (CreateUpdateContactModel, *http.Response, error)
- func (a *ContactsApiService) CreateDoiContact(ctx context.Context, body CreateDoiContact) (*http.Response, error)
- func (a *ContactsApiService) CreateFolder(ctx context.Context, body CreateUpdateFolder) (CreateModel, *http.Response, error)
- func (a *ContactsApiService) CreateList(ctx context.Context, body CreateList) (CreateModel, *http.Response, error)
- func (a *ContactsApiService) DeleteAttribute(ctx context.Context, attributeCategory string, attributeName string) (*http.Response, error)
- func (a *ContactsApiService) DeleteContact(ctx context.Context, identifier string) (*http.Response, error)
- func (a *ContactsApiService) DeleteFolder(ctx context.Context, folderId int64) (*http.Response, error)
- func (a *ContactsApiService) DeleteList(ctx context.Context, listId int64) (*http.Response, error)
- func (a *ContactsApiService) GetAttributes(ctx context.Context) (GetAttributes, *http.Response, error)
- func (a *ContactsApiService) GetContactInfo(ctx context.Context, identifier string) (GetExtendedContactDetails, *http.Response, error)
- func (a *ContactsApiService) GetContactStats(ctx context.Context, identifier string, ...) (GetContactCampaignStats, *http.Response, error)
- func (a *ContactsApiService) GetContacts(ctx context.Context, localVarOptionals *ContactsApiGetContactsOpts) (GetContacts, *http.Response, error)
- func (a *ContactsApiService) GetContactsFromList(ctx context.Context, listId int64, ...) (GetContacts, *http.Response, error)
- func (a *ContactsApiService) GetFolder(ctx context.Context, folderId int64) (GetFolder, *http.Response, error)
- func (a *ContactsApiService) GetFolderLists(ctx context.Context, folderId int64, ...) (GetFolderLists, *http.Response, error)
- func (a *ContactsApiService) GetFolders(ctx context.Context, limit int64, offset int64, ...) (GetFolders, *http.Response, error)
- func (a *ContactsApiService) GetList(ctx context.Context, listId int64) (GetExtendedList, *http.Response, error)
- func (a *ContactsApiService) GetLists(ctx context.Context, localVarOptionals *ContactsApiGetListsOpts) (GetLists, *http.Response, error)
- func (a *ContactsApiService) ImportContacts(ctx context.Context, body RequestContactImport) (CreatedProcessId, *http.Response, error)
- func (a *ContactsApiService) RemoveContactFromList(ctx context.Context, body RemoveContactFromList, listId int64) (PostContactInfo, *http.Response, error)
- func (a *ContactsApiService) RequestContactExport(ctx context.Context, body RequestContactExport) (CreatedProcessId, *http.Response, error)
- func (a *ContactsApiService) UpdateAttribute(ctx context.Context, body UpdateAttribute, attributeCategory string, ...) (*http.Response, error)
- func (a *ContactsApiService) UpdateContact(ctx context.Context, body UpdateContact, identifier string) (*http.Response, error)
- func (a *ContactsApiService) UpdateFolder(ctx context.Context, body CreateUpdateFolder, folderId int64) (*http.Response, error)
- func (a *ContactsApiService) UpdateList(ctx context.Context, body UpdateList, listId int64) (*http.Response, error)
type CreateAttribute
type CreateAttributeEnumeration
type CreateChild
type CreateContact
type CreateDoiContact
type CreateEmailCampaign
type CreateEmailCampaignRecipients
type CreateEmailCampaignSender
type CreateList
type CreateModel
type CreateReseller
type CreateSender
type CreateSenderIps
type CreateSenderModel
type CreateSmsCampaign
type CreateSmsCampaignRecipients
type CreateSmtpEmail
type CreateSmtpTemplate
type CreateSmtpTemplateSender
type CreateUpdateContactModel
type CreateUpdateFolder
type CreateWebhook
type CreatedProcessId
type DeleteHardbounces
type EmailCampaignsApiEmailExportRecipientsOpts
type EmailCampaignsApiGetEmailCampaignsOpts
type EmailCampaignsApiService
- func (a *EmailCampaignsApiService) CreateEmailCampaign(ctx context.Context, body CreateEmailCampaign) (CreateModel, *http.Response, error)
- func (a *EmailCampaignsApiService) DeleteEmailCampaign(ctx context.Context, campaignId int64) (*http.Response, error)
- func (a *EmailCampaignsApiService) EmailExportRecipients(ctx context.Context, campaignId int64, ...) (CreatedProcessId, *http.Response, error)
- func (a *EmailCampaignsApiService) GetAbTestCampaignResult(ctx context.Context, campaignId int64) (AbTestCampaignResult, *http.Response, error)
- func (a *EmailCampaignsApiService) GetEmailCampaign(ctx context.Context, campaignId int64) (GetEmailCampaign, *http.Response, error)
- func (a *EmailCampaignsApiService) GetEmailCampaigns(ctx context.Context, localVarOptionals *EmailCampaignsApiGetEmailCampaignsOpts) (GetEmailCampaigns, *http.Response, error)
- func (a *EmailCampaignsApiService) GetSharedTemplateUrl(ctx context.Context, campaignId int64) (GetSharedTemplateUrl, *http.Response, error)
- func (a *EmailCampaignsApiService) SendEmailCampaignNow(ctx context.Context, campaignId int64) (*http.Response, error)
- func (a *EmailCampaignsApiService) SendReport(ctx context.Context, body SendReport, campaignId int64) (*http.Response, error)
- func (a *EmailCampaignsApiService) SendTestEmail(ctx context.Context, body SendTestEmail, campaignId int64) (*http.Response, error)
- func (a *EmailCampaignsApiService) UpdateCampaignStatus(ctx context.Context, body UpdateCampaignStatus, campaignId int64) (*http.Response, error)
- func (a *EmailCampaignsApiService) UpdateEmailCampaign(ctx context.Context, body UpdateEmailCampaign, campaignId int64) (*http.Response, error)
- func (a *EmailCampaignsApiService) UploadImageToGallery(ctx context.Context, body UploadImageToGallery) (*http.Response, error)
type EmailExportRecipients
type ErrorModel
type FoldersApiGetFolderListsOpts
type FoldersApiGetFoldersOpts
type FoldersApiService
- func (a *FoldersApiService) CreateFolder(ctx context.Context, body CreateUpdateFolder) (CreateModel, *http.Response, error)
- func (a *FoldersApiService) DeleteFolder(ctx context.Context, folderId int64) (*http.Response, error)
- func (a *FoldersApiService) GetFolder(ctx context.Context, folderId int64) (GetFolder, *http.Response, error)
- func (a *FoldersApiService) GetFolderLists(ctx context.Context, folderId int64, ...) (GetFolderLists, *http.Response, error)
- func (a *FoldersApiService) GetFolders(ctx context.Context, limit int64, offset int64, ...) (GetFolders, *http.Response, error)
- func (a *FoldersApiService) UpdateFolder(ctx context.Context, body CreateUpdateFolder, folderId int64) (*http.Response, error)
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type GetAccount
type GetAccountMarketingAutomation
type GetAccountPlan
type GetAccountRelay
type GetAccountRelayData
type GetAggregatedReport
type GetAttributes
type GetAttributesAttributes
type GetAttributesEnumeration
type GetBlockedDomains
type GetCampaignOverview
type GetCampaignRecipients
type GetCampaignStats
type GetChildAccountCreationStatus
type GetChildDomain
type GetChildInfo
type GetChildInfoApiKeys
type GetChildInfoApiKeysV2
type GetChildInfoApiKeysV3
type GetChildInfoCredits
type GetChildInfoStatistics
type GetChildrenList
type GetClient
type GetContactCampaignStats
type GetContactCampaignStatsClicked
type GetContactCampaignStatsOpened
type GetContactCampaignStatsTransacAttributes
type GetContactCampaignStatsUnsubscriptions
type GetContactDetails
type GetContacts
type GetDeviceBrowserStats
type GetEmailCampaign
type GetEmailCampaigns
type GetEmailEventReport
type GetEmailEventReportEvents
type GetExtendedCampaignOverview
type GetExtendedCampaignOverviewSender
type GetExtendedCampaignStats
type GetExtendedClient
type GetExtendedClientAddress
type GetExtendedContactDetails
type GetExtendedContactDetailsStatistics
type GetExtendedContactDetailsStatisticsClicked
type GetExtendedContactDetailsStatisticsLinks
type GetExtendedContactDetailsStatisticsMessagesSent
type GetExtendedContactDetailsStatisticsOpened
type GetExtendedContactDetailsStatisticsUnsubscriptions
type GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription
type GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription
type GetExtendedList
type GetExtendedListCampaignStats
type GetFolder
type GetFolderLists
type GetFolders
type GetIp
type GetIpFromSender
type GetIps
type GetIpsFromSender
type GetList
type GetLists
type GetProcess
type GetProcesses
type GetReports
type GetReportsReports
type GetSendersList
type GetSendersListIps
type GetSendersListSenders
type GetSharedTemplateUrl
type GetSmsCampaign
type GetSmsCampaignOverview
type GetSmsCampaignStats
type GetSmsCampaigns
type GetSmsEventReport
type GetSmsEventReportEvents
type GetSmtpTemplateOverview
type GetSmtpTemplateOverviewSender
type GetSmtpTemplates
type GetSsoToken
type GetStatsByDevice
type GetTransacAggregatedSmsReport
type GetTransacBlockedContacts
type GetTransacBlockedContactsContacts
type GetTransacBlockedContactsReason
type GetTransacEmailContent
type GetTransacEmailContentEvents
type GetTransacEmailsList
type GetTransacEmailsListTransactionalEmails
type GetTransacSmsReport
type GetTransacSmsReportReports
type GetWebhook
type GetWebhooks
type ListsApiGetContactsFromListOpts
type ListsApiGetFolderListsOpts
type ListsApiGetListsOpts
type ListsApiService
- func (a *ListsApiService) AddContactToList(ctx context.Context, body AddContactToList, listId int64) (PostContactInfo, *http.Response, error)
- func (a *ListsApiService) CreateList(ctx context.Context, body CreateList) (CreateModel, *http.Response, error)
- func (a *ListsApiService) DeleteList(ctx context.Context, listId int64) (*http.Response, error)
- func (a *ListsApiService) GetContactsFromList(ctx context.Context, listId int64, ...) (GetContacts, *http.Response, error)
- func (a *ListsApiService) GetFolderLists(ctx context.Context, folderId int64, ...) (GetFolderLists, *http.Response, error)
- func (a *ListsApiService) GetList(ctx context.Context, listId int64) (GetExtendedList, *http.Response, error)
- func (a *ListsApiService) GetLists(ctx context.Context, localVarOptionals *ListsApiGetListsOpts) (GetLists, *http.Response, error)
- func (a *ListsApiService) RemoveContactFromList(ctx context.Context, body RemoveContactFromList, listId int64) (PostContactInfo, *http.Response, error)
- func (a *ListsApiService) UpdateList(ctx context.Context, body UpdateList, listId int64) (*http.Response, error)
type ManageIp
type PostContactInfo
type PostContactInfoContacts
type PostSendFailed
type PostSendSmsTestFailed
type ProcessApiGetProcessesOpts
type ProcessApiService
- func (a *ProcessApiService) GetProcess(ctx context.Context, processId int64) (GetProcess, *http.Response, error)
- func (a *ProcessApiService) GetProcesses(ctx context.Context, localVarOptionals *ProcessApiGetProcessesOpts) (GetProcesses, *http.Response, error)
type RemainingCreditModel
type RemainingCreditModelChild
type RemainingCreditModelReseller
type RemoveContactFromList
type RemoveCredits
type RequestContactExport
type RequestContactExportCustomContactFilter
type RequestContactImport
type RequestContactImportNewList
type RequestSmsRecipientExport
type ResellerApiCreateResellerChildOpts
type ResellerApiGetResellerChildsOpts
type ResellerApiService
- func (a *ResellerApiService) AddCredits(ctx context.Context, body AddCredits, childIdentifier string) (RemainingCreditModel, *http.Response, error)
- func (a *ResellerApiService) AssociateIpToChild(ctx context.Context, body ManageIp, childIdentifier string) (*http.Response, error)
- func (a *ResellerApiService) CreateChildDomain(ctx context.Context, body AddChildDomain, childIdentifier string) (*http.Response, error)
- func (a *ResellerApiService) CreateResellerChild(ctx context.Context, localVarOptionals *ResellerApiCreateResellerChildOpts) (CreateReseller, *http.Response, error)
- func (a *ResellerApiService) DeleteChildDomain(ctx context.Context, childIdentifier string, domainName string) (*http.Response, error)
- func (a *ResellerApiService) DeleteResellerChild(ctx context.Context, childIdentifier string) (*http.Response, error)
- func (a *ResellerApiService) DissociateIpFromChild(ctx context.Context, body ManageIp, childIdentifier string) (*http.Response, error)
- func (a *ResellerApiService) GetChildAccountCreationStatus(ctx context.Context, childIdentifier string) (GetChildAccountCreationStatus, *http.Response, error)
- func (a *ResellerApiService) GetChildDomains(ctx context.Context, childIdentifier string) ([]string, *http.Response, error)
- func (a *ResellerApiService) GetChildInfo(ctx context.Context, childIdentifier string) (GetChildInfo, *http.Response, error)
- func (a *ResellerApiService) GetResellerChilds(ctx context.Context, localVarOptionals *ResellerApiGetResellerChildsOpts) (GetChildrenList, *http.Response, error)
- func (a *ResellerApiService) GetSsoToken(ctx context.Context, childIdentifier string) (GetSsoToken, *http.Response, error)
- func (a *ResellerApiService) RemoveCredits(ctx context.Context, body RemoveCredits, childIdentifier string) (RemainingCreditModel, *http.Response, error)
- func (a *ResellerApiService) UpdateChildAccountStatus(ctx context.Context, body UpdateChildAccountStatus, childIdentifier string) (*http.Response, error)
- func (a *ResellerApiService) UpdateChildDomain(ctx context.Context, body UpdateChildDomain, childIdentifier string, ...) (*http.Response, error)
- func (a *ResellerApiService) UpdateResellerChild(ctx context.Context, body UpdateChild, childIdentifier string) (*http.Response, error)
type SMSCampaignsApiGetSmsCampaignsOpts
type SMSCampaignsApiRequestSmsRecipientExportOpts
type SMSCampaignsApiService
- func (a *SMSCampaignsApiService) CreateSmsCampaign(ctx context.Context, body CreateSmsCampaign) (CreateModel, *http.Response, error)
- func (a *SMSCampaignsApiService) DeleteSmsCampaign(ctx context.Context, campaignId int64) (*http.Response, error)
- func (a *SMSCampaignsApiService) GetSmsCampaign(ctx context.Context, campaignId int64) (GetSmsCampaign, *http.Response, error)
- func (a *SMSCampaignsApiService) GetSmsCampaigns(ctx context.Context, localVarOptionals *SMSCampaignsApiGetSmsCampaignsOpts) (GetSmsCampaigns, *http.Response, error)
- func (a *SMSCampaignsApiService) RequestSmsRecipientExport(ctx context.Context, campaignId int64, ...) (CreatedProcessId, *http.Response, error)
- func (a *SMSCampaignsApiService) SendSmsCampaignNow(ctx context.Context, campaignId int64) (*http.Response, error)
- func (a *SMSCampaignsApiService) SendSmsReport(ctx context.Context, body SendReport, campaignId int64) (*http.Response, error)
- func (a *SMSCampaignsApiService) SendTestSms(ctx context.Context, body SendTestSms, campaignId int64) (*http.Response, error)
- func (a *SMSCampaignsApiService) UpdateSmsCampaign(ctx context.Context, body UpdateSmsCampaign, campaignId int64) (*http.Response, error)
- func (a *SMSCampaignsApiService) UpdateSmsCampaignStatus(ctx context.Context, body UpdateCampaignStatus, campaignId int64) (*http.Response, error)
type SendEmail
type SendEmailAttachment
type SendReport
type SendReportEmail
type SendSms
type SendSmtpEmail
type SendSmtpEmailAttachment
type SendSmtpEmailBcc
type SendSmtpEmailCc
type SendSmtpEmailMessageVersions
type SendSmtpEmailReplyTo
type SendSmtpEmailReplyTo1
type SendSmtpEmailSender
type SendSmtpEmailTo
type SendSmtpEmailTo1
type SendTemplateEmail
type SendTestEmail
type SendTestSms
type SendTransacSms
type SendersApiCreateSenderOpts
type SendersApiGetSendersOpts
type SendersApiService
- func (a *SendersApiService) CreateSender(ctx context.Context, localVarOptionals *SendersApiCreateSenderOpts) (CreateSenderModel, *http.Response, error)
- func (a *SendersApiService) DeleteSender(ctx context.Context, senderId int64) (*http.Response, error)
- func (a *SendersApiService) GetIps(ctx context.Context) (GetIps, *http.Response, error)
- func (a *SendersApiService) GetIpsFromSender(ctx context.Context, senderId int64) (GetIpsFromSender, *http.Response, error)
- func (a *SendersApiService) GetSenders(ctx context.Context, localVarOptionals *SendersApiGetSendersOpts) (GetSendersList, *http.Response, error)
- func (a *SendersApiService) UpdateSender(ctx context.Context, senderId int64, ...) (*http.Response, error)
type SendersApiUpdateSenderOpts
type TransactionalEmailsApiDeleteHardbouncesOpts
type TransactionalEmailsApiGetAggregatedSmtpReportOpts
type TransactionalEmailsApiGetEmailEventReportOpts
type TransactionalEmailsApiGetSmtpReportOpts
type TransactionalEmailsApiGetSmtpTemplatesOpts
type TransactionalEmailsApiGetTransacBlockedContactsOpts
type TransactionalEmailsApiGetTransacEmailsListOpts
type TransactionalEmailsApiService
- func (a *TransactionalEmailsApiService) BlockNewDomain(ctx context.Context, body BlockDomain) (*http.Response, error)
- func (a *TransactionalEmailsApiService) CreateSmtpTemplate(ctx context.Context, body CreateSmtpTemplate) (CreateModel, *http.Response, error)
- func (a *TransactionalEmailsApiService) DeleteBlockedDomain(ctx context.Context, domain string) (*http.Response, error)
- func (a *TransactionalEmailsApiService) DeleteHardbounces(ctx context.Context, ...) (*http.Response, error)
- func (a *TransactionalEmailsApiService) DeleteSmtpTemplate(ctx context.Context, templateId int64) (*http.Response, error)
- func (a *TransactionalEmailsApiService) GetAggregatedSmtpReport(ctx context.Context, ...) (GetAggregatedReport, *http.Response, error)
- func (a *TransactionalEmailsApiService) GetBlockedDomains(ctx context.Context) (GetBlockedDomains, *http.Response, error)
- func (a *TransactionalEmailsApiService) GetEmailEventReport(ctx context.Context, ...) (GetEmailEventReport, *http.Response, error)
- func (a *TransactionalEmailsApiService) GetSmtpReport(ctx context.Context, ...) (GetReports, *http.Response, error)
- func (a *TransactionalEmailsApiService) GetSmtpTemplate(ctx context.Context, templateId int64) (GetSmtpTemplateOverview, *http.Response, error)
- func (a *TransactionalEmailsApiService) GetSmtpTemplates(ctx context.Context, ...) (GetSmtpTemplates, *http.Response, error)
- func (a *TransactionalEmailsApiService) GetTransacBlockedContacts(ctx context.Context, ...) (GetTransacBlockedContacts, *http.Response, error)
- func (a *TransactionalEmailsApiService) GetTransacEmailContent(ctx context.Context, uuid string) (GetTransacEmailContent, *http.Response, error)
- func (a *TransactionalEmailsApiService) GetTransacEmailsList(ctx context.Context, ...) (GetTransacEmailsList, *http.Response, error)
- func (a *TransactionalEmailsApiService) SendTemplate(ctx context.Context, body SendEmail, templateId int64) (SendTemplateEmail, *http.Response, error)
- func (a *TransactionalEmailsApiService) SendTestTemplate(ctx context.Context, body SendTestEmail, templateId int64) (*http.Response, error)
- func (a *TransactionalEmailsApiService) SendTransacEmail(ctx context.Context, body SendSmtpEmail) (CreateSmtpEmail, *http.Response, error)
- func (a *TransactionalEmailsApiService) SmtpBlockedContactsEmailDelete(ctx context.Context, email string) (*http.Response, error)
- func (a *TransactionalEmailsApiService) SmtpLogMessageIdDelete(ctx context.Context, messageId string) (*http.Response, error)
- func (a *TransactionalEmailsApiService) UpdateSmtpTemplate(ctx context.Context, body UpdateSmtpTemplate, templateId int64) (*http.Response, error)
type TransactionalSMSApiGetSmsEventsOpts
type TransactionalSMSApiGetTransacAggregatedSmsReportOpts
type TransactionalSMSApiGetTransacSmsReportOpts
type TransactionalSMSApiService
- func (a *TransactionalSMSApiService) GetSmsEvents(ctx context.Context, localVarOptionals *TransactionalSMSApiGetSmsEventsOpts) (GetSmsEventReport, *http.Response, error)
- func (a *TransactionalSMSApiService) GetTransacAggregatedSmsReport(ctx context.Context, ...) (GetTransacAggregatedSmsReport, *http.Response, error)
- func (a *TransactionalSMSApiService) GetTransacSmsReport(ctx context.Context, ...) (GetTransacSmsReport, *http.Response, error)
- func (a *TransactionalSMSApiService) SendTransacSms(ctx context.Context, body SendTransacSms) (SendSms, *http.Response, error)
type UpdateAttribute
type UpdateAttributeEnumeration
type UpdateCampaignStatus
type UpdateChild
type UpdateChildAccountStatus
type UpdateChildDomain
type UpdateContact
type UpdateEmailCampaign
type UpdateEmailCampaignRecipients
type UpdateEmailCampaignSender
type UpdateList
type UpdateSender
type UpdateSmsCampaign
type UpdateSmtpTemplate
type UpdateSmtpTemplateSender
type UpdateWebhook
type UploadImageToGallery
type WebhooksApiGetWebhooksOpts
type WebhooksApiService
- func (a *WebhooksApiService) CreateWebhook(ctx context.Context, body CreateWebhook) (CreateModel, *http.Response, error)
- func (a *WebhooksApiService) DeleteWebhook(ctx context.Context, webhookId int64) (*http.Response, error)
- func (a *WebhooksApiService) GetWebhook(ctx context.Context, webhookId int64) (GetWebhook, *http.Response, error)
- func (a *WebhooksApiService) GetWebhooks(ctx context.Context, localVarOptionals *WebhooksApiGetWebhooksOpts) (GetWebhooks, *http.Response, error)
- func (a *WebhooksApiService) UpdateWebhook(ctx context.Context, body UpdateWebhook, webhookId int64) (*http.Response, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	AccountApi *AccountApiService

	AttributesApi *AttributesApiService

	ContactsApi *ContactsApiService

	EmailCampaignsApi *EmailCampaignsApiService

	FoldersApi *FoldersApiService

	ListsApi *ListsApiService

	ProcessApi *ProcessApiService

	ResellerApi *ResellerApiService

	SMSCampaignsApi *SMSCampaignsApiService

	SendersApi *SendersApiService

	TransactionalEmailsApi *TransactionalEmailsApiService

	TransactionalSMSApi *TransactionalSMSApiService

	WebhooksApi *WebhooksApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the SendinBlue API API v3.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

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:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AbTestCampaignResult ¶

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 ¶

type AbTestCampaignResultClickedLinks struct {
	VersionA *[]AbTestVersionClicksInner `json:"Version A"`
	VersionB *[]AbTestVersionClicksInner `json:"Version B"`
}

type AbTestCampaignResultStatistics ¶

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 AbTestVersionClicksInner ¶

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

type AbTestVersionStats ¶

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"`
}

Percentage of a particular event for both versions

type AccountApiService ¶

type AccountApiService service

func (*AccountApiService) GetAccount ¶

func (a *AccountApiService) GetAccount(ctx context.Context) (GetAccount, *http.Response, error)

AccountApiService Get your account information, plan and credits details

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return GetAccount

type AddChildDomain ¶

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

type AddContactToList ¶

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 ¶

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 AllOfgetChildrenListChildrenItems ¶

type AllOfgetChildrenListChildrenItems struct {
	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"`
	// ID of the child
	Id int64 `json:"id,omitempty"`
}

type AllOfgetContactsContactsItems ¶

type AllOfgetContactsContactsItems struct {
	// Email address of the contact for which you requested the details
	Email string `json:"email"`
	// 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 *interface{} `json:"attributes"`
}

type AllOfgetEmailCampaignsCampaignsItems ¶

type AllOfgetEmailCampaignsCampaignsItems struct {
	// 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   *interface{} `json:"recipients"`
	Statistics   *interface{} `json:"statistics"`
}

type AllOfgetExtendedCampaignStatsCampaignStatsItems ¶

type AllOfgetExtendedCampaignStatsCampaignStatsItems 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"`
	// 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 AllOfgetExtendedCampaignStatsGlobalStats ¶

type AllOfgetExtendedCampaignStatsGlobalStats 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"`
	// 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"`
}

Overall statistics of the campaign

type AllOfgetFolderListsListsItems ¶

type AllOfgetFolderListsListsItems struct {
	// ID of the list
	Id int64 `json:"id"`
	// Name of the list
	Name string `json:"name"`
	// Number of blacklisted contacts in the list
	TotalBlacklisted int64 `json:"totalBlacklisted"`
	// Number of contacts in the list
	TotalSubscribers int64 `json:"totalSubscribers"`
}

type AllOfgetFoldersFoldersItems ¶

type AllOfgetFoldersFoldersItems struct {
	// ID of the folder
	Id int64 `json:"id"`
	// Name of the folder
	Name string `json:"name"`
	// Number of blacklisted contacts in the folder
	TotalBlacklisted int64 `json:"totalBlacklisted"`
	// Number of contacts in the folder
	TotalSubscribers int64 `json:"totalSubscribers"`
	// Number of unique contacts in the folder
	UniqueSubscribers int64 `json:"uniqueSubscribers"`
}

type AllOfgetListsListsItems ¶

type AllOfgetListsListsItems struct {
	// ID of the list
	Id int64 `json:"id"`
	// Name of the list
	Name string `json:"name"`
	// Number of blacklisted contacts in the list
	TotalBlacklisted int64 `json:"totalBlacklisted"`
	// Number of contacts in the list
	TotalSubscribers int64 `json:"totalSubscribers"`
	// ID of the folder
	FolderId int64 `json:"folderId"`
}

type AllOfgetSmsCampaignsCampaignsItems ¶

type AllOfgetSmsCampaignsCampaignsItems struct {
	// ID of the SMS Campaign
	Id int64 `json:"id"`
	// Name of the SMS Campaign
	Name string `json:"name"`
	// Status of the SMS Campaign
	Status string `json:"status"`
	// Content of the SMS Campaign
	Content string `json:"content"`
	// UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format
	ScheduledAt string `json:"scheduledAt,omitempty"`
	// Sender of the SMS Campaign
	Sender string `json:"sender"`
	// Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
	CreatedAt string `json:"createdAt"`
	// UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
	ModifiedAt string       `json:"modifiedAt"`
	Recipients *interface{} `json:"recipients"`
	Statistics *interface{} `json:"statistics"`
}

type AllOfgetWebhooksWebhooksItems ¶

type AllOfgetWebhooksWebhooksItems struct {
	// URL of the webhook
	Url string `json:"url"`
	// ID of the webhook
	Id int64 `json:"id"`
	// Description of the webhook
	Description string   `json:"description"`
	Events      []string `json:"events"`
	// Type of webhook (marketing or transac)
	Type_ string `json:"type"`
	// Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)
	CreatedAt string `json:"createdAt"`
	// Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)
	ModifiedAt string `json:"modifiedAt"`
}

type AttributesApiService ¶

type AttributesApiService service

func (*AttributesApiService) CreateAttribute ¶

func (a *AttributesApiService) CreateAttribute(ctx context.Context, body CreateAttribute, attributeCategory string, attributeName string) (*http.Response, error)

AttributesApiService Create contact attribute

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to create an attribute
@param attributeCategory Category of the attribute
@param attributeName Name of the attribute

func (*AttributesApiService) DeleteAttribute ¶

func (a *AttributesApiService) DeleteAttribute(ctx context.Context, attributeCategory string, attributeName string) (*http.Response, error)

AttributesApiService Delete an attribute

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param attributeCategory Category of the attribute
@param attributeName Name of the existing attribute

func (*AttributesApiService) GetAttributes ¶

func (a *AttributesApiService) GetAttributes(ctx context.Context) (GetAttributes, *http.Response, error)

AttributesApiService List all attributes

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return GetAttributes

func (*AttributesApiService) UpdateAttribute ¶

func (a *AttributesApiService) UpdateAttribute(ctx context.Context, body UpdateAttribute, attributeCategory string, attributeName string) (*http.Response, error)

AttributesApiService Update contact attribute

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to update an attribute
@param attributeCategory Category of the attribute
@param attributeName Name of the existing attribute

type BasicAuth ¶

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

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BlockDomain ¶

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

type Configuration ¶

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"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type ContactsApiGetContactStatsOpts ¶

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

type ContactsApiGetContactsFromListOpts ¶

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

type ContactsApiGetContactsOpts ¶

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

type ContactsApiGetFolderListsOpts ¶

type ContactsApiGetFolderListsOpts struct {
	Limit  optional.Int64
	Offset optional.Int64
	Sort   optional.String
}

type ContactsApiGetFoldersOpts ¶

type ContactsApiGetFoldersOpts struct {
	Sort optional.String
}

type ContactsApiGetListsOpts ¶

type ContactsApiGetListsOpts struct {
	Limit  optional.Int64
	Offset optional.Int64
	Sort   optional.String
}

type ContactsApiService ¶

type ContactsApiService service

func (*ContactsApiService) AddContactToList ¶

func (a *ContactsApiService) AddContactToList(ctx context.Context, body AddContactToList, listId int64) (PostContactInfo, *http.Response, error)

ContactsApiService Add existing contacts to a list

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Emails addresses OR IDs of the contacts
@param listId Id of the list

@return PostContactInfo

func (*ContactsApiService) CreateAttribute ¶

func (a *ContactsApiService) CreateAttribute(ctx context.Context, body CreateAttribute, attributeCategory string, attributeName string) (*http.Response, error)

ContactsApiService Create contact attribute

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to create an attribute
@param attributeCategory Category of the attribute
@param attributeName Name of the attribute

func (*ContactsApiService) CreateContact ¶

func (a *ContactsApiService) CreateContact(ctx context.Context, body CreateContact) (CreateUpdateContactModel, *http.Response, error)

ContactsApiService Create a contact

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to create a contact

@return CreateUpdateContactModel

func (*ContactsApiService) CreateDoiContact ¶

func (a *ContactsApiService) CreateDoiContact(ctx context.Context, body CreateDoiContact) (*http.Response, error)

ContactsApiService Create Contact via DOI (Double-Opt-In) Flow

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to create the Double opt-in (DOI) contact

func (*ContactsApiService) CreateFolder ¶

func (a *ContactsApiService) CreateFolder(ctx context.Context, body CreateUpdateFolder) (CreateModel, *http.Response, error)

ContactsApiService Create a folder

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Name of the folder

@return CreateModel

func (*ContactsApiService) CreateList ¶

func (a *ContactsApiService) CreateList(ctx context.Context, body CreateList) (CreateModel, *http.Response, error)

ContactsApiService Create a list

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to create a list

@return CreateModel

func (*ContactsApiService) DeleteAttribute ¶

func (a *ContactsApiService) DeleteAttribute(ctx context.Context, attributeCategory string, attributeName string) (*http.Response, error)

ContactsApiService Delete an attribute

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param attributeCategory Category of the attribute
@param attributeName Name of the existing attribute

func (*ContactsApiService) DeleteContact ¶

func (a *ContactsApiService) DeleteContact(ctx context.Context, identifier string) (*http.Response, error)

ContactsApiService Delete a contact

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param identifier Email (urlencoded) OR ID of the contact

func (*ContactsApiService) DeleteFolder ¶

func (a *ContactsApiService) DeleteFolder(ctx context.Context, folderId int64) (*http.Response, error)

ContactsApiService Delete a folder (and all its lists)

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param folderId Id of the folder

func (*ContactsApiService) DeleteList ¶

func (a *ContactsApiService) DeleteList(ctx context.Context, listId int64) (*http.Response, error)

ContactsApiService Delete a list

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param listId Id of the list

func (*ContactsApiService) GetAttributes ¶

func (a *ContactsApiService) GetAttributes(ctx context.Context) (GetAttributes, *http.Response, error)

ContactsApiService List all attributes

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return GetAttributes

func (*ContactsApiService) GetContactInfo ¶

func (a *ContactsApiService) GetContactInfo(ctx context.Context, identifier string) (GetExtendedContactDetails, *http.Response, error)

ContactsApiService Get a contact's details

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value

@return GetExtendedContactDetails

func (*ContactsApiService) GetContactStats ¶

func (a *ContactsApiService) GetContactStats(ctx context.Context, identifier string, localVarOptionals *ContactsApiGetContactStatsOpts) (GetContactCampaignStats, *http.Response, error)

func (*ContactsApiService) GetContacts ¶

func (a *ContactsApiService) GetContacts(ctx context.Context, localVarOptionals *ContactsApiGetContactsOpts) (GetContacts, *http.Response, error)

func (*ContactsApiService) GetContactsFromList ¶

func (a *ContactsApiService) GetContactsFromList(ctx context.Context, listId int64, localVarOptionals *ContactsApiGetContactsFromListOpts) (GetContacts, *http.Response, error)

func (*ContactsApiService) GetFolder ¶

func (a *ContactsApiService) GetFolder(ctx context.Context, folderId int64) (GetFolder, *http.Response, error)

ContactsApiService Returns a folder's details

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param folderId id of the folder

@return GetFolder

func (*ContactsApiService) GetFolderLists ¶

func (a *ContactsApiService) GetFolderLists(ctx context.Context, folderId int64, localVarOptionals *ContactsApiGetFolderListsOpts) (GetFolderLists, *http.Response, error)

func (*ContactsApiService) GetFolders ¶

func (a *ContactsApiService) GetFolders(ctx context.Context, limit int64, offset int64, localVarOptionals *ContactsApiGetFoldersOpts) (GetFolders, *http.Response, error)

func (*ContactsApiService) GetList ¶

func (a *ContactsApiService) GetList(ctx context.Context, listId int64) (GetExtendedList, *http.Response, error)

ContactsApiService Get a list's details

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param listId Id of the list

@return GetExtendedList

func (*ContactsApiService) GetLists ¶

func (a *ContactsApiService) GetLists(ctx context.Context, localVarOptionals *ContactsApiGetListsOpts) (GetLists, *http.Response, error)

func (*ContactsApiService) ImportContacts ¶

func (a *ContactsApiService) ImportContacts(ctx context.Context, body RequestContactImport) (CreatedProcessId, *http.Response, error)

ContactsApiService Import contacts It returns the background process ID which on completion calls the notify URL that you have set in the input.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to import contacts in Sendinblue. To know more about the expected format, please have a look at ``https://help.sendinblue.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns``

@return CreatedProcessId

func (*ContactsApiService) RemoveContactFromList ¶

func (a *ContactsApiService) RemoveContactFromList(ctx context.Context, body RemoveContactFromList, listId int64) (PostContactInfo, *http.Response, error)

ContactsApiService Delete a contact from a list

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Emails addresses OR IDs of the contacts
@param listId Id of the list

@return PostContactInfo

func (*ContactsApiService) RequestContactExport ¶

func (a *ContactsApiService) RequestContactExport(ctx context.Context, body RequestContactExport) (CreatedProcessId, *http.Response, error)

ContactsApiService Export contacts It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to request a contact export

@return CreatedProcessId

func (*ContactsApiService) UpdateAttribute ¶

func (a *ContactsApiService) UpdateAttribute(ctx context.Context, body UpdateAttribute, attributeCategory string, attributeName string) (*http.Response, error)

ContactsApiService Update contact attribute

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to update an attribute
@param attributeCategory Category of the attribute
@param attributeName Name of the existing attribute

func (*ContactsApiService) UpdateContact ¶

func (a *ContactsApiService) UpdateContact(ctx context.Context, body UpdateContact, identifier string) (*http.Response, error)

ContactsApiService Update a contact

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to update a contact
@param identifier Email (urlencoded) OR ID of the contact

func (*ContactsApiService) UpdateFolder ¶

func (a *ContactsApiService) UpdateFolder(ctx context.Context, body CreateUpdateFolder, folderId int64) (*http.Response, error)

ContactsApiService Update a folder

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Name of the folder
@param folderId Id of the folder

func (*ContactsApiService) UpdateList ¶

func (a *ContactsApiService) UpdateList(ctx context.Context, body UpdateList, listId int64) (*http.Response, error)

ContactsApiService Update a list

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to update a list
@param listId Id of the list

type CreateAttribute ¶

type CreateAttribute struct {
	// Value of the attribute. Use only if the attribute's category is 'calculated' or 'global'
	Value string `json:"value,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"`
	// Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' 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 ¶

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

type CreateChild ¶

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 ¶

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 the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"}
	Attributes *interface{} `json:"attributes,omitempty"`
	// Set this field to blacklist the contact for emails (emailBlacklisted = true)
	EmailBlacklisted bool `json:"emailBlacklisted,omitempty"`
	// Set this field to blacklist the contact for SMS (smsBlacklisted = true)
	SmsBlacklisted bool `json:"smsBlacklisted,omitempty"`
	// 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 CreateDoiContact ¶

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 SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'}
	Attributes *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 CreateEmailCampaign ¶

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"`
	// 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 SendinBlue 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 *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"`
}

type CreateEmailCampaignRecipients ¶

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"`
}

List ids to include/exclude from campaign

type CreateEmailCampaignSender ¶

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"`
}

Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` , `{\"name\":\"xyz\", \"id\":123}`

type CreateList ¶

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 ¶

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

type CreateReseller ¶

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

type CreateSender ¶

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 ¶

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 ¶

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 CreateSmsCampaign ¶

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"`
}

type CreateSmsCampaignRecipients ¶

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 ¶

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

type CreateSmtpTemplate ¶

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 SendinBlue 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 ¶

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"`
}

Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` , `{\"name\":\"xyz\", \"id\":123}`

type CreateUpdateContactModel ¶

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

type CreateUpdateFolder ¶

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

type CreateWebhook ¶

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` and possible values for Marketing type webhook – `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered`
	Events []string `json:"events"`
	// Type of the webhook
	Type_ string `json:"type,omitempty"`
}

type CreatedProcessId ¶

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

type DeleteHardbounces ¶

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 EmailCampaignsApiEmailExportRecipientsOpts ¶

type EmailCampaignsApiEmailExportRecipientsOpts struct {
	Body optional.Interface
}

type EmailCampaignsApiGetEmailCampaignsOpts ¶

type EmailCampaignsApiGetEmailCampaignsOpts struct {
	Type_     optional.String
	Status    optional.String
	StartDate optional.String
	EndDate   optional.String
	Limit     optional.Int64
	Offset    optional.Int64
	Sort      optional.String
}

type EmailCampaignsApiService ¶

type EmailCampaignsApiService service

func (*EmailCampaignsApiService) CreateEmailCampaign ¶

func (a *EmailCampaignsApiService) CreateEmailCampaign(ctx context.Context, body CreateEmailCampaign) (CreateModel, *http.Response, error)

EmailCampaignsApiService Create an email campaign

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to create a campaign

@return CreateModel

func (*EmailCampaignsApiService) DeleteEmailCampaign ¶

func (a *EmailCampaignsApiService) DeleteEmailCampaign(ctx context.Context, campaignId int64) (*http.Response, error)

EmailCampaignsApiService Delete an email campaign

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param campaignId id of the campaign

func (*EmailCampaignsApiService) EmailExportRecipients ¶

func (a *EmailCampaignsApiService) EmailExportRecipients(ctx context.Context, campaignId int64, localVarOptionals *EmailCampaignsApiEmailExportRecipientsOpts) (CreatedProcessId, *http.Response, error)

func (*EmailCampaignsApiService) GetAbTestCampaignResult ¶

func (a *EmailCampaignsApiService) GetAbTestCampaignResult(ctx context.Context, campaignId int64) (AbTestCampaignResult, *http.Response, error)

EmailCampaignsApiService Get an A/B test email campaign results Obtain winning version of an A/B test email campaign

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param campaignId Id of the A/B test campaign

@return AbTestCampaignResult

func (*EmailCampaignsApiService) GetEmailCampaign ¶

func (a *EmailCampaignsApiService) GetEmailCampaign(ctx context.Context, campaignId int64) (GetEmailCampaign, *http.Response, error)

EmailCampaignsApiService Get an email campaign report

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param campaignId Id of the campaign

@return GetEmailCampaign

func (*EmailCampaignsApiService) GetEmailCampaigns ¶

func (a *EmailCampaignsApiService) GetEmailCampaigns(ctx context.Context, localVarOptionals *EmailCampaignsApiGetEmailCampaignsOpts) (GetEmailCampaigns, *http.Response, error)

func (*EmailCampaignsApiService) GetSharedTemplateUrl ¶

func (a *EmailCampaignsApiService) GetSharedTemplateUrl(ctx context.Context, campaignId int64) (GetSharedTemplateUrl, *http.Response, error)

EmailCampaignsApiService Get a shared template url Get a unique URL to share & import an email template from one Sendinblue account to another.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param campaignId Id of the campaign or template

@return GetSharedTemplateUrl

func (*EmailCampaignsApiService) SendEmailCampaignNow ¶

func (a *EmailCampaignsApiService) SendEmailCampaignNow(ctx context.Context, campaignId int64) (*http.Response, error)

EmailCampaignsApiService Send an email campaign immediately, based on campaignId

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param campaignId Id of the campaign

func (*EmailCampaignsApiService) SendReport ¶

func (a *EmailCampaignsApiService) SendReport(ctx context.Context, body SendReport, campaignId int64) (*http.Response, error)

EmailCampaignsApiService Send the report of a campaign A PDF will be sent to the specified email addresses

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values for send a report
@param campaignId Id of the campaign

func (*EmailCampaignsApiService) SendTestEmail ¶

func (a *EmailCampaignsApiService) SendTestEmail(ctx context.Context, body SendTestEmail, campaignId int64) (*http.Response, error)

EmailCampaignsApiService Send an email campaign to your test list

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param campaignId Id of the campaign

func (*EmailCampaignsApiService) UpdateCampaignStatus ¶

func (a *EmailCampaignsApiService) UpdateCampaignStatus(ctx context.Context, body UpdateCampaignStatus, campaignId int64) (*http.Response, error)

EmailCampaignsApiService Update an email campaign status

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Status of the campaign
@param campaignId Id of the campaign

func (*EmailCampaignsApiService) UpdateEmailCampaign ¶

func (a *EmailCampaignsApiService) UpdateEmailCampaign(ctx context.Context, body UpdateEmailCampaign, campaignId int64) (*http.Response, error)

EmailCampaignsApiService Update an email campaign

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to update a campaign
@param campaignId Id of the campaign

func (*EmailCampaignsApiService) UploadImageToGallery ¶

func (a *EmailCampaignsApiService) UploadImageToGallery(ctx context.Context, body UploadImageToGallery) (*http.Response, error)

EmailCampaignsApiService Upload an image to your account's image gallery

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Parameters to upload an image

type EmailExportRecipients ¶

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

type ErrorModel ¶

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 FoldersApiGetFolderListsOpts ¶

type FoldersApiGetFolderListsOpts struct {
	Limit  optional.Int64
	Offset optional.Int64
	Sort   optional.String
}

type FoldersApiGetFoldersOpts ¶

type FoldersApiGetFoldersOpts struct {
	Sort optional.String
}

type FoldersApiService ¶

type FoldersApiService service

func (*FoldersApiService) CreateFolder ¶

func (a *FoldersApiService) CreateFolder(ctx context.Context, body CreateUpdateFolder) (CreateModel, *http.Response, error)

FoldersApiService Create a folder

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Name of the folder

@return CreateModel

func (*FoldersApiService) DeleteFolder ¶

func (a *FoldersApiService) DeleteFolder(ctx context.Context, folderId int64) (*http.Response, error)

FoldersApiService Delete a folder (and all its lists)

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param folderId Id of the folder

func (*FoldersApiService) GetFolder ¶

func (a *FoldersApiService) GetFolder(ctx context.Context, folderId int64) (GetFolder, *http.Response, error)

FoldersApiService Returns a folder's details

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param folderId id of the folder

@return GetFolder

func (*FoldersApiService) GetFolderLists ¶

func (a *FoldersApiService) GetFolderLists(ctx context.Context, folderId int64, localVarOptionals *FoldersApiGetFolderListsOpts) (GetFolderLists, *http.Response, error)

func (*FoldersApiService) GetFolders ¶

func (a *FoldersApiService) GetFolders(ctx context.Context, limit int64, offset int64, localVarOptionals *FoldersApiGetFoldersOpts) (GetFolders, *http.Response, error)

func (*FoldersApiService) UpdateFolder ¶

func (a *FoldersApiService) UpdateFolder(ctx context.Context, body CreateUpdateFolder, folderId int64) (*http.Response, error)

FoldersApiService Update a folder

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Name of the folder
@param folderId Id of the folder

type GenericSwaggerError ¶

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

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type GetAccount ¶

type GetAccount struct {
	Address *GetExtendedClientAddress `json:"address"`
	// Information about your plans and credits
	Plan                []GetAccountPlan               `json:"plan"`
	Relay               *GetAccountRelay               `json:"relay"`
	MarketingAutomation *GetAccountMarketingAutomation `json:"marketingAutomation,omitempty"`
}

type GetAccountMarketingAutomation ¶

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 ¶

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 ¶

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

Information about your transactional email account

type GetAccountRelayData ¶

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"`
}

Data regarding the transactional email account

type GetAggregatedReport ¶

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 GetAttributes ¶

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

type GetAttributesAttributes ¶

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 ¶

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 ¶

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

list of blocked domains

type GetCampaignOverview ¶

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"`
	// 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 ¶

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

type GetCampaignStats ¶

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"`
	// 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 GetChildAccountCreationStatus ¶

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

type GetChildDomain ¶

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

type GetChildInfo ¶

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 ¶

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

API Keys associated to child account

type GetChildInfoApiKeysV2 ¶

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 ¶

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 ¶

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"`
}

Credits available for your child

type GetChildInfoStatistics ¶

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"`
}

Statistics about your child account activity

type GetChildrenList ¶

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

type GetClient ¶

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 ¶

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"`
}

Campaign Statistics for the contact

type GetContactCampaignStatsClicked ¶

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

type GetContactCampaignStatsOpened ¶

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 ¶

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 ¶

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 ¶

type GetContactDetails struct {
	// Email address of the contact for which you requested the details
	Email string `json:"email"`
	// 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 *interface{} `json:"attributes"`
}

type GetContacts ¶

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

type GetDeviceBrowserStats ¶

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 GetEmailCampaign ¶

type GetEmailCampaign struct {
	// 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   *interface{} `json:"recipients"`
	Statistics   *interface{} `json:"statistics"`
}

type GetEmailCampaigns ¶

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

type GetEmailEventReport ¶

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

type GetEmailEventReportEvents ¶

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 GetExtendedCampaignOverview ¶

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"`
	// 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"`
	// 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"`
}

type GetExtendedCampaignOverviewSender ¶

type GetExtendedCampaignOverviewSender struct {
	// Sender name of the campaign
	Name string `json:"name,omitempty"`
	// Sender email of the campaign
	Email string `json:"email,omitempty"`
	// Sender id of the campaign
	Id string `json:"id,omitempty"`
}

type GetExtendedCampaignStats ¶

type GetExtendedCampaignStats struct {
	// Overall statistics of the campaign
	GlobalStats *AllOfgetExtendedCampaignStatsGlobalStats `json:"globalStats"`
	// List-wise statistics of the campaign.
	CampaignStats []AllOfgetExtendedCampaignStatsCampaignStatsItems `json:"campaignStats"`
	// Number of clicks on mirror link
	MirrorClick int64 `json:"mirrorClick"`
	// Number of remaning emails to send
	Remaining int64 `json:"remaining"`
	// Statistics about the number of clicks for the links
	LinksStats     *interface{}                      `json:"linksStats"`
	StatsByDomain  *map[string]GetCampaignStats      `json:"statsByDomain"`
	StatsByDevice  *GetStatsByDevice                 `json:"statsByDevice"`
	StatsByBrowser *map[string]GetDeviceBrowserStats `json:"statsByBrowser"`
}

type GetExtendedClient ¶

type GetExtendedClient 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"`
}

type GetExtendedClientAddress ¶

type GetExtendedClientAddress struct {
	// Street information
	Street string `json:"street"`
	// City information
	City string `json:"city"`
	// Zip Code information
	ZipCode string `json:"zipCode"`
	// Country information
	Country string `json:"country"`
}

Address informations

type GetExtendedContactDetails ¶

type GetExtendedContactDetails struct {
	// Email address of the contact for which you requested the details
	Email string `json:"email"`
	// 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 *interface{}                         `json:"attributes"`
	Statistics *GetExtendedContactDetailsStatistics `json:"statistics"`
}

type GetExtendedContactDetailsStatistics ¶

type GetExtendedContactDetailsStatistics struct {
	// Listing of the sent campaign for the contact
	MessagesSent []GetExtendedContactDetailsStatisticsMessagesSent `json:"messagesSent,omitempty"`
	// Listing of the hardbounes generated by the contact
	HardBounces []GetExtendedContactDetailsStatisticsMessagesSent `json:"hardBounces,omitempty"`
	// Listing of the softbounes generated by the contact
	SoftBounces []GetExtendedContactDetailsStatisticsMessagesSent `json:"softBounces,omitempty"`
	// Listing of the complaints generated by the contact
	Complaints      []GetExtendedContactDetailsStatisticsMessagesSent   `json:"complaints,omitempty"`
	Unsubscriptions *GetExtendedContactDetailsStatisticsUnsubscriptions `json:"unsubscriptions,omitempty"`
	// Listing of the openings generated by the contact
	Opened []GetExtendedContactDetailsStatisticsOpened `json:"opened,omitempty"`
	// Listing of the clicks generated by the contact
	Clicked []GetExtendedContactDetailsStatisticsClicked `json:"clicked,omitempty"`
	// Listing of the transactional attributes for the contact
	TransacAttributes []interface{} `json:"transacAttributes,omitempty"`
}

Campaign statistics of the contact

type GetExtendedContactDetailsStatisticsClicked ¶

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

type GetExtendedContactDetailsStatisticsLinks ¶

type GetExtendedContactDetailsStatisticsLinks struct {
	// Number of clicks on this link for the campaign
	Count int64 `json:"count"`
	// UTC date-time of the event
	EventTime string `json:"eventTime"`
	// IP from which the user has clicked on the link
	Ip string `json:"ip"`
	// URL of the clicked link
	Url string `json:"url"`
}

type GetExtendedContactDetailsStatisticsMessagesSent ¶

type GetExtendedContactDetailsStatisticsMessagesSent struct {
	// ID of the campaign which generated the event
	CampaignId int64 `json:"campaignId"`
	// UTC date-time of the event
	EventTime string `json:"eventTime"`
}

type GetExtendedContactDetailsStatisticsOpened ¶

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

type GetExtendedContactDetailsStatisticsUnsubscriptions ¶

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

Listing of the unsubscription for the contact

type GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription ¶

type GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription struct {
	// UTC date-time of the event
	EventTime string `json:"eventTime"`
	// IP from which the user has been unsubscribed
	Ip string `json:"ip,omitempty"`
}

type GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription ¶

type GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription struct {
	// ID of the campaign which generated the event
	CampaignId int64 `json:"campaignId"`
	// UTC date-time of the event
	EventTime string `json:"eventTime"`
	// IP from which the user has unsubscribed
	Ip string `json:"ip,omitempty"`
}

type GetExtendedList ¶

type GetExtendedList struct {
	// ID of the list
	Id int64 `json:"id"`
	// Name of the list
	Name string `json:"name"`
	// Number of blacklisted contacts in the list
	TotalBlacklisted int64 `json:"totalBlacklisted"`
	// Number of contacts in the list
	TotalSubscribers int64 `json:"totalSubscribers"`
	// ID of the folder
	FolderId int64 `json:"folderId"`
	// Creation UTC date-time of the list (YYYY-MM-DDTHH:mm:ss.SSSZ)
	CreatedAt     string                         `json:"createdAt"`
	CampaignStats []GetExtendedListCampaignStats `json:"campaignStats,omitempty"`
	// Status telling if the list is dynamic or not (true=dynamic, false=not dynamic)
	DynamicList bool `json:"dynamicList,omitempty"`
}

type GetExtendedListCampaignStats ¶

type GetExtendedListCampaignStats struct {
	// ID of the campaign
	CampaignId int64             `json:"campaignId"`
	Stats      *GetCampaignStats `json:"stats"`
}

type GetFolder ¶

type GetFolder struct {
	// ID of the folder
	Id int64 `json:"id"`
	// Name of the folder
	Name string `json:"name"`
	// Number of blacklisted contacts in the folder
	TotalBlacklisted int64 `json:"totalBlacklisted"`
	// Number of contacts in the folder
	TotalSubscribers int64 `json:"totalSubscribers"`
	// Number of unique contacts in the folder
	UniqueSubscribers int64 `json:"uniqueSubscribers"`
}

type GetFolderLists ¶

type GetFolderLists struct {
	Lists []AllOfgetFolderListsListsItems `json:"lists,omitempty"`
	// Number of lists in the folder
	Count int64 `json:"count,omitempty"`
}

type GetFolders ¶

type GetFolders struct {
	Folders []AllOfgetFoldersFoldersItems `json:"folders,omitempty"`
	// Number of folders available in your account
	Count int64 `json:"count,omitempty"`
}

type GetIp ¶

type GetIp struct {
	// ID of the dedicated IP
	Id int64 `json:"id"`
	// Dedicated IP
	Ip string `json:"ip"`
	// Status of the IP (true=active, false=inactive)
	Active bool `json:"active"`
	// Domain associated to the IP
	Domain string `json:"domain"`
}

type GetIpFromSender ¶

type GetIpFromSender struct {
	// ID of the dedicated IP
	Id int64 `json:"id"`
	// Dedicated IP
	Ip string `json:"ip"`
	// Domain associated to the IP
	Domain string `json:"domain"`
	// Weight of the IP
	Weight int64 `json:"weight"`
}

type GetIps ¶

type GetIps struct {
	// Dedicated IP(s) available on your account
	Ips []GetIp `json:"ips"`
}

type GetIpsFromSender ¶

type GetIpsFromSender struct {
	// Dedicated IP(s) linked to a sender
	Ips []GetIpFromSender `json:"ips"`
}

type GetList ¶

type GetList struct {
	// ID of the list
	Id int64 `json:"id"`
	// Name of the list
	Name string `json:"name"`
	// Number of blacklisted contacts in the list
	TotalBlacklisted int64 `json:"totalBlacklisted"`
	// Number of contacts in the list
	TotalSubscribers int64 `json:"totalSubscribers"`
}

type GetLists ¶

type GetLists struct {
	// Listing of all the lists available in your account
	Lists []AllOfgetListsListsItems `json:"lists,omitempty"`
	// Number of lists in your account
	Count int64 `json:"count,omitempty"`
}

type GetProcess ¶

type GetProcess struct {
	// Id of the process
	Id int64 `json:"id"`
	// Status of the process
	Status string `json:"status"`
	// Process name
	Name string `json:"name"`
	// URL on which send export the of contacts once the process is completed
	ExportUrl string `json:"export_url,omitempty"`
}

type GetProcesses ¶

type GetProcesses struct {
	// List of processes available on your account
	Processes []GetProcess `json:"processes,omitempty"`
	// Number of processes available on your account
	Count int64 `json:"count,omitempty"`
}

type GetReports ¶

type GetReports struct {
	Reports []GetReportsReports `json:"reports,omitempty"`
}

type GetReportsReports ¶

type GetReportsReports struct {
	// Date of the statistics
	Date string `json:"date"`
	// Number of requests for the date
	Requests int64 `json:"requests"`
	// Number of delivered emails for the date
	Delivered int64 `json:"delivered"`
	// Number of hardbounces for the date
	HardBounces int64 `json:"hardBounces"`
	// Number of softbounces for the date
	SoftBounces int64 `json:"softBounces"`
	// Number of clicks for the date
	Clicks int64 `json:"clicks"`
	// Number of unique clicks for the date
	UniqueClicks int64 `json:"uniqueClicks"`
	// Number of openings for the date
	Opens int64 `json:"opens"`
	// Number of unique openings for the date
	UniqueOpens int64 `json:"uniqueOpens"`
	// Number of complaints (spam reports) for the date
	SpamReports int64 `json:"spamReports"`
	// Number of blocked emails for the date
	Blocked int64 `json:"blocked"`
	// Number of invalid emails for the date
	Invalid int64 `json:"invalid"`
	// Number of unsubscribed emails for the date
	Unsubscribed int64 `json:"unsubscribed"`
}

type GetSendersList ¶

type GetSendersList struct {
	// List of the senders available in your account
	Senders []GetSendersListSenders `json:"senders,omitempty"`
}

type GetSendersListIps ¶

type GetSendersListIps struct {
	// Dedicated IP available in your account
	Ip string `json:"ip"`
	// Domain of the IP
	Domain string `json:"domain"`
	// Weight of the IP for this sender
	Weight int64 `json:"weight"`
}

type GetSendersListSenders ¶

type GetSendersListSenders struct {
	// Id of the sender
	Id int64 `json:"id"`
	// From Name associated to the sender
	Name string `json:"name"`
	// From Email associated to the sender
	Email string `json:"email"`
	// Status of sender (true=activated, false=deactivated)
	Active bool `json:"active"`
	// List of dedicated IP(s) available in the account. This data is displayed only for dedicated IPs
	Ips []GetSendersListIps `json:"ips,omitempty"`
}

type GetSharedTemplateUrl ¶

type GetSharedTemplateUrl struct {
	// A unique URL for the email campaign or transactional template. This URL can be shared with other Sendinblue users.
	SharedUrl string `json:"sharedUrl"`
}

type GetSmsCampaign ¶

type GetSmsCampaign struct {
	// ID of the SMS Campaign
	Id int64 `json:"id"`
	// Name of the SMS Campaign
	Name string `json:"name"`
	// Status of the SMS Campaign
	Status string `json:"status"`
	// Content of the SMS Campaign
	Content string `json:"content"`
	// UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format
	ScheduledAt string `json:"scheduledAt,omitempty"`
	// Sender of the SMS Campaign
	Sender string `json:"sender"`
	// Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
	CreatedAt string `json:"createdAt"`
	// UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
	ModifiedAt string       `json:"modifiedAt"`
	Recipients *interface{} `json:"recipients"`
	Statistics *interface{} `json:"statistics"`
}

type GetSmsCampaignOverview ¶

type GetSmsCampaignOverview struct {
	// ID of the SMS Campaign
	Id int64 `json:"id"`
	// Name of the SMS Campaign
	Name string `json:"name"`
	// Status of the SMS Campaign
	Status string `json:"status"`
	// Content of the SMS Campaign
	Content string `json:"content"`
	// UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format
	ScheduledAt string `json:"scheduledAt,omitempty"`
	// Sender of the SMS Campaign
	Sender string `json:"sender"`
	// Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
	CreatedAt string `json:"createdAt"`
	// UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
	ModifiedAt string `json:"modifiedAt"`
}

type GetSmsCampaignStats ¶

type GetSmsCampaignStats struct {
	// Number of delivered SMS
	Delivered int64 `json:"delivered"`
	// Number of sent SMS
	Sent int64 `json:"sent"`
	// Number of processing SMS
	Processing int64 `json:"processing"`
	// Number of softbounced SMS
	SoftBounces int64 `json:"softBounces"`
	// Number of hardbounced SMS
	HardBounces int64 `json:"hardBounces"`
	// Number of unsubscription SMS
	Unsubscriptions int64 `json:"unsubscriptions"`
	// Number of replies to the SMS
	Answered int64 `json:"answered"`
}

type GetSmsCampaigns ¶

type GetSmsCampaigns struct {
	Campaigns []AllOfgetSmsCampaignsCampaignsItems `json:"campaigns,omitempty"`
	// Number of SMS campaigns retrieved
	Count int64 `json:"count,omitempty"`
}

type GetSmsEventReport ¶

type GetSmsEventReport struct {
	Events []GetSmsEventReportEvents `json:"events,omitempty"`
}

type GetSmsEventReportEvents ¶

type GetSmsEventReportEvents struct {
	// Phone number which has generated the event
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// UTC date-time on which the event has been generated
	Date string `json:"date,omitempty"`
	// Message ID which generated the event
	MessageId string `json:"messageId,omitempty"`
	// Event which occurred
	Event string `json:"event,omitempty"`
	// Reason of bounce (only available if the event is hardbounce or softbounce)
	Reason string `json:"reason,omitempty"`
	Reply  string `json:"reply,omitempty"`
	// Tag of the SMS which generated the event
	Tag string `json:"tag,omitempty"`
}

type GetSmtpTemplateOverview ¶

type GetSmtpTemplateOverview struct {
	// ID of the template
	Id int64 `json:"id"`
	// Name of the template
	Name string `json:"name"`
	// Subject of the template
	Subject string `json:"subject"`
	// Status of template (true=active, false=inactive)
	IsActive bool `json:"isActive"`
	// Status of test sending for the template (true=test email has been sent, false=test email has not been sent)
	TestSent bool                           `json:"testSent"`
	Sender   *GetSmtpTemplateOverviewSender `json:"sender"`
	// Email defined as the \"Reply to\" for the template
	ReplyTo string `json:"replyTo"`
	// Customisation of the \"to\" field for the template
	ToField string `json:"toField"`
	// Tag of the template
	Tag string `json:"tag"`
	// HTML content of the template
	HtmlContent string `json:"htmlContent"`
	// Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ)
	CreatedAt string `json:"createdAt"`
	// Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ)
	ModifiedAt string `json:"modifiedAt"`
	// It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call.
	DoiTemplate bool `json:"doiTemplate,omitempty"`
}

type GetSmtpTemplateOverviewSender ¶

type GetSmtpTemplateOverviewSender struct {
	// From email for the template
	Name string `json:"name,omitempty"`
	// From email for the template
	Email string `json:"email,omitempty"`
	// Sender id of the template
	Id string `json:"id,omitempty"`
}

type GetSmtpTemplates ¶

type GetSmtpTemplates struct {
	// Count of transactional email templates
	Count     int64                     `json:"count,omitempty"`
	Templates []GetSmtpTemplateOverview `json:"templates,omitempty"`
}

type GetSsoToken ¶

type GetSsoToken struct {
	// Session token. It will remain valid for a short period of time only.
	Token string `json:"token"`
}

type GetStatsByDevice ¶

type GetStatsByDevice struct {
	// Statistics of the campaign on the basis of desktop devices
	Desktop map[string]GetDeviceBrowserStats `json:"desktop,omitempty"`
	// Statistics of the campaign on the basis of mobile devices
	Mobile map[string]GetDeviceBrowserStats `json:"mobile,omitempty"`
	// Statistics of the campaign on the basis of tablet devices
	Tablet map[string]GetDeviceBrowserStats `json:"tablet,omitempty"`
	// Statistics of the campaign on the basis of unknown devices
	Unknown map[string]GetDeviceBrowserStats `json:"unknown,omitempty"`
}

type GetTransacAggregatedSmsReport ¶

type GetTransacAggregatedSmsReport 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 SMS 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 blocked contact for the timeframe
	Blocked int64 `json:"blocked,omitempty"`
	// Number of unsubscription for the timeframe
	Unsubscribed int64 `json:"unsubscribed,omitempty"`
	// Number of answered SMS for the timeframe
	Replied int64 `json:"replied,omitempty"`
	// Number of accepted for the timeframe
	Accepted int64 `json:"accepted,omitempty"`
	// Number of rejected for the timeframe
	Rejected int64 `json:"rejected,omitempty"`
}

type GetTransacBlockedContacts ¶

type GetTransacBlockedContacts struct {
	// Count of blocked or unsubscribed contact
	Count    int64                               `json:"count,omitempty"`
	Contacts []GetTransacBlockedContactsContacts `json:"contacts,omitempty"`
}

type GetTransacBlockedContactsContacts ¶

type GetTransacBlockedContactsContacts struct {
	// Email address of the blocked or unsubscribed contact
	Email string `json:"email"`
	// Sender email address of the blocked or unsubscribed contact
	SenderEmail string                           `json:"senderEmail"`
	Reason      *GetTransacBlockedContactsReason `json:"reason"`
	// Date when the contact was blocked or unsubscribed on
	BlockedAt string `json:"blockedAt"`
}

type GetTransacBlockedContactsReason ¶

type GetTransacBlockedContactsReason struct {
	// Reason code for blocking / unsubscribing (This code is safe for comparison)
	Code string `json:"code,omitempty"`
	// Reason for blocking / unsubscribing (This string is not safe for comparison)
	Message string `json:"message,omitempty"`
}

Reason for blocking / unsubscribing

type GetTransacEmailContent ¶

type GetTransacEmailContent struct {
	// Email address to which transactional email has been sent
	Email string `json:"email"`
	// Subject of the sent email
	Subject string `json:"subject"`
	// Id of the template
	TemplateId int64 `json:"templateId,omitempty"`
	// Date on which transactional email was sent
	Date string `json:"date"`
	// Series of events which occurred on the transactional email
	Events []GetTransacEmailContentEvents `json:"events"`
	// Actual content of the transactional email that has been sent
	Body string `json:"body"`
	// Count of the attachments that were sent in the email
	AttachmentCount int64 `json:"attachmentCount"`
}

type GetTransacEmailContentEvents ¶

type GetTransacEmailContentEvents struct {
	// Name of the event that occurred on the sent email
	Name string `json:"name"`
	// Time at which the event occurred
	Time string `json:"time"`
}

type GetTransacEmailsList ¶

type GetTransacEmailsList struct {
	TransactionalEmails []GetTransacEmailsListTransactionalEmails `json:"transactionalEmails,omitempty"`
}

type GetTransacEmailsListTransactionalEmails ¶

type GetTransacEmailsListTransactionalEmails struct {
	// Email address to which transactional email has been sent
	Email string `json:"email"`
	// Subject of the sent email
	Subject string `json:"subject"`
	// Id of the template
	TemplateId int64 `json:"templateId,omitempty"`
	// Message Id of the sent email
	MessageId string `json:"messageId"`
	// Unique id of the email sent to a particular contact
	Uuid string `json:"uuid"`
	// Date on which transactional email was sent
	Date string `json:"date"`
	// Email address of the sender from which the email was sent
	From string `json:"from,omitempty"`
	// Tags used for your email
	Tags []string `json:"tags,omitempty"`
}

type GetTransacSmsReport ¶

type GetTransacSmsReport struct {
	Reports []GetTransacSmsReportReports `json:"reports,omitempty"`
}

type GetTransacSmsReportReports ¶

type GetTransacSmsReportReports struct {
	// Date for which statistics are retrieved
	Date string `json:"date,omitempty"`
	// Number of requests for the date
	Requests int64 `json:"requests,omitempty"`
	// Number of delivered SMS for the date
	Delivered int64 `json:"delivered,omitempty"`
	// Number of hardbounces for the date
	HardBounces int64 `json:"hardBounces,omitempty"`
	// Number of softbounces for the date
	SoftBounces int64 `json:"softBounces,omitempty"`
	// Number of blocked contact for the date
	Blocked int64 `json:"blocked,omitempty"`
	// Number of unsubscription for the date
	Unsubscribed int64 `json:"unsubscribed,omitempty"`
	// Number of answered SMS for the date
	Replied int64 `json:"replied,omitempty"`
	// Number of accepted for the date
	Accepted int64 `json:"accepted,omitempty"`
	// Number of rejected for the date
	Rejected int64 `json:"rejected,omitempty"`
}

type GetWebhook ¶

type GetWebhook struct {
	// URL of the webhook
	Url string `json:"url"`
	// ID of the webhook
	Id int64 `json:"id"`
	// Description of the webhook
	Description string   `json:"description"`
	Events      []string `json:"events"`
	// Type of webhook (marketing or transac)
	Type_ string `json:"type"`
	// Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)
	CreatedAt string `json:"createdAt"`
	// Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)
	ModifiedAt string `json:"modifiedAt"`
}

type GetWebhooks ¶

type GetWebhooks struct {
	Webhooks []AllOfgetWebhooksWebhooksItems `json:"webhooks"`
}

type ListsApiGetContactsFromListOpts ¶

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

type ListsApiGetFolderListsOpts ¶

type ListsApiGetFolderListsOpts struct {
	Limit  optional.Int64
	Offset optional.Int64
	Sort   optional.String
}

type ListsApiGetListsOpts ¶

type ListsApiGetListsOpts struct {
	Limit  optional.Int64
	Offset optional.Int64
	Sort   optional.String
}

type ListsApiService ¶

type ListsApiService service

func (*ListsApiService) AddContactToList ¶

func (a *ListsApiService) AddContactToList(ctx context.Context, body AddContactToList, listId int64) (PostContactInfo, *http.Response, error)

ListsApiService Add existing contacts to a list

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Emails addresses OR IDs of the contacts
@param listId Id of the list

@return PostContactInfo

func (*ListsApiService) CreateList ¶

func (a *ListsApiService) CreateList(ctx context.Context, body CreateList) (CreateModel, *http.Response, error)

ListsApiService Create a list

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to create a list

@return CreateModel

func (*ListsApiService) DeleteList ¶

func (a *ListsApiService) DeleteList(ctx context.Context, listId int64) (*http.Response, error)

ListsApiService Delete a list

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param listId Id of the list

func (*ListsApiService) GetContactsFromList ¶

func (a *ListsApiService) GetContactsFromList(ctx context.Context, listId int64, localVarOptionals *ListsApiGetContactsFromListOpts) (GetContacts, *http.Response, error)

func (*ListsApiService) GetFolderLists ¶

func (a *ListsApiService) GetFolderLists(ctx context.Context, folderId int64, localVarOptionals *ListsApiGetFolderListsOpts) (GetFolderLists, *http.Response, error)

func (*ListsApiService) GetList ¶

func (a *ListsApiService) GetList(ctx context.Context, listId int64) (GetExtendedList, *http.Response, error)

ListsApiService Get a list's details

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param listId Id of the list

@return GetExtendedList

func (*ListsApiService) GetLists ¶

func (a *ListsApiService) GetLists(ctx context.Context, localVarOptionals *ListsApiGetListsOpts) (GetLists, *http.Response, error)

func (*ListsApiService) RemoveContactFromList ¶

func (a *ListsApiService) RemoveContactFromList(ctx context.Context, body RemoveContactFromList, listId int64) (PostContactInfo, *http.Response, error)

ListsApiService Delete a contact from a list

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Emails addresses OR IDs of the contacts
@param listId Id of the list

@return PostContactInfo

func (*ListsApiService) UpdateList ¶

func (a *ListsApiService) UpdateList(ctx context.Context, body UpdateList, listId int64) (*http.Response, error)

ListsApiService Update a list

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to update a list
@param listId Id of the list

type ManageIp ¶

type ManageIp struct {
	// Dedicated ID
	Ip string `json:"ip,omitempty"`
}

type PostContactInfo ¶

type PostContactInfo struct {
	Contacts *PostContactInfoContacts `json:"contacts"`
}

type PostContactInfoContacts ¶

type PostContactInfoContacts struct {
	Success []string `json:"success,omitempty"`
	Failure []string `json:"failure,omitempty"`
	// Displays the count of total number of contacts removed from list when user opts for \"all\" option.
	Total int64 `json:"total,omitempty"`
	// Id of the process created to remove contacts from list when user opts for \"all\" option.
	ProcessId int64 `json:"processId,omitempty"`
}

type PostSendFailed ¶

type PostSendFailed struct {
	// Response code
	Code int64 `json:"code"`
	// Response message
	Message           string   `json:"message"`
	UnexistingEmails  []string `json:"unexistingEmails,omitempty"`
	WithoutListEmails []string `json:"withoutListEmails,omitempty"`
	BlackListedEmails []string `json:"blackListedEmails,omitempty"`
}

type PostSendSmsTestFailed ¶

type PostSendSmsTestFailed struct {
	// Response code
	Code int64 `json:"code"`
	// Response message
	Message        string   `json:"message"`
	UnexistingSms  []string `json:"unexistingSms,omitempty"`
	WithoutListSms []string `json:"withoutListSms,omitempty"`
}

type ProcessApiGetProcessesOpts ¶

type ProcessApiGetProcessesOpts struct {
	Limit  optional.Int64
	Offset optional.Int64
	Sort   optional.String
}

type ProcessApiService ¶

type ProcessApiService service

func (*ProcessApiService) GetProcess ¶

func (a *ProcessApiService) GetProcess(ctx context.Context, processId int64) (GetProcess, *http.Response, error)

ProcessApiService Return the informations for a process

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param processId Id of the process

@return GetProcess

func (*ProcessApiService) GetProcesses ¶

func (a *ProcessApiService) GetProcesses(ctx context.Context, localVarOptionals *ProcessApiGetProcessesOpts) (GetProcesses, *http.Response, error)

type RemainingCreditModel ¶

type RemainingCreditModel struct {
	Child    *RemainingCreditModelChild    `json:"child"`
	Reseller *RemainingCreditModelReseller `json:"reseller"`
}

type RemainingCreditModelChild ¶

type RemainingCreditModelChild struct {
	// SMS Credits remaining for child account
	Sms float64 `json:"sms"`
	// Email Credits remaining for child account
	Email float64 `json:"email"`
}

Credits remaining for child account

type RemainingCreditModelReseller ¶

type RemainingCreditModelReseller struct {
	// SMS Credits remaining for reseller account
	Sms float64 `json:"sms"`
	// Email Credits remaining for reseller account
	Email float64 `json:"email"`
}

type RemoveContactFromList ¶

type RemoveContactFromList struct {
	// Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request.
	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"`
	// Required if none of 'emails' or 'ids' are passed. Remove all existing contacts from a list.  A process will be created in this scenario. You can fetch the process details to know about the progress
	All bool `json:"all,omitempty"`
}

type RemoveCredits ¶

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

type RequestContactExport ¶

type RequestContactExport struct {
	// List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email'].
	ExportAttributes []string `json:"exportAttributes,omitempty"`
	// This attribute has been deprecated and will be removed by January 1st, 2021. Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported. For example, {\"blacklisted\":true} will export all the blacklisted contacts.
	ContactFilter       *interface{}                             `json:"contactFilter,omitempty"`
	CustomContactFilter *RequestContactExportCustomContactFilter `json:"customContactFilter,omitempty"`
	// Webhook that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479
	NotifyUrl string `json:"notifyUrl,omitempty"`
}

type RequestContactExportCustomContactFilter ¶

type RequestContactExportCustomContactFilter struct {
	// 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.
	ActionForContacts string `json:"actionForContacts,omitempty"`
	// 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. Fetch the list of readers / non-readers for a particular email campaign. * clickers & nonClickers - emailCampaignId is mandatory. Fetch the list of clickers / non-clickers for a particular email campaign. * unsubscribed - emailCampaignId is mandatory. Fetch the list of all unsubscribed (blacklisted via any means) contacts for a particular email campaign. * hardBounces & softBounces - emailCampaignId is optional. Fetch the list of hard bounces / soft bounces for a particular / all email campaign(s).
	ActionForEmailCampaigns string `json:"actionForEmailCampaigns,omitempty"`
	// 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.
	ActionForSmsCampaigns string `json:"actionForSmsCampaigns,omitempty"`
	// Mandatory if actionForContacts is passed, ignored otherwise. Id of the list for which the corresponding action shall be applied in the filter.
	ListId int64 `json:"listId,omitempty"`
	// Considered only if actionForEmailCampaigns is passed, ignored otherwise. Mandatory if action is one of the following - openers, nonOpeners, clickers, nonClickers, unsubscribed. The id of the email campaign for which the corresponding action shall be applied in the filter.
	EmailCampaignId int64 `json:"emailCampaignId,omitempty"`
	// Considered only if actionForSmsCampaigns is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter.
	SmsCampaignId int64 `json:"smsCampaignId,omitempty"`
}

Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported.

type RequestContactImport ¶

type RequestContactImport struct {
	// Mandatory if fileBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv
	FileUrl string `json:"fileUrl,omitempty"`
	// Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files.
	FileBody string `json:"fileBody,omitempty"`
	// Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7].
	ListIds []int64 `json:"listIds,omitempty"`
	// URL that will be called once the import process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479
	NotifyUrl string                       `json:"notifyUrl,omitempty"`
	NewList   *RequestContactImportNewList `json:"newList,omitempty"`
	// To blacklist all the contacts for email
	EmailBlacklist bool `json:"emailBlacklist,omitempty"`
	// To blacklist all the contacts for sms
	SmsBlacklist bool `json:"smsBlacklist,omitempty"`
	// To facilitate the choice to update the existing contacts
	UpdateExistingContacts bool `json:"updateExistingContacts,omitempty"`
	// To facilitate the choice to erase any attribute of the existing contacts with empty value. emptyContactsAttributes = true means the empty fields in your import will erase any attribute that currently contain data in SendinBlue, & emptyContactsAttributes = false means the empty fields will not affect your existing data ( only available if `updateExistingContacts` set to true )
	EmptyContactsAttributes bool `json:"emptyContactsAttributes,omitempty"`
}

type RequestContactImportNewList ¶

type RequestContactImportNewList struct {
	// List with listName will be created first and users will be imported in it (Mandatory if listIds is empty).
	ListName string `json:"listName,omitempty"`
	// Id of the folder where this new list shall be created (Mandatory if listName is not empty).
	FolderId int64 `json:"folderId,omitempty"`
}

To create a new list and import the contacts into it, pass the listName and an optional folderId.

type RequestSmsRecipientExport ¶

type RequestSmsRecipientExport struct {
	// URL that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479
	NotifyURL string `json:"notifyURL,omitempty"`
	// Filter the recipients based on how they interacted with the campaign
	RecipientsType string `json:"recipientsType"`
}

type ResellerApiCreateResellerChildOpts ¶

type ResellerApiCreateResellerChildOpts struct {
	Body optional.Interface
}

type ResellerApiGetResellerChildsOpts ¶

type ResellerApiGetResellerChildsOpts struct {
	Limit  optional.Int64
	Offset optional.Int64
}

type ResellerApiService ¶

type ResellerApiService service

func (*ResellerApiService) AddCredits ¶

func (a *ResellerApiService) AddCredits(ctx context.Context, body AddCredits, childIdentifier string) (RemainingCreditModel, *http.Response, error)

ResellerApiService Add Email and/or SMS credits to a specific child account

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to post to add credit to a specific child account
@param childIdentifier Either auth key or id of reseller's child

@return RemainingCreditModel

func (*ResellerApiService) AssociateIpToChild ¶

func (a *ResellerApiService) AssociateIpToChild(ctx context.Context, body ManageIp, childIdentifier string) (*http.Response, error)

ResellerApiService Associate a dedicated IP to the child

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body IP to associate
@param childIdentifier Either auth key or id of reseller's child

func (*ResellerApiService) CreateChildDomain ¶

func (a *ResellerApiService) CreateChildDomain(ctx context.Context, body AddChildDomain, childIdentifier string) (*http.Response, error)

ResellerApiService Create a domain for a child account

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Sender domain to add for a specific child account. This will not be displayed to the parent account.
@param childIdentifier Either auth key or id of reseller's child

func (*ResellerApiService) CreateResellerChild ¶

func (a *ResellerApiService) CreateResellerChild(ctx context.Context, localVarOptionals *ResellerApiCreateResellerChildOpts) (CreateReseller, *http.Response, error)

func (*ResellerApiService) DeleteChildDomain ¶

func (a *ResellerApiService) DeleteChildDomain(ctx context.Context, childIdentifier string, domainName string) (*http.Response, error)

ResellerApiService Delete the sender domain of the reseller child based on the childIdentifier and domainName passed

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param childIdentifier Either auth key or id of reseller's child
@param domainName Pass the existing domain that needs to be deleted

func (*ResellerApiService) DeleteResellerChild ¶

func (a *ResellerApiService) DeleteResellerChild(ctx context.Context, childIdentifier string) (*http.Response, error)

ResellerApiService Delete a single reseller child based on the child identifier supplied

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param childIdentifier Either auth key or child id of reseller's child

func (*ResellerApiService) DissociateIpFromChild ¶

func (a *ResellerApiService) DissociateIpFromChild(ctx context.Context, body ManageIp, childIdentifier string) (*http.Response, error)

ResellerApiService Dissociate a dedicated IP to the child

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body IP to dissociate
@param childIdentifier Either auth key or id of reseller's child

func (*ResellerApiService) GetChildAccountCreationStatus ¶

func (a *ResellerApiService) GetChildAccountCreationStatus(ctx context.Context, childIdentifier string) (GetChildAccountCreationStatus, *http.Response, error)

ResellerApiService Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param childIdentifier Either auth key or id of reseller's child

@return GetChildAccountCreationStatus

func (*ResellerApiService) GetChildDomains ¶

func (a *ResellerApiService) GetChildDomains(ctx context.Context, childIdentifier string) ([]string, *http.Response, error)

ResellerApiService Get all sender domains for a specific child account

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param childIdentifier Either auth key or id of reseller's child

@return []AllOfgetChildDomainsItems

func (*ResellerApiService) GetChildInfo ¶

func (a *ResellerApiService) GetChildInfo(ctx context.Context, childIdentifier string) (GetChildInfo, *http.Response, error)

ResellerApiService Get a child account's details

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param childIdentifier Either auth key or id of reseller's child

@return GetChildInfo

func (*ResellerApiService) GetResellerChilds ¶

func (a *ResellerApiService) GetResellerChilds(ctx context.Context, localVarOptionals *ResellerApiGetResellerChildsOpts) (GetChildrenList, *http.Response, error)

func (*ResellerApiService) GetSsoToken ¶

func (a *ResellerApiService) GetSsoToken(ctx context.Context, childIdentifier string) (GetSsoToken, *http.Response, error)

ResellerApiService Get session token to access Sendinblue (SSO) It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param childIdentifier Either auth key or id of reseller's child

@return GetSsoToken

func (*ResellerApiService) RemoveCredits ¶

func (a *ResellerApiService) RemoveCredits(ctx context.Context, body RemoveCredits, childIdentifier string) (RemainingCreditModel, *http.Response, error)

ResellerApiService Remove Email and/or SMS credits from a specific child account

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to post to remove email or SMS credits from a specific child account
@param childIdentifier Either auth key or id of reseller's child

@return RemainingCreditModel

func (*ResellerApiService) UpdateChildAccountStatus ¶

func (a *ResellerApiService) UpdateChildAccountStatus(ctx context.Context, body UpdateChildAccountStatus, childIdentifier string) (*http.Response, error)

ResellerApiService Update info of reseller's child account status based on the childIdentifier supplied

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body values to update in child account status
@param childIdentifier Either auth key or id of reseller's child

func (*ResellerApiService) UpdateChildDomain ¶

func (a *ResellerApiService) UpdateChildDomain(ctx context.Context, body UpdateChildDomain, childIdentifier string, domainName string) (*http.Response, error)

ResellerApiService Update the sender domain of reseller's child based on the childIdentifier and domainName passed

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body value to update for sender domain
@param childIdentifier Either auth key or id of reseller's child
@param domainName Pass the existing domain that needs to be updated

func (*ResellerApiService) UpdateResellerChild ¶

func (a *ResellerApiService) UpdateResellerChild(ctx context.Context, body UpdateChild, childIdentifier string) (*http.Response, error)

ResellerApiService Update info of reseller's child based on the child identifier supplied

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body values to update in child profile
@param childIdentifier Either auth key or id of reseller's child

type SMSCampaignsApiGetSmsCampaignsOpts ¶

type SMSCampaignsApiGetSmsCampaignsOpts struct {
	Status    optional.String
	StartDate optional.String
	EndDate   optional.String
	Limit     optional.Int64
	Offset    optional.Int64
	Sort      optional.String
}

type SMSCampaignsApiRequestSmsRecipientExportOpts ¶

type SMSCampaignsApiRequestSmsRecipientExportOpts struct {
	Body optional.Interface
}

type SMSCampaignsApiService ¶

type SMSCampaignsApiService service

func (*SMSCampaignsApiService) CreateSmsCampaign ¶

func (a *SMSCampaignsApiService) CreateSmsCampaign(ctx context.Context, body CreateSmsCampaign) (CreateModel, *http.Response, error)

SMSCampaignsApiService Creates an SMS campaign

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to create an SMS Campaign

@return CreateModel

func (*SMSCampaignsApiService) DeleteSmsCampaign ¶

func (a *SMSCampaignsApiService) DeleteSmsCampaign(ctx context.Context, campaignId int64) (*http.Response, error)

SMSCampaignsApiService Delete an SMS campaign

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param campaignId id of the SMS campaign

func (*SMSCampaignsApiService) GetSmsCampaign ¶

func (a *SMSCampaignsApiService) GetSmsCampaign(ctx context.Context, campaignId int64) (GetSmsCampaign, *http.Response, error)

SMSCampaignsApiService Get an SMS campaign

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param campaignId id of the SMS campaign

@return GetSmsCampaign

func (*SMSCampaignsApiService) GetSmsCampaigns ¶

func (a *SMSCampaignsApiService) GetSmsCampaigns(ctx context.Context, localVarOptionals *SMSCampaignsApiGetSmsCampaignsOpts) (GetSmsCampaigns, *http.Response, error)

func (*SMSCampaignsApiService) RequestSmsRecipientExport ¶

func (a *SMSCampaignsApiService) RequestSmsRecipientExport(ctx context.Context, campaignId int64, localVarOptionals *SMSCampaignsApiRequestSmsRecipientExportOpts) (CreatedProcessId, *http.Response, error)

func (*SMSCampaignsApiService) SendSmsCampaignNow ¶

func (a *SMSCampaignsApiService) SendSmsCampaignNow(ctx context.Context, campaignId int64) (*http.Response, error)

SMSCampaignsApiService Send your SMS campaign immediately

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param campaignId id of the campaign

func (*SMSCampaignsApiService) SendSmsReport ¶

func (a *SMSCampaignsApiService) SendSmsReport(ctx context.Context, body SendReport, campaignId int64) (*http.Response, error)

SMSCampaignsApiService Send an SMS campaign's report Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values for send a report
@param campaignId id of the campaign

func (*SMSCampaignsApiService) SendTestSms ¶

func (a *SMSCampaignsApiService) SendTestSms(ctx context.Context, body SendTestSms, campaignId int64) (*http.Response, error)

SMSCampaignsApiService Send a test SMS campaign

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted
@param campaignId Id of the SMS campaign

func (*SMSCampaignsApiService) UpdateSmsCampaign ¶

func (a *SMSCampaignsApiService) UpdateSmsCampaign(ctx context.Context, body UpdateSmsCampaign, campaignId int64) (*http.Response, error)

SMSCampaignsApiService Update an SMS campaign

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to update an SMS Campaign
@param campaignId id of the SMS campaign

func (*SMSCampaignsApiService) UpdateSmsCampaignStatus ¶

func (a *SMSCampaignsApiService) UpdateSmsCampaignStatus(ctx context.Context, body UpdateCampaignStatus, campaignId int64) (*http.Response, error)

SMSCampaignsApiService Update a campaign's status

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Status of the campaign.
@param campaignId id of the campaign

type SendEmail ¶

type SendEmail struct {
	// List of the email addresses of the recipients. For example, ['abc@example.com', 'asd@example.com'].
	EmailTo []string `json:"emailTo"`
	// List of the email addresses of the recipients in bcc
	EmailBcc []string `json:"emailBcc,omitempty"`
	// List of the email addresses of the recipients in cc
	EmailCc []string `json:"emailCc,omitempty"`
	// Email address which shall be used by campaign recipients to reply back
	ReplyTo string `json:"replyTo,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"`
	// Pass the list of content (base64 encoded) and name of the attachment. For example, [{\"content\":\"base64 encoded content 1\", \"name\":\"attcahment1\"}, {\"content\":\"base64 encoded content 2\", \"name\":\"attcahment2\"}].
	Attachment []SendEmailAttachment `json:"attachment,omitempty"`
	// Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, {\"Content-Type\":\"text/html\", \"charset\":\"iso-8859-1\", \"sender.ip\":\"1.2.3.4\"}
	Headers *interface{} `json:"headers,omitempty"`
	// Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}
	Attributes *interface{} `json:"attributes,omitempty"`
	// Tag your emails to find them more easily
	Tags []string `json:"tags,omitempty"`
}

type SendEmailAttachment ¶

type SendEmailAttachment struct {
	// Base64 encoded chunk data of the attachment generated on the fly
	Content string `json:"content"`
	// Required for content. Name of the attachment
	Name string `json:"name"`
}

type SendReport ¶

type SendReport struct {
	// Language of email content for campaign report sending.
	Language string           `json:"language,omitempty"`
	Email    *SendReportEmail `json:"email"`
}

type SendReportEmail ¶

type SendReportEmail struct {
	// Email addresses of the recipients
	To []string `json:"to"`
	// Custom text message to be presented in the report email.
	Body string `json:"body"`
}

Custom attributes for the report email.

type SendSms ¶

type SendSms struct {
	Reference string `json:"reference"`
	MessageId int64  `json:"messageId"`
	// Count of SMS's to send multiple text messages
	SmsCount int64 `json:"smsCount,omitempty"`
	// SMS credits used per text message
	UsedCredits float32 `json:"usedCredits,omitempty"`
	// Remaining SMS credits of the user
	RemainingCredits float32 `json:"remainingCredits,omitempty"`
}

type SendSmtpEmail ¶

type SendSmtpEmail struct {
	Sender *SendSmtpEmailSender `json:"sender,omitempty"`
	// Mandatory if messageVersions are not passed, ignored if messageVersions are passed. List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}]
	To []SendSmtpEmailTo `json:"to,omitempty"`
	// List of email addresses and names (optional) of the recipients in bcc
	Bcc []SendSmtpEmailBcc `json:"bcc,omitempty"`
	// List of email addresses and names (optional) of the recipients in cc
	Cc []SendSmtpEmailCc `json:"cc,omitempty"`
	// HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed )
	HtmlContent string `json:"htmlContent,omitempty"`
	// Plain Text body of the message ( Ignored if 'templateId' is passed )
	TextContent string `json:"textContent,omitempty"`
	// Subject of the message. Mandatory if 'templateId' is not passed
	Subject string                `json:"subject,omitempty"`
	ReplyTo *SendSmtpEmailReplyTo `json:"replyTo,omitempty"`
	// Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: 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, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored )
	Attachment []SendSmtpEmailAttachment `json:"attachment,omitempty"`
	// Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`.
	Headers *interface{} `json:"headers,omitempty"`
	// Id of the template. Mandatory if messageVersions are passed
	TemplateId int64 `json:"templateId,omitempty"`
	// Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format.
	Params *interface{} `json:"params,omitempty"`
	// You can customize and send out multiple versions of a templateId. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. This feature is currently in its beta version. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails
	MessageVersions []SendSmtpEmailMessageVersions `json:"messageVersions,omitempty"`
	// Tag your emails to find them more easily
	Tags []string `json:"tags,omitempty"`
}

type SendSmtpEmailAttachment ¶

type SendSmtpEmailAttachment struct {
	// Absolute url of the attachment (no local file).
	Url string `json:"url,omitempty"`
	// Base64 encoded chunk data of the attachment generated on the fly
	Content string `json:"content,omitempty"`
	// Required if content is passed. Name of the attachment
	Name string `json:"name,omitempty"`
}

type SendSmtpEmailBcc ¶

type SendSmtpEmailBcc struct {
	// Email address of the recipient in bcc
	Email string `json:"email"`
	// Name of the recipient in bcc. Maximum allowed characters are 70.
	Name string `json:"name,omitempty"`
}

type SendSmtpEmailCc ¶

type SendSmtpEmailCc struct {
	// Email address of the recipient in cc
	Email string `json:"email"`
	// Name of the recipient in cc. Maximum allowed characters are 70.
	Name string `json:"name,omitempty"`
}

type SendSmtpEmailMessageVersions ¶

type SendSmtpEmailMessageVersions struct {
	// List of email addresses and names (_optional_) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}]
	To []SendSmtpEmailTo1 `json:"to"`
	// Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format.
	Params map[string]interface{} `json:"params,omitempty"`
	// List of email addresses and names (optional) of the recipients in bcc
	Bcc []SendSmtpEmailBcc `json:"bcc,omitempty"`
	// List of email addresses and names (optional) of the recipients in cc
	Cc      []SendSmtpEmailCc      `json:"cc,omitempty"`
	ReplyTo *SendSmtpEmailReplyTo1 `json:"replyTo,omitempty"`
	// Custom subject specific to message version
	Subject string `json:"subject,omitempty"`
}

type SendSmtpEmailReplyTo ¶

type SendSmtpEmailReplyTo struct {
	// Email address in reply to
	Email string `json:"email"`
	// Name in reply to. Maximum allowed characters are 70.
	Name string `json:"name,omitempty"`
}

Email (required), along with name (optional), on which transactional mail recipients will be able to reply back. For example, {\"email\":\"ann6533@example.com\", \"name\":\"Ann\"}.

type SendSmtpEmailReplyTo1 ¶

type SendSmtpEmailReplyTo1 struct {
	// Email address in reply to
	Email string `json:"email"`
	// Name in reply to. Maximum allowed characters are 70.
	Name string `json:"name,omitempty"`
}

Email (required), along with name (optional), on which transactional mail recipients will be able to reply back. For example, {\"email\":\"ann6533@example.com\", \"name\":\"Ann\"}

type SendSmtpEmailSender ¶

type SendSmtpEmailSender struct {
	// Name of the sender from which the emails will be sent. Maximum allowed characters are 70. Applicable only when email is passed.
	Name string `json:"name,omitempty"`
	// Email of the sender from which the emails will be sent. Mandatory if sender id is not passed.
	Email string `json:"email,omitempty"`
	// Id of the sender from which the emails will be sent. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). Mandatory if email is not passed.
	Id int64 `json:"id,omitempty"`
}

Mandatory if `templateId` is not passed. Pass `name` (optional) and `email` OR `id` of sender from which emails will be sent. `name` will be ignored if passed along with sender `id`. For example, {\"name\":\"Mary from MyShop\", \"email\":\"no-reply@myshop.com\"} or {\"id\":2}

type SendSmtpEmailTo ¶

type SendSmtpEmailTo struct {
	// Email address of the recipient
	Email string `json:"email"`
	// Name of the recipient. Maximum allowed characters are 70.
	Name string `json:"name,omitempty"`
}

type SendSmtpEmailTo1 ¶

type SendSmtpEmailTo1 struct {
	// Email address of the recipient
	Email string `json:"email"`
	// Name of the recipient. **Maximum allowed characters are 70**.
	Name string `json:"name,omitempty"`
}

type SendTemplateEmail ¶

type SendTemplateEmail struct {
	// Message ID of the template Email sent
	MessageId string `json:"messageId"`
}

type SendTestEmail ¶

type SendTestEmail struct {
	// List of the email addresses of the recipients whom you wish to send the test mail. If left empty, the test mail will be sent to your entire test list.
	EmailTo []string `json:"emailTo,omitempty"`
}

type SendTestSms ¶

type SendTestSms struct {
	// Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted
	PhoneNumber string `json:"phoneNumber,omitempty"`
}

type SendTransacSms ¶

type SendTransacSms struct {
	// Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters**
	Sender string `json:"sender"`
	// Mobile number to send SMS with the country code
	Recipient string `json:"recipient"`
	// Content of the message. If more than 160 characters long, will be sent as multiple text messages
	Content string `json:"content"`
	// Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc.
	Type_ string `json:"type,omitempty"`
	// Tag of the message
	Tag string `json:"tag,omitempty"`
	// Webhook to call for each event triggered by the message (delivered etc.)
	WebUrl string `json:"webUrl,omitempty"`
}

type SendersApiCreateSenderOpts ¶

type SendersApiCreateSenderOpts struct {
	Body optional.Interface
}

type SendersApiGetSendersOpts ¶

type SendersApiGetSendersOpts struct {
	Ip     optional.String
	Domain optional.String
}

type SendersApiService ¶

type SendersApiService service

func (*SendersApiService) CreateSender ¶

func (a *SendersApiService) CreateSender(ctx context.Context, localVarOptionals *SendersApiCreateSenderOpts) (CreateSenderModel, *http.Response, error)

func (*SendersApiService) DeleteSender ¶

func (a *SendersApiService) DeleteSender(ctx context.Context, senderId int64) (*http.Response, error)

SendersApiService Delete a sender

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param senderId Id of the sender

func (*SendersApiService) GetIps ¶

func (a *SendersApiService) GetIps(ctx context.Context) (GetIps, *http.Response, error)

SendersApiService Get all the dedicated IPs for your account

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return GetIps

func (*SendersApiService) GetIpsFromSender ¶

func (a *SendersApiService) GetIpsFromSender(ctx context.Context, senderId int64) (GetIpsFromSender, *http.Response, error)

SendersApiService Get all the dedicated IPs for a sender

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param senderId Id of the sender

@return GetIpsFromSender

func (*SendersApiService) GetSenders ¶

func (a *SendersApiService) GetSenders(ctx context.Context, localVarOptionals *SendersApiGetSendersOpts) (GetSendersList, *http.Response, error)

func (*SendersApiService) UpdateSender ¶

func (a *SendersApiService) UpdateSender(ctx context.Context, senderId int64, localVarOptionals *SendersApiUpdateSenderOpts) (*http.Response, error)

type SendersApiUpdateSenderOpts ¶

type SendersApiUpdateSenderOpts struct {
	Body optional.Interface
}

type TransactionalEmailsApiDeleteHardbouncesOpts ¶

type TransactionalEmailsApiDeleteHardbouncesOpts struct {
	Body optional.Interface
}

type TransactionalEmailsApiGetAggregatedSmtpReportOpts ¶

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

type TransactionalEmailsApiGetEmailEventReportOpts ¶

type TransactionalEmailsApiGetEmailEventReportOpts 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 TransactionalEmailsApiGetSmtpReportOpts ¶

type TransactionalEmailsApiGetSmtpReportOpts struct {
	Limit     optional.Int64
	Offset    optional.Int64
	StartDate optional.String
	EndDate   optional.String
	Days      optional.Int64
	Tag       optional.String
	Sort      optional.String
}

type TransactionalEmailsApiGetSmtpTemplatesOpts ¶

type TransactionalEmailsApiGetSmtpTemplatesOpts struct {
	TemplateStatus optional.Bool
	Limit          optional.Int64
	Offset         optional.Int64
	Sort           optional.String
}

type TransactionalEmailsApiGetTransacBlockedContactsOpts ¶

type TransactionalEmailsApiGetTransacBlockedContactsOpts struct {
	StartDate optional.String
	EndDate   optional.String
	Limit     optional.Int64
	Offset    optional.Int64
	Senders   optional.Interface
	Sort      optional.String
}

type TransactionalEmailsApiGetTransacEmailsListOpts ¶

type TransactionalEmailsApiGetTransacEmailsListOpts struct {
	Email      optional.String
	TemplateId optional.Int64
	MessageId  optional.String
	StartDate  optional.String
	EndDate    optional.String
	Sort       optional.String
}

type TransactionalEmailsApiService ¶

type TransactionalEmailsApiService service

func (*TransactionalEmailsApiService) BlockNewDomain ¶

func (a *TransactionalEmailsApiService) BlockNewDomain(ctx context.Context, body BlockDomain) (*http.Response, error)

TransactionalEmailsApiService Add a new domain to the list of blocked domains Blocks a new domain in order to avoid messages being sent to the same

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

func (*TransactionalEmailsApiService) CreateSmtpTemplate ¶

func (a *TransactionalEmailsApiService) CreateSmtpTemplate(ctx context.Context, body CreateSmtpTemplate) (CreateModel, *http.Response, error)

TransactionalEmailsApiService Create an email template

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body values to update in transactional email template

@return CreateModel

func (*TransactionalEmailsApiService) DeleteBlockedDomain ¶

func (a *TransactionalEmailsApiService) DeleteBlockedDomain(ctx context.Context, domain string) (*http.Response, error)

TransactionalEmailsApiService Unblock an existing domain from the list of blocked domains Unblocks an existing domain from the list of blocked domains

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param domain The name of the domain to be deleted

func (*TransactionalEmailsApiService) DeleteHardbounces ¶

func (a *TransactionalEmailsApiService) DeleteHardbounces(ctx context.Context, localVarOptionals *TransactionalEmailsApiDeleteHardbouncesOpts) (*http.Response, error)

func (*TransactionalEmailsApiService) DeleteSmtpTemplate ¶

func (a *TransactionalEmailsApiService) DeleteSmtpTemplate(ctx context.Context, templateId int64) (*http.Response, error)

TransactionalEmailsApiService Delete an inactive email template

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param templateId id of the template

func (*TransactionalEmailsApiService) GetAggregatedSmtpReport ¶

func (a *TransactionalEmailsApiService) GetAggregatedSmtpReport(ctx context.Context, localVarOptionals *TransactionalEmailsApiGetAggregatedSmtpReportOpts) (GetAggregatedReport, *http.Response, error)

func (*TransactionalEmailsApiService) GetBlockedDomains ¶

func (a *TransactionalEmailsApiService) GetBlockedDomains(ctx context.Context) (GetBlockedDomains, *http.Response, error)

TransactionalEmailsApiService Get the list of blocked domains Get the list of blocked domains

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return GetBlockedDomains

func (*TransactionalEmailsApiService) GetEmailEventReport ¶

func (a *TransactionalEmailsApiService) GetEmailEventReport(ctx context.Context, localVarOptionals *TransactionalEmailsApiGetEmailEventReportOpts) (GetEmailEventReport, *http.Response, error)

func (*TransactionalEmailsApiService) GetSmtpReport ¶

func (a *TransactionalEmailsApiService) GetSmtpReport(ctx context.Context, localVarOptionals *TransactionalEmailsApiGetSmtpReportOpts) (GetReports, *http.Response, error)

func (*TransactionalEmailsApiService) GetSmtpTemplate ¶

func (a *TransactionalEmailsApiService) GetSmtpTemplate(ctx context.Context, templateId int64) (GetSmtpTemplateOverview, *http.Response, error)

TransactionalEmailsApiService Returns the template information

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param templateId id of the template

@return GetSmtpTemplateOverview

func (*TransactionalEmailsApiService) GetSmtpTemplates ¶

func (a *TransactionalEmailsApiService) GetSmtpTemplates(ctx context.Context, localVarOptionals *TransactionalEmailsApiGetSmtpTemplatesOpts) (GetSmtpTemplates, *http.Response, error)

func (*TransactionalEmailsApiService) GetTransacBlockedContacts ¶

func (a *TransactionalEmailsApiService) GetTransacBlockedContacts(ctx context.Context, localVarOptionals *TransactionalEmailsApiGetTransacBlockedContactsOpts) (GetTransacBlockedContacts, *http.Response, error)

func (*TransactionalEmailsApiService) GetTransacEmailContent ¶

func (a *TransactionalEmailsApiService) GetTransacEmailContent(ctx context.Context, uuid string) (GetTransacEmailContent, *http.Response, error)

TransactionalEmailsApiService Get the personalized content of a sent transactional email

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param uuid Unique id of the transactional email that has been sent to a particular contact

@return GetTransacEmailContent

func (*TransactionalEmailsApiService) GetTransacEmailsList ¶

func (a *TransactionalEmailsApiService) GetTransacEmailsList(ctx context.Context, localVarOptionals *TransactionalEmailsApiGetTransacEmailsListOpts) (GetTransacEmailsList, *http.Response, error)

func (*TransactionalEmailsApiService) SendTemplate ¶

func (a *TransactionalEmailsApiService) SendTemplate(ctx context.Context, body SendEmail, templateId int64) (SendTemplateEmail, *http.Response, error)

TransactionalEmailsApiService Send a template This endpoint is deprecated. Prefer v3/smtp/email instead.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param templateId Id of the template

@return SendTemplateEmail

func (*TransactionalEmailsApiService) SendTestTemplate ¶

func (a *TransactionalEmailsApiService) SendTestTemplate(ctx context.Context, body SendTestEmail, templateId int64) (*http.Response, error)

TransactionalEmailsApiService Send a template to your test list

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param templateId Id of the template

func (*TransactionalEmailsApiService) SendTransacEmail ¶

func (a *TransactionalEmailsApiService) SendTransacEmail(ctx context.Context, body SendSmtpEmail) (CreateSmtpEmail, *http.Response, error)

TransactionalEmailsApiService Send a transactional email

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to send a transactional email

@return CreateSmtpEmail

func (*TransactionalEmailsApiService) SmtpBlockedContactsEmailDelete ¶

func (a *TransactionalEmailsApiService) SmtpBlockedContactsEmailDelete(ctx context.Context, email string) (*http.Response, error)

TransactionalEmailsApiService Unblock or resubscribe a transactional contact

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param email contact email (urlencoded) to unblock.

func (*TransactionalEmailsApiService) SmtpLogMessageIdDelete ¶

func (a *TransactionalEmailsApiService) SmtpLogMessageIdDelete(ctx context.Context, messageId string) (*http.Response, error)

TransactionalEmailsApiService Delete an SMTP transactional log

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param messageId MessageId of the transactional log to delete

func (*TransactionalEmailsApiService) UpdateSmtpTemplate ¶

func (a *TransactionalEmailsApiService) UpdateSmtpTemplate(ctx context.Context, body UpdateSmtpTemplate, templateId int64) (*http.Response, error)

TransactionalEmailsApiService Update an email template

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body values to update in transactional email template
@param templateId id of the template

type TransactionalSMSApiGetSmsEventsOpts ¶

type TransactionalSMSApiGetSmsEventsOpts struct {
	Limit       optional.Int64
	StartDate   optional.String
	EndDate     optional.String
	Offset      optional.Int64
	Days        optional.Int64
	PhoneNumber optional.String
	Event       optional.String
	Tags        optional.String
	Sort        optional.String
}

type TransactionalSMSApiGetTransacAggregatedSmsReportOpts ¶

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

type TransactionalSMSApiGetTransacSmsReportOpts ¶

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

type TransactionalSMSApiService ¶

type TransactionalSMSApiService service

func (*TransactionalSMSApiService) GetSmsEvents ¶

func (a *TransactionalSMSApiService) GetSmsEvents(ctx context.Context, localVarOptionals *TransactionalSMSApiGetSmsEventsOpts) (GetSmsEventReport, *http.Response, error)

func (*TransactionalSMSApiService) GetTransacAggregatedSmsReport ¶

func (a *TransactionalSMSApiService) GetTransacAggregatedSmsReport(ctx context.Context, localVarOptionals *TransactionalSMSApiGetTransacAggregatedSmsReportOpts) (GetTransacAggregatedSmsReport, *http.Response, error)

func (*TransactionalSMSApiService) GetTransacSmsReport ¶

func (a *TransactionalSMSApiService) GetTransacSmsReport(ctx context.Context, localVarOptionals *TransactionalSMSApiGetTransacSmsReportOpts) (GetTransacSmsReport, *http.Response, error)

func (*TransactionalSMSApiService) SendTransacSms ¶

func (a *TransactionalSMSApiService) SendTransacSms(ctx context.Context, body SendTransacSms) (SendSms, *http.Response, error)

TransactionalSMSApiService Send SMS message to a mobile number

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to send a transactional SMS

@return SendSms

type UpdateAttribute ¶

type UpdateAttribute struct {
	// Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global'
	Value string `json:"value,omitempty"`
	// List of the 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 []UpdateAttributeEnumeration `json:"enumeration,omitempty"`
}

type UpdateAttributeEnumeration ¶

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

type UpdateCampaignStatus ¶

type UpdateCampaignStatus struct {
	// Note:- replicateTemplate status will be available only for template type campaigns.
	Status string `json:"status,omitempty"`
}

Status of the campaign

type UpdateChild ¶

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

type UpdateChildAccountStatus ¶

type UpdateChildAccountStatus struct {
	// Status of Transactional Email Platform activation for your account (true=enabled, false=disabled)
	TransactionalEmail bool `json:"transactionalEmail,omitempty"`
	// Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled)
	TransactionalSms bool `json:"transactionalSms,omitempty"`
	// Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled)
	MarketingAutomation bool `json:"marketingAutomation,omitempty"`
	// Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled)
	SmsCampaign bool `json:"smsCampaign,omitempty"`
}

type UpdateChildDomain ¶

type UpdateChildDomain struct {
	// Value for the sender domain that will replace the existing domain
	Domain string `json:"domain,omitempty"`
}

type UpdateContact ¶

type UpdateContact struct {
	// Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"}
	Attributes *interface{} `json:"attributes,omitempty"`
	// Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true)
	EmailBlacklisted bool `json:"emailBlacklisted,omitempty"`
	// Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true)
	SmsBlacklisted bool `json:"smsBlacklisted,omitempty"`
	// Ids of the lists to add the contact to
	ListIds []int64 `json:"listIds,omitempty"`
	// Ids of the lists to remove the contact from
	UnlinkListIds []int64 `json:"unlinkListIds,omitempty"`
	// transactional email forbidden sender for contact. Use only for email Contact
	SmtpBlacklistSender []string `json:"smtpBlacklistSender,omitempty"`
}

type UpdateEmailCampaign ¶

type UpdateEmailCampaign struct {
	// Tag of the campaign
	Tag    string                     `json:"tag,omitempty"`
	Sender *UpdateEmailCampaignSender `json:"sender,omitempty"`
	// Name of the campaign
	Name string `json:"name,omitempty"`
	// Body of the message (HTML version). 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"`
	// 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. 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
	Subject string `json:"subject,omitempty"`
	// 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 SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
	ToField    string                         `json:"toField,omitempty"`
	Recipients *UpdateEmailCampaignRecipients `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"`
	// Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts.
	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"`
	// 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\"}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField'
	Params *interface{} `json:"params,omitempty"`
	// Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled.
	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 if abTesting is set to true. '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. Considered if abTesting = true. subjectA & subjectB should have unique value
	SubjectA string `json:"subjectA,omitempty"`
	// Subject B of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value
	SubjectB string `json:"subjectB,omitempty"`
	// Add the size of your test groups. Considered if abTesting = true. 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. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed or alreday exist in record
	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. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed or alreday exist in record
	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"`
	// 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"`
	// 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"`
}

type UpdateEmailCampaignRecipients ¶

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

List ids to include/exclude from campaign

type UpdateEmailCampaignSender ¶

type UpdateEmailCampaignSender struct {
	// Sender Name from which the campaign emails are sent
	Name string `json:"name,omitempty"`
	// Sender email from which the campaign emails are sent
	Email string `json:"email,omitempty"`
	// 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"`
}

Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` , `{\"name\":\"xyz\", \"id\":123}`

type UpdateList ¶

type UpdateList struct {
	// Name of the list. Either of the two parameters (name, folderId) can be updated at a time.
	Name string `json:"name,omitempty"`
	// Id of the folder in which the list is to be moved. Either of the two parameters (name, folderId) can be updated at a time.
	FolderId int64 `json:"folderId,omitempty"`
}

type UpdateSender ¶

type UpdateSender struct {
	// From Name to update the sender
	Name string `json:"name,omitempty"`
	// From Email to update the sender
	Email string `json:"email,omitempty"`
	// Only in case of dedicated IP, IPs to associate to the sender. If passed, will replace all the existing IPs.
	Ips []CreateSenderIps `json:"ips,omitempty"`
}

type UpdateSmsCampaign ¶

type UpdateSmsCampaign struct {
	// Name of the campaign
	Name string `json:"name,omitempty"`
	// Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters**
	Sender string `json:"sender,omitempty"`
	// 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,omitempty"`
	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"`
}

type UpdateSmtpTemplate ¶

type UpdateSmtpTemplate struct {
	// Tag of the template
	Tag    string                    `json:"tag,omitempty"`
	Sender *UpdateSmtpTemplateSender `json:"sender,omitempty"`
	// Name of the template
	TemplateName string `json:"templateName,omitempty"`
	// Required if htmlUrl is empty. Body of the message (HTML must have more than 10 characters)
	HtmlContent string `json:"htmlContent,omitempty"`
	// Required if htmlContent is empty. URL to the body of the email (HTML)
	HtmlUrl string `json:"htmlUrl,omitempty"`
	// Subject of the email
	Subject string `json:"subject,omitempty"`
	// 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 SendinBlue 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 the template. isActive = false means template is inactive, isActive = true means template is active
	IsActive bool `json:"isActive,omitempty"`
}

type UpdateSmtpTemplateSender ¶

type UpdateSmtpTemplateSender struct {
	// Name of the sender
	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"`
}

Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` , `{\"name\":\"xyz\", \"id\":123}`

type UpdateWebhook ¶

type UpdateWebhook struct {
	// URL of the webhook
	Url string `json:"url,omitempty"`
	// 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` and possible values for Marketing type webhook – `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` and `delivered`
	Events []string `json:"events,omitempty"`
}

type UploadImageToGallery ¶

type UploadImageToGallery struct {
	// The absolute url of the image (no local file). Maximum allowed size for image is 2MB. Allowed extensions for images are - jpeg, jpg, png, bmp, gif.
	ImageUrl string `json:"imageUrl"`
	// Name of the image.
	Name string `json:"name,omitempty"`
}

type WebhooksApiGetWebhooksOpts ¶

type WebhooksApiGetWebhooksOpts struct {
	Type_ optional.String
}

type WebhooksApiService ¶

type WebhooksApiService service

func (*WebhooksApiService) CreateWebhook ¶

func (a *WebhooksApiService) CreateWebhook(ctx context.Context, body CreateWebhook) (CreateModel, *http.Response, error)

WebhooksApiService Create a webhook

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to create a webhook

@return CreateModel

func (*WebhooksApiService) DeleteWebhook ¶

func (a *WebhooksApiService) DeleteWebhook(ctx context.Context, webhookId int64) (*http.Response, error)

WebhooksApiService Delete a webhook

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param webhookId Id of the webhook

func (*WebhooksApiService) GetWebhook ¶

func (a *WebhooksApiService) GetWebhook(ctx context.Context, webhookId int64) (GetWebhook, *http.Response, error)

WebhooksApiService Get a webhook details

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param webhookId Id of the webhook

@return GetWebhook

func (*WebhooksApiService) GetWebhooks ¶

func (a *WebhooksApiService) GetWebhooks(ctx context.Context, localVarOptionals *WebhooksApiGetWebhooksOpts) (GetWebhooks, *http.Response, error)

func (*WebhooksApiService) UpdateWebhook ¶

func (a *WebhooksApiService) UpdateWebhook(ctx context.Context, body UpdateWebhook, webhookId int64) (*http.Response, error)

WebhooksApiService Update a webhook

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Values to update a webhook
@param webhookId Id of the webhook

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL