budgets

package
v0.0.0-...-2502b59 Latest Latest
Warning

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

Go to latest
Published: Aug 11, 2023 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 budgets API

func (*Client) GetBudgets

func (a *Client) GetBudgets(params *GetBudgetsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetBudgetsOK, error)

GetBudgets lists budgets

Returns budgets list with summary information

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 {
	GetBudgets(params *GetBudgetsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetBudgetsOK, 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 budgets API client.

type GetBudgetsDefault

type GetBudgetsDefault struct {
	Payload *models.ErrorResponse
	// contains filtered or unexported fields
}

GetBudgetsDefault describes a response with status code -1, with default header values.

An error occurred

func NewGetBudgetsDefault

func NewGetBudgetsDefault(code int) *GetBudgetsDefault

NewGetBudgetsDefault creates a GetBudgetsDefault with default headers values

func (*GetBudgetsDefault) Code

func (o *GetBudgetsDefault) Code() int

Code gets the status code for the get budgets default response

func (*GetBudgetsDefault) Error

func (o *GetBudgetsDefault) Error() string

func (*GetBudgetsDefault) GetPayload

func (o *GetBudgetsDefault) GetPayload() *models.ErrorResponse

func (*GetBudgetsDefault) IsClientError

func (o *GetBudgetsDefault) IsClientError() bool

IsClientError returns true when this get budgets default response has a 4xx status code

func (*GetBudgetsDefault) IsCode

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

IsCode returns true when this get budgets default response a status code equal to that given

func (*GetBudgetsDefault) IsRedirect

func (o *GetBudgetsDefault) IsRedirect() bool

IsRedirect returns true when this get budgets default response has a 3xx status code

func (*GetBudgetsDefault) IsServerError

func (o *GetBudgetsDefault) IsServerError() bool

IsServerError returns true when this get budgets default response has a 5xx status code

func (*GetBudgetsDefault) IsSuccess

func (o *GetBudgetsDefault) IsSuccess() bool

IsSuccess returns true when this get budgets default response has a 2xx status code

func (*GetBudgetsDefault) String

func (o *GetBudgetsDefault) String() string

type GetBudgetsNotFound

type GetBudgetsNotFound struct {
	Payload *models.ErrorResponse
}

GetBudgetsNotFound describes a response with status code 404, with default header values.

No budgets were found

func NewGetBudgetsNotFound

func NewGetBudgetsNotFound() *GetBudgetsNotFound

NewGetBudgetsNotFound creates a GetBudgetsNotFound with default headers values

func (*GetBudgetsNotFound) Code

func (o *GetBudgetsNotFound) Code() int

Code gets the status code for the get budgets not found response

func (*GetBudgetsNotFound) Error

func (o *GetBudgetsNotFound) Error() string

func (*GetBudgetsNotFound) GetPayload

func (o *GetBudgetsNotFound) GetPayload() *models.ErrorResponse

func (*GetBudgetsNotFound) IsClientError

func (o *GetBudgetsNotFound) IsClientError() bool

IsClientError returns true when this get budgets not found response has a 4xx status code

func (*GetBudgetsNotFound) IsCode

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

IsCode returns true when this get budgets not found response a status code equal to that given

func (*GetBudgetsNotFound) IsRedirect

func (o *GetBudgetsNotFound) IsRedirect() bool

IsRedirect returns true when this get budgets not found response has a 3xx status code

func (*GetBudgetsNotFound) IsServerError

func (o *GetBudgetsNotFound) IsServerError() bool

IsServerError returns true when this get budgets not found response has a 5xx status code

func (*GetBudgetsNotFound) IsSuccess

func (o *GetBudgetsNotFound) IsSuccess() bool

IsSuccess returns true when this get budgets not found response has a 2xx status code

func (*GetBudgetsNotFound) String

func (o *GetBudgetsNotFound) String() string

type GetBudgetsOK

type GetBudgetsOK struct {
	Payload *models.BudgetSummaryResponse
}

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

The list of budgets

func NewGetBudgetsOK

func NewGetBudgetsOK() *GetBudgetsOK

NewGetBudgetsOK creates a GetBudgetsOK with default headers values

func (*GetBudgetsOK) Code

func (o *GetBudgetsOK) Code() int

Code gets the status code for the get budgets Ok response

func (*GetBudgetsOK) Error

func (o *GetBudgetsOK) Error() string

func (*GetBudgetsOK) GetPayload

func (o *GetBudgetsOK) GetPayload() *models.BudgetSummaryResponse

func (*GetBudgetsOK) IsClientError

func (o *GetBudgetsOK) IsClientError() bool

IsClientError returns true when this get budgets Ok response has a 4xx status code

func (*GetBudgetsOK) IsCode

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

IsCode returns true when this get budgets Ok response a status code equal to that given

func (*GetBudgetsOK) IsRedirect

func (o *GetBudgetsOK) IsRedirect() bool

IsRedirect returns true when this get budgets Ok response has a 3xx status code

func (*GetBudgetsOK) IsServerError

func (o *GetBudgetsOK) IsServerError() bool

IsServerError returns true when this get budgets Ok response has a 5xx status code

func (*GetBudgetsOK) IsSuccess

func (o *GetBudgetsOK) IsSuccess() bool

IsSuccess returns true when this get budgets Ok response has a 2xx status code

func (*GetBudgetsOK) String

func (o *GetBudgetsOK) String() string

type GetBudgetsParams

type GetBudgetsParams struct {

	/* IncludeAccounts.

	   Whether to include the list of budget accounts
	*/
	IncludeAccounts *bool

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

GetBudgetsParams contains all the parameters to send to the API endpoint

for the get budgets operation.

Typically these are written to a http.Request.

func NewGetBudgetsParams

func NewGetBudgetsParams() *GetBudgetsParams

NewGetBudgetsParams creates a new GetBudgetsParams 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 NewGetBudgetsParamsWithContext

func NewGetBudgetsParamsWithContext(ctx context.Context) *GetBudgetsParams

NewGetBudgetsParamsWithContext creates a new GetBudgetsParams object with the ability to set a context for a request.

func NewGetBudgetsParamsWithHTTPClient

func NewGetBudgetsParamsWithHTTPClient(client *http.Client) *GetBudgetsParams

NewGetBudgetsParamsWithHTTPClient creates a new GetBudgetsParams object with the ability to set a custom HTTPClient for a request.

func NewGetBudgetsParamsWithTimeout

func NewGetBudgetsParamsWithTimeout(timeout time.Duration) *GetBudgetsParams

NewGetBudgetsParamsWithTimeout creates a new GetBudgetsParams object with the ability to set a timeout on a request.

func (*GetBudgetsParams) SetContext

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

SetContext adds the context to the get budgets params

func (*GetBudgetsParams) SetDefaults

func (o *GetBudgetsParams) SetDefaults()

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

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

func (*GetBudgetsParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get budgets params

func (*GetBudgetsParams) SetIncludeAccounts

func (o *GetBudgetsParams) SetIncludeAccounts(includeAccounts *bool)

SetIncludeAccounts adds the includeAccounts to the get budgets params

func (*GetBudgetsParams) SetTimeout

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

SetTimeout adds the timeout to the get budgets params

func (*GetBudgetsParams) WithContext

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

WithContext adds the context to the get budgets params

func (*GetBudgetsParams) WithDefaults

func (o *GetBudgetsParams) WithDefaults() *GetBudgetsParams

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

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

func (*GetBudgetsParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the get budgets params

func (*GetBudgetsParams) WithIncludeAccounts

func (o *GetBudgetsParams) WithIncludeAccounts(includeAccounts *bool) *GetBudgetsParams

WithIncludeAccounts adds the includeAccounts to the get budgets params

func (*GetBudgetsParams) WithTimeout

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

WithTimeout adds the timeout to the get budgets params

func (*GetBudgetsParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type GetBudgetsReader

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

GetBudgetsReader is a Reader for the GetBudgets structure.

func (*GetBudgetsReader) ReadResponse

func (o *GetBudgetsReader) 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