bank_accounts

package
v0.0.0-...-dc3cc4a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 30, 2021 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

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

Client for bank accounts API

func (*Client) GetBankAccount

func (a *Client) GetBankAccount(params *GetBankAccountParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetBankAccountOK, error)
GetBankAccount gets bank account

Returns details of a [BankAccount](#type-bankaccount)

linked to a Square account.

func (*Client) GetBankAccountByV1ID

func (a *Client) GetBankAccountByV1ID(params *GetBankAccountByV1IDParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetBankAccountByV1IDOK, error)

GetBankAccountByV1ID gets bank account by v1 Id

Returns details of a [BankAccount](#type-bankaccount) identified by V1 bank account ID.

func (*Client) ListBankAccounts

func (a *Client) ListBankAccounts(params *ListBankAccountsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListBankAccountsOK, error)

ListBankAccounts lists bank accounts

Returns a list of [BankAccount](#type-bankaccount) objects linked to a Square account.

func (*Client) SetTransport

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type ClientOption

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService

type ClientService interface {
	GetBankAccount(params *GetBankAccountParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetBankAccountOK, error)

	GetBankAccountByV1ID(params *GetBankAccountByV1IDParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetBankAccountByV1IDOK, error)

	ListBankAccounts(params *ListBankAccountsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListBankAccountsOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New

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

New creates a new bank accounts API client.

type GetBankAccountByV1IDOK

type GetBankAccountByV1IDOK struct {
	Payload *models.GetBankAccountByV1IDResponse
}
GetBankAccountByV1IDOK describes a response with status code 200, with default header values.

Success

func NewGetBankAccountByV1IDOK

func NewGetBankAccountByV1IDOK() *GetBankAccountByV1IDOK

NewGetBankAccountByV1IDOK creates a GetBankAccountByV1IDOK with default headers values

func (*GetBankAccountByV1IDOK) Error

func (o *GetBankAccountByV1IDOK) Error() string

func (*GetBankAccountByV1IDOK) GetPayload

type GetBankAccountByV1IDParams

type GetBankAccountByV1IDParams struct {

	/* V1BankAccountID.

	     Connect V1 ID of the desired `BankAccount`. For more information, see
	[Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api).
	*/
	V1BankAccountID string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetBankAccountByV1IDParams contains all the parameters to send to the API endpoint

for the get bank account by v1 Id operation.

Typically these are written to a http.Request.

func NewGetBankAccountByV1IDParams

func NewGetBankAccountByV1IDParams() *GetBankAccountByV1IDParams

NewGetBankAccountByV1IDParams creates a new GetBankAccountByV1IDParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetBankAccountByV1IDParamsWithContext

func NewGetBankAccountByV1IDParamsWithContext(ctx context.Context) *GetBankAccountByV1IDParams

NewGetBankAccountByV1IDParamsWithContext creates a new GetBankAccountByV1IDParams object with the ability to set a context for a request.

func NewGetBankAccountByV1IDParamsWithHTTPClient

func NewGetBankAccountByV1IDParamsWithHTTPClient(client *http.Client) *GetBankAccountByV1IDParams

NewGetBankAccountByV1IDParamsWithHTTPClient creates a new GetBankAccountByV1IDParams object with the ability to set a custom HTTPClient for a request.

func NewGetBankAccountByV1IDParamsWithTimeout

func NewGetBankAccountByV1IDParamsWithTimeout(timeout time.Duration) *GetBankAccountByV1IDParams

NewGetBankAccountByV1IDParamsWithTimeout creates a new GetBankAccountByV1IDParams object with the ability to set a timeout on a request.

func (*GetBankAccountByV1IDParams) SetContext

func (o *GetBankAccountByV1IDParams) SetContext(ctx context.Context)

SetContext adds the context to the get bank account by v1 Id params

func (*GetBankAccountByV1IDParams) SetDefaults

func (o *GetBankAccountByV1IDParams) SetDefaults()

SetDefaults hydrates default values in the get bank account by v1 Id params (not the query body).

All values with no default are reset to their zero value.

func (*GetBankAccountByV1IDParams) SetHTTPClient

func (o *GetBankAccountByV1IDParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get bank account by v1 Id params

func (*GetBankAccountByV1IDParams) SetTimeout

func (o *GetBankAccountByV1IDParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get bank account by v1 Id params

func (*GetBankAccountByV1IDParams) SetV1BankAccountID

func (o *GetBankAccountByV1IDParams) SetV1BankAccountID(v1BankAccountID string)

SetV1BankAccountID adds the v1BankAccountId to the get bank account by v1 Id params

func (*GetBankAccountByV1IDParams) WithContext

WithContext adds the context to the get bank account by v1 Id params

func (*GetBankAccountByV1IDParams) WithDefaults

WithDefaults hydrates default values in the get bank account by v1 Id params (not the query body).

All values with no default are reset to their zero value.

func (*GetBankAccountByV1IDParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the get bank account by v1 Id params

func (*GetBankAccountByV1IDParams) WithTimeout

WithTimeout adds the timeout to the get bank account by v1 Id params

func (*GetBankAccountByV1IDParams) WithV1BankAccountID

func (o *GetBankAccountByV1IDParams) WithV1BankAccountID(v1BankAccountID string) *GetBankAccountByV1IDParams

WithV1BankAccountID adds the v1BankAccountID to the get bank account by v1 Id params

func (*GetBankAccountByV1IDParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type GetBankAccountByV1IDReader

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

GetBankAccountByV1IDReader is a Reader for the GetBankAccountByV1ID structure.

func (*GetBankAccountByV1IDReader) ReadResponse

func (o *GetBankAccountByV1IDReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetBankAccountOK

type GetBankAccountOK struct {
	Payload *models.GetBankAccountResponse
}
GetBankAccountOK describes a response with status code 200, with default header values.

Success

func NewGetBankAccountOK

func NewGetBankAccountOK() *GetBankAccountOK

NewGetBankAccountOK creates a GetBankAccountOK with default headers values

func (*GetBankAccountOK) Error

func (o *GetBankAccountOK) Error() string

func (*GetBankAccountOK) GetPayload

type GetBankAccountParams

type GetBankAccountParams struct {

	/* BankAccountID.

	   Square-issued ID of the desired `BankAccount`.
	*/
	BankAccountID string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetBankAccountParams contains all the parameters to send to the API endpoint

for the get bank account operation.

Typically these are written to a http.Request.

func NewGetBankAccountParams

func NewGetBankAccountParams() *GetBankAccountParams

NewGetBankAccountParams creates a new GetBankAccountParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetBankAccountParamsWithContext

func NewGetBankAccountParamsWithContext(ctx context.Context) *GetBankAccountParams

NewGetBankAccountParamsWithContext creates a new GetBankAccountParams object with the ability to set a context for a request.

func NewGetBankAccountParamsWithHTTPClient

func NewGetBankAccountParamsWithHTTPClient(client *http.Client) *GetBankAccountParams

NewGetBankAccountParamsWithHTTPClient creates a new GetBankAccountParams object with the ability to set a custom HTTPClient for a request.

func NewGetBankAccountParamsWithTimeout

func NewGetBankAccountParamsWithTimeout(timeout time.Duration) *GetBankAccountParams

NewGetBankAccountParamsWithTimeout creates a new GetBankAccountParams object with the ability to set a timeout on a request.

func (*GetBankAccountParams) SetBankAccountID

func (o *GetBankAccountParams) SetBankAccountID(bankAccountID string)

SetBankAccountID adds the bankAccountId to the get bank account params

func (*GetBankAccountParams) SetContext

func (o *GetBankAccountParams) SetContext(ctx context.Context)

SetContext adds the context to the get bank account params

func (*GetBankAccountParams) SetDefaults

func (o *GetBankAccountParams) SetDefaults()

SetDefaults hydrates default values in the get bank account params (not the query body).

All values with no default are reset to their zero value.

func (*GetBankAccountParams) SetHTTPClient

func (o *GetBankAccountParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get bank account params

func (*GetBankAccountParams) SetTimeout

func (o *GetBankAccountParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get bank account params

func (*GetBankAccountParams) WithBankAccountID

func (o *GetBankAccountParams) WithBankAccountID(bankAccountID string) *GetBankAccountParams

WithBankAccountID adds the bankAccountID to the get bank account params

func (*GetBankAccountParams) WithContext

WithContext adds the context to the get bank account params

func (*GetBankAccountParams) WithDefaults

func (o *GetBankAccountParams) WithDefaults() *GetBankAccountParams

WithDefaults hydrates default values in the get bank account params (not the query body).

All values with no default are reset to their zero value.

func (*GetBankAccountParams) WithHTTPClient

func (o *GetBankAccountParams) WithHTTPClient(client *http.Client) *GetBankAccountParams

WithHTTPClient adds the HTTPClient to the get bank account params

func (*GetBankAccountParams) WithTimeout

func (o *GetBankAccountParams) WithTimeout(timeout time.Duration) *GetBankAccountParams

WithTimeout adds the timeout to the get bank account params

func (*GetBankAccountParams) WriteToRequest

func (o *GetBankAccountParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type GetBankAccountReader

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

GetBankAccountReader is a Reader for the GetBankAccount structure.

func (*GetBankAccountReader) ReadResponse

func (o *GetBankAccountReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type ListBankAccountsOK

type ListBankAccountsOK struct {
	Payload *models.ListBankAccountsResponse
}
ListBankAccountsOK describes a response with status code 200, with default header values.

Success

func NewListBankAccountsOK

func NewListBankAccountsOK() *ListBankAccountsOK

NewListBankAccountsOK creates a ListBankAccountsOK with default headers values

func (*ListBankAccountsOK) Error

func (o *ListBankAccountsOK) Error() string

func (*ListBankAccountsOK) GetPayload

type ListBankAccountsParams

type ListBankAccountsParams struct {

	/* Cursor.

	     The pagination cursor returned by a previous call to this endpoint.
	Use it in the next `ListBankAccounts` request to retrieve the next set
	of results.

	See the [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) guide for more information.
	*/
	Cursor *string

	/* Limit.

	     Upper limit on the number of bank accounts to return in the response.
	Currently, 1000 is the largest supported limit. You can specify a limit
	of up to 1000 bank accounts. This is also the default limit.
	*/
	Limit *int64

	/* LocationID.

	     Location ID. You can specify this optional filter
	to retrieve only the linked bank accounts belonging to a specific location.
	*/
	LocationID *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

ListBankAccountsParams contains all the parameters to send to the API endpoint

for the list bank accounts operation.

Typically these are written to a http.Request.

func NewListBankAccountsParams

func NewListBankAccountsParams() *ListBankAccountsParams

NewListBankAccountsParams creates a new ListBankAccountsParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewListBankAccountsParamsWithContext

func NewListBankAccountsParamsWithContext(ctx context.Context) *ListBankAccountsParams

NewListBankAccountsParamsWithContext creates a new ListBankAccountsParams object with the ability to set a context for a request.

func NewListBankAccountsParamsWithHTTPClient

func NewListBankAccountsParamsWithHTTPClient(client *http.Client) *ListBankAccountsParams

NewListBankAccountsParamsWithHTTPClient creates a new ListBankAccountsParams object with the ability to set a custom HTTPClient for a request.

func NewListBankAccountsParamsWithTimeout

func NewListBankAccountsParamsWithTimeout(timeout time.Duration) *ListBankAccountsParams

NewListBankAccountsParamsWithTimeout creates a new ListBankAccountsParams object with the ability to set a timeout on a request.

func (*ListBankAccountsParams) SetContext

func (o *ListBankAccountsParams) SetContext(ctx context.Context)

SetContext adds the context to the list bank accounts params

func (*ListBankAccountsParams) SetCursor

func (o *ListBankAccountsParams) SetCursor(cursor *string)

SetCursor adds the cursor to the list bank accounts params

func (*ListBankAccountsParams) SetDefaults

func (o *ListBankAccountsParams) SetDefaults()

SetDefaults hydrates default values in the list bank accounts params (not the query body).

All values with no default are reset to their zero value.

func (*ListBankAccountsParams) SetHTTPClient

func (o *ListBankAccountsParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the list bank accounts params

func (*ListBankAccountsParams) SetLimit

func (o *ListBankAccountsParams) SetLimit(limit *int64)

SetLimit adds the limit to the list bank accounts params

func (*ListBankAccountsParams) SetLocationID

func (o *ListBankAccountsParams) SetLocationID(locationID *string)

SetLocationID adds the locationId to the list bank accounts params

func (*ListBankAccountsParams) SetTimeout

func (o *ListBankAccountsParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the list bank accounts params

func (*ListBankAccountsParams) WithContext

WithContext adds the context to the list bank accounts params

func (*ListBankAccountsParams) WithCursor

func (o *ListBankAccountsParams) WithCursor(cursor *string) *ListBankAccountsParams

WithCursor adds the cursor to the list bank accounts params

func (*ListBankAccountsParams) WithDefaults

WithDefaults hydrates default values in the list bank accounts params (not the query body).

All values with no default are reset to their zero value.

func (*ListBankAccountsParams) WithHTTPClient

func (o *ListBankAccountsParams) WithHTTPClient(client *http.Client) *ListBankAccountsParams

WithHTTPClient adds the HTTPClient to the list bank accounts params

func (*ListBankAccountsParams) WithLimit

func (o *ListBankAccountsParams) WithLimit(limit *int64) *ListBankAccountsParams

WithLimit adds the limit to the list bank accounts params

func (*ListBankAccountsParams) WithLocationID

func (o *ListBankAccountsParams) WithLocationID(locationID *string) *ListBankAccountsParams

WithLocationID adds the locationID to the list bank accounts params

func (*ListBankAccountsParams) WithTimeout

WithTimeout adds the timeout to the list bank accounts params

func (*ListBankAccountsParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type ListBankAccountsReader

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

ListBankAccountsReader is a Reader for the ListBankAccounts structure.

func (*ListBankAccountsReader) ReadResponse

func (o *ListBankAccountsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL