models_pkg

package
Version: v5.0.1+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 28, 2020 License: MIT Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ActionEnumArrayToValue

func ActionEnumArrayToValue(actionEnum []ActionEnum) []string

*

* Converts ActionEnum Array to its string Array representation

func ActionEnumToValue

func ActionEnumToValue(actionEnum ActionEnum) string

*

* Converts ActionEnum to its string representation

func AggregatedByEnumArrayToValue

func AggregatedByEnumArrayToValue(aggregatedByEnum []AggregatedByEnum) []string

*

* Converts AggregatedByEnum Array to its string Array representation

func AggregatedByEnumToValue

func AggregatedByEnumToValue(aggregatedByEnum AggregatedByEnum) string

*

* Converts AggregatedByEnum to its string representation

func EventsEnumArrayToValue

func EventsEnumArrayToValue(eventsEnum []EventsEnum) []string

*

* Converts EventsEnum Array to its string Array representation

func EventsEnumToValue

func EventsEnumToValue(eventsEnum EventsEnum) string

*

* Converts EventsEnum to its string representation

func SortEnumArrayToValue

func SortEnumArrayToValue(sortEnum []SortEnum) []string

*

* Converts SortEnum Array to its string Array representation

func SortEnumToValue

func SortEnumToValue(sortEnum SortEnum) string

*

* Converts SortEnum to its string representation

func TimeperiodEnumArrayToValue

func TimeperiodEnumArrayToValue(timeperiodEnum []TimeperiodEnum) []string

*

* Converts TimeperiodEnum Array to its string Array representation

func TimeperiodEnumToValue

func TimeperiodEnumToValue(timeperiodEnum TimeperiodEnum) string

*

* Converts TimeperiodEnum to its string representation

func TypeEnumArrayToValue

func TypeEnumArrayToValue(typeEnum []TypeEnum) []string

*

* Converts TypeEnum Array to its string Array representation

func TypeEnumToValue

func TypeEnumToValue(typeEnum TypeEnum) string

*

* Converts TypeEnum to its string representation

Types

type ActionEnum

type ActionEnum int

*

* Type definition for ActionEnum enum
const (
	Action_INCREASE ActionEnum = 1 + iota
	Action_DECREASE
)

*

* Value collection for ActionEnum enum

func ActionEnumFromValue

func ActionEnumFromValue(value string) ActionEnum

*

* Converts given value to its enum representation

func (ActionEnum) MarshalJSON

func (r ActionEnum) MarshalJSON() ([]byte, error)

func (*ActionEnum) UnmarshalJSON

func (r *ActionEnum) UnmarshalJSON(data []byte) error

type AddEmailOrDomainToSuppressionList

type AddEmailOrDomainToSuppressionList struct {
	Domain *string `json:"domain,omitempty" form:"domain,omitempty"` //Add the domain to be suppressed here. We will not deliver emails to recipients email addresses with this domain.<br>\nComma separate the values to suppress multiple domains..
	Email  *string `json:"email,omitempty" form:"email,omitempty"`   //Add an email address to be suppressed here. We will not deliver emails to this email address.<br>\nComma separate the values to suppress multiple email addresses
}

* Structure for the custom type AddEmailOrDomainToSuppressionList

type AggregatedByEnum

type AggregatedByEnum int

*

* Type definition for AggregatedByEnum enum
const (
	AggregatedBy_DAY AggregatedByEnum = 1 + iota
	AggregatedBy_WEEK
	AggregatedBy_MONTH
)

*

* Value collection for AggregatedByEnum enum

func AggregatedByEnumFromValue

func AggregatedByEnumFromValue(value string) AggregatedByEnum

*

* Converts given value to its enum representation

func (AggregatedByEnum) MarshalJSON

func (r AggregatedByEnum) MarshalJSON() ([]byte, error)

func (*AggregatedByEnum) UnmarshalJSON

func (r *AggregatedByEnum) UnmarshalJSON(data []byte) error

type Attachments

type Attachments struct {
	Content *string `json:"content,omitempty" form:"content,omitempty"` //Base64 encoded value of the attached file
	Name    *string `json:"name,omitempty" form:"name,omitempty"`       //filename of attachments
}

* Structure for the custom type Attachments

type Content

type Content struct {
	Type  TypeEnum `json:"type,omitempty" form:"type,omitempty"`   //TODO: Write general description for this field
	Value *string  `json:"value,omitempty" form:"value,omitempty"` //HTML content to be sent in your email
}

* Structure for the custom type Content

type CreateSubaccount

type CreateSubaccount struct {
	Username    string  `json:"username" form:"username"`                           //provide a username for the subaccount
	Email       string  `json:"email" form:"email"`                                 //email address to be registered with the account.
	Setpassword string  `json:"setpassword" form:"setpassword"`                     //You can opt to set the password for the subaccount.\nIf set as 1, please provide a value in password parameter.\nIf set as 0, the email confirmation link will act as a password reset link.
	Password    *string `json:"password,omitempty" form:"password,omitempty"`       //It is required to pass this value, if setpassword is set as 1.\nThe password must comprise minimum of 8 characters and include one uppercase character, one lowercase character, one numeric character.
	CreditType  *string `json:"credit_type,omitempty" form:"credit_type,omitempty"` //Allowed values one_time_credit or unlimited by default, all subaccounts are created with credit type as unlimited.
}

* Structure for the custom type CreateSubaccount

type DeleteDomain

type DeleteDomain struct {
	Domain *string `json:"domain,omitempty" form:"domain,omitempty"` //Name of the domain
}

* Structure for the custom type DeleteDomain

type DeleteSubacoount

type DeleteSubacoount struct {
	Username *string `json:"username,omitempty" form:"username,omitempty"` //The username of the subaccount
}

* Structure for the custom type DeleteSubacoount

type DomainStruct

type DomainStruct struct {
	Domain       string  `json:"domain" form:"domain"`                                 //The domain you wish to include in the 'From' header of your emails.
	EnvelopeName *string `json:"envelopeName,omitempty" form:"envelopeName,omitempty"` //The subdomain which will be used for tracking opens, clicks and unsubscribe
}

* Structure for the custom type DomainStruct

type EmailStruct

type EmailStruct struct {
	Name  *string `json:"name,omitempty" form:"name,omitempty"`   //Name of recipient
	Email *string `json:"email,omitempty" form:"email,omitempty"` //Email of recipient
}

* Structure for the custom type EmailStruct

type EnableOrDisableSubacoount

type EnableOrDisableSubacoount struct {
	Username *string `json:"username,omitempty" form:"username,omitempty"` //The username of the subaccount
	Disabled *bool   `json:"disabled,omitempty" form:"disabled,omitempty"` //Flag to indicate whether the subaccount should be enabled or disabled.
}

* Structure for the custom type EnableOrDisableSubacoount

type EventsEnum

type EventsEnum int

*

* Type definition for EventsEnum enum
const (
	Events_PROCESSED EventsEnum = 1 + iota
	Events_SENT
	Events_OPEN
	Events_CLICK
	Events_UNSUBSCRIBE
	Events_BOUNCE
	Events_SOFTBOUNCE
	Events_SPAM
	Events_INVALID
	Events_DROPPED
	Events_HARDBOUNCE
)

*

* Value collection for EventsEnum enum

func EventsEnumFromValue

func EventsEnumFromValue(value string) EventsEnum

*

* Converts given value to its enum representation

func (EventsEnum) MarshalJSON

func (r EventsEnum) MarshalJSON() ([]byte, error)

func (*EventsEnum) UnmarshalJSON

func (r *EventsEnum) UnmarshalJSON(data []byte) error

type From

type From struct {
	Email *string `json:"email,omitempty" form:"email,omitempty"` //TODO: Write general description for this field
	Name  *string `json:"name,omitempty" form:"name,omitempty"`   //TODO: Write general description for this field
}

* Structure for the custom type From

type Personalizations

type Personalizations struct {
	Attributes  *interface{}   `json:"attributes,omitempty" form:"attributes,omitempty"`   //Dynamic attributes
	Headers     *interface{}   `json:"headers,omitempty" form:"headers,omitempty"`         //Dynamic headers attributes
	Attachments []*Attachments `json:"attachments,omitempty" form:"attachments,omitempty"` //Attachments to individuals recipient
	To          []*EmailStruct `json:"to" form:"to"`                                       //To email-address
	Cc          []*EmailStruct `json:"cc,omitempty" form:"cc,omitempty"`                   //CC email-address
	Bcc         []*EmailStruct `json:"bcc,omitempty" form:"bcc,omitempty"`                 //Bcc email-addresses
	TokenTo     *string        `json:"token_to,omitempty" form:"token_to,omitempty"`       //token to which is json string
	TokenCc     *string        `json:"token_cc,omitempty" form:"token_cc,omitempty"`       //token cc which is json string
	TokenBcc    *string        `json:"token_bcc,omitempty" form:"token_bcc,omitempty"`     //token bcc which is json string
}

* Structure for the custom type Personalizations

type RemoveEmailOrDomainToSuppressionList

type RemoveEmailOrDomainToSuppressionList struct {
	Domain *string `json:"domain,omitempty" form:"domain,omitempty"` //List one or more recipient domains to be removed from the suppression list here. <br>\nComma separate the values to suppress multiple recipient domains.
	Email  *string `json:"email,omitempty" form:"email,omitempty"`   //List one or more email addresses to be removed from the suppression list here. <br>\nComma separate the values to suppress multiple email addresses.
}

* Structure for the custom type RemoveEmailOrDomainToSuppressionList

type Send

type Send struct {
	ReplyTo          *string             `json:"reply_to,omitempty" form:"reply_to,omitempty"`         //email address which recipients can reply to.
	From             From                `json:"from" form:"from"`                                     //Email address representing the sender of the mail
	Subject          string              `json:"subject" form:"subject"`                               //Subject line of the email
	TemplateId       *int64              `json:"template_id,omitempty" form:"template_id,omitempty"`   //ID of the template to be used for sending the mail
	Content          []*Content          `json:"content" form:"content"`                               //content in text/plain format
	Attachments      []*Attachments      `json:"attachments,omitempty" form:"attachments,omitempty"`   //attachment information
	Personalizations []*Personalizations `json:"personalizations" form:"personalizations"`             //to recipient with some personalized data like to address, attachments and attributes
	Settings         *Settings           `json:"settings,omitempty" form:"settings,omitempty"`         //TODO: Write general description for this field
	Tags             *[]string           `json:"tags,omitempty" form:"tags,omitempty"`                 //define custom tags to organize your emails
	LintPayload      *bool               `json:"lint_payload,omitempty" form:"lint_payload,omitempty"` //TODO: Write general description for this field
	Schedule         *int64              `json:"schedule,omitempty" form:"schedule,omitempty"`         //schedule the time of email delivery
	Bcc              []*EmailStruct      `json:"bcc,omitempty" form:"bcc,omitempty"`                   //Global bcc can be defined here
}

* Structure for the custom type Send

type Settings

type Settings struct {
	Footer           *bool `json:"footer,omitempty" form:"footer,omitempty"`                       //enable or disable footer
	ClickTrack       *bool `json:"click_track,omitempty" form:"click_track,omitempty"`             //enable or disable click tracking
	OpenTrack        *bool `json:"open_track,omitempty" form:"open_track,omitempty"`               //enable or disable open tracking
	UnsubscribeTrack *bool `json:"unsubscribe_track,omitempty" form:"unsubscribe_track,omitempty"` //enable or disable unsubscribe tracking
	Hepf             *bool `json:"hepf,omitempty" form:"hepf,omitempty"`                           //TODO: Write general description for this field
}

* Structure for the custom type Settings

type SortEnum

type SortEnum int

*

* Type definition for SortEnum enum
const (
	Sort_ASC SortEnum = 1 + iota
	Sort_DESC
)

*

* Value collection for SortEnum enum

func SortEnumFromValue

func SortEnumFromValue(value string) SortEnum

*

* Converts given value to its enum representation

func (SortEnum) MarshalJSON

func (r SortEnum) MarshalJSON() ([]byte, error)

func (*SortEnum) UnmarshalJSON

func (r *SortEnum) UnmarshalJSON(data []byte) error

type TimeperiodEnum

type TimeperiodEnum int

*

* Type definition for TimeperiodEnum enum
const (
	Timeperiod_DAILY TimeperiodEnum = 1 + iota
	Timeperiod_WEEKLY
	Timeperiod_MONHTLY
)

*

* Value collection for TimeperiodEnum enum

func TimeperiodEnumFromValue

func TimeperiodEnumFromValue(value string) TimeperiodEnum

*

* Converts given value to its enum representation

func (TimeperiodEnum) MarshalJSON

func (r TimeperiodEnum) MarshalJSON() ([]byte, error)

func (*TimeperiodEnum) UnmarshalJSON

func (r *TimeperiodEnum) UnmarshalJSON(data []byte) error

type TypeEnum

type TypeEnum int

*

* Type definition for TypeEnum enum
const (
	Type_AMP TypeEnum = 1 + iota
	Type_HTML
)

*

* Value collection for TypeEnum enum

func TypeEnumFromValue

func TypeEnumFromValue(value string) TypeEnum

*

* Converts given value to its enum representation

func (TypeEnum) MarshalJSON

func (r TypeEnum) MarshalJSON() ([]byte, error)

func (*TypeEnum) UnmarshalJSON

func (r *TypeEnum) UnmarshalJSON(data []byte) error

type UpdateCredisOfSubaccount

type UpdateCredisOfSubaccount struct {
	Username *string    `json:"username,omitempty" form:"username,omitempty"` //The username of the subaccount
	Action   ActionEnum `json:"action,omitempty" form:"action,omitempty"`     //Indicate the action (add or subtract) to be taken.Allowed values increase, decrease
	Amount   *int64     `json:"amount,omitempty" form:"amount,omitempty"`     //Amount of credits
}

* Structure for the custom type UpdateCredisOfSubaccount

type UpdateRecurringCredisOfSubaccount

type UpdateRecurringCredisOfSubaccount struct {
	Username        *string        `json:"username,omitempty" form:"username,omitempty"`                 //The username of the subaccount
	RecurringCredit *int64         `json:"recurring_credit,omitempty" form:"recurring_credit,omitempty"` //The amount to be added periodically
	Timeperiod      TimeperiodEnum `json:"timeperiod,omitempty" form:"timeperiod,omitempty"`             //The periodic \n\nAllowed values  \"daily\", \"weekly\", \"monhtly\"
	StartDate       *string        `json:"start_date,omitempty" form:"start_date,omitempty"`             //The date from which the credit allocation will commence
	EndDate         *string        `json:"end_date,omitempty" form:"end_date,omitempty"`                 //The last date of credit allocation
	Status          *string        `json:"status,omitempty" form:"status,omitempty"`                     //Flag to enable or disable the recurring credit allocation
}

* Structure for the custom type UpdateRecurringCredisOfSubaccount

type UpdateSubaccount

type UpdateSubaccount struct {
	Username        *string `json:"username,omitempty" form:"username,omitempty"`                 //The username for the subaccount
	NewEmail        *string `json:"new_email,omitempty" form:"new_email,omitempty"`               //The new email address to be registered with the subaccount
	NewPassword     *string `json:"new_password,omitempty" form:"new_password,omitempty"`         //The new password of the subaccount
	ConfirmPassword *string `json:"confirm_password,omitempty" form:"confirm_password,omitempty"` //reconfirm the new password for the subaccount
	CreditType      *string `json:"credit_type,omitempty" form:"credit_type,omitempty"`           //Allowed values one_time_credit or unlimited by default, all subaccounts are created with credit type as unlimited.
}

* Structure for the custom type UpdateSubaccount

Jump to

Keyboard shortcuts

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