financial_commitments

package
v0.0.36 Latest Latest
Warning

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

 Go to latest Published: Aug 28, 2024 License: MIT Imports: 12 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 financial commitments API

func (*Client) GetFinancialCommitments 

func (a *Client) GetFinancialCommitments(params *GetFinancialCommitmentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetFinancialCommitmentsOK, error)

GetFinancialCommitments Return all FinancialCommitments.

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 may be used to customize the behavior of Client methods.

type ClientService 

type ClientService interface {
	GetFinancialCommitments(params *GetFinancialCommitmentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetFinancialCommitmentsOK, 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 financial commitments API client.

func NewClientWithBasicAuth added in v0.0.33 

func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService

New creates a new financial commitments API client with basic auth credentials. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - user: user for basic authentication header. - password: password for basic authentication header.

func NewClientWithBearerToken added in v0.0.33 

func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService

New creates a new financial commitments API client with a bearer token for authentication. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - bearerToken: bearer token for Bearer authentication header.

type GetFinancialCommitmentsOK 

type GetFinancialCommitmentsOK struct {
	Payload *models.FinancialCommitments
}

GetFinancialCommitmentsOK describes a response with status code 200, with default header values.

GetFinancialCommitmentsOK get financial commitments o k

func NewGetFinancialCommitmentsOK 

func NewGetFinancialCommitmentsOK() *GetFinancialCommitmentsOK

NewGetFinancialCommitmentsOK creates a GetFinancialCommitmentsOK with default headers values

func (*GetFinancialCommitmentsOK) Code 

func (o *GetFinancialCommitmentsOK) Code() int

Code gets the status code for the get financial commitments o k response

func (*GetFinancialCommitmentsOK) Error 

func (o *GetFinancialCommitmentsOK) Error() string

func (*GetFinancialCommitmentsOK) GetPayload 

func (o *GetFinancialCommitmentsOK) GetPayload() *models.FinancialCommitments

func (*GetFinancialCommitmentsOK) IsClientError 

func (o *GetFinancialCommitmentsOK) IsClientError() bool

IsClientError returns true when this get financial commitments o k response has a 4xx status code

func (*GetFinancialCommitmentsOK) IsCode 

func (o *GetFinancialCommitmentsOK) IsCode(code int) bool

IsCode returns true when this get financial commitments o k response a status code equal to that given

func (*GetFinancialCommitmentsOK) IsRedirect 

func (o *GetFinancialCommitmentsOK) IsRedirect() bool

IsRedirect returns true when this get financial commitments o k response has a 3xx status code

func (*GetFinancialCommitmentsOK) IsServerError 

func (o *GetFinancialCommitmentsOK) IsServerError() bool

IsServerError returns true when this get financial commitments o k response has a 5xx status code

func (*GetFinancialCommitmentsOK) IsSuccess 

func (o *GetFinancialCommitmentsOK) IsSuccess() bool

IsSuccess returns true when this get financial commitments o k response has a 2xx status code

func (*GetFinancialCommitmentsOK) String 

func (o *GetFinancialCommitmentsOK) String() string

type GetFinancialCommitmentsParams 

type GetFinancialCommitmentsParams struct {

	/* Limit.

	   The amount of results to return. The maximum is 1000.

	   Format: int32
	*/
	Limit *int32

	/* Page.

	   The page of results to return.

	   Format: int32
	*/
	Page *int32

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

GetFinancialCommitmentsParams contains all the parameters to send to the API endpoint 

for the get financial commitments operation.

Typically these are written to a http.Request.

func NewGetFinancialCommitmentsParams 

func NewGetFinancialCommitmentsParams() *GetFinancialCommitmentsParams

NewGetFinancialCommitmentsParams creates a new GetFinancialCommitmentsParams 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 NewGetFinancialCommitmentsParamsWithContext 

func NewGetFinancialCommitmentsParamsWithContext(ctx context.Context) *GetFinancialCommitmentsParams

NewGetFinancialCommitmentsParamsWithContext creates a new GetFinancialCommitmentsParams object with the ability to set a context for a request.

func NewGetFinancialCommitmentsParamsWithHTTPClient 

func NewGetFinancialCommitmentsParamsWithHTTPClient(client *http.Client) *GetFinancialCommitmentsParams

NewGetFinancialCommitmentsParamsWithHTTPClient creates a new GetFinancialCommitmentsParams object with the ability to set a custom HTTPClient for a request.

func NewGetFinancialCommitmentsParamsWithTimeout 

func NewGetFinancialCommitmentsParamsWithTimeout(timeout time.Duration) *GetFinancialCommitmentsParams

NewGetFinancialCommitmentsParamsWithTimeout creates a new GetFinancialCommitmentsParams object with the ability to set a timeout on a request.

func (*GetFinancialCommitmentsParams) SetContext 

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

SetContext adds the context to the get financial commitments params

func (*GetFinancialCommitmentsParams) SetDefaults 

func (o *GetFinancialCommitmentsParams) SetDefaults()

SetDefaults hydrates default values in the get financial commitments params (not the query body).

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

func (*GetFinancialCommitmentsParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get financial commitments params

func (*GetFinancialCommitmentsParams) SetLimit 

func (o *GetFinancialCommitmentsParams) SetLimit(limit *int32)

SetLimit adds the limit to the get financial commitments params

func (*GetFinancialCommitmentsParams) SetPage 

func (o *GetFinancialCommitmentsParams) SetPage(page *int32)

SetPage adds the page to the get financial commitments params

func (*GetFinancialCommitmentsParams) SetTimeout 

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

SetTimeout adds the timeout to the get financial commitments params

func (*GetFinancialCommitmentsParams) WithContext 

func (o *GetFinancialCommitmentsParams) WithContext(ctx context.Context) *GetFinancialCommitmentsParams

WithContext adds the context to the get financial commitments params

func (*GetFinancialCommitmentsParams) WithDefaults 

func (o *GetFinancialCommitmentsParams) WithDefaults() *GetFinancialCommitmentsParams

WithDefaults hydrates default values in the get financial commitments params (not the query body).

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

func (*GetFinancialCommitmentsParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get financial commitments params

func (*GetFinancialCommitmentsParams) WithLimit 

func (o *GetFinancialCommitmentsParams) WithLimit(limit *int32) *GetFinancialCommitmentsParams

WithLimit adds the limit to the get financial commitments params

func (*GetFinancialCommitmentsParams) WithPage 

func (o *GetFinancialCommitmentsParams) WithPage(page *int32) *GetFinancialCommitmentsParams

WithPage adds the page to the get financial commitments params

func (*GetFinancialCommitmentsParams) WithTimeout 

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

WithTimeout adds the timeout to the get financial commitments params

func (*GetFinancialCommitmentsParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetFinancialCommitmentsReader 

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

GetFinancialCommitmentsReader is a Reader for the GetFinancialCommitments structure.

func (*GetFinancialCommitmentsReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.