Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

instantly

package module

Go to main page

Versions in this module

v0

v0.2.1

Oct 17, 2026

v0.2.0

Aug 3, 2026

Changes in this version

+ func DeleteResult[T any](ctx context.Context, c *Client, path string) (*T, error)

+ func GetResult[T any](ctx context.Context, c *Client, path string) (*T, error)

+ func JoinPath(base string, segments ...string) string

+ func Paginate[T any, O ~func(*Query)](ctx context.Context, opts []O, withCursor func(string) O, ...) iter.Seq2[*T, error]

+ func PatchResult[T any](ctx context.Context, c *Client, path string, payload any) (*T, error)

+ func PostResult[T any](ctx context.Context, c *Client, path string, payload any) (*T, error)

+ type CountResponse struct

+ Count int64

+ type Page struct

+ Items []T

+ NextStartingAfter string

type Query

+ func ApplyOptions[O ~func(*Query)](opts ...O) *Query

v0.1.0

Aug 2, 2026

Changes in this version

+ const ErrCodeAccountAuthError

+ const ErrCodeAccountNotFound

+ const ErrCodeAccountUnknownError

+ func BuildPath(base string, values url.Values) string

+ func Iterate[T any](ctx context.Context, fetch FetchPage[T]) iter.Seq2[*T, error]

+ func Ptr[T any](v T) *T

+ type APIError struct

+ Code string

+ Message string

+ StatusCode int64

+ func (e *APIError) Error() string

+ type Client struct

+ func NewClient(apiKey string, opts ...ClientOption) *Client

+ func (c *Client) Delete(ctx context.Context, path string, out any) error

+ func (c *Client) Do(ctx context.Context, method, path string, payload, out any) error

+ func (c *Client) DoRaw(ctx context.Context, method, path string, payload any) ([]byte, error)

+ func (c *Client) Get(ctx context.Context, path string, out any) error

+ func (c *Client) Patch(ctx context.Context, path string, payload, out any) error

+ func (c *Client) Post(ctx context.Context, path string, payload, out any) error

+ func (c *Client) Put(ctx context.Context, path string, payload, out any) error

+ type ClientOption func(*Client)

+ func WithBaseURL(baseURL string) ClientOption

+ func WithHTTPClient(httpClient *http.Client) ClientOption

+ func WithHTTPHeader(key, value string) ClientOption

+ func WithUserAgent(userAgent string) ClientOption

+ type FetchPage func(ctx context.Context, cursor string) (items []T, next string, err error)

+ type Query struct

+ func NewQuery() *Query

+ func SetEnum[E ~string](q *Query, key string, value E) *Query

+ func (q *Query) AddString(key, value string) *Query

+ func (q *Query) Encode() string

+ func (q *Query) Get(key string) string

+ func (q *Query) Len() int

+ func (q *Query) Path(base string) string

+ func (q *Query) SetBool(key string, value bool) *Query

+ func (q *Query) SetInt(key string, value int) *Query

+ func (q *Query) SetString(key, value string) *Query

+ type SortOrder string

+ const SortOrderAsc

+ const SortOrderDesc