shipment

package
v0.3.0 Latest Latest
Warning

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

Go to latest
Published: Dec 14, 2023 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 Client

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

Client for shipment API

func (*Client) SetTransport

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

SetTransport changes the transport on the client

func (*Client) UpdateShipmentStatus

func (a *Client) UpdateShipmentStatus(params *UpdateShipmentStatusParams, opts ...ClientOption) (*UpdateShipmentStatusNoContent, error)
UpdateShipmentStatus Update the shipment status for an order that you specify.

**Usage Plan:**

| Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 |

The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).

type ClientOption

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService

type ClientService interface {
	UpdateShipmentStatus(params *UpdateShipmentStatusParams, opts ...ClientOption) (*UpdateShipmentStatusNoContent, 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 shipment API client.

type UpdateShipmentStatusBadRequest

type UpdateShipmentStatusBadRequest struct {

	/* Your rate limit (requests per second) for this operation.
	 */
	XAmznRateLimitLimit string

	/* Unique request reference identifier.
	 */
	XAmznRequestID string

	Payload *orders_v0_models.UpdateShipmentStatusErrorResponse
}

UpdateShipmentStatusBadRequest describes a response with status code 400, with default header values.

Request has missing or invalid parameters and cannot be parsed.

func NewUpdateShipmentStatusBadRequest

func NewUpdateShipmentStatusBadRequest() *UpdateShipmentStatusBadRequest

NewUpdateShipmentStatusBadRequest creates a UpdateShipmentStatusBadRequest with default headers values

func (*UpdateShipmentStatusBadRequest) Error

func (*UpdateShipmentStatusBadRequest) GetPayload

func (*UpdateShipmentStatusBadRequest) IsClientError

func (o *UpdateShipmentStatusBadRequest) IsClientError() bool

IsClientError returns true when this update shipment status bad request response has a 4xx status code

func (*UpdateShipmentStatusBadRequest) IsCode

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

IsCode returns true when this update shipment status bad request response a status code equal to that given

func (*UpdateShipmentStatusBadRequest) IsRedirect

func (o *UpdateShipmentStatusBadRequest) IsRedirect() bool

IsRedirect returns true when this update shipment status bad request response has a 3xx status code

func (*UpdateShipmentStatusBadRequest) IsServerError

func (o *UpdateShipmentStatusBadRequest) IsServerError() bool

IsServerError returns true when this update shipment status bad request response has a 5xx status code

func (*UpdateShipmentStatusBadRequest) IsSuccess

func (o *UpdateShipmentStatusBadRequest) IsSuccess() bool

IsSuccess returns true when this update shipment status bad request response has a 2xx status code

func (*UpdateShipmentStatusBadRequest) String

type UpdateShipmentStatusForbidden

type UpdateShipmentStatusForbidden struct {

	/* Unique request reference identifier.
	 */
	XAmznRequestID string

	Payload *orders_v0_models.UpdateShipmentStatusErrorResponse
}

UpdateShipmentStatusForbidden describes a response with status code 403, with default header values.

Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

func NewUpdateShipmentStatusForbidden

func NewUpdateShipmentStatusForbidden() *UpdateShipmentStatusForbidden

NewUpdateShipmentStatusForbidden creates a UpdateShipmentStatusForbidden with default headers values

func (*UpdateShipmentStatusForbidden) Error

func (*UpdateShipmentStatusForbidden) GetPayload

func (*UpdateShipmentStatusForbidden) IsClientError

func (o *UpdateShipmentStatusForbidden) IsClientError() bool

IsClientError returns true when this update shipment status forbidden response has a 4xx status code

func (*UpdateShipmentStatusForbidden) IsCode

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

IsCode returns true when this update shipment status forbidden response a status code equal to that given

func (*UpdateShipmentStatusForbidden) IsRedirect

func (o *UpdateShipmentStatusForbidden) IsRedirect() bool

IsRedirect returns true when this update shipment status forbidden response has a 3xx status code

func (*UpdateShipmentStatusForbidden) IsServerError

func (o *UpdateShipmentStatusForbidden) IsServerError() bool

IsServerError returns true when this update shipment status forbidden response has a 5xx status code

func (*UpdateShipmentStatusForbidden) IsSuccess

func (o *UpdateShipmentStatusForbidden) IsSuccess() bool

IsSuccess returns true when this update shipment status forbidden response has a 2xx status code

func (*UpdateShipmentStatusForbidden) String

type UpdateShipmentStatusInternalServerError

type UpdateShipmentStatusInternalServerError struct {

	/* Unique request reference identifier.
	 */
	XAmznRequestID string

	Payload *orders_v0_models.UpdateShipmentStatusErrorResponse
}

UpdateShipmentStatusInternalServerError describes a response with status code 500, with default header values.

An unexpected condition occurred that prevented the server from fulfilling the request.

func NewUpdateShipmentStatusInternalServerError

func NewUpdateShipmentStatusInternalServerError() *UpdateShipmentStatusInternalServerError

NewUpdateShipmentStatusInternalServerError creates a UpdateShipmentStatusInternalServerError with default headers values

func (*UpdateShipmentStatusInternalServerError) Error

func (*UpdateShipmentStatusInternalServerError) GetPayload

func (*UpdateShipmentStatusInternalServerError) IsClientError

func (o *UpdateShipmentStatusInternalServerError) IsClientError() bool

IsClientError returns true when this update shipment status internal server error response has a 4xx status code

func (*UpdateShipmentStatusInternalServerError) IsCode

IsCode returns true when this update shipment status internal server error response a status code equal to that given

func (*UpdateShipmentStatusInternalServerError) IsRedirect

IsRedirect returns true when this update shipment status internal server error response has a 3xx status code

func (*UpdateShipmentStatusInternalServerError) IsServerError

func (o *UpdateShipmentStatusInternalServerError) IsServerError() bool

IsServerError returns true when this update shipment status internal server error response has a 5xx status code

func (*UpdateShipmentStatusInternalServerError) IsSuccess

IsSuccess returns true when this update shipment status internal server error response has a 2xx status code

func (*UpdateShipmentStatusInternalServerError) String

type UpdateShipmentStatusNoContent

type UpdateShipmentStatusNoContent struct {

	/* Your rate limit (requests per second) for this operation.
	 */
	XAmznRateLimitLimit string

	/* Unique request reference identifier.
	 */
	XAmznRequestID string
}

UpdateShipmentStatusNoContent describes a response with status code 204, with default header values.

Success.

func NewUpdateShipmentStatusNoContent

func NewUpdateShipmentStatusNoContent() *UpdateShipmentStatusNoContent

NewUpdateShipmentStatusNoContent creates a UpdateShipmentStatusNoContent with default headers values

func (*UpdateShipmentStatusNoContent) Error

func (*UpdateShipmentStatusNoContent) IsClientError

func (o *UpdateShipmentStatusNoContent) IsClientError() bool

IsClientError returns true when this update shipment status no content response has a 4xx status code

func (*UpdateShipmentStatusNoContent) IsCode

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

IsCode returns true when this update shipment status no content response a status code equal to that given

func (*UpdateShipmentStatusNoContent) IsRedirect

func (o *UpdateShipmentStatusNoContent) IsRedirect() bool

IsRedirect returns true when this update shipment status no content response has a 3xx status code

func (*UpdateShipmentStatusNoContent) IsServerError

func (o *UpdateShipmentStatusNoContent) IsServerError() bool

IsServerError returns true when this update shipment status no content response has a 5xx status code

func (*UpdateShipmentStatusNoContent) IsSuccess

func (o *UpdateShipmentStatusNoContent) IsSuccess() bool

IsSuccess returns true when this update shipment status no content response has a 2xx status code

func (*UpdateShipmentStatusNoContent) String

type UpdateShipmentStatusNotFound

type UpdateShipmentStatusNotFound struct {

	/* Your rate limit (requests per second) for this operation.
	 */
	XAmznRateLimitLimit string

	/* Unique request reference identifier.
	 */
	XAmznRequestID string

	Payload *orders_v0_models.UpdateShipmentStatusErrorResponse
}

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

The resource specified does not exist.

func NewUpdateShipmentStatusNotFound

func NewUpdateShipmentStatusNotFound() *UpdateShipmentStatusNotFound

NewUpdateShipmentStatusNotFound creates a UpdateShipmentStatusNotFound with default headers values

func (*UpdateShipmentStatusNotFound) Error

func (*UpdateShipmentStatusNotFound) GetPayload

func (*UpdateShipmentStatusNotFound) IsClientError

func (o *UpdateShipmentStatusNotFound) IsClientError() bool

IsClientError returns true when this update shipment status not found response has a 4xx status code

func (*UpdateShipmentStatusNotFound) IsCode

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

IsCode returns true when this update shipment status not found response a status code equal to that given

func (*UpdateShipmentStatusNotFound) IsRedirect

func (o *UpdateShipmentStatusNotFound) IsRedirect() bool

IsRedirect returns true when this update shipment status not found response has a 3xx status code

func (*UpdateShipmentStatusNotFound) IsServerError

func (o *UpdateShipmentStatusNotFound) IsServerError() bool

IsServerError returns true when this update shipment status not found response has a 5xx status code

func (*UpdateShipmentStatusNotFound) IsSuccess

func (o *UpdateShipmentStatusNotFound) IsSuccess() bool

IsSuccess returns true when this update shipment status not found response has a 2xx status code

func (*UpdateShipmentStatusNotFound) String

type UpdateShipmentStatusParams

type UpdateShipmentStatusParams struct {

	/* OrderID.

	   An Amazon-defined order identifier, in 3-7-7 format.
	*/
	OrderID string

	/* Payload.

	   The request body for the updateShipmentStatus operation.
	*/
	Payload *orders_v0_models.UpdateShipmentStatusRequest

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

UpdateShipmentStatusParams contains all the parameters to send to the API endpoint

for the update shipment status operation.

Typically these are written to a http.Request.

func NewUpdateShipmentStatusParams

func NewUpdateShipmentStatusParams() *UpdateShipmentStatusParams

NewUpdateShipmentStatusParams creates a new UpdateShipmentStatusParams 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 NewUpdateShipmentStatusParamsWithContext

func NewUpdateShipmentStatusParamsWithContext(ctx context.Context) *UpdateShipmentStatusParams

NewUpdateShipmentStatusParamsWithContext creates a new UpdateShipmentStatusParams object with the ability to set a context for a request.

func NewUpdateShipmentStatusParamsWithHTTPClient

func NewUpdateShipmentStatusParamsWithHTTPClient(client *http.Client) *UpdateShipmentStatusParams

NewUpdateShipmentStatusParamsWithHTTPClient creates a new UpdateShipmentStatusParams object with the ability to set a custom HTTPClient for a request.

func NewUpdateShipmentStatusParamsWithTimeout

func NewUpdateShipmentStatusParamsWithTimeout(timeout time.Duration) *UpdateShipmentStatusParams

NewUpdateShipmentStatusParamsWithTimeout creates a new UpdateShipmentStatusParams object with the ability to set a timeout on a request.

func (*UpdateShipmentStatusParams) SetContext

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

SetContext adds the context to the update shipment status params

func (*UpdateShipmentStatusParams) SetDefaults

func (o *UpdateShipmentStatusParams) SetDefaults()

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

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

func (*UpdateShipmentStatusParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the update shipment status params

func (*UpdateShipmentStatusParams) SetOrderID

func (o *UpdateShipmentStatusParams) SetOrderID(orderID string)

SetOrderID adds the orderId to the update shipment status params

func (*UpdateShipmentStatusParams) SetPayload

SetPayload adds the payload to the update shipment status params

func (*UpdateShipmentStatusParams) SetTimeout

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

SetTimeout adds the timeout to the update shipment status params

func (*UpdateShipmentStatusParams) WithContext

WithContext adds the context to the update shipment status params

func (*UpdateShipmentStatusParams) WithDefaults

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

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

func (*UpdateShipmentStatusParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the update shipment status params

func (*UpdateShipmentStatusParams) WithOrderID

WithOrderID adds the orderID to the update shipment status params

func (*UpdateShipmentStatusParams) WithPayload

WithPayload adds the payload to the update shipment status params

func (*UpdateShipmentStatusParams) WithTimeout

WithTimeout adds the timeout to the update shipment status params

func (*UpdateShipmentStatusParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type UpdateShipmentStatusReader

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

UpdateShipmentStatusReader is a Reader for the UpdateShipmentStatus structure.

func (*UpdateShipmentStatusReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type UpdateShipmentStatusRequestEntityTooLarge

type UpdateShipmentStatusRequestEntityTooLarge struct {

	/* Unique request reference identifier.
	 */
	XAmznRequestID string

	Payload *orders_v0_models.UpdateShipmentStatusErrorResponse
}

UpdateShipmentStatusRequestEntityTooLarge describes a response with status code 413, with default header values.

The request size exceeded the maximum accepted size.

func NewUpdateShipmentStatusRequestEntityTooLarge

func NewUpdateShipmentStatusRequestEntityTooLarge() *UpdateShipmentStatusRequestEntityTooLarge

NewUpdateShipmentStatusRequestEntityTooLarge creates a UpdateShipmentStatusRequestEntityTooLarge with default headers values

func (*UpdateShipmentStatusRequestEntityTooLarge) Error

func (*UpdateShipmentStatusRequestEntityTooLarge) GetPayload

func (*UpdateShipmentStatusRequestEntityTooLarge) IsClientError

IsClientError returns true when this update shipment status request entity too large response has a 4xx status code

func (*UpdateShipmentStatusRequestEntityTooLarge) IsCode

IsCode returns true when this update shipment status request entity too large response a status code equal to that given

func (*UpdateShipmentStatusRequestEntityTooLarge) IsRedirect

IsRedirect returns true when this update shipment status request entity too large response has a 3xx status code

func (*UpdateShipmentStatusRequestEntityTooLarge) IsServerError

IsServerError returns true when this update shipment status request entity too large response has a 5xx status code

func (*UpdateShipmentStatusRequestEntityTooLarge) IsSuccess

IsSuccess returns true when this update shipment status request entity too large response has a 2xx status code

func (*UpdateShipmentStatusRequestEntityTooLarge) String

type UpdateShipmentStatusServiceUnavailable

type UpdateShipmentStatusServiceUnavailable struct {

	/* Unique request reference identifier.
	 */
	XAmznRequestID string

	Payload *orders_v0_models.UpdateShipmentStatusErrorResponse
}

UpdateShipmentStatusServiceUnavailable describes a response with status code 503, with default header values.

Temporary overloading or maintenance of the server.

func NewUpdateShipmentStatusServiceUnavailable

func NewUpdateShipmentStatusServiceUnavailable() *UpdateShipmentStatusServiceUnavailable

NewUpdateShipmentStatusServiceUnavailable creates a UpdateShipmentStatusServiceUnavailable with default headers values

func (*UpdateShipmentStatusServiceUnavailable) Error

func (*UpdateShipmentStatusServiceUnavailable) GetPayload

func (*UpdateShipmentStatusServiceUnavailable) IsClientError

func (o *UpdateShipmentStatusServiceUnavailable) IsClientError() bool

IsClientError returns true when this update shipment status service unavailable response has a 4xx status code

func (*UpdateShipmentStatusServiceUnavailable) IsCode

IsCode returns true when this update shipment status service unavailable response a status code equal to that given

func (*UpdateShipmentStatusServiceUnavailable) IsRedirect

IsRedirect returns true when this update shipment status service unavailable response has a 3xx status code

func (*UpdateShipmentStatusServiceUnavailable) IsServerError

func (o *UpdateShipmentStatusServiceUnavailable) IsServerError() bool

IsServerError returns true when this update shipment status service unavailable response has a 5xx status code

func (*UpdateShipmentStatusServiceUnavailable) IsSuccess

IsSuccess returns true when this update shipment status service unavailable response has a 2xx status code

func (*UpdateShipmentStatusServiceUnavailable) String

type UpdateShipmentStatusTooManyRequests

type UpdateShipmentStatusTooManyRequests struct {

	/* Unique request reference identifier.
	 */
	XAmznRequestID string

	Payload *orders_v0_models.UpdateShipmentStatusErrorResponse
}

UpdateShipmentStatusTooManyRequests describes a response with status code 429, with default header values.

The frequency of requests was greater than allowed.

func NewUpdateShipmentStatusTooManyRequests

func NewUpdateShipmentStatusTooManyRequests() *UpdateShipmentStatusTooManyRequests

NewUpdateShipmentStatusTooManyRequests creates a UpdateShipmentStatusTooManyRequests with default headers values

func (*UpdateShipmentStatusTooManyRequests) Error

func (*UpdateShipmentStatusTooManyRequests) GetPayload

func (*UpdateShipmentStatusTooManyRequests) IsClientError

func (o *UpdateShipmentStatusTooManyRequests) IsClientError() bool

IsClientError returns true when this update shipment status too many requests response has a 4xx status code

func (*UpdateShipmentStatusTooManyRequests) IsCode

IsCode returns true when this update shipment status too many requests response a status code equal to that given

func (*UpdateShipmentStatusTooManyRequests) IsRedirect

func (o *UpdateShipmentStatusTooManyRequests) IsRedirect() bool

IsRedirect returns true when this update shipment status too many requests response has a 3xx status code

func (*UpdateShipmentStatusTooManyRequests) IsServerError

func (o *UpdateShipmentStatusTooManyRequests) IsServerError() bool

IsServerError returns true when this update shipment status too many requests response has a 5xx status code

func (*UpdateShipmentStatusTooManyRequests) IsSuccess

IsSuccess returns true when this update shipment status too many requests response has a 2xx status code

func (*UpdateShipmentStatusTooManyRequests) String

type UpdateShipmentStatusUnsupportedMediaType

type UpdateShipmentStatusUnsupportedMediaType struct {

	/* Unique request reference identifier.
	 */
	XAmznRequestID string

	Payload *orders_v0_models.UpdateShipmentStatusErrorResponse
}

UpdateShipmentStatusUnsupportedMediaType describes a response with status code 415, with default header values.

The request payload is in an unsupported format.

func NewUpdateShipmentStatusUnsupportedMediaType

func NewUpdateShipmentStatusUnsupportedMediaType() *UpdateShipmentStatusUnsupportedMediaType

NewUpdateShipmentStatusUnsupportedMediaType creates a UpdateShipmentStatusUnsupportedMediaType with default headers values

func (*UpdateShipmentStatusUnsupportedMediaType) Error

func (*UpdateShipmentStatusUnsupportedMediaType) GetPayload

func (*UpdateShipmentStatusUnsupportedMediaType) IsClientError

IsClientError returns true when this update shipment status unsupported media type response has a 4xx status code

func (*UpdateShipmentStatusUnsupportedMediaType) IsCode

IsCode returns true when this update shipment status unsupported media type response a status code equal to that given

func (*UpdateShipmentStatusUnsupportedMediaType) IsRedirect

IsRedirect returns true when this update shipment status unsupported media type response has a 3xx status code

func (*UpdateShipmentStatusUnsupportedMediaType) IsServerError

IsServerError returns true when this update shipment status unsupported media type response has a 5xx status code

func (*UpdateShipmentStatusUnsupportedMediaType) IsSuccess

IsSuccess returns true when this update shipment status unsupported media type response has a 2xx status code

func (*UpdateShipmentStatusUnsupportedMediaType) String

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL