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 CallParams ¶ added in v0.0.35

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

CallParams represents the parameters used to issue an API call.

type Caller ¶ added in v0.0.35

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

Caller calls APIs and deserializes their response, if any.

func NewCaller(client HTTPClient) *Caller

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

type ClientOption ¶

type ClientOption func(*ClientOptions)

ClientOption adapts the behavior of the generated client.

type ClientOptions ¶

type ClientOptions struct {
	BaseURL    string
	HTTPClient HTTPClient
	HTTPHeader http.Header
	ApiKey     string
}

ClientOptions defines all of the possible client options. This type is primarily used by the generated code and is not meant to be used directly; use ClientOption instead.

func NewClientOptions() *ClientOptions

func (c *ClientOptions) ToHeader() http.Header

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 Optional ¶ added in v0.0.28

type Optional[T any] struct {
	Value T
	Null  bool
}

Optional is a wrapper used to distinguish zero values from null or omitted fields.

To instantiate an Optional, use the `Optional()` and `Null()` helpers exported from the root package.

func (o *Optional[T]) MarshalJSON() ([]byte, error)

func (o *Optional[T]) String() string