events_pkg

Documentation

Index

• type EVENTS
• type EVENTS_IMPL
  • func NewEVENTS(config configuration_pkg.CONFIGURATION) *EVENTS_IMPL
  • func (me *EVENTS_IMPL) GetEventsGET(startdate *time.Time, events models_pkg.EventsEnum, sort models_pkg.SortEnum, ...) (interface{}, error)

Types

type EVENTS

type EVENTS interface {
	GetEventsGET(*time.Time, models_pkg.EventsEnum, models_pkg.SortEnum, *time.Time, *int64, *int64, *string, *string, *string, *string) (interface{}, error)
}

* Interface for the EVENTS_IMPL

type EVENTS_IMPL

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

* Client structure as interface implementation

func NewEVENTS

func NewEVENTS(config configuration_pkg.CONFIGURATION) *EVENTS_IMPL

* Factory for the EVENTS interaface returning EVENTS_IMPL

func (*EVENTS_IMPL) GetEventsGET

func (me *EVENTS_IMPL) GetEventsGET(
	startdate *time.Time,
	events models_pkg.EventsEnum,
	sort models_pkg.SortEnum,
	enddate *time.Time,
	offset *int64,
	limit *int64,
	subject *string,
	xapiheader *string,
	fromaddress *string,
	email *string) (interface{}, error)

*

• Lets you to retrieve the email transaction logs.
• @param *time.Time startdate parameter: Required
• @param models_pkg.EventsEnum events parameter: Optional
• @param models_pkg.SortEnum sort parameter: Optional
• @param *time.Time enddate parameter: Optional
• @param *int64 offset parameter: Optional
• @param *int64 limit parameter: Optional
• @param *string subject parameter: Optional
• @param *string xapiheader parameter: Optional
• @param *string fromaddress parameter: Optional
• @param *string email parameter: Optional
• @return Returns the interface{} response from the API call