client

Documentation

Overview

Package client provides the base for all requests and responses to the Paddle API.

Index

• Variables
• func ContextWithTransitID(ctx context.Context, transitID string) context.Context
• func TransitIDFromContext(ctx context.Context) string
• type Client
  • func New(httpClient HTTPDoer, apiKey string, baseURL *url.URL) (*Client, error)
  • func (c *Client) Do(ctx context.Context, method, path string, src, dst any) (err error)
• type DirectiveInclude
  • func (*DirectiveInclude) Decode(_ *core.DirectiveRuntime) error
  • func (*DirectiveInclude) Encode(rtm *core.DirectiveRuntime) error
• type Doer
• type HTTPDoer
• type Wanter

Variables

var ErrDirectiveRequiresBool = errors.New("include directive requires a boolean value")

ErrDirectiveRequiresBool is returned when the directive's struct field is not a boolean.

Functions

func ContextWithTransitID

func ContextWithTransitID(ctx context.Context, transitID string) context.Context

ContextWithTransitID returns a new context with the provided transit ID.

func TransitIDFromContext

func TransitIDFromContext(ctx context.Context) string

TransitIDFromContext returns the transit ID from the provided context.

Types

type Client

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

Client provides the base for all requests and responses to the Paddle API.

func New

func New(httpClient HTTPDoer, apiKey string, baseURL *url.URL) (*Client, error)

New returns a new Client with the provided http.Client, apiKey, and baseURL.

func (*Client) Do

func (c *Client) Do(ctx context.Context, method, path string, src, dst any) (err error)

Do sends an API request and returns the API response. The src field is a request which contains `json` or `in` struct tags (see github.com/ggicci/httpin) and will be encoded as the request body. The dst field is a response which will be decoded from the response body. The dst field should be given as a pointer. If the src field is nil, no request body will be sent. If the dst field is nil, no response body will be decoded.

type DirectiveInclude

type DirectiveInclude struct{}

DirectiveInclude is a directive that adds the custom 'include' query parameter to the request, based on the value of the directive's struct field.

func (*DirectiveInclude) Decode

func (*DirectiveInclude) Decode(_ *core.DirectiveRuntime) error

Decode is not implemented. This is because we only deal with encoding concerns in the client.

func (*DirectiveInclude) Encode

func (*DirectiveInclude) Encode(rtm *core.DirectiveRuntime) error

Encode adds/appends the custom 'include' query parameter to the request. The value of the directive's struct field is expected to be a boolean. If the value is true, the directive's value query parameter 'include'. e.g.

type Request struct {
 IncludeCustomer bool `in:"paddle_include=customer"`
}

Req{IncludeCustomer: true} // ?paddle_include=customer

type Doer

type Doer interface {
	Do(ctx context.Context, method, path string, src, dst any) (err error)
}

Doer is an interface that expects the Do method for making API requests.

type HTTPDoer

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

HTTPDoer is an interface that expects the Do method for making HTTP requests.

type Wanter

type Wanter interface {
	Wants(Doer)
}

Wanter is an interface that can be implemented by a response struct. It is used to inject the client into to the response struct after a request has been successfully made.