stripeauth

Documentation

Index

• type Client
  • func NewClient(client stripe.RequestPerformer, cfg *Config) *Client
  • func (c *Client) Authorize(ctx context.Context, req CreateSessionRequest) (*StripeCLISession, error)
• type Config
• type CreateSessionRequest
• type DeviceURLMap
• type StripeCLISession

Types

type Client

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

Client is the client used to initiate new CLI sessions with Stripe.

func NewClient

func NewClient(client stripe.RequestPerformer, cfg *Config) *Client

NewClient returns a new Client.

func (*Client) Authorize

func (c *Client) Authorize(ctx context.Context, req CreateSessionRequest) (*StripeCLISession, error)

Authorize sends a request to Stripe to initiate a new CLI session.

type Config

type Config struct {
	Log *log.Logger
}

Config contains the optional configuration parameters of a Client.

type CreateSessionRequest

type CreateSessionRequest struct {
	DeviceName        string
	WebSocketFeatures []string

	Filters      *string
	DeviceURLMap *DeviceURLMap
}

CreateSessionRequest defines the API input parameters for client.Authorize.

type DeviceURLMap

type DeviceURLMap struct {
	ForwardURL        string
	ForwardConnectURL string
}

DeviceURLMap is a mapping of the urls that the device is listening for forwarded events on.

type StripeCLISession

type StripeCLISession struct {
	DisplayConnectFilterWarning bool   `json:"display_connect_filter_warning"`
	ReconnectDelay              int    `json:"reconnect_delay"`
	Secret                      string `json:"secret"`
	WebSocketAuthorizedFeature  string `json:"websocket_authorized_feature"`
	WebSocketID                 string `json:"websocket_id"`
	WebSocketURL                string `json:"websocket_url"`
	DefaultVersion              string `json:"default_version"`
	LatestVersion               string `json:"latest_version"`
}

StripeCLISession is the API resource returned by Stripe when initiating a new CLI session.