decisionapi

Documentation

Index

• Constants
• func APIKey(apiKey string) func(r *APIClient)
• func APIUrl(apiURL string) func(r *APIClient)
• func APIVersion(version APIVersionNumber) func(r *APIClient)
• func Retries(retries int) func(r *APIClient)
• func Timeout(timeout time.Duration) func(r *APIClient)
• type APIClient
  • func NewAPIClient(envID string, apiKey string, params ...func(*APIClient)) (*APIClient, error)
  • func (r *APIClient) ActivateCampaign(request model.ActivationHit) error
  • func (r *APIClient) GetModifications(visitorID string, anonymousID *string, context map[string]interface{}) (*model.APIClientResponse, error)
  • func (r *APIClient) SendEvent(request model.Event) error
• type APIVersionNumber

Constants

const (
	// V1 is Decision API V1
	V1 = iota + 1
	// V2 is Decision API V2
	V2
)

Functions

func APIKey

func APIKey(apiKey string) func(r *APIClient)

APIKey sets http client api key

func APIUrl

func APIUrl(apiURL string) func(r *APIClient)

APIUrl sets http client URL

func APIVersion

func APIVersion(version APIVersionNumber) func(r *APIClient)

APIVersion sets http client base URL

func Retries

func Retries(retries int) func(r *APIClient)

Retries sets max number of retries for failed calls

func Timeout

func Timeout(timeout time.Duration) func(r *APIClient)

Timeout sets http client timeout

Types

type APIClient

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

APIClient represents the Decision API client informations

func NewAPIClient

func NewAPIClient(envID string, apiKey string, params ...func(*APIClient)) (*APIClient, error)

NewAPIClient creates a Decision API client from the environment ID and option builders

func (*APIClient) ActivateCampaign

func (r *APIClient) ActivateCampaign(request model.ActivationHit) error

ActivateCampaign activate a campaign / variation id to the Decision API

func (*APIClient) GetModifications

func (r *APIClient) GetModifications(visitorID string, anonymousID *string, context map[string]interface{}) (*model.APIClientResponse, error)

GetModifications gets modifications from Decision API

func (*APIClient) SendEvent

func (r *APIClient) SendEvent(request model.Event) error

SendEvent sends an event to flagship Event endpoint

type APIVersionNumber

type APIVersionNumber int

APIVersionNumber specifies the version of the Decision API to use