cash_drawers

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 cash drawers API

func (*Client) ListCashDrawerShiftEvents

func (a *Client) ListCashDrawerShiftEvents(params *ListCashDrawerShiftEventsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListCashDrawerShiftEventsOK, error)

ListCashDrawerShiftEvents lists cash drawer shift events

Provides a paginated list of events for a single cash drawer shift.

func (*Client) ListCashDrawerShifts

func (a *Client) ListCashDrawerShifts(params *ListCashDrawerShiftsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListCashDrawerShiftsOK, error)
ListCashDrawerShifts lists cash drawer shifts

Provides the details for all of the cash drawer shifts for a location

in a date range.

func (*Client) RetrieveCashDrawerShift

func (a *Client) RetrieveCashDrawerShift(params *RetrieveCashDrawerShiftParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*RetrieveCashDrawerShiftOK, error)
RetrieveCashDrawerShift retrieves cash drawer shift

Provides the summary details for a single cash drawer shift. See

[ListCashDrawerShiftEvents](#endpoint-CashDrawers-ListCashDrawerShiftEvents) for a list of cash drawer shift events.

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 {
	ListCashDrawerShiftEvents(params *ListCashDrawerShiftEventsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListCashDrawerShiftEventsOK, error)

	ListCashDrawerShifts(params *ListCashDrawerShiftsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListCashDrawerShiftsOK, error)

	RetrieveCashDrawerShift(params *RetrieveCashDrawerShiftParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*RetrieveCashDrawerShiftOK, 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 cash drawers API client.

type ListCashDrawerShiftEventsOK

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

Success

func NewListCashDrawerShiftEventsOK

func NewListCashDrawerShiftEventsOK() *ListCashDrawerShiftEventsOK

NewListCashDrawerShiftEventsOK creates a ListCashDrawerShiftEventsOK with default headers values

func (*ListCashDrawerShiftEventsOK) Error

func (*ListCashDrawerShiftEventsOK) GetPayload

type ListCashDrawerShiftEventsParams

type ListCashDrawerShiftEventsParams struct {

	/* Cursor.

	   Opaque cursor for fetching the next page of results.
	*/
	Cursor *string

	/* Limit.

	     Number of resources to be returned in a page of results (200 by
	default, 1000 max).
	*/
	Limit *int64

	/* LocationID.

	   The ID of the location to list cash drawer shifts for.
	*/
	LocationID string

	/* ShiftID.

	   The shift ID.
	*/
	ShiftID string

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

ListCashDrawerShiftEventsParams contains all the parameters to send to the API endpoint

for the list cash drawer shift events operation.

Typically these are written to a http.Request.

func NewListCashDrawerShiftEventsParams

func NewListCashDrawerShiftEventsParams() *ListCashDrawerShiftEventsParams

NewListCashDrawerShiftEventsParams creates a new ListCashDrawerShiftEventsParams 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 NewListCashDrawerShiftEventsParamsWithContext

func NewListCashDrawerShiftEventsParamsWithContext(ctx context.Context) *ListCashDrawerShiftEventsParams

NewListCashDrawerShiftEventsParamsWithContext creates a new ListCashDrawerShiftEventsParams object with the ability to set a context for a request.

func NewListCashDrawerShiftEventsParamsWithHTTPClient

func NewListCashDrawerShiftEventsParamsWithHTTPClient(client *http.Client) *ListCashDrawerShiftEventsParams

NewListCashDrawerShiftEventsParamsWithHTTPClient creates a new ListCashDrawerShiftEventsParams object with the ability to set a custom HTTPClient for a request.

func NewListCashDrawerShiftEventsParamsWithTimeout

func NewListCashDrawerShiftEventsParamsWithTimeout(timeout time.Duration) *ListCashDrawerShiftEventsParams

NewListCashDrawerShiftEventsParamsWithTimeout creates a new ListCashDrawerShiftEventsParams object with the ability to set a timeout on a request.

func (*ListCashDrawerShiftEventsParams) SetContext

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

SetContext adds the context to the list cash drawer shift events params

func (*ListCashDrawerShiftEventsParams) SetCursor

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

SetCursor adds the cursor to the list cash drawer shift events params

func (*ListCashDrawerShiftEventsParams) SetDefaults

func (o *ListCashDrawerShiftEventsParams) SetDefaults()

SetDefaults hydrates default values in the list cash drawer shift events params (not the query body).

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

func (*ListCashDrawerShiftEventsParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the list cash drawer shift events params

func (*ListCashDrawerShiftEventsParams) SetLimit

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

SetLimit adds the limit to the list cash drawer shift events params

func (*ListCashDrawerShiftEventsParams) SetLocationID

func (o *ListCashDrawerShiftEventsParams) SetLocationID(locationID string)

SetLocationID adds the locationId to the list cash drawer shift events params

func (*ListCashDrawerShiftEventsParams) SetShiftID

func (o *ListCashDrawerShiftEventsParams) SetShiftID(shiftID string)

SetShiftID adds the shiftId to the list cash drawer shift events params

func (*ListCashDrawerShiftEventsParams) SetTimeout

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

SetTimeout adds the timeout to the list cash drawer shift events params

func (*ListCashDrawerShiftEventsParams) WithContext

WithContext adds the context to the list cash drawer shift events params

func (*ListCashDrawerShiftEventsParams) WithCursor

WithCursor adds the cursor to the list cash drawer shift events params

func (*ListCashDrawerShiftEventsParams) WithDefaults

WithDefaults hydrates default values in the list cash drawer shift events params (not the query body).

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

func (*ListCashDrawerShiftEventsParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the list cash drawer shift events params

func (*ListCashDrawerShiftEventsParams) WithLimit

WithLimit adds the limit to the list cash drawer shift events params

func (*ListCashDrawerShiftEventsParams) WithLocationID

WithLocationID adds the locationID to the list cash drawer shift events params

func (*ListCashDrawerShiftEventsParams) WithShiftID

WithShiftID adds the shiftID to the list cash drawer shift events params

func (*ListCashDrawerShiftEventsParams) WithTimeout

WithTimeout adds the timeout to the list cash drawer shift events params

func (*ListCashDrawerShiftEventsParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type ListCashDrawerShiftEventsReader

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

ListCashDrawerShiftEventsReader is a Reader for the ListCashDrawerShiftEvents structure.

func (*ListCashDrawerShiftEventsReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type ListCashDrawerShiftsOK

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

Success

func NewListCashDrawerShiftsOK

func NewListCashDrawerShiftsOK() *ListCashDrawerShiftsOK

NewListCashDrawerShiftsOK creates a ListCashDrawerShiftsOK with default headers values

func (*ListCashDrawerShiftsOK) Error

func (o *ListCashDrawerShiftsOK) Error() string

func (*ListCashDrawerShiftsOK) GetPayload

type ListCashDrawerShiftsParams

type ListCashDrawerShiftsParams struct {

	/* BeginTime.

	   The inclusive start time of the query on opened_at, in ISO 8601 format.
	*/
	BeginTime *string

	/* Cursor.

	   Opaque cursor for fetching the next page of results.
	*/
	Cursor *string

	/* EndTime.

	   The exclusive end date of the query on opened_at, in ISO 8601 format.
	*/
	EndTime *string

	/* Limit.

	     Number of cash drawer shift events in a page of results (200 by
	default, 1000 max).
	*/
	Limit *int64

	/* LocationID.

	   The ID of the location to query for a list of cash drawer shifts.
	*/
	LocationID string

	/* SortOrder.

	     The order in which cash drawer shifts are listed in the response,
	based on their opened_at field. Default value: ASC
	*/
	SortOrder *string

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

ListCashDrawerShiftsParams contains all the parameters to send to the API endpoint

for the list cash drawer shifts operation.

Typically these are written to a http.Request.

func NewListCashDrawerShiftsParams

func NewListCashDrawerShiftsParams() *ListCashDrawerShiftsParams

NewListCashDrawerShiftsParams creates a new ListCashDrawerShiftsParams 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 NewListCashDrawerShiftsParamsWithContext

func NewListCashDrawerShiftsParamsWithContext(ctx context.Context) *ListCashDrawerShiftsParams

NewListCashDrawerShiftsParamsWithContext creates a new ListCashDrawerShiftsParams object with the ability to set a context for a request.

func NewListCashDrawerShiftsParamsWithHTTPClient

func NewListCashDrawerShiftsParamsWithHTTPClient(client *http.Client) *ListCashDrawerShiftsParams

NewListCashDrawerShiftsParamsWithHTTPClient creates a new ListCashDrawerShiftsParams object with the ability to set a custom HTTPClient for a request.

func NewListCashDrawerShiftsParamsWithTimeout

func NewListCashDrawerShiftsParamsWithTimeout(timeout time.Duration) *ListCashDrawerShiftsParams

NewListCashDrawerShiftsParamsWithTimeout creates a new ListCashDrawerShiftsParams object with the ability to set a timeout on a request.

func (*ListCashDrawerShiftsParams) SetBeginTime

func (o *ListCashDrawerShiftsParams) SetBeginTime(beginTime *string)

SetBeginTime adds the beginTime to the list cash drawer shifts params

func (*ListCashDrawerShiftsParams) SetContext

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

SetContext adds the context to the list cash drawer shifts params

func (*ListCashDrawerShiftsParams) SetCursor

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

SetCursor adds the cursor to the list cash drawer shifts params

func (*ListCashDrawerShiftsParams) SetDefaults

func (o *ListCashDrawerShiftsParams) SetDefaults()

SetDefaults hydrates default values in the list cash drawer shifts params (not the query body).

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

func (*ListCashDrawerShiftsParams) SetEndTime

func (o *ListCashDrawerShiftsParams) SetEndTime(endTime *string)

SetEndTime adds the endTime to the list cash drawer shifts params

func (*ListCashDrawerShiftsParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the list cash drawer shifts params

func (*ListCashDrawerShiftsParams) SetLimit

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

SetLimit adds the limit to the list cash drawer shifts params

func (*ListCashDrawerShiftsParams) SetLocationID

func (o *ListCashDrawerShiftsParams) SetLocationID(locationID string)

SetLocationID adds the locationId to the list cash drawer shifts params

func (*ListCashDrawerShiftsParams) SetSortOrder

func (o *ListCashDrawerShiftsParams) SetSortOrder(sortOrder *string)

SetSortOrder adds the sortOrder to the list cash drawer shifts params

func (*ListCashDrawerShiftsParams) SetTimeout

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

SetTimeout adds the timeout to the list cash drawer shifts params

func (*ListCashDrawerShiftsParams) WithBeginTime

func (o *ListCashDrawerShiftsParams) WithBeginTime(beginTime *string) *ListCashDrawerShiftsParams

WithBeginTime adds the beginTime to the list cash drawer shifts params

func (*ListCashDrawerShiftsParams) WithContext

WithContext adds the context to the list cash drawer shifts params

func (*ListCashDrawerShiftsParams) WithCursor

WithCursor adds the cursor to the list cash drawer shifts params

func (*ListCashDrawerShiftsParams) WithDefaults

WithDefaults hydrates default values in the list cash drawer shifts params (not the query body).

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

func (*ListCashDrawerShiftsParams) WithEndTime

WithEndTime adds the endTime to the list cash drawer shifts params

func (*ListCashDrawerShiftsParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the list cash drawer shifts params

func (*ListCashDrawerShiftsParams) WithLimit

WithLimit adds the limit to the list cash drawer shifts params

func (*ListCashDrawerShiftsParams) WithLocationID

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

WithLocationID adds the locationID to the list cash drawer shifts params

func (*ListCashDrawerShiftsParams) WithSortOrder

func (o *ListCashDrawerShiftsParams) WithSortOrder(sortOrder *string) *ListCashDrawerShiftsParams

WithSortOrder adds the sortOrder to the list cash drawer shifts params

func (*ListCashDrawerShiftsParams) WithTimeout

WithTimeout adds the timeout to the list cash drawer shifts params

func (*ListCashDrawerShiftsParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type ListCashDrawerShiftsReader

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

ListCashDrawerShiftsReader is a Reader for the ListCashDrawerShifts structure.

func (*ListCashDrawerShiftsReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type RetrieveCashDrawerShiftOK

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

Success

func NewRetrieveCashDrawerShiftOK

func NewRetrieveCashDrawerShiftOK() *RetrieveCashDrawerShiftOK

NewRetrieveCashDrawerShiftOK creates a RetrieveCashDrawerShiftOK with default headers values

func (*RetrieveCashDrawerShiftOK) Error

func (o *RetrieveCashDrawerShiftOK) Error() string

func (*RetrieveCashDrawerShiftOK) GetPayload

type RetrieveCashDrawerShiftParams

type RetrieveCashDrawerShiftParams struct {

	/* LocationID.

	   The ID of the location to retrieve cash drawer shifts from.
	*/
	LocationID string

	/* ShiftID.

	   The shift ID.
	*/
	ShiftID string

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

RetrieveCashDrawerShiftParams contains all the parameters to send to the API endpoint

for the retrieve cash drawer shift operation.

Typically these are written to a http.Request.

func NewRetrieveCashDrawerShiftParams

func NewRetrieveCashDrawerShiftParams() *RetrieveCashDrawerShiftParams

NewRetrieveCashDrawerShiftParams creates a new RetrieveCashDrawerShiftParams 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 NewRetrieveCashDrawerShiftParamsWithContext

func NewRetrieveCashDrawerShiftParamsWithContext(ctx context.Context) *RetrieveCashDrawerShiftParams

NewRetrieveCashDrawerShiftParamsWithContext creates a new RetrieveCashDrawerShiftParams object with the ability to set a context for a request.

func NewRetrieveCashDrawerShiftParamsWithHTTPClient

func NewRetrieveCashDrawerShiftParamsWithHTTPClient(client *http.Client) *RetrieveCashDrawerShiftParams

NewRetrieveCashDrawerShiftParamsWithHTTPClient creates a new RetrieveCashDrawerShiftParams object with the ability to set a custom HTTPClient for a request.

func NewRetrieveCashDrawerShiftParamsWithTimeout

func NewRetrieveCashDrawerShiftParamsWithTimeout(timeout time.Duration) *RetrieveCashDrawerShiftParams

NewRetrieveCashDrawerShiftParamsWithTimeout creates a new RetrieveCashDrawerShiftParams object with the ability to set a timeout on a request.

func (*RetrieveCashDrawerShiftParams) SetContext

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

SetContext adds the context to the retrieve cash drawer shift params

func (*RetrieveCashDrawerShiftParams) SetDefaults

func (o *RetrieveCashDrawerShiftParams) SetDefaults()

SetDefaults hydrates default values in the retrieve cash drawer shift params (not the query body).

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

func (*RetrieveCashDrawerShiftParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the retrieve cash drawer shift params

func (*RetrieveCashDrawerShiftParams) SetLocationID

func (o *RetrieveCashDrawerShiftParams) SetLocationID(locationID string)

SetLocationID adds the locationId to the retrieve cash drawer shift params

func (*RetrieveCashDrawerShiftParams) SetShiftID

func (o *RetrieveCashDrawerShiftParams) SetShiftID(shiftID string)

SetShiftID adds the shiftId to the retrieve cash drawer shift params

func (*RetrieveCashDrawerShiftParams) SetTimeout

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

SetTimeout adds the timeout to the retrieve cash drawer shift params

func (*RetrieveCashDrawerShiftParams) WithContext

WithContext adds the context to the retrieve cash drawer shift params

func (*RetrieveCashDrawerShiftParams) WithDefaults

WithDefaults hydrates default values in the retrieve cash drawer shift params (not the query body).

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

func (*RetrieveCashDrawerShiftParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the retrieve cash drawer shift params

func (*RetrieveCashDrawerShiftParams) WithLocationID

WithLocationID adds the locationID to the retrieve cash drawer shift params

func (*RetrieveCashDrawerShiftParams) WithShiftID

WithShiftID adds the shiftID to the retrieve cash drawer shift params

func (*RetrieveCashDrawerShiftParams) WithTimeout

WithTimeout adds the timeout to the retrieve cash drawer shift params

func (*RetrieveCashDrawerShiftParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type RetrieveCashDrawerShiftReader

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

RetrieveCashDrawerShiftReader is a Reader for the RetrieveCashDrawerShift structure.

func (*RetrieveCashDrawerShiftReader) ReadResponse

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