Documentation
¶
Index ¶
- type Client
- func (a *Client) SetTransport(transport runtime.ClientTransport)
- func (a *Client) SyncOrders(params *SyncOrdersParams, authInfo runtime.ClientAuthInfoWriter) (*SyncOrdersOK, error)deprecated
- func (a *Client) SyncOrdersShort(params *SyncOrdersParams, authInfo runtime.ClientAuthInfoWriter) (*SyncOrdersOK, error)
- type ClientService
- type SyncOrdersOK
- type SyncOrdersParams
- func (o *SyncOrdersParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)
- func (o *SyncOrdersParams) SetContext(ctx context.Context)
- func (o *SyncOrdersParams) SetEnd(end string)
- func (o *SyncOrdersParams) SetFlightId(flightId string)
- func (o *SyncOrdersParams) SetHTTPClient(client *http.Client)
- func (o *SyncOrdersParams) SetHTTPClientTransport(roundTripper http.RoundTripper)
- func (o *SyncOrdersParams) SetNextEvaluatedKey(nextEvaluatedKey *string)
- func (o *SyncOrdersParams) SetStart(start string)
- func (o *SyncOrdersParams) SetTimeout(timeout time.Duration)
- func (o *SyncOrdersParams) WithContext(ctx context.Context) *SyncOrdersParams
- func (o *SyncOrdersParams) WithEnd(end string) *SyncOrdersParams
- func (o *SyncOrdersParams) WithHTTPClient(client *http.Client) *SyncOrdersParams
- func (o *SyncOrdersParams) WithNextEvaluatedKey(nextEvaluatedKey *string) *SyncOrdersParams
- func (o *SyncOrdersParams) WithStart(start string) *SyncOrdersParams
- func (o *SyncOrdersParams) WithTimeout(timeout time.Duration) *SyncOrdersParams
- func (o *SyncOrdersParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type SyncOrdersReader
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 order dedicated API
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
func (*Client) SyncOrders
deprecated
func (a *Client) SyncOrders(params *SyncOrdersParams, authInfo runtime.ClientAuthInfoWriter) (*SyncOrdersOK, error)
Deprecated: 2022-08-10 - Use SyncOrdersShort instead.
SyncOrders sync orders
[Not Supported Yet In Starter] Sync orders. If response contains nextEvaluatedKey, please use it as query param in the next call to fetch the next batch, a batch has 1000 elements or less.
Other detail info:
- Required permission : resource="ADMIN:ORDER", action=2 (READ)
- Returns : sync orders
func (*Client) SyncOrdersShort ¶ added in v0.8.0
func (a *Client) SyncOrdersShort(params *SyncOrdersParams, authInfo runtime.ClientAuthInfoWriter) (*SyncOrdersOK, error)
SyncOrdersShort sync orders
[Not Supported Yet In Starter] Sync orders. If response contains nextEvaluatedKey, please use it as query param in the next call to fetch the next batch, a batch has 1000 elements or less.
Other detail info:
- Required permission : resource="ADMIN:ORDER", action=2 (READ)
- Returns : sync orders
type ClientService ¶
type ClientService interface {
SyncOrders(params *SyncOrdersParams, authInfo runtime.ClientAuthInfoWriter) (*SyncOrdersOK, error)
SyncOrdersShort(params *SyncOrdersParams, authInfo runtime.ClientAuthInfoWriter) (*SyncOrdersOK, 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 order dedicated API client.
type SyncOrdersOK ¶
type SyncOrdersOK struct {
Payload *platformclientmodels.OrderSyncResult
}
SyncOrdersOK handles this case with default header values.
successful operation
func NewSyncOrdersOK ¶
func NewSyncOrdersOK() *SyncOrdersOK
NewSyncOrdersOK creates a SyncOrdersOK with default headers values
func (*SyncOrdersOK) Error ¶
func (o *SyncOrdersOK) Error() string
func (*SyncOrdersOK) GetPayload ¶
func (o *SyncOrdersOK) GetPayload() *platformclientmodels.OrderSyncResult
func (*SyncOrdersOK) ToJSONString ¶ added in v0.25.0
func (o *SyncOrdersOK) ToJSONString() string
type SyncOrdersParams ¶
type SyncOrdersParams struct {
/*RetryPolicy*/
RetryPolicy *utils.Retry
/*NextEvaluatedKey*/
NextEvaluatedKey *string
/*End
exclude ISODateTimeFormat no millis like yyyy-MM-dd'T'HH:mm:ssZZ
*/
End string
/*Start
include ISODateTimeFormat no millis like yyyy-MM-dd'T'HH:mm:ssZZ
*/
Start string
AuthInfoWriter runtime.ClientAuthInfoWriter
Context context.Context
HTTPClient *http.Client
// XFlightId is an optional parameter from this SDK
XFlightId *string
// contains filtered or unexported fields
}
SyncOrdersParams contains all the parameters to send to the API endpoint for the sync orders operation typically these are written to a http.Request
func NewSyncOrdersParams ¶
func NewSyncOrdersParams() *SyncOrdersParams
NewSyncOrdersParams creates a new SyncOrdersParams object with the default values initialized.
func NewSyncOrdersParamsWithContext ¶
func NewSyncOrdersParamsWithContext(ctx context.Context) *SyncOrdersParams
NewSyncOrdersParamsWithContext creates a new SyncOrdersParams object with the default values initialized, and the ability to set a context for a request
func NewSyncOrdersParamsWithHTTPClient ¶
func NewSyncOrdersParamsWithHTTPClient(client *http.Client) *SyncOrdersParams
NewSyncOrdersParamsWithHTTPClient creates a new SyncOrdersParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewSyncOrdersParamsWithTimeout ¶
func NewSyncOrdersParamsWithTimeout(timeout time.Duration) *SyncOrdersParams
NewSyncOrdersParamsWithTimeout creates a new SyncOrdersParams object with the default values initialized, and the ability to set a timeout on a request
func (*SyncOrdersParams) SetAuthInfoWriter ¶ added in v0.17.0
func (o *SyncOrdersParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)
SetAuthInfoWriter adds the authInfoWriter to the sync orders params
func (*SyncOrdersParams) SetContext ¶
func (o *SyncOrdersParams) SetContext(ctx context.Context)
SetContext adds the context to the sync orders params
func (*SyncOrdersParams) SetEnd ¶
func (o *SyncOrdersParams) SetEnd(end string)
SetEnd adds the end to the sync orders params
func (*SyncOrdersParams) SetFlightId ¶ added in v0.63.0
func (o *SyncOrdersParams) SetFlightId(flightId string)
SetFlightId adds the flightId as the header value for this specific endpoint
func (*SyncOrdersParams) SetHTTPClient ¶
func (o *SyncOrdersParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the sync orders params
func (*SyncOrdersParams) SetHTTPClientTransport ¶ added in v0.19.0
func (o *SyncOrdersParams) SetHTTPClientTransport(roundTripper http.RoundTripper)
SetHTTPClient adds the HTTPClient Transport to the sync orders params
func (*SyncOrdersParams) SetNextEvaluatedKey ¶
func (o *SyncOrdersParams) SetNextEvaluatedKey(nextEvaluatedKey *string)
SetNextEvaluatedKey adds the nextEvaluatedKey to the sync orders params
func (*SyncOrdersParams) SetStart ¶
func (o *SyncOrdersParams) SetStart(start string)
SetStart adds the start to the sync orders params
func (*SyncOrdersParams) SetTimeout ¶
func (o *SyncOrdersParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the sync orders params
func (*SyncOrdersParams) WithContext ¶
func (o *SyncOrdersParams) WithContext(ctx context.Context) *SyncOrdersParams
WithContext adds the context to the sync orders params
func (*SyncOrdersParams) WithEnd ¶
func (o *SyncOrdersParams) WithEnd(end string) *SyncOrdersParams
WithEnd adds the end to the sync orders params
func (*SyncOrdersParams) WithHTTPClient ¶
func (o *SyncOrdersParams) WithHTTPClient(client *http.Client) *SyncOrdersParams
WithHTTPClient adds the HTTPClient to the sync orders params
func (*SyncOrdersParams) WithNextEvaluatedKey ¶
func (o *SyncOrdersParams) WithNextEvaluatedKey(nextEvaluatedKey *string) *SyncOrdersParams
WithNextEvaluatedKey adds the nextEvaluatedKey to the sync orders params
func (*SyncOrdersParams) WithStart ¶
func (o *SyncOrdersParams) WithStart(start string) *SyncOrdersParams
WithStart adds the start to the sync orders params
func (*SyncOrdersParams) WithTimeout ¶
func (o *SyncOrdersParams) WithTimeout(timeout time.Duration) *SyncOrdersParams
WithTimeout adds the timeout to the sync orders params
func (*SyncOrdersParams) WriteToRequest ¶
func (o *SyncOrdersParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type SyncOrdersReader ¶
type SyncOrdersReader struct {
// contains filtered or unexported fields
}
SyncOrdersReader is a Reader for the SyncOrders structure.
func (*SyncOrdersReader) ReadResponse ¶
func (o *SyncOrdersReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
Source Files