mto_shipment

package
v0.0.0-...-c486877 Latest Latest
Warning

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

Go to latest
Published: Oct 18, 2024 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source
const UpdateMTOShipmentStatusBadRequestCode int = 400

UpdateMTOShipmentStatusBadRequestCode is the HTTP code returned for type UpdateMTOShipmentStatusBadRequest

View Source
const UpdateMTOShipmentStatusConflictCode int = 409

UpdateMTOShipmentStatusConflictCode is the HTTP code returned for type UpdateMTOShipmentStatusConflict

View Source
const UpdateMTOShipmentStatusForbiddenCode int = 403

UpdateMTOShipmentStatusForbiddenCode is the HTTP code returned for type UpdateMTOShipmentStatusForbidden

View Source
const UpdateMTOShipmentStatusInternalServerErrorCode int = 500

UpdateMTOShipmentStatusInternalServerErrorCode is the HTTP code returned for type UpdateMTOShipmentStatusInternalServerError

View Source
const UpdateMTOShipmentStatusNotFoundCode int = 404

UpdateMTOShipmentStatusNotFoundCode is the HTTP code returned for type UpdateMTOShipmentStatusNotFound

View Source
const UpdateMTOShipmentStatusOKCode int = 200

UpdateMTOShipmentStatusOKCode is the HTTP code returned for type UpdateMTOShipmentStatusOK

View Source
const UpdateMTOShipmentStatusPreconditionFailedCode int = 412

UpdateMTOShipmentStatusPreconditionFailedCode is the HTTP code returned for type UpdateMTOShipmentStatusPreconditionFailed

View Source
const UpdateMTOShipmentStatusUnauthorizedCode int = 401

UpdateMTOShipmentStatusUnauthorizedCode is the HTTP code returned for type UpdateMTOShipmentStatusUnauthorized

View Source
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

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

SetPayload sets the payload to the update m t o shipment status bad request response

func (*UpdateMTOShipmentStatusBadRequest) WithPayload

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

SetPayload sets the payload to the update m t o shipment status conflict response

func (*UpdateMTOShipmentStatusConflict) WithPayload

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

SetPayload sets the payload to the update m t o shipment status forbidden response

func (*UpdateMTOShipmentStatusForbidden) WithPayload

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

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

SetPayload sets the payload to the update m t o shipment status internal server error response

func (*UpdateMTOShipmentStatusInternalServerError) WithPayload

WithPayload adds the payload to the update m t o shipment status internal server error response

func (*UpdateMTOShipmentStatusInternalServerError) WriteResponse

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

SetPayload sets the payload to the update m t o shipment status not found response

func (*UpdateMTOShipmentStatusNotFound) WithPayload

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

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

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

SetPayload sets the payload to the update m t o shipment status precondition failed response

func (*UpdateMTOShipmentStatusPreconditionFailed) WithPayload

WithPayload adds the payload to the update m t o shipment status precondition failed response

func (*UpdateMTOShipmentStatusPreconditionFailed) WriteResponse

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

func (o *UpdateMTOShipmentStatusURL) Must(u *url.URL, err error) *url.URL

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

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 {

	/*
	  In: Body
	*/
	Payload *supportmessages.ClientError `json:"body,omitempty"`
}

UpdateMTOShipmentStatusUnauthorized The request was denied.

swagger:response updateMTOShipmentStatusUnauthorized

func NewUpdateMTOShipmentStatusUnauthorized

func NewUpdateMTOShipmentStatusUnauthorized() *UpdateMTOShipmentStatusUnauthorized

NewUpdateMTOShipmentStatusUnauthorized creates UpdateMTOShipmentStatusUnauthorized with default headers values

func (*UpdateMTOShipmentStatusUnauthorized) SetPayload

SetPayload sets the payload to the update m t o shipment status unauthorized response

func (*UpdateMTOShipmentStatusUnauthorized) WithPayload

WithPayload adds the payload to the update m t o shipment status unauthorized response

func (*UpdateMTOShipmentStatusUnauthorized) WriteResponse

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

SetPayload sets the payload to the update m t o shipment status unprocessable entity response

func (*UpdateMTOShipmentStatusUnprocessableEntity) WithPayload

WithPayload adds the payload to the update m t o shipment status unprocessable entity response

func (*UpdateMTOShipmentStatusUnprocessableEntity) WriteResponse

WriteResponse to the client

Jump to

Keyboard shortcuts

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