core

type APIError ¶

type APIError struct {
	StatusCode int `json:"-"`
	// contains filtered or unexported fields
}

APIError is a lightweight wrapper around the standard error interface that preserves the status code from the RPC, if any.

func NewAPIError(statusCode int, err error) *APIError

func (a *APIError) Error() string

func (a *APIError) Unwrap() error

type BaseURLOption ¶ added in v2.5.2

type BaseURLOption struct {
	BaseURL string
}

BaseURLOption implements the RequestOption interface.

type CallParams ¶

type CallParams struct {
	URL                string
	Method             string
	MaxAttempts        uint
	Headers            http.Header
	Client             HTTPClient
	Request            interface{}
	Response           interface{}
	ResponseIsOptional bool
	ErrorDecoder       ErrorDecoder
}

CallParams represents the parameters used to issue an API call.

type Caller ¶

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

Caller calls APIs and deserializes their response, if any.

func NewCaller(params *CallerParams) *Caller

func (c *Caller) Call(ctx context.Context, params *CallParams) error

type CallerParams ¶ added in v2.5.2

type CallerParams struct {
	Client      HTTPClient
	MaxAttempts uint
}

CallerParams represents the parameters used to constrcut a new *Caller.

type ClientNameOption ¶ added in v2.5.2

type ClientNameOption struct {
	ClientName *string
}

ClientNameOption implements the RequestOption interface.

type Date ¶ added in v2.6.0

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

DateTime wraps time.Time and adapts its JSON representation to conform to a RFC3339 date (e.g. 2006-01-02).

Ref: https://ijmacd.github.io/rfc3339-iso8601

func NewDate(t time.Time) *Date

func NewOptionalDate(t *time.Time) *Date

func (d *Date) MarshalJSON() ([]byte, error)

func (d *Date) Time() time.Time

func (d *Date) TimePtr() *time.Time

func (d *Date) UnmarshalJSON(data []byte) error

type DateTime ¶ added in v2.6.0

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

DateTime wraps time.Time and adapts its JSON representation to conform to a RFC3339 date-time (e.g. 2017-07-21T17:32:28Z).

Ref: https://ijmacd.github.io/rfc3339-iso8601

func NewDateTime(t time.Time) *DateTime

func NewOptionalDateTime(t *time.Time) *DateTime

func (d *DateTime) MarshalJSON() ([]byte, error)

func (d *DateTime) Time() time.Time

func (d *DateTime) TimePtr() *time.Time

func (d *DateTime) UnmarshalJSON(data []byte) error

type ErrorDecoder ¶

type ErrorDecoder func(statusCode int, body io.Reader) error

ErrorDecoder decodes *http.Response errors and returns a typed API error (e.g. *APIError).

type HTTPClient ¶

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

HTTPClient is an interface for a subset of the *http.Client.

type HTTPClientOption ¶ added in v2.5.2

type HTTPClientOption struct {
	HTTPClient HTTPClient
}

HTTPClientOption implements the RequestOption interface.

type HTTPHeaderOption ¶ added in v2.5.2

type HTTPHeaderOption struct {
	HTTPHeader http.Header
}

HTTPHeaderOption implements the RequestOption interface.

type MaxAttemptsOption ¶ added in v2.5.2

type MaxAttemptsOption struct {
	MaxAttempts uint
}

MaxAttemptsOption implements the RequestOption interface.

type QueryEncoder ¶ added in v2.5.2

type QueryEncoder interface {
	EncodeQueryValues(key string, v *url.Values) error
}

QueryEncoder is an interface implemented by any type that wishes to encode itself into URL values in a non-standard way.

type RequestOption ¶ added in v2.5.2

type RequestOption interface {
	// contains filtered or unexported methods
}

RequestOption adapts the behavior of the client or an individual request.

type RequestOptions ¶ added in v2.5.2

type RequestOptions struct {
	BaseURL     string
	HTTPClient  HTTPClient
	HTTPHeader  http.Header
	MaxAttempts uint
	Token       string
	ClientName  *string
}

RequestOptions defines all of the possible request options.

This type is primarily used by the generated code and is not meant to be used directly; use the option package instead.

func NewRequestOptions(opts ...RequestOption) *RequestOptions

func (r *RequestOptions) ToHeader() http.Header

type Retrier ¶ added in v2.5.2

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

Retrier retries failed requests a configurable number of times with an exponential back-off between each retry.

func NewRetrier(opts ...RetryOption) *Retrier

func (r *Retrier) Run(
	fn RetryFunc,
	request *http.Request,
	errorDecoder ErrorDecoder,
	opts ...RetryOption,
) (*http.Response, error)

type RetryFunc ¶ added in v2.5.2

type RetryFunc func(*http.Request) (*http.Response, error)

RetryFunc is a retriable HTTP function call (i.e. *http.Client.Do).

type RetryOption ¶ added in v2.5.2

type RetryOption func(*retryOptions)

RetryOption adapts the behavior the *Retrier.

func WithMaxAttempts(attempts uint) RetryOption

type Stream ¶

type Stream[T any] struct {
	// contains filtered or unexported fields
}

Stream represents a stream of messages sent from a server.

func NewStream[T any](response *http.Response, opts ...StreamOption) *Stream[T]

func (s Stream[T]) Close() error

func (s Stream[T]) Recv() (T, error)

type StreamOption ¶

type StreamOption func(*streamOptions)

StreamOption adapts the behavior of the Stream.

func WithDelimiter(delimiter string) StreamOption

type StreamParams ¶

type StreamParams struct {
	URL          string
	Method       string
	Delimiter    string
	MaxAttempts  uint
	Headers      http.Header
	Client       HTTPClient
	Request      interface{}
	ErrorDecoder ErrorDecoder
}

StreamParams represents the parameters used to issue an API streaming call.

type Streamer ¶

type Streamer[T any] struct {
	// contains filtered or unexported fields
}

Streamer calls APIs and streams responses using a *Stream.

func NewStreamer[T any](caller *Caller) *Streamer[T]

func (s *Streamer[T]) Stream(ctx context.Context, params *StreamParams) (*Stream[T], error)

type TokenOption ¶ added in v2.5.2

type TokenOption struct {
	Token string
}

TokenOption implements the RequestOption interface.