adminapi

Documentation

Index

• Constants
• func AdminPath(path string) string
• func AdminTokensURL() string
• type AdminToken
  • func ExchangeAuthorizationCode(ctx context.Context, code, codeVerifier, version string, debug bool) (AdminToken, error)
• type Client
  • func NewClientWithBaseURL(ctx context.Context, token, version string, debug bool, baseURL string) *Client
  • func NewClientWithContext(ctx context.Context, token, version string, debug bool) *Client
  • func (c *Client) Delete(path string, params url.Values) (json.RawMessage, error)
  • func (c *Client) Get(path string, params url.Values) (json.RawMessage, error)
  • func (c *Client) Post(path string, params url.Values) (json.RawMessage, error)
  • func (c *Client) PostJSON(path string, payload any) (json.RawMessage, error)
  • func (c *Client) Put(path string, params url.Values) (json.RawMessage, error)
  • func (c *Client) PutJSON(path string, payload any) (json.RawMessage, error)
  • func (c *Client) RevokeSelf() error
  • func (c *Client) SetDebugWriter(w io.Writer)
  • func (c *Client) Whoami() (WhoamiResponse, error)
• type TokenMetadata
• type WhoamiResponse

Constants

const (
	EnvAPIBaseURL = "GUMROAD_ADMIN_API_BASE_URL"
)

Functions

func AdminPath

func AdminPath(path string) string

AdminPath returns the absolute admin-prefixed path for path.

func AdminTokensURL

func AdminTokensURL() string

Types

type AdminToken

type AdminToken struct {
	Token           string            `json:"token"`
	TokenExternalID string            `json:"token_external_id"`
	Actor           adminconfig.Actor `json:"actor"`
	ExpiresAt       string            `json:"expires_at"`
}

func ExchangeAuthorizationCode

func ExchangeAuthorizationCode(ctx context.Context, code, codeVerifier, version string, debug bool) (AdminToken, error)

type Client

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

func NewClientWithBaseURL

func NewClientWithBaseURL(ctx context.Context, token, version string, debug bool, baseURL string) *Client

func NewClientWithContext

func NewClientWithContext(ctx context.Context, token, version string, debug bool) *Client

func (*Client) Delete

func (c *Client) Delete(path string, params url.Values) (json.RawMessage, error)

func (*Client) Get

func (c *Client) Get(path string, params url.Values) (json.RawMessage, error)

func (*Client) Post

func (c *Client) Post(path string, params url.Values) (json.RawMessage, error)

func (*Client) PostJSON

func (c *Client) PostJSON(path string, payload any) (json.RawMessage, error)

func (*Client) Put

func (c *Client) Put(path string, params url.Values) (json.RawMessage, error)

func (*Client) PutJSON

func (c *Client) PutJSON(path string, payload any) (json.RawMessage, error)

func (*Client) RevokeSelf

func (c *Client) RevokeSelf() error

func (*Client) SetDebugWriter

func (c *Client) SetDebugWriter(w io.Writer)

func (*Client) Whoami

func (c *Client) Whoami() (WhoamiResponse, error)

type TokenMetadata

type TokenMetadata struct {
	ExternalID string `json:"external_id"`
	ExpiresAt  string `json:"expires_at"`
}

type WhoamiResponse

type WhoamiResponse struct {
	Actor  adminconfig.Actor `json:"actor"`
	Token  TokenMetadata     `json:"token"`
	Scopes []string          `json:"scopes"`
}