api

Documentation

Index

• Constants
• Variables
• type AuthenticationRequestPayload
• type AuthenticationType
  • func (authenticationType AuthenticationType) Route() string
• type Client
  • func NewAPIClientFromAuthentication(storeConfig *StoreConfig, payload AuthenticationRequestPayload, ...) (*Client, error)
  • func NewAPIClientFromIntegration(storeConfig *StoreConfig, bearer string) (*Client, error)
  • func NewAPIClientWithoutAuthentication(storeConfig *StoreConfig) *Client
  • func (c *Client) GetRouteAndDecode(route string, target interface{}, tryTo string) error
  • func (c *Client) PostRouteAndDecode(route string, body, target interface{}, tryTo string) error
• type StoreConfig

Constants

const (
	RetryAttemps        = 3
	RetryWaitSeconds    = 5
	RetryMaxWaitSeconds = 20
)

Variables

var ErrNoPointer = fmt.Errorf("target interface must be a pointer")

Types

type AuthenticationRequestPayload

type AuthenticationRequestPayload struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

type AuthenticationType

type AuthenticationType int

const (
	Customer AuthenticationType = iota
	Administrator
)

func (AuthenticationType) Route

func (authenticationType AuthenticationType) Route() string

type Client

type Client struct {
	HTTPClient *resty.Client
}

func NewAPIClientFromAuthentication

func NewAPIClientFromAuthentication(storeConfig *StoreConfig, payload AuthenticationRequestPayload, authenticationType AuthenticationType) (*Client, error)

func NewAPIClientFromIntegration

func NewAPIClientFromIntegration(storeConfig *StoreConfig, bearer string) (*Client, error)

func NewAPIClientWithoutAuthentication

func NewAPIClientWithoutAuthentication(storeConfig *StoreConfig) *Client

func (*Client) GetRouteAndDecode

func (c *Client) GetRouteAndDecode(route string, target interface{}, tryTo string) error

func (*Client) PostRouteAndDecode

func (c *Client) PostRouteAndDecode(route string, body, target interface{}, tryTo string) error

type StoreConfig

type StoreConfig struct {
	Scheme    string
	HostName  string
	StoreCode string
}