data

Documentation

Index

• Constants
• func GenerateUrl() *url.URL
• func GetIntegrationName() string
• type EffxEvent
  • func (y EffxEvent) SendEvent(apiKey string) error
• type EffxYaml
  • func (y EffxYaml) Lint() error
  • func (y EffxYaml) Sync(apiKey string) error

Constants

const EffxAPIHost = "EFFX_API_HOST"

EffxAPIHost Is the environment variable to override the API host

const EffxYamlPattern = "(.+\\.)?effx\\.ya?ml$"

EffxYamlPattern is the regex pattern for yaml files

Functions

func GenerateUrl

func GenerateUrl() *url.URL

func GetIntegrationName

func GetIntegrationName() string

GetIntegrationName uses the environment to generate an effx integration name

Types

type EffxEvent

type EffxEvent struct {
	Payload *effx_api.CreateEventPayload
}

func (EffxEvent) SendEvent

func (y EffxEvent) SendEvent(apiKey string) error

Sync Updates the Effx API with yaml file contents

type EffxYaml

type EffxYaml struct {
	FilePath string
}

EffxYaml provides a data structure and methods for interacting with effx yamls

func (EffxYaml) Lint

func (y EffxYaml) Lint() error

Lint Checks for syntax errors in the yaml file

func (EffxYaml) Sync

func (y EffxYaml) Sync(apiKey string) error

Sync Updates the Effx API with yaml file contents