client

Documentation

Index

• Constants
• Variables
• type Form3PublicAPI
  • func New(transport runtime.ClientTransport, formats strfmt.Registry, ...) *Form3PublicAPI
  • func (c *Form3PublicAPI) 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 DefaultSchemes = []string{"https"}

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

Types

type Form3PublicAPI

type Form3PublicAPI struct {
	Ace *a_c_e.Client

	AccountAmendment *account_amendment.Client

	AccountIdentification *account_identification.Client

	AccountRequest *account_request.Client

	AccountValidation *account_validation.Client

	Accounts *accounts.Client

	Audit *audit.Client

	Claims *claims.Client

	DirectDebits *direct_debits.Client

	GoSubscriptionAPI *go_subscription_api.Client

	LhvGateway *lhv_gateway.Client

	Mandates *mandates.Client

	MetricsAPI *metrics_api.Client

	NameVerificationAPI *name_verification_api.Client

	Oauth2 *oauth2.Client

	Organisations *organisations.Client

	Payments *payments.Client

	Platformsecurityapi *platformsecurityapi.Client

	QueryAPI *query_api.Client

	Reports *reports.Client

	Roles *roles.Client

	SchemeFileAPI *scheme_file_api.Client

	SchemeMessages *scheme_messages.Client

	Subscriptions *subscriptions.Client

	TransactionFileAPI *transaction_file_api.Client

	Users *users.Client

	Transport runtime.ClientTransport
}

Form3PublicAPI is a client for form3 public API

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry, defaults client.Defaults) *Form3PublicAPI

New creates a new form3 public API client

func (*Form3PublicAPI) SetTransport

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