Documentation
¶
Index ¶
- Constants
- type UpdateMTOShipmentStatus
- type UpdateMTOShipmentStatusBadRequest
- func (o *UpdateMTOShipmentStatusBadRequest) SetPayload(payload *supportmessages.ClientError)
- func (o *UpdateMTOShipmentStatusBadRequest) WithPayload(payload *supportmessages.ClientError) *UpdateMTOShipmentStatusBadRequest
- func (o *UpdateMTOShipmentStatusBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type UpdateMTOShipmentStatusConflict
- func (o *UpdateMTOShipmentStatusConflict) SetPayload(payload *supportmessages.ClientError)
- func (o *UpdateMTOShipmentStatusConflict) WithPayload(payload *supportmessages.ClientError) *UpdateMTOShipmentStatusConflict
- func (o *UpdateMTOShipmentStatusConflict) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type UpdateMTOShipmentStatusForbidden
- func (o *UpdateMTOShipmentStatusForbidden) SetPayload(payload *supportmessages.ClientError)
- func (o *UpdateMTOShipmentStatusForbidden) WithPayload(payload *supportmessages.ClientError) *UpdateMTOShipmentStatusForbidden
- func (o *UpdateMTOShipmentStatusForbidden) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type UpdateMTOShipmentStatusHandler
- type UpdateMTOShipmentStatusHandlerFunc
- type UpdateMTOShipmentStatusInternalServerError
- func (o *UpdateMTOShipmentStatusInternalServerError) SetPayload(payload *supportmessages.Error)
- func (o *UpdateMTOShipmentStatusInternalServerError) WithPayload(payload *supportmessages.Error) *UpdateMTOShipmentStatusInternalServerError
- func (o *UpdateMTOShipmentStatusInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type UpdateMTOShipmentStatusNotFound
- func (o *UpdateMTOShipmentStatusNotFound) SetPayload(payload *supportmessages.ClientError)
- func (o *UpdateMTOShipmentStatusNotFound) WithPayload(payload *supportmessages.ClientError) *UpdateMTOShipmentStatusNotFound
- func (o *UpdateMTOShipmentStatusNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type UpdateMTOShipmentStatusOK
- type UpdateMTOShipmentStatusParams
- type UpdateMTOShipmentStatusPreconditionFailed
- func (o *UpdateMTOShipmentStatusPreconditionFailed) SetPayload(payload *supportmessages.ClientError)
- func (o *UpdateMTOShipmentStatusPreconditionFailed) WithPayload(payload *supportmessages.ClientError) *UpdateMTOShipmentStatusPreconditionFailed
- func (o *UpdateMTOShipmentStatusPreconditionFailed) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type UpdateMTOShipmentStatusURL
- func (o *UpdateMTOShipmentStatusURL) Build() (*url.URL, error)
- func (o *UpdateMTOShipmentStatusURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *UpdateMTOShipmentStatusURL) Must(u *url.URL, err error) *url.URL
- func (o *UpdateMTOShipmentStatusURL) SetBasePath(bp string)
- func (o *UpdateMTOShipmentStatusURL) String() string
- func (o *UpdateMTOShipmentStatusURL) StringFull(scheme, host string) string
- func (o *UpdateMTOShipmentStatusURL) WithBasePath(bp string) *UpdateMTOShipmentStatusURL
- type UpdateMTOShipmentStatusUnauthorized
- func (o *UpdateMTOShipmentStatusUnauthorized) SetPayload(payload *supportmessages.ClientError)
- func (o *UpdateMTOShipmentStatusUnauthorized) WithPayload(payload *supportmessages.ClientError) *UpdateMTOShipmentStatusUnauthorized
- func (o *UpdateMTOShipmentStatusUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type UpdateMTOShipmentStatusUnprocessableEntity
- func (o *UpdateMTOShipmentStatusUnprocessableEntity) SetPayload(payload *supportmessages.ValidationError)
- func (o *UpdateMTOShipmentStatusUnprocessableEntity) WithPayload(payload *supportmessages.ValidationError) *UpdateMTOShipmentStatusUnprocessableEntity
- func (o *UpdateMTOShipmentStatusUnprocessableEntity) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
Constants ¶
const UpdateMTOShipmentStatusBadRequestCode int = 400
UpdateMTOShipmentStatusBadRequestCode is the HTTP code returned for type UpdateMTOShipmentStatusBadRequest
const UpdateMTOShipmentStatusConflictCode int = 409
UpdateMTOShipmentStatusConflictCode is the HTTP code returned for type UpdateMTOShipmentStatusConflict
const UpdateMTOShipmentStatusForbiddenCode int = 403
UpdateMTOShipmentStatusForbiddenCode is the HTTP code returned for type UpdateMTOShipmentStatusForbidden
const UpdateMTOShipmentStatusInternalServerErrorCode int = 500
UpdateMTOShipmentStatusInternalServerErrorCode is the HTTP code returned for type UpdateMTOShipmentStatusInternalServerError
const UpdateMTOShipmentStatusNotFoundCode int = 404
UpdateMTOShipmentStatusNotFoundCode is the HTTP code returned for type UpdateMTOShipmentStatusNotFound
const UpdateMTOShipmentStatusOKCode int = 200
UpdateMTOShipmentStatusOKCode is the HTTP code returned for type UpdateMTOShipmentStatusOK
const UpdateMTOShipmentStatusPreconditionFailedCode int = 412
UpdateMTOShipmentStatusPreconditionFailedCode is the HTTP code returned for type UpdateMTOShipmentStatusPreconditionFailed
UpdateMTOShipmentStatusUnauthorizedCode is the HTTP code returned for type UpdateMTOShipmentStatusUnauthorized
const UpdateMTOShipmentStatusUnprocessableEntityCode int = 422
UpdateMTOShipmentStatusUnprocessableEntityCode is the HTTP code returned for type UpdateMTOShipmentStatusUnprocessableEntity
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type UpdateMTOShipmentStatus ¶
type UpdateMTOShipmentStatus struct { Context *middleware.Context Handler UpdateMTOShipmentStatusHandler }
UpdateMTOShipmentStatus swagger:route PATCH /mto-shipments/{mtoShipmentID}/status mtoShipment updateMTOShipmentStatus
updateMTOShipmentStatus
Updates a shipment's status to APPROVED or REJECTED for the purpose of testing the Prime API. If APPROVED, `rejectionReason` should be blank and any value passed through the body will be ignored. If REJECTED, a value in `rejectionReason` is required. <br /> <br /> This is a support endpoint and will not be available in production.
func NewUpdateMTOShipmentStatus ¶
func NewUpdateMTOShipmentStatus(ctx *middleware.Context, handler UpdateMTOShipmentStatusHandler) *UpdateMTOShipmentStatus
NewUpdateMTOShipmentStatus creates a new http.Handler for the update m t o shipment status operation
func (*UpdateMTOShipmentStatus) ServeHTTP ¶
func (o *UpdateMTOShipmentStatus) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type UpdateMTOShipmentStatusBadRequest ¶
type UpdateMTOShipmentStatusBadRequest struct { /* In: Body */ Payload *supportmessages.ClientError `json:"body,omitempty"` }
UpdateMTOShipmentStatusBadRequest The request payload is invalid.
swagger:response updateMTOShipmentStatusBadRequest
func NewUpdateMTOShipmentStatusBadRequest ¶
func NewUpdateMTOShipmentStatusBadRequest() *UpdateMTOShipmentStatusBadRequest
NewUpdateMTOShipmentStatusBadRequest creates UpdateMTOShipmentStatusBadRequest with default headers values
func (*UpdateMTOShipmentStatusBadRequest) SetPayload ¶
func (o *UpdateMTOShipmentStatusBadRequest) SetPayload(payload *supportmessages.ClientError)
SetPayload sets the payload to the update m t o shipment status bad request response
func (*UpdateMTOShipmentStatusBadRequest) WithPayload ¶
func (o *UpdateMTOShipmentStatusBadRequest) WithPayload(payload *supportmessages.ClientError) *UpdateMTOShipmentStatusBadRequest
WithPayload adds the payload to the update m t o shipment status bad request response
func (*UpdateMTOShipmentStatusBadRequest) WriteResponse ¶
func (o *UpdateMTOShipmentStatusBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type UpdateMTOShipmentStatusConflict ¶
type UpdateMTOShipmentStatusConflict struct { /* In: Body */ Payload *supportmessages.ClientError `json:"body,omitempty"` }
UpdateMTOShipmentStatusConflict There was a conflict with the request.
swagger:response updateMTOShipmentStatusConflict
func NewUpdateMTOShipmentStatusConflict ¶
func NewUpdateMTOShipmentStatusConflict() *UpdateMTOShipmentStatusConflict
NewUpdateMTOShipmentStatusConflict creates UpdateMTOShipmentStatusConflict with default headers values
func (*UpdateMTOShipmentStatusConflict) SetPayload ¶
func (o *UpdateMTOShipmentStatusConflict) SetPayload(payload *supportmessages.ClientError)
SetPayload sets the payload to the update m t o shipment status conflict response
func (*UpdateMTOShipmentStatusConflict) WithPayload ¶
func (o *UpdateMTOShipmentStatusConflict) WithPayload(payload *supportmessages.ClientError) *UpdateMTOShipmentStatusConflict
WithPayload adds the payload to the update m t o shipment status conflict response
func (*UpdateMTOShipmentStatusConflict) WriteResponse ¶
func (o *UpdateMTOShipmentStatusConflict) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type UpdateMTOShipmentStatusForbidden ¶
type UpdateMTOShipmentStatusForbidden struct { /* In: Body */ Payload *supportmessages.ClientError `json:"body,omitempty"` }
UpdateMTOShipmentStatusForbidden The request was denied.
swagger:response updateMTOShipmentStatusForbidden
func NewUpdateMTOShipmentStatusForbidden ¶
func NewUpdateMTOShipmentStatusForbidden() *UpdateMTOShipmentStatusForbidden
NewUpdateMTOShipmentStatusForbidden creates UpdateMTOShipmentStatusForbidden with default headers values
func (*UpdateMTOShipmentStatusForbidden) SetPayload ¶
func (o *UpdateMTOShipmentStatusForbidden) SetPayload(payload *supportmessages.ClientError)
SetPayload sets the payload to the update m t o shipment status forbidden response
func (*UpdateMTOShipmentStatusForbidden) WithPayload ¶
func (o *UpdateMTOShipmentStatusForbidden) WithPayload(payload *supportmessages.ClientError) *UpdateMTOShipmentStatusForbidden
WithPayload adds the payload to the update m t o shipment status forbidden response
func (*UpdateMTOShipmentStatusForbidden) WriteResponse ¶
func (o *UpdateMTOShipmentStatusForbidden) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type UpdateMTOShipmentStatusHandler ¶
type UpdateMTOShipmentStatusHandler interface {
Handle(UpdateMTOShipmentStatusParams) middleware.Responder
}
UpdateMTOShipmentStatusHandler interface for that can handle valid update m t o shipment status params
type UpdateMTOShipmentStatusHandlerFunc ¶
type UpdateMTOShipmentStatusHandlerFunc func(UpdateMTOShipmentStatusParams) middleware.Responder
UpdateMTOShipmentStatusHandlerFunc turns a function with the right signature into a update m t o shipment status handler
func (UpdateMTOShipmentStatusHandlerFunc) Handle ¶
func (fn UpdateMTOShipmentStatusHandlerFunc) Handle(params UpdateMTOShipmentStatusParams) middleware.Responder
Handle executing the request and returning a response
type UpdateMTOShipmentStatusInternalServerError ¶
type UpdateMTOShipmentStatusInternalServerError struct { /* In: Body */ Payload *supportmessages.Error `json:"body,omitempty"` }
UpdateMTOShipmentStatusInternalServerError A server error occurred.
swagger:response updateMTOShipmentStatusInternalServerError
func NewUpdateMTOShipmentStatusInternalServerError ¶
func NewUpdateMTOShipmentStatusInternalServerError() *UpdateMTOShipmentStatusInternalServerError
NewUpdateMTOShipmentStatusInternalServerError creates UpdateMTOShipmentStatusInternalServerError with default headers values
func (*UpdateMTOShipmentStatusInternalServerError) SetPayload ¶
func (o *UpdateMTOShipmentStatusInternalServerError) SetPayload(payload *supportmessages.Error)
SetPayload sets the payload to the update m t o shipment status internal server error response
func (*UpdateMTOShipmentStatusInternalServerError) WithPayload ¶
func (o *UpdateMTOShipmentStatusInternalServerError) WithPayload(payload *supportmessages.Error) *UpdateMTOShipmentStatusInternalServerError
WithPayload adds the payload to the update m t o shipment status internal server error response
func (*UpdateMTOShipmentStatusInternalServerError) WriteResponse ¶
func (o *UpdateMTOShipmentStatusInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type UpdateMTOShipmentStatusNotFound ¶
type UpdateMTOShipmentStatusNotFound struct { /* In: Body */ Payload *supportmessages.ClientError `json:"body,omitempty"` }
UpdateMTOShipmentStatusNotFound The requested resource wasn't found.
swagger:response updateMTOShipmentStatusNotFound
func NewUpdateMTOShipmentStatusNotFound ¶
func NewUpdateMTOShipmentStatusNotFound() *UpdateMTOShipmentStatusNotFound
NewUpdateMTOShipmentStatusNotFound creates UpdateMTOShipmentStatusNotFound with default headers values
func (*UpdateMTOShipmentStatusNotFound) SetPayload ¶
func (o *UpdateMTOShipmentStatusNotFound) SetPayload(payload *supportmessages.ClientError)
SetPayload sets the payload to the update m t o shipment status not found response
func (*UpdateMTOShipmentStatusNotFound) WithPayload ¶
func (o *UpdateMTOShipmentStatusNotFound) WithPayload(payload *supportmessages.ClientError) *UpdateMTOShipmentStatusNotFound
WithPayload adds the payload to the update m t o shipment status not found response
func (*UpdateMTOShipmentStatusNotFound) WriteResponse ¶
func (o *UpdateMTOShipmentStatusNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type UpdateMTOShipmentStatusOK ¶
type UpdateMTOShipmentStatusOK struct { /* In: Body */ Payload *supportmessages.MTOShipment `json:"body,omitempty"` }
UpdateMTOShipmentStatusOK Successfully updated the shipment's status.
swagger:response updateMTOShipmentStatusOK
func NewUpdateMTOShipmentStatusOK ¶
func NewUpdateMTOShipmentStatusOK() *UpdateMTOShipmentStatusOK
NewUpdateMTOShipmentStatusOK creates UpdateMTOShipmentStatusOK with default headers values
func (*UpdateMTOShipmentStatusOK) SetPayload ¶
func (o *UpdateMTOShipmentStatusOK) SetPayload(payload *supportmessages.MTOShipment)
SetPayload sets the payload to the update m t o shipment status o k response
func (*UpdateMTOShipmentStatusOK) WithPayload ¶
func (o *UpdateMTOShipmentStatusOK) WithPayload(payload *supportmessages.MTOShipment) *UpdateMTOShipmentStatusOK
WithPayload adds the payload to the update m t o shipment status o k response
func (*UpdateMTOShipmentStatusOK) WriteResponse ¶
func (o *UpdateMTOShipmentStatusOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type UpdateMTOShipmentStatusParams ¶
type UpdateMTOShipmentStatusParams struct { // HTTP Request Object HTTPRequest *http.Request `json:"-"` /*Optimistic locking is implemented via the `If-Match` header. If the ETag header does not match the value of the resource on the server, the server rejects the change with a `412 Precondition Failed` error. Required: true In: header */ IfMatch string /* Required: true In: body */ Body *supportmessages.UpdateMTOShipmentStatus /*UUID of the shipment being updated. Required: true In: path */ MtoShipmentID strfmt.UUID }
UpdateMTOShipmentStatusParams contains all the bound params for the update m t o shipment status operation typically these are obtained from a http.Request
swagger:parameters updateMTOShipmentStatus
func NewUpdateMTOShipmentStatusParams ¶
func NewUpdateMTOShipmentStatusParams() UpdateMTOShipmentStatusParams
NewUpdateMTOShipmentStatusParams creates a new UpdateMTOShipmentStatusParams object
There are no default values defined in the spec.
func (*UpdateMTOShipmentStatusParams) BindRequest ¶
func (o *UpdateMTOShipmentStatusParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.
To ensure default values, the struct must have been initialized with NewUpdateMTOShipmentStatusParams() beforehand.
type UpdateMTOShipmentStatusPreconditionFailed ¶
type UpdateMTOShipmentStatusPreconditionFailed struct { /* In: Body */ Payload *supportmessages.ClientError `json:"body,omitempty"` }
UpdateMTOShipmentStatusPreconditionFailed Precondition failed, likely due to a stale eTag (If-Match). Fetch the request again to get the updated eTag value.
swagger:response updateMTOShipmentStatusPreconditionFailed
func NewUpdateMTOShipmentStatusPreconditionFailed ¶
func NewUpdateMTOShipmentStatusPreconditionFailed() *UpdateMTOShipmentStatusPreconditionFailed
NewUpdateMTOShipmentStatusPreconditionFailed creates UpdateMTOShipmentStatusPreconditionFailed with default headers values
func (*UpdateMTOShipmentStatusPreconditionFailed) SetPayload ¶
func (o *UpdateMTOShipmentStatusPreconditionFailed) SetPayload(payload *supportmessages.ClientError)
SetPayload sets the payload to the update m t o shipment status precondition failed response
func (*UpdateMTOShipmentStatusPreconditionFailed) WithPayload ¶
func (o *UpdateMTOShipmentStatusPreconditionFailed) WithPayload(payload *supportmessages.ClientError) *UpdateMTOShipmentStatusPreconditionFailed
WithPayload adds the payload to the update m t o shipment status precondition failed response
func (*UpdateMTOShipmentStatusPreconditionFailed) WriteResponse ¶
func (o *UpdateMTOShipmentStatusPreconditionFailed) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type UpdateMTOShipmentStatusURL ¶
type UpdateMTOShipmentStatusURL struct { MtoShipmentID strfmt.UUID // contains filtered or unexported fields }
UpdateMTOShipmentStatusURL generates an URL for the update m t o shipment status operation
func (*UpdateMTOShipmentStatusURL) Build ¶
func (o *UpdateMTOShipmentStatusURL) Build() (*url.URL, error)
Build a url path and query string
func (*UpdateMTOShipmentStatusURL) BuildFull ¶
func (o *UpdateMTOShipmentStatusURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*UpdateMTOShipmentStatusURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*UpdateMTOShipmentStatusURL) SetBasePath ¶
func (o *UpdateMTOShipmentStatusURL) SetBasePath(bp string)
SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
func (*UpdateMTOShipmentStatusURL) String ¶
func (o *UpdateMTOShipmentStatusURL) String() string
String returns the string representation of the path with query string
func (*UpdateMTOShipmentStatusURL) StringFull ¶
func (o *UpdateMTOShipmentStatusURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*UpdateMTOShipmentStatusURL) WithBasePath ¶
func (o *UpdateMTOShipmentStatusURL) WithBasePath(bp string) *UpdateMTOShipmentStatusURL
WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
type UpdateMTOShipmentStatusUnauthorized ¶
type UpdateMTOShipmentStatusUnauthorized struct { supportmessages.ClientError `json:"body,omitempty"` }Payload *
UpdateMTOShipmentStatusUnauthorized The request was denied.
swagger:response updateMTOShipmentStatusUnauthorized
func NewUpdateMTOShipmentStatusUnauthorized ¶
func NewUpdateMTOShipmentStatusUnauthorized() *UpdateMTOShipmentStatusUnauthorized
NewUpdateMTOShipmentStatusUnauthorized creates UpdateMTOShipmentStatusUnauthorized with default headers values
func (*UpdateMTOShipmentStatusUnauthorized) SetPayload ¶
func (o *UpdateMTOShipmentStatusUnauthorized) SetPayload(payload *supportmessages.ClientError)
SetPayload sets the payload to the update m t o shipment status unauthorized response
func (*UpdateMTOShipmentStatusUnauthorized) WithPayload ¶
func (o *UpdateMTOShipmentStatusUnauthorized) WithPayload(payload *supportmessages.ClientError) *UpdateMTOShipmentStatusUnauthorized
WithPayload adds the payload to the update m t o shipment status unauthorized response
func (*UpdateMTOShipmentStatusUnauthorized) WriteResponse ¶
func (o *UpdateMTOShipmentStatusUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type UpdateMTOShipmentStatusUnprocessableEntity ¶
type UpdateMTOShipmentStatusUnprocessableEntity struct { /* In: Body */ Payload *supportmessages.ValidationError `json:"body,omitempty"` }
UpdateMTOShipmentStatusUnprocessableEntity The payload was unprocessable.
swagger:response updateMTOShipmentStatusUnprocessableEntity
func NewUpdateMTOShipmentStatusUnprocessableEntity ¶
func NewUpdateMTOShipmentStatusUnprocessableEntity() *UpdateMTOShipmentStatusUnprocessableEntity
NewUpdateMTOShipmentStatusUnprocessableEntity creates UpdateMTOShipmentStatusUnprocessableEntity with default headers values
func (*UpdateMTOShipmentStatusUnprocessableEntity) SetPayload ¶
func (o *UpdateMTOShipmentStatusUnprocessableEntity) SetPayload(payload *supportmessages.ValidationError)
SetPayload sets the payload to the update m t o shipment status unprocessable entity response
func (*UpdateMTOShipmentStatusUnprocessableEntity) WithPayload ¶
func (o *UpdateMTOShipmentStatusUnprocessableEntity) WithPayload(payload *supportmessages.ValidationError) *UpdateMTOShipmentStatusUnprocessableEntity
WithPayload adds the payload to the update m t o shipment status unprocessable entity response
func (*UpdateMTOShipmentStatusUnprocessableEntity) WriteResponse ¶
func (o *UpdateMTOShipmentStatusUnprocessableEntity) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client