orders

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: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BatchRetrieveOrdersOK 

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

Success

func NewBatchRetrieveOrdersOK 

func NewBatchRetrieveOrdersOK() *BatchRetrieveOrdersOK

NewBatchRetrieveOrdersOK creates a BatchRetrieveOrdersOK with default headers values

func (*BatchRetrieveOrdersOK) Error 

func (o *BatchRetrieveOrdersOK) Error() string

func (*BatchRetrieveOrdersOK) GetPayload 

func (o *BatchRetrieveOrdersOK) GetPayload() *models.BatchRetrieveOrdersResponse

type BatchRetrieveOrdersParams 

type BatchRetrieveOrdersParams struct {

	/* Body.

	     An object containing the fields to POST for the request.

	See the corresponding object definition for field details.
	*/
	Body *models.BatchRetrieveOrdersRequest

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

BatchRetrieveOrdersParams contains all the parameters to send to the API endpoint 

for the batch retrieve orders operation.

Typically these are written to a http.Request.

func NewBatchRetrieveOrdersParams 

func NewBatchRetrieveOrdersParams() *BatchRetrieveOrdersParams

NewBatchRetrieveOrdersParams creates a new BatchRetrieveOrdersParams 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 NewBatchRetrieveOrdersParamsWithContext 

func NewBatchRetrieveOrdersParamsWithContext(ctx context.Context) *BatchRetrieveOrdersParams

NewBatchRetrieveOrdersParamsWithContext creates a new BatchRetrieveOrdersParams object with the ability to set a context for a request.

func NewBatchRetrieveOrdersParamsWithHTTPClient 

func NewBatchRetrieveOrdersParamsWithHTTPClient(client *http.Client) *BatchRetrieveOrdersParams

NewBatchRetrieveOrdersParamsWithHTTPClient creates a new BatchRetrieveOrdersParams object with the ability to set a custom HTTPClient for a request.

func NewBatchRetrieveOrdersParamsWithTimeout 

func NewBatchRetrieveOrdersParamsWithTimeout(timeout time.Duration) *BatchRetrieveOrdersParams

NewBatchRetrieveOrdersParamsWithTimeout creates a new BatchRetrieveOrdersParams object with the ability to set a timeout on a request.

func (*BatchRetrieveOrdersParams) SetBody 

func (o *BatchRetrieveOrdersParams) SetBody(body *models.BatchRetrieveOrdersRequest)

SetBody adds the body to the batch retrieve orders params

func (*BatchRetrieveOrdersParams) SetContext 

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

SetContext adds the context to the batch retrieve orders params

func (*BatchRetrieveOrdersParams) SetDefaults 

func (o *BatchRetrieveOrdersParams) SetDefaults()

SetDefaults hydrates default values in the batch retrieve orders params (not the query body).

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

func (*BatchRetrieveOrdersParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the batch retrieve orders params

func (*BatchRetrieveOrdersParams) SetTimeout 

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

SetTimeout adds the timeout to the batch retrieve orders params

func (*BatchRetrieveOrdersParams) WithBody 

func (o *BatchRetrieveOrdersParams) WithBody(body *models.BatchRetrieveOrdersRequest) *BatchRetrieveOrdersParams

WithBody adds the body to the batch retrieve orders params

func (*BatchRetrieveOrdersParams) WithContext 

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

WithContext adds the context to the batch retrieve orders params

func (*BatchRetrieveOrdersParams) WithDefaults 

func (o *BatchRetrieveOrdersParams) WithDefaults() *BatchRetrieveOrdersParams

WithDefaults hydrates default values in the batch retrieve orders params (not the query body).

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

func (*BatchRetrieveOrdersParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the batch retrieve orders params

func (*BatchRetrieveOrdersParams) WithTimeout 

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

WithTimeout adds the timeout to the batch retrieve orders params

func (*BatchRetrieveOrdersParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type BatchRetrieveOrdersReader 

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

BatchRetrieveOrdersReader is a Reader for the BatchRetrieveOrders structure.

func (*BatchRetrieveOrdersReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type CalculateOrderOK 

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

Success

func NewCalculateOrderOK 

func NewCalculateOrderOK() *CalculateOrderOK

NewCalculateOrderOK creates a CalculateOrderOK with default headers values

func (*CalculateOrderOK) Error 

func (o *CalculateOrderOK) Error() string

func (*CalculateOrderOK) GetPayload 

func (o *CalculateOrderOK) GetPayload() *models.CalculateOrderResponse

type CalculateOrderParams 

type CalculateOrderParams struct {

	/* Body.

	     An object containing the fields to POST for the request.

	See the corresponding object definition for field details.
	*/
	Body *models.CalculateOrderRequest

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

CalculateOrderParams contains all the parameters to send to the API endpoint 

for the calculate order operation.

Typically these are written to a http.Request.

func NewCalculateOrderParams 

func NewCalculateOrderParams() *CalculateOrderParams

NewCalculateOrderParams creates a new CalculateOrderParams 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 NewCalculateOrderParamsWithContext 

func NewCalculateOrderParamsWithContext(ctx context.Context) *CalculateOrderParams

NewCalculateOrderParamsWithContext creates a new CalculateOrderParams object with the ability to set a context for a request.

func NewCalculateOrderParamsWithHTTPClient 

func NewCalculateOrderParamsWithHTTPClient(client *http.Client) *CalculateOrderParams

NewCalculateOrderParamsWithHTTPClient creates a new CalculateOrderParams object with the ability to set a custom HTTPClient for a request.

func NewCalculateOrderParamsWithTimeout 

func NewCalculateOrderParamsWithTimeout(timeout time.Duration) *CalculateOrderParams

NewCalculateOrderParamsWithTimeout creates a new CalculateOrderParams object with the ability to set a timeout on a request.

func (*CalculateOrderParams) SetBody 

func (o *CalculateOrderParams) SetBody(body *models.CalculateOrderRequest)

SetBody adds the body to the calculate order params

func (*CalculateOrderParams) SetContext 

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

SetContext adds the context to the calculate order params

func (*CalculateOrderParams) SetDefaults 

func (o *CalculateOrderParams) SetDefaults()

SetDefaults hydrates default values in the calculate order params (not the query body).

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

func (*CalculateOrderParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the calculate order params

func (*CalculateOrderParams) SetTimeout 

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

SetTimeout adds the timeout to the calculate order params

func (*CalculateOrderParams) WithBody 

func (o *CalculateOrderParams) WithBody(body *models.CalculateOrderRequest) *CalculateOrderParams

WithBody adds the body to the calculate order params

func (*CalculateOrderParams) WithContext 

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

WithContext adds the context to the calculate order params

func (*CalculateOrderParams) WithDefaults 

func (o *CalculateOrderParams) WithDefaults() *CalculateOrderParams

WithDefaults hydrates default values in the calculate order params (not the query body).

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

func (*CalculateOrderParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the calculate order params

func (*CalculateOrderParams) WithTimeout 

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

WithTimeout adds the timeout to the calculate order params

func (*CalculateOrderParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type CalculateOrderReader 

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

CalculateOrderReader is a Reader for the CalculateOrder structure.

func (*CalculateOrderReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type Client 

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

Client for orders API

func (*Client) BatchRetrieveOrders 

func (a *Client) BatchRetrieveOrders(params *BatchRetrieveOrdersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*BatchRetrieveOrdersOK, error)
BatchRetrieveOrders batches retrieve orders

Retrieves a set of [Order](#type-order)s by their IDs.

If a given Order ID does not exist, the ID is ignored instead of generating an error.

func (*Client) CalculateOrder 

func (a *Client) CalculateOrder(params *CalculateOrderParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CalculateOrderOK, error)

CalculateOrder calculates order

Calculates an [Order](#type-order).

func (*Client) CreateOrder 

func (a *Client) CreateOrder(params *CreateOrderParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CreateOrderOK, error)
CreateOrder creates order

Creates a new [Order](#type-order) which can include information on products for

purchase and settings to apply to the purchase.

To pay for a created order, please refer to the [Pay for Orders](/orders-api/pay-for-orders) guide.

You can modify open orders using the [UpdateOrder](#endpoint-orders-updateorder) endpoint.

func (*Client) PayOrder 

func (a *Client) PayOrder(params *PayOrderParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PayOrderOK, error)
PayOrder pays order

Pay for an [order](#type-order) using one or more approved [payments](#type-payment),

or settle an order with a total of `0`.

The total of the `payment_ids` listed in the request must be equal to the order total. Orders with a total amount of `0` can be marked as paid by specifying an empty array of `payment_ids` in the request.

To be used with PayOrder, a payment must:

- Reference the order by specifying the `order_id` when [creating the payment](#endpoint-payments-createpayment). Any approved payments that reference the same `order_id` not specified in the `payment_ids` will be canceled. - Be approved with [delayed capture](/payments-api/take-payments#delayed-capture). Using a delayed capture payment with PayOrder will complete the approved payment.

func (*Client) RetrieveOrder 

func (a *Client) RetrieveOrder(params *RetrieveOrderParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*RetrieveOrderOK, error)

RetrieveOrder retrieves order

Retrieves an [Order](#type-order) by ID.

func (*Client) SearchOrders 

func (a *Client) SearchOrders(params *SearchOrdersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*SearchOrdersOK, error)
SearchOrders searches orders

Search all orders for one or more locations. Orders include all sales,

returns, and exchanges regardless of how or when they entered the Square Ecosystem (e.g. Point of Sale, Invoices, Connect APIs, etc).

SearchOrders requests need to specify which locations to search and define a [`SearchOrdersQuery`](#type-searchordersquery) object which controls how to sort or filter the results. Your SearchOrdersQuery can: 

Set filter criteria.
Set sort order.
Determine whether to return results as complete Order objects, or as

[OrderEntry](#type-orderentry) objects.

Note that details for orders processed with Square Point of Sale while in offline mode may not be transmitted to Square for up to 72 hours. Offline orders have a `created_at` value that reflects the time the order was created, not the time it was subsequently transmitted to Square.

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

func (*Client) UpdateOrder 

func (a *Client) UpdateOrder(params *UpdateOrderParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UpdateOrderOK, error)
UpdateOrder updates order

Updates an open [Order](#type-order) by adding, replacing, or deleting

fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.

An UpdateOrder request requires the following:

- The `order_id` in the endpoint path, identifying the order to update. - The latest `version` of the order to update. - The [sparse order](/orders-api/manage-orders#sparse-order-objects) containing only the fields to update and the version the update is being applied to. - If deleting fields, the [dot notation paths](/orders-api/manage-orders#on-dot-notation) identifying fields to clear.

To pay for an order, please refer to the [Pay for Orders](/orders-api/pay-for-orders) guide.

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService 

type ClientService interface {
	BatchRetrieveOrders(params *BatchRetrieveOrdersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*BatchRetrieveOrdersOK, error)

	CalculateOrder(params *CalculateOrderParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CalculateOrderOK, error)

	CreateOrder(params *CreateOrderParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CreateOrderOK, error)

	PayOrder(params *PayOrderParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PayOrderOK, error)

	RetrieveOrder(params *RetrieveOrderParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*RetrieveOrderOK, error)

	SearchOrders(params *SearchOrdersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*SearchOrdersOK, error)

	UpdateOrder(params *UpdateOrderParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UpdateOrderOK, 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 orders API client.

type CreateOrderOK 

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

Success

func NewCreateOrderOK 

func NewCreateOrderOK() *CreateOrderOK

NewCreateOrderOK creates a CreateOrderOK with default headers values

func (*CreateOrderOK) Error 

func (o *CreateOrderOK) Error() string

func (*CreateOrderOK) GetPayload 

func (o *CreateOrderOK) GetPayload() *models.CreateOrderResponse

type CreateOrderParams 

type CreateOrderParams struct {

	/* Body.

	     An object containing the fields to POST for the request.

	See the corresponding object definition for field details.
	*/
	Body *models.CreateOrderRequest

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

CreateOrderParams contains all the parameters to send to the API endpoint 

for the create order operation.

Typically these are written to a http.Request.

func NewCreateOrderParams 

func NewCreateOrderParams() *CreateOrderParams

NewCreateOrderParams creates a new CreateOrderParams 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 NewCreateOrderParamsWithContext 

func NewCreateOrderParamsWithContext(ctx context.Context) *CreateOrderParams

NewCreateOrderParamsWithContext creates a new CreateOrderParams object with the ability to set a context for a request.

func NewCreateOrderParamsWithHTTPClient 

func NewCreateOrderParamsWithHTTPClient(client *http.Client) *CreateOrderParams

NewCreateOrderParamsWithHTTPClient creates a new CreateOrderParams object with the ability to set a custom HTTPClient for a request.

func NewCreateOrderParamsWithTimeout 

func NewCreateOrderParamsWithTimeout(timeout time.Duration) *CreateOrderParams

NewCreateOrderParamsWithTimeout creates a new CreateOrderParams object with the ability to set a timeout on a request.

func (*CreateOrderParams) SetBody 

func (o *CreateOrderParams) SetBody(body *models.CreateOrderRequest)

SetBody adds the body to the create order params

func (*CreateOrderParams) SetContext 

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

SetContext adds the context to the create order params

func (*CreateOrderParams) SetDefaults 

func (o *CreateOrderParams) SetDefaults()

SetDefaults hydrates default values in the create order params (not the query body).

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

func (*CreateOrderParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the create order params

func (*CreateOrderParams) SetTimeout 

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

SetTimeout adds the timeout to the create order params

func (*CreateOrderParams) WithBody 

func (o *CreateOrderParams) WithBody(body *models.CreateOrderRequest) *CreateOrderParams

WithBody adds the body to the create order params

func (*CreateOrderParams) WithContext 

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

WithContext adds the context to the create order params

func (*CreateOrderParams) WithDefaults 

func (o *CreateOrderParams) WithDefaults() *CreateOrderParams

WithDefaults hydrates default values in the create order params (not the query body).

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

func (*CreateOrderParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the create order params

func (*CreateOrderParams) WithTimeout 

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

WithTimeout adds the timeout to the create order params

func (*CreateOrderParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type CreateOrderReader 

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

CreateOrderReader is a Reader for the CreateOrder structure.

func (*CreateOrderReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type PayOrderOK 

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

Success

func NewPayOrderOK 

func NewPayOrderOK() *PayOrderOK

NewPayOrderOK creates a PayOrderOK with default headers values

func (*PayOrderOK) Error 

func (o *PayOrderOK) Error() string

func (*PayOrderOK) GetPayload 

func (o *PayOrderOK) GetPayload() *models.PayOrderResponse

type PayOrderParams 

type PayOrderParams struct {

	/* Body.

	     An object containing the fields to POST for the request.

	See the corresponding object definition for field details.
	*/
	Body *models.PayOrderRequest

	/* OrderID.

	   The ID of the order being paid.
	*/
	OrderID string

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

PayOrderParams contains all the parameters to send to the API endpoint 

for the pay order operation.

Typically these are written to a http.Request.

func NewPayOrderParams 

func NewPayOrderParams() *PayOrderParams

NewPayOrderParams creates a new PayOrderParams 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 NewPayOrderParamsWithContext 

func NewPayOrderParamsWithContext(ctx context.Context) *PayOrderParams

NewPayOrderParamsWithContext creates a new PayOrderParams object with the ability to set a context for a request.

func NewPayOrderParamsWithHTTPClient 

func NewPayOrderParamsWithHTTPClient(client *http.Client) *PayOrderParams

NewPayOrderParamsWithHTTPClient creates a new PayOrderParams object with the ability to set a custom HTTPClient for a request.

func NewPayOrderParamsWithTimeout 

func NewPayOrderParamsWithTimeout(timeout time.Duration) *PayOrderParams

NewPayOrderParamsWithTimeout creates a new PayOrderParams object with the ability to set a timeout on a request.

func (*PayOrderParams) SetBody 

func (o *PayOrderParams) SetBody(body *models.PayOrderRequest)

SetBody adds the body to the pay order params

func (*PayOrderParams) SetContext 

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

SetContext adds the context to the pay order params

func (*PayOrderParams) SetDefaults 

func (o *PayOrderParams) SetDefaults()

SetDefaults hydrates default values in the pay order params (not the query body).

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

func (*PayOrderParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the pay order params

func (*PayOrderParams) SetOrderID 

func (o *PayOrderParams) SetOrderID(orderID string)

SetOrderID adds the orderId to the pay order params

func (*PayOrderParams) SetTimeout 

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

SetTimeout adds the timeout to the pay order params

func (*PayOrderParams) WithBody 

func (o *PayOrderParams) WithBody(body *models.PayOrderRequest) *PayOrderParams

WithBody adds the body to the pay order params

func (*PayOrderParams) WithContext 

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

WithContext adds the context to the pay order params

func (*PayOrderParams) WithDefaults 

func (o *PayOrderParams) WithDefaults() *PayOrderParams

WithDefaults hydrates default values in the pay order params (not the query body).

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

func (*PayOrderParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the pay order params

func (*PayOrderParams) WithOrderID 

func (o *PayOrderParams) WithOrderID(orderID string) *PayOrderParams

WithOrderID adds the orderID to the pay order params

func (*PayOrderParams) WithTimeout 

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

WithTimeout adds the timeout to the pay order params

func (*PayOrderParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type PayOrderReader 

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

PayOrderReader is a Reader for the PayOrder structure.

func (*PayOrderReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type RetrieveOrderOK 

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

Success

func NewRetrieveOrderOK 

func NewRetrieveOrderOK() *RetrieveOrderOK

NewRetrieveOrderOK creates a RetrieveOrderOK with default headers values

func (*RetrieveOrderOK) Error 

func (o *RetrieveOrderOK) Error() string

func (*RetrieveOrderOK) GetPayload 

func (o *RetrieveOrderOK) GetPayload() *models.RetrieveOrderResponse

type RetrieveOrderParams 

type RetrieveOrderParams struct {

	/* OrderID.

	   The ID of the order to retrieve.
	*/
	OrderID string

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

RetrieveOrderParams contains all the parameters to send to the API endpoint 

for the retrieve order operation.

Typically these are written to a http.Request.

func NewRetrieveOrderParams 

func NewRetrieveOrderParams() *RetrieveOrderParams

NewRetrieveOrderParams creates a new RetrieveOrderParams 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 NewRetrieveOrderParamsWithContext 

func NewRetrieveOrderParamsWithContext(ctx context.Context) *RetrieveOrderParams

NewRetrieveOrderParamsWithContext creates a new RetrieveOrderParams object with the ability to set a context for a request.

func NewRetrieveOrderParamsWithHTTPClient 

func NewRetrieveOrderParamsWithHTTPClient(client *http.Client) *RetrieveOrderParams

NewRetrieveOrderParamsWithHTTPClient creates a new RetrieveOrderParams object with the ability to set a custom HTTPClient for a request.

func NewRetrieveOrderParamsWithTimeout 

func NewRetrieveOrderParamsWithTimeout(timeout time.Duration) *RetrieveOrderParams

NewRetrieveOrderParamsWithTimeout creates a new RetrieveOrderParams object with the ability to set a timeout on a request.

func (*RetrieveOrderParams) SetContext 

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

SetContext adds the context to the retrieve order params

func (*RetrieveOrderParams) SetDefaults 

func (o *RetrieveOrderParams) SetDefaults()

SetDefaults hydrates default values in the retrieve order params (not the query body).

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

func (*RetrieveOrderParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the retrieve order params

func (*RetrieveOrderParams) SetOrderID 

func (o *RetrieveOrderParams) SetOrderID(orderID string)

SetOrderID adds the orderId to the retrieve order params

func (*RetrieveOrderParams) SetTimeout 

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

SetTimeout adds the timeout to the retrieve order params

func (*RetrieveOrderParams) WithContext 

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

WithContext adds the context to the retrieve order params

func (*RetrieveOrderParams) WithDefaults 

func (o *RetrieveOrderParams) WithDefaults() *RetrieveOrderParams

WithDefaults hydrates default values in the retrieve order params (not the query body).

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

func (*RetrieveOrderParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the retrieve order params

func (*RetrieveOrderParams) WithOrderID 

func (o *RetrieveOrderParams) WithOrderID(orderID string) *RetrieveOrderParams

WithOrderID adds the orderID to the retrieve order params

func (*RetrieveOrderParams) WithTimeout 

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

WithTimeout adds the timeout to the retrieve order params

func (*RetrieveOrderParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type RetrieveOrderReader 

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

RetrieveOrderReader is a Reader for the RetrieveOrder structure.

func (*RetrieveOrderReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type SearchOrdersOK 

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

Success

func NewSearchOrdersOK 

func NewSearchOrdersOK() *SearchOrdersOK

NewSearchOrdersOK creates a SearchOrdersOK with default headers values

func (*SearchOrdersOK) Error 

func (o *SearchOrdersOK) Error() string

func (*SearchOrdersOK) GetPayload 

func (o *SearchOrdersOK) GetPayload() *models.SearchOrdersResponse

type SearchOrdersParams 

type SearchOrdersParams struct {

	/* Body.

	     An object containing the fields to POST for the request.

	See the corresponding object definition for field details.
	*/
	Body *models.SearchOrdersRequest

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

SearchOrdersParams contains all the parameters to send to the API endpoint 

for the search orders operation.

Typically these are written to a http.Request.

func NewSearchOrdersParams 

func NewSearchOrdersParams() *SearchOrdersParams

NewSearchOrdersParams creates a new SearchOrdersParams 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 NewSearchOrdersParamsWithContext 

func NewSearchOrdersParamsWithContext(ctx context.Context) *SearchOrdersParams

NewSearchOrdersParamsWithContext creates a new SearchOrdersParams object with the ability to set a context for a request.

func NewSearchOrdersParamsWithHTTPClient 

func NewSearchOrdersParamsWithHTTPClient(client *http.Client) *SearchOrdersParams

NewSearchOrdersParamsWithHTTPClient creates a new SearchOrdersParams object with the ability to set a custom HTTPClient for a request.

func NewSearchOrdersParamsWithTimeout 

func NewSearchOrdersParamsWithTimeout(timeout time.Duration) *SearchOrdersParams

NewSearchOrdersParamsWithTimeout creates a new SearchOrdersParams object with the ability to set a timeout on a request.

func (*SearchOrdersParams) SetBody 

func (o *SearchOrdersParams) SetBody(body *models.SearchOrdersRequest)

SetBody adds the body to the search orders params

func (*SearchOrdersParams) SetContext 

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

SetContext adds the context to the search orders params

func (*SearchOrdersParams) SetDefaults 

func (o *SearchOrdersParams) SetDefaults()

SetDefaults hydrates default values in the search orders params (not the query body).

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

func (*SearchOrdersParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the search orders params

func (*SearchOrdersParams) SetTimeout 

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

SetTimeout adds the timeout to the search orders params

func (*SearchOrdersParams) WithBody 

func (o *SearchOrdersParams) WithBody(body *models.SearchOrdersRequest) *SearchOrdersParams

WithBody adds the body to the search orders params

func (*SearchOrdersParams) WithContext 

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

WithContext adds the context to the search orders params

func (*SearchOrdersParams) WithDefaults 

func (o *SearchOrdersParams) WithDefaults() *SearchOrdersParams

WithDefaults hydrates default values in the search orders params (not the query body).

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

func (*SearchOrdersParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the search orders params

func (*SearchOrdersParams) WithTimeout 

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

WithTimeout adds the timeout to the search orders params

func (*SearchOrdersParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type SearchOrdersReader 

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

SearchOrdersReader is a Reader for the SearchOrders structure.

func (*SearchOrdersReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type UpdateOrderOK 

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

Success

func NewUpdateOrderOK 

func NewUpdateOrderOK() *UpdateOrderOK

NewUpdateOrderOK creates a UpdateOrderOK with default headers values

func (*UpdateOrderOK) Error 

func (o *UpdateOrderOK) Error() string

func (*UpdateOrderOK) GetPayload 

func (o *UpdateOrderOK) GetPayload() *models.UpdateOrderResponse

type UpdateOrderParams 

type UpdateOrderParams struct {

	/* Body.

	     An object containing the fields to POST for the request.

	See the corresponding object definition for field details.
	*/
	Body *models.UpdateOrderRequest

	/* OrderID.

	   The ID of the order to update.
	*/
	OrderID string

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

UpdateOrderParams contains all the parameters to send to the API endpoint 

for the update order operation.

Typically these are written to a http.Request.

func NewUpdateOrderParams 

func NewUpdateOrderParams() *UpdateOrderParams

NewUpdateOrderParams creates a new UpdateOrderParams 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 NewUpdateOrderParamsWithContext 

func NewUpdateOrderParamsWithContext(ctx context.Context) *UpdateOrderParams

NewUpdateOrderParamsWithContext creates a new UpdateOrderParams object with the ability to set a context for a request.

func NewUpdateOrderParamsWithHTTPClient 

func NewUpdateOrderParamsWithHTTPClient(client *http.Client) *UpdateOrderParams

NewUpdateOrderParamsWithHTTPClient creates a new UpdateOrderParams object with the ability to set a custom HTTPClient for a request.

func NewUpdateOrderParamsWithTimeout 

func NewUpdateOrderParamsWithTimeout(timeout time.Duration) *UpdateOrderParams

NewUpdateOrderParamsWithTimeout creates a new UpdateOrderParams object with the ability to set a timeout on a request.

func (*UpdateOrderParams) SetBody 

func (o *UpdateOrderParams) SetBody(body *models.UpdateOrderRequest)

SetBody adds the body to the update order params

func (*UpdateOrderParams) SetContext 

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

SetContext adds the context to the update order params

func (*UpdateOrderParams) SetDefaults 

func (o *UpdateOrderParams) SetDefaults()

SetDefaults hydrates default values in the update order params (not the query body).

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

func (*UpdateOrderParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the update order params

func (*UpdateOrderParams) SetOrderID 

func (o *UpdateOrderParams) SetOrderID(orderID string)

SetOrderID adds the orderId to the update order params

func (*UpdateOrderParams) SetTimeout 

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

SetTimeout adds the timeout to the update order params

func (*UpdateOrderParams) WithBody 

func (o *UpdateOrderParams) WithBody(body *models.UpdateOrderRequest) *UpdateOrderParams

WithBody adds the body to the update order params

func (*UpdateOrderParams) WithContext 

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

WithContext adds the context to the update order params

func (*UpdateOrderParams) WithDefaults 

func (o *UpdateOrderParams) WithDefaults() *UpdateOrderParams

WithDefaults hydrates default values in the update order params (not the query body).

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

func (*UpdateOrderParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the update order params

func (*UpdateOrderParams) WithOrderID 

func (o *UpdateOrderParams) WithOrderID(orderID string) *UpdateOrderParams

WithOrderID adds the orderID to the update order params

func (*UpdateOrderParams) WithTimeout 

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

WithTimeout adds the timeout to the update order params

func (*UpdateOrderParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type UpdateOrderReader 

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

UpdateOrderReader is a Reader for the UpdateOrder structure.

func (*UpdateOrderReader) ReadResponse 

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