client

Documentation

Index

• Constants
• Variables
• type SquareConnectAPI
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) *SquareConnectAPI
  • func NewHTTPClient(formats strfmt.Registry) *SquareConnectAPI
  • func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *SquareConnectAPI
  • func (c *SquareConnectAPI) SetTransport(transport runtime.ClientTransport)
• type TransportConfig
  • func DefaultTransportConfig() *TransportConfig
  • func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig
  • func (cfg *TransportConfig) WithHost(host string) *TransportConfig
  • func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

Constants

const (
	// DefaultHost is the default Host
	// found in Meta (info) section of spec file
	DefaultHost string = "connect.squareup.com"
	// DefaultBasePath is the default BasePath
	// found in Meta (info) section of spec file
	DefaultBasePath string = "/"
)

Variables

var Default = NewHTTPClient(nil)

Default square connect API HTTP client.

var DefaultSchemes = []string{"https"}

DefaultSchemes are the default schemes found in Meta (info) section of spec file

Types

type SquareConnectAPI

type SquareConnectAPI struct {
	ApplePay apple_pay.ClientService

	BankAccounts bank_accounts.ClientService

	Bookings bookings.ClientService

	CashDrawers cash_drawers.ClientService

	Catalog catalog.ClientService

	Checkout checkout.ClientService

	CustomerGroups customer_groups.ClientService

	CustomerSegments customer_segments.ClientService

	Customers customers.ClientService

	Devices devices.ClientService

	Disputes disputes.ClientService

	Employees employees.ClientService

	Inventory inventory.ClientService

	Invoices invoices.ClientService

	Labor labor.ClientService

	Locations locations.ClientService

	Loyalty loyalty.ClientService

	Merchants merchants.ClientService

	MobileAuthorization mobile_authorization.ClientService

	OAuth o_auth.ClientService

	Orders orders.ClientService

	Payments payments.ClientService

	Refunds refunds.ClientService

	Subscriptions subscriptions.ClientService

	Team team.ClientService

	Terminal terminal.ClientService

	Transactions transactions.ClientService

	Transport runtime.ClientTransport
}

SquareConnectAPI is a client for square connect API

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) *SquareConnectAPI

New creates a new square connect API client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *SquareConnectAPI

NewHTTPClient creates a new square connect API HTTP client.

func NewHTTPClientWithConfig

func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *SquareConnectAPI

NewHTTPClientWithConfig creates a new square connect API HTTP client, using a customizable transport config.

func (*SquareConnectAPI) SetTransport

func (c *SquareConnectAPI) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client and all its subresources

type TransportConfig

type TransportConfig struct {
	Host     string
	BasePath string
	Schemes  []string
}

TransportConfig contains the transport related info, found in the meta section of the spec file.

func DefaultTransportConfig

func DefaultTransportConfig() *TransportConfig

DefaultTransportConfig creates a TransportConfig with the default settings taken from the meta section of the spec file.

func (*TransportConfig) WithBasePath

func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig

WithBasePath overrides the default basePath, provided by the meta section of the spec file.

func (*TransportConfig) WithHost

func (cfg *TransportConfig) WithHost(host string) *TransportConfig

WithHost overrides the default host, provided by the meta section of the spec file.

func (*TransportConfig) WithSchemes

func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

WithSchemes overrides the default schemes, provided by the meta section of the spec file.