client

Documentation

Index

• Constants
• func CreateBaseURL(subDomain string, apiVersion string, edge *string, region *string) string
• type APIClientConfig
  • func NewAPIClientConfig(config *Config) *APIClientConfig
• type Client
  • func New(sess *session.Session, config *APIClientConfig) *Client
  • func (c Client) GetRestyClient() *resty.Client
  • func (c Client) Send(context context.Context, op Operation, input interface{}, output interface{}) error
• type Config
• type Operation
• type RetryConfig

Constants

const (
	JSON       = "application/json"
	URLEncoded = "application/x-www-form-urlencoded"
	FormData   = "multipart/form-data"
)

Functions

func CreateBaseURL

func CreateBaseURL(subDomain string, apiVersion string, edge *string, region *string) string

Types

type APIClientConfig

type APIClientConfig struct {
	APIVersion   string
	Beta         bool
	DebugEnabled bool
	Edge         *string
	Region       *string
	RetryConfig  RetryConfig
	SubDomain    string
}

APIClientConfig is the internal definition for each sub client which is used to call the Twilio API's

func NewAPIClientConfig

func NewAPIClientConfig(config *Config) *APIClientConfig

NewAPIClientConfig is an internal function for creating a api client config struct using default and user defined config

type Client

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

func New

func New(sess *session.Session, config *APIClientConfig) *Client

func (Client) GetRestyClient

func (c Client) GetRestyClient() *resty.Client

Used for testing purposes only

func (Client) Send

func (c Client) Send(context context.Context, op Operation, input interface{}, output interface{}) error

type Config

type Config struct {
	BackoffInterval *int
	DebugEnabled    *bool
	Edge            *string
	Region          *string
	RetryAttempts   *int
}

Config is the user defined configuration for the Twilio Client. This can be used to enable debugging, configuring the number of retry attempts, setting the time in milliseconds between retry attempts, edge location and region details

type Operation

type Operation struct {
	OverrideBaseURL *string
	Method          string
	URI             string
	ContentType     string
	PathParams      map[string]string
	QueryParams     *url.Values
}

type RetryConfig

type RetryConfig struct {
	Attempts int
	WaitTime time.Duration
}

RetryConfig defines the retry configuration for the HTTP client