client

Documentation

Index

• Constants
• Variables
• type Form3CorelibDataStructures
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) *Form3CorelibDataStructures
  • func NewHTTPClient(formats strfmt.Registry) *Form3CorelibDataStructures
  • func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *Form3CorelibDataStructures
  • func (c *Form3CorelibDataStructures) 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 = "api.form3.tech"
	// DefaultBasePath is the default BasePath
	// found in Meta (info) section of spec file
	DefaultBasePath string = "/v1"
)

Variables

var Default = NewHTTPClient(nil)

Default form3 corelib data structures HTTP client.

var DefaultSchemes = []string{"https"}

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

Types

type Form3CorelibDataStructures

type Form3CorelibDataStructures struct {
	AccountRoutings account_routings.ClientService

	Accounts accounts.ClientService

	Ace ace.ClientService

	Admins admins.ClientService

	Associations associations.ClientService

	DirectDebits direct_debits.ClientService

	Limits limits.ClientService

	Mandates mandates.ClientService

	Organisations organisations.ClientService

	PaymentDefaults payment_defaults.ClientService

	Payments payments.ClientService

	Roles roles.ClientService

	Subscriptions subscriptions.ClientService

	System system.ClientService

	Users users.ClientService

	Transport runtime.ClientTransport
}

Form3CorelibDataStructures is a client for form3 corelib data structures

func New

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

New creates a new form3 corelib data structures client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *Form3CorelibDataStructures

NewHTTPClient creates a new form3 corelib data structures HTTP client.

func NewHTTPClientWithConfig

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

NewHTTPClientWithConfig creates a new form3 corelib data structures HTTP client, using a customizable transport config.

func (*Form3CorelibDataStructures) SetTransport

func (c *Form3CorelibDataStructures) 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.