apis

Documentation

Index

• Variables
• func AddToQueryIfSet(q url.Values, key string, value string)
• func FirstNElementsOfSlice[Element any](slice []Element, n int) []Element
• func MapToCommaString[t any](slice []t) string
• type Call
  • func NewCall[responseType any](method string, url string) *Call[responseType]
  • func (a *Call[responseType]) Execute(httpClient HTTPClient) (*CallResponse[responseType], error)
  • func (a *Call[responseType]) WithBody(body []byte) *Call[responseType]
  • func (a *Call[responseType]) WithParseErrorListOnError() *Call[responseType]
  • func (a *Call[responseType]) WithQueryParams(queryParams url.Values) *Call[responseType]
  • func (a *Call[responseType]) WithRateLimit(callsPer float32, duration time.Duration) *Call[responseType]
  • func (a *Call[responseType]) WithRestrictedDataToken(token *string) *Call[responseType]
• type CallResponse
  • func (r *CallResponse[any]) ErrorsAsString() string
  • func (r *CallResponse[any]) IsError() bool
  • func (r *CallResponse[any]) IsSuccess() bool
• type Error
• type ErrorList
• type HTTPClient
• type JsonTimeISO8601
  • func (t JsonTimeISO8601) MarshalJSON() ([]byte, error)
  • func (t JsonTimeISO8601) String() string

Variables

var (
	ErrMaxRetryCountReached = fmt.Errorf("max retry count of %d reached", constants.MaxRetryCountOnTooManyRequestsError)
)

Functions

func AddToQueryIfSet

func AddToQueryIfSet(q url.Values, key string, value string)

func FirstNElementsOfSlice

func FirstNElementsOfSlice[Element any](slice []Element, n int) []Element

func MapToCommaString

func MapToCommaString[t any](slice []t) string

Types

type Call

type Call[responseType any] struct {
	Method                  string
	URL                     string
	QueryParams             url.Values
	Body                    []byte
	RestrictedDataToken     *string
	ParseErrorListOnError   bool
	WaitDurationOnRateLimit time.Duration
}

func NewCall

func NewCall[responseType any](method string, url string) *Call[responseType]

func (*Call[responseType]) Execute

func (a *Call[responseType]) Execute(httpClient HTTPClient) (*CallResponse[responseType], error)

Execute will return response object on success

func (*Call[responseType]) WithBody

func (a *Call[responseType]) WithBody(body []byte) *Call[responseType]

func (*Call[responseType]) WithParseErrorListOnError

func (a *Call[responseType]) WithParseErrorListOnError() *Call[responseType]

func (*Call[responseType]) WithQueryParams

func (a *Call[responseType]) WithQueryParams(queryParams url.Values) *Call[responseType]

func (*Call[responseType]) WithRateLimit

func (a *Call[responseType]) WithRateLimit(callsPer float32, duration time.Duration) *Call[responseType]

func (*Call[responseType]) WithRestrictedDataToken

func (a *Call[responseType]) WithRestrictedDataToken(token *string) *Call[responseType]

WithRestrictedDataToken is optional and can be passed to replace the existing accessToken

type CallResponse

type CallResponse[responseBodyType any] struct {
	Status       int
	ResponseBody *responseBodyType
	ErrorList    *ErrorList
}

func (*CallResponse[any]) ErrorsAsString

func (r *CallResponse[any]) ErrorsAsString() string

ErrorsAsString returns all errors as string or an empty string.

func (*CallResponse[any]) IsError

func (r *CallResponse[any]) IsError() bool

IsError checks if the status is in range 4xx - 5xx

func (*CallResponse[any]) IsSuccess

func (r *CallResponse[any]) IsSuccess() bool

IsSuccess checks if the status is in range 2xx

type Error

type Error struct {
	// An error code that identifies the type of error that occurred.
	Code string `json:"code"`
	// A message that describes the error condition in a human-readable form.
	Message string `json:"message"`
	// Additional details that can help the caller understand or fix the issue.
	Details *string `json:"details,omitempty"`
}

Error response returned when the request is unsuccessful.

type ErrorList

type ErrorList struct {
	Errors []Error `json:"errors"`
}

ErrorList A list of error responses returned when a request is unsuccessful.

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
	GetEndpoint() constants.Endpoint
	Close()
}

type JsonTimeISO8601

type JsonTimeISO8601 struct {
	time.Time
}

JsonTimeISO8601 marshals time.Time to ISO 8601 format

func (JsonTimeISO8601) MarshalJSON

func (t JsonTimeISO8601) MarshalJSON() ([]byte, error)

func (JsonTimeISO8601) String

func (t JsonTimeISO8601) String() string