mto_shipment

package
v0.0.0-...-c407d37 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source
const CreateMTOAgentBadRequestCode int = 400

CreateMTOAgentBadRequestCode is the HTTP code returned for type CreateMTOAgentBadRequest

View Source
const CreateMTOAgentConflictCode int = 409

CreateMTOAgentConflictCode is the HTTP code returned for type CreateMTOAgentConflict

View Source
const CreateMTOAgentForbiddenCode int = 403

CreateMTOAgentForbiddenCode is the HTTP code returned for type CreateMTOAgentForbidden

View Source
const CreateMTOAgentInternalServerErrorCode int = 500

CreateMTOAgentInternalServerErrorCode is the HTTP code returned for type CreateMTOAgentInternalServerError

View Source
const CreateMTOAgentNotFoundCode int = 404

CreateMTOAgentNotFoundCode is the HTTP code returned for type CreateMTOAgentNotFound

View Source
const CreateMTOAgentOKCode int = 200

CreateMTOAgentOKCode is the HTTP code returned for type CreateMTOAgentOK

View Source
const CreateMTOAgentUnauthorizedCode int = 401

CreateMTOAgentUnauthorizedCode is the HTTP code returned for type CreateMTOAgentUnauthorized

View Source
const CreateMTOAgentUnprocessableEntityCode int = 422

CreateMTOAgentUnprocessableEntityCode is the HTTP code returned for type CreateMTOAgentUnprocessableEntity

View Source
const CreateMTOShipmentBadRequestCode int = 400

CreateMTOShipmentBadRequestCode is the HTTP code returned for type CreateMTOShipmentBadRequest

View Source
const CreateMTOShipmentInternalServerErrorCode int = 500

CreateMTOShipmentInternalServerErrorCode is the HTTP code returned for type CreateMTOShipmentInternalServerError

View Source
const CreateMTOShipmentNotFoundCode int = 404

CreateMTOShipmentNotFoundCode is the HTTP code returned for type CreateMTOShipmentNotFound

View Source
const CreateMTOShipmentOKCode int = 200

CreateMTOShipmentOKCode is the HTTP code returned for type CreateMTOShipmentOK

View Source
const CreateMTOShipmentUnprocessableEntityCode int = 422

CreateMTOShipmentUnprocessableEntityCode is the HTTP code returned for type CreateMTOShipmentUnprocessableEntity

View Source
const CreateSITExtensionBadRequestCode int = 400

CreateSITExtensionBadRequestCode is the HTTP code returned for type CreateSITExtensionBadRequest

View Source
const CreateSITExtensionConflictCode int = 409

CreateSITExtensionConflictCode is the HTTP code returned for type CreateSITExtensionConflict

View Source
const CreateSITExtensionCreatedCode int = 201

CreateSITExtensionCreatedCode is the HTTP code returned for type CreateSITExtensionCreated

View Source
const CreateSITExtensionForbiddenCode int = 403

CreateSITExtensionForbiddenCode is the HTTP code returned for type CreateSITExtensionForbidden

View Source
const CreateSITExtensionInternalServerErrorCode int = 500

CreateSITExtensionInternalServerErrorCode is the HTTP code returned for type CreateSITExtensionInternalServerError

View Source
const CreateSITExtensionNotFoundCode int = 404

CreateSITExtensionNotFoundCode is the HTTP code returned for type CreateSITExtensionNotFound

View Source
const CreateSITExtensionUnauthorizedCode int = 401

CreateSITExtensionUnauthorizedCode is the HTTP code returned for type CreateSITExtensionUnauthorized

View Source
const CreateSITExtensionUnprocessableEntityCode int = 422

CreateSITExtensionUnprocessableEntityCode is the HTTP code returned for type CreateSITExtensionUnprocessableEntity

View Source
const DeleteMTOShipmentBadRequestCode int = 400

DeleteMTOShipmentBadRequestCode is the HTTP code returned for type DeleteMTOShipmentBadRequest

View Source
const DeleteMTOShipmentConflictCode int = 409

DeleteMTOShipmentConflictCode is the HTTP code returned for type DeleteMTOShipmentConflict

View Source
const DeleteMTOShipmentForbiddenCode int = 403

DeleteMTOShipmentForbiddenCode is the HTTP code returned for type DeleteMTOShipmentForbidden

View Source
const DeleteMTOShipmentInternalServerErrorCode int = 500

DeleteMTOShipmentInternalServerErrorCode is the HTTP code returned for type DeleteMTOShipmentInternalServerError

View Source
const DeleteMTOShipmentNoContentCode int = 204

DeleteMTOShipmentNoContentCode is the HTTP code returned for type DeleteMTOShipmentNoContent

View Source
const DeleteMTOShipmentNotFoundCode int = 404

DeleteMTOShipmentNotFoundCode is the HTTP code returned for type DeleteMTOShipmentNotFound

View Source
const DeleteMTOShipmentUnprocessableEntityCode int = 422

DeleteMTOShipmentUnprocessableEntityCode is the HTTP code returned for type DeleteMTOShipmentUnprocessableEntity

View Source
const UpdateMTOAgentBadRequestCode int = 400

UpdateMTOAgentBadRequestCode is the HTTP code returned for type UpdateMTOAgentBadRequest

View Source
const UpdateMTOAgentForbiddenCode int = 403

UpdateMTOAgentForbiddenCode is the HTTP code returned for type UpdateMTOAgentForbidden

View Source
const UpdateMTOAgentInternalServerErrorCode int = 500

UpdateMTOAgentInternalServerErrorCode is the HTTP code returned for type UpdateMTOAgentInternalServerError

View Source
const UpdateMTOAgentNotFoundCode int = 404

UpdateMTOAgentNotFoundCode is the HTTP code returned for type UpdateMTOAgentNotFound

View Source
const UpdateMTOAgentOKCode int = 200

UpdateMTOAgentOKCode is the HTTP code returned for type UpdateMTOAgentOK

View Source
const UpdateMTOAgentPreconditionFailedCode int = 412

UpdateMTOAgentPreconditionFailedCode is the HTTP code returned for type UpdateMTOAgentPreconditionFailed

View Source
const UpdateMTOAgentUnauthorizedCode int = 401

UpdateMTOAgentUnauthorizedCode is the HTTP code returned for type UpdateMTOAgentUnauthorized

View Source
const UpdateMTOAgentUnprocessableEntityCode int = 422

UpdateMTOAgentUnprocessableEntityCode is the HTTP code returned for type UpdateMTOAgentUnprocessableEntity

View Source
const UpdateMTOShipmentAddressBadRequestCode int = 400

UpdateMTOShipmentAddressBadRequestCode is the HTTP code returned for type UpdateMTOShipmentAddressBadRequest

View Source
const UpdateMTOShipmentAddressConflictCode int = 409

UpdateMTOShipmentAddressConflictCode is the HTTP code returned for type UpdateMTOShipmentAddressConflict

View Source
const UpdateMTOShipmentAddressForbiddenCode int = 403

UpdateMTOShipmentAddressForbiddenCode is the HTTP code returned for type UpdateMTOShipmentAddressForbidden

View Source
const UpdateMTOShipmentAddressInternalServerErrorCode int = 500

UpdateMTOShipmentAddressInternalServerErrorCode is the HTTP code returned for type UpdateMTOShipmentAddressInternalServerError

View Source
const UpdateMTOShipmentAddressNotFoundCode int = 404

UpdateMTOShipmentAddressNotFoundCode is the HTTP code returned for type UpdateMTOShipmentAddressNotFound

View Source
const UpdateMTOShipmentAddressOKCode int = 200

UpdateMTOShipmentAddressOKCode is the HTTP code returned for type UpdateMTOShipmentAddressOK

View Source
const UpdateMTOShipmentAddressPreconditionFailedCode int = 412

UpdateMTOShipmentAddressPreconditionFailedCode is the HTTP code returned for type UpdateMTOShipmentAddressPreconditionFailed

View Source
const UpdateMTOShipmentAddressUnauthorizedCode int = 401

UpdateMTOShipmentAddressUnauthorizedCode is the HTTP code returned for type UpdateMTOShipmentAddressUnauthorized

View Source
const UpdateMTOShipmentAddressUnprocessableEntityCode int = 422

UpdateMTOShipmentAddressUnprocessableEntityCode is the HTTP code returned for type UpdateMTOShipmentAddressUnprocessableEntity

View Source
const UpdateMTOShipmentBadRequestCode int = 400

UpdateMTOShipmentBadRequestCode is the HTTP code returned for type UpdateMTOShipmentBadRequest

View Source
const UpdateMTOShipmentForbiddenCode int = 403

UpdateMTOShipmentForbiddenCode is the HTTP code returned for type UpdateMTOShipmentForbidden

View Source
const UpdateMTOShipmentInternalServerErrorCode int = 500

UpdateMTOShipmentInternalServerErrorCode is the HTTP code returned for type UpdateMTOShipmentInternalServerError

View Source
const UpdateMTOShipmentNotFoundCode int = 404

UpdateMTOShipmentNotFoundCode is the HTTP code returned for type UpdateMTOShipmentNotFound

View Source
const UpdateMTOShipmentOKCode int = 200

UpdateMTOShipmentOKCode is the HTTP code returned for type UpdateMTOShipmentOK

View Source
const UpdateMTOShipmentPreconditionFailedCode int = 412

UpdateMTOShipmentPreconditionFailedCode is the HTTP code returned for type UpdateMTOShipmentPreconditionFailed

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

View Source
const UpdateMTOShipmentUnauthorizedCode int = 401

UpdateMTOShipmentUnauthorizedCode is the HTTP code returned for type UpdateMTOShipmentUnauthorized

View Source
const UpdateMTOShipmentUnprocessableEntityCode int = 422

UpdateMTOShipmentUnprocessableEntityCode is the HTTP code returned for type UpdateMTOShipmentUnprocessableEntity

View Source
const UpdateReweighBadRequestCode int = 400

UpdateReweighBadRequestCode is the HTTP code returned for type UpdateReweighBadRequest

View Source
const UpdateReweighConflictCode int = 409

UpdateReweighConflictCode is the HTTP code returned for type UpdateReweighConflict

View Source
const UpdateReweighForbiddenCode int = 403

UpdateReweighForbiddenCode is the HTTP code returned for type UpdateReweighForbidden

View Source
const UpdateReweighInternalServerErrorCode int = 500

UpdateReweighInternalServerErrorCode is the HTTP code returned for type UpdateReweighInternalServerError

View Source
const UpdateReweighNotFoundCode int = 404

UpdateReweighNotFoundCode is the HTTP code returned for type UpdateReweighNotFound

View Source
const UpdateReweighOKCode int = 200

UpdateReweighOKCode is the HTTP code returned for type UpdateReweighOK

View Source
const UpdateReweighPreconditionFailedCode int = 412

UpdateReweighPreconditionFailedCode is the HTTP code returned for type UpdateReweighPreconditionFailed

View Source
const UpdateReweighUnauthorizedCode int = 401

UpdateReweighUnauthorizedCode is the HTTP code returned for type UpdateReweighUnauthorized

View Source
const UpdateReweighUnprocessableEntityCode int = 422

UpdateReweighUnprocessableEntityCode is the HTTP code returned for type UpdateReweighUnprocessableEntity

View Source
const UpdateShipmentDestinationAddressBadRequestCode int = 400

UpdateShipmentDestinationAddressBadRequestCode is the HTTP code returned for type UpdateShipmentDestinationAddressBadRequest

View Source
const UpdateShipmentDestinationAddressConflictCode int = 409

UpdateShipmentDestinationAddressConflictCode is the HTTP code returned for type UpdateShipmentDestinationAddressConflict

View Source
const UpdateShipmentDestinationAddressCreatedCode int = 201

UpdateShipmentDestinationAddressCreatedCode is the HTTP code returned for type UpdateShipmentDestinationAddressCreated

View Source
const UpdateShipmentDestinationAddressForbiddenCode int = 403

UpdateShipmentDestinationAddressForbiddenCode is the HTTP code returned for type UpdateShipmentDestinationAddressForbidden

View Source
const UpdateShipmentDestinationAddressInternalServerErrorCode int = 500

UpdateShipmentDestinationAddressInternalServerErrorCode is the HTTP code returned for type UpdateShipmentDestinationAddressInternalServerError

View Source
const UpdateShipmentDestinationAddressNotFoundCode int = 404

UpdateShipmentDestinationAddressNotFoundCode is the HTTP code returned for type UpdateShipmentDestinationAddressNotFound

View Source
const UpdateShipmentDestinationAddressPreconditionFailedCode int = 412

UpdateShipmentDestinationAddressPreconditionFailedCode is the HTTP code returned for type UpdateShipmentDestinationAddressPreconditionFailed

View Source
const UpdateShipmentDestinationAddressUnauthorizedCode int = 401

UpdateShipmentDestinationAddressUnauthorizedCode is the HTTP code returned for type UpdateShipmentDestinationAddressUnauthorized

View Source
const UpdateShipmentDestinationAddressUnprocessableEntityCode int = 422

UpdateShipmentDestinationAddressUnprocessableEntityCode is the HTTP code returned for type UpdateShipmentDestinationAddressUnprocessableEntity

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateMTOAgent

type CreateMTOAgent struct {
	Context *middleware.Context
	Handler CreateMTOAgentHandler
}
CreateMTOAgent swagger:route POST /mto-shipments/{mtoShipmentID}/agents mtoShipment createMTOAgent

createMTOAgent

### Functionality This endpoint is used to **create** and add agents for an existing MTO Shipment. Only the fields being modified need to be sent in the request body.

### Errors The agent must always have a name and at least one method of contact (either `email` or `phone`).

The agent must be associated with the MTO shipment passed in the url.

The shipment should be associated with an MTO that is available to the Pime. If the caller requests a new agent, and the shipment is not on an available MTO, the caller will receive a **NotFound** response.

func NewCreateMTOAgent

func NewCreateMTOAgent(ctx *middleware.Context, handler CreateMTOAgentHandler) *CreateMTOAgent

NewCreateMTOAgent creates a new http.Handler for the create m t o agent operation

func (*CreateMTOAgent) ServeHTTP

func (o *CreateMTOAgent) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type CreateMTOAgentBadRequest

type CreateMTOAgentBadRequest struct {

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

CreateMTOAgentBadRequest The request payload is invalid.

swagger:response createMTOAgentBadRequest

func NewCreateMTOAgentBadRequest

func NewCreateMTOAgentBadRequest() *CreateMTOAgentBadRequest

NewCreateMTOAgentBadRequest creates CreateMTOAgentBadRequest with default headers values

func (*CreateMTOAgentBadRequest) SetPayload

func (o *CreateMTOAgentBadRequest) SetPayload(payload *primemessages.ClientError)

SetPayload sets the payload to the create m t o agent bad request response

func (*CreateMTOAgentBadRequest) WithPayload

WithPayload adds the payload to the create m t o agent bad request response

func (*CreateMTOAgentBadRequest) WriteResponse

func (o *CreateMTOAgentBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CreateMTOAgentConflict

type CreateMTOAgentConflict struct {

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

CreateMTOAgentConflict The request could not be processed because of conflict in the current state of the resource.

swagger:response createMTOAgentConflict

func NewCreateMTOAgentConflict

func NewCreateMTOAgentConflict() *CreateMTOAgentConflict

NewCreateMTOAgentConflict creates CreateMTOAgentConflict with default headers values

func (*CreateMTOAgentConflict) SetPayload

func (o *CreateMTOAgentConflict) SetPayload(payload *primemessages.ClientError)

SetPayload sets the payload to the create m t o agent conflict response

func (*CreateMTOAgentConflict) WithPayload

WithPayload adds the payload to the create m t o agent conflict response

func (*CreateMTOAgentConflict) WriteResponse

func (o *CreateMTOAgentConflict) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CreateMTOAgentForbidden

type CreateMTOAgentForbidden struct {

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

CreateMTOAgentForbidden The request was denied.

swagger:response createMTOAgentForbidden

func NewCreateMTOAgentForbidden

func NewCreateMTOAgentForbidden() *CreateMTOAgentForbidden

NewCreateMTOAgentForbidden creates CreateMTOAgentForbidden with default headers values

func (*CreateMTOAgentForbidden) SetPayload

func (o *CreateMTOAgentForbidden) SetPayload(payload *primemessages.ClientError)

SetPayload sets the payload to the create m t o agent forbidden response

func (*CreateMTOAgentForbidden) WithPayload

WithPayload adds the payload to the create m t o agent forbidden response

func (*CreateMTOAgentForbidden) WriteResponse

func (o *CreateMTOAgentForbidden) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CreateMTOAgentHandler

type CreateMTOAgentHandler interface {
	Handle(CreateMTOAgentParams) middleware.Responder
}

CreateMTOAgentHandler interface for that can handle valid create m t o agent params

type CreateMTOAgentHandlerFunc

type CreateMTOAgentHandlerFunc func(CreateMTOAgentParams) middleware.Responder

CreateMTOAgentHandlerFunc turns a function with the right signature into a create m t o agent handler

func (CreateMTOAgentHandlerFunc) Handle

Handle executing the request and returning a response

type CreateMTOAgentInternalServerError

type CreateMTOAgentInternalServerError struct {

	/*
	  In: Body
	*/
	Payload *primemessages.Error `json:"body,omitempty"`
}

CreateMTOAgentInternalServerError A server error occurred.

swagger:response createMTOAgentInternalServerError

func NewCreateMTOAgentInternalServerError

func NewCreateMTOAgentInternalServerError() *CreateMTOAgentInternalServerError

NewCreateMTOAgentInternalServerError creates CreateMTOAgentInternalServerError with default headers values

func (*CreateMTOAgentInternalServerError) SetPayload

func (o *CreateMTOAgentInternalServerError) SetPayload(payload *primemessages.Error)

SetPayload sets the payload to the create m t o agent internal server error response

func (*CreateMTOAgentInternalServerError) WithPayload

WithPayload adds the payload to the create m t o agent internal server error response

func (*CreateMTOAgentInternalServerError) WriteResponse

func (o *CreateMTOAgentInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CreateMTOAgentNotFound

type CreateMTOAgentNotFound struct {

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

CreateMTOAgentNotFound The requested resource wasn't found.

swagger:response createMTOAgentNotFound

func NewCreateMTOAgentNotFound

func NewCreateMTOAgentNotFound() *CreateMTOAgentNotFound

NewCreateMTOAgentNotFound creates CreateMTOAgentNotFound with default headers values

func (*CreateMTOAgentNotFound) SetPayload

func (o *CreateMTOAgentNotFound) SetPayload(payload *primemessages.ClientError)

SetPayload sets the payload to the create m t o agent not found response

func (*CreateMTOAgentNotFound) WithPayload

WithPayload adds the payload to the create m t o agent not found response

func (*CreateMTOAgentNotFound) WriteResponse

func (o *CreateMTOAgentNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CreateMTOAgentOK

type CreateMTOAgentOK struct {

	/*
	  In: Body
	*/
	Payload *primemessages.MTOAgent `json:"body,omitempty"`
}

CreateMTOAgentOK Successfully added the agent.

swagger:response createMTOAgentOK

func NewCreateMTOAgentOK

func NewCreateMTOAgentOK() *CreateMTOAgentOK

NewCreateMTOAgentOK creates CreateMTOAgentOK with default headers values

func (*CreateMTOAgentOK) SetPayload

func (o *CreateMTOAgentOK) SetPayload(payload *primemessages.MTOAgent)

SetPayload sets the payload to the create m t o agent o k response

func (*CreateMTOAgentOK) WithPayload

func (o *CreateMTOAgentOK) WithPayload(payload *primemessages.MTOAgent) *CreateMTOAgentOK

WithPayload adds the payload to the create m t o agent o k response

func (*CreateMTOAgentOK) WriteResponse

func (o *CreateMTOAgentOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CreateMTOAgentParams

type CreateMTOAgentParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*
	  Required: true
	  In: body
	*/
	Body *primemessages.MTOAgent
	/*UUID of the shipment associated with the agent
	  Required: true
	  In: path
	*/
	MtoShipmentID strfmt.UUID
}

CreateMTOAgentParams contains all the bound params for the create m t o agent operation typically these are obtained from a http.Request

swagger:parameters createMTOAgent

func NewCreateMTOAgentParams

func NewCreateMTOAgentParams() CreateMTOAgentParams

NewCreateMTOAgentParams creates a new CreateMTOAgentParams object

There are no default values defined in the spec.

func (*CreateMTOAgentParams) BindRequest

func (o *CreateMTOAgentParams) 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 NewCreateMTOAgentParams() beforehand.

type CreateMTOAgentURL

type CreateMTOAgentURL struct {
	MtoShipmentID strfmt.UUID
	// contains filtered or unexported fields
}

CreateMTOAgentURL generates an URL for the create m t o agent operation

func (*CreateMTOAgentURL) Build

func (o *CreateMTOAgentURL) Build() (*url.URL, error)

Build a url path and query string

func (*CreateMTOAgentURL) BuildFull

func (o *CreateMTOAgentURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*CreateMTOAgentURL) Must

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

Must is a helper function to panic when the url builder returns an error

func (*CreateMTOAgentURL) SetBasePath

func (o *CreateMTOAgentURL) 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 (*CreateMTOAgentURL) String

func (o *CreateMTOAgentURL) String() string

String returns the string representation of the path with query string

func (*CreateMTOAgentURL) StringFull

func (o *CreateMTOAgentURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*CreateMTOAgentURL) WithBasePath

func (o *CreateMTOAgentURL) WithBasePath(bp string) *CreateMTOAgentURL

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 CreateMTOAgentUnauthorized

type CreateMTOAgentUnauthorized struct {

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

CreateMTOAgentUnauthorized The request was denied.

swagger:response createMTOAgentUnauthorized

func NewCreateMTOAgentUnauthorized

func NewCreateMTOAgentUnauthorized() *CreateMTOAgentUnauthorized

NewCreateMTOAgentUnauthorized creates CreateMTOAgentUnauthorized with default headers values

func (*CreateMTOAgentUnauthorized) SetPayload

func (o *CreateMTOAgentUnauthorized) SetPayload(payload *primemessages.ClientError)

SetPayload sets the payload to the create m t o agent unauthorized response

func (*CreateMTOAgentUnauthorized) WithPayload

WithPayload adds the payload to the create m t o agent unauthorized response

func (*CreateMTOAgentUnauthorized) WriteResponse

func (o *CreateMTOAgentUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CreateMTOAgentUnprocessableEntity

type CreateMTOAgentUnprocessableEntity struct {

	/*
	  In: Body
	*/
	Payload *primemessages.ValidationError `json:"body,omitempty"`
}

CreateMTOAgentUnprocessableEntity The request was unprocessable, likely due to bad input from the requester.

swagger:response createMTOAgentUnprocessableEntity

func NewCreateMTOAgentUnprocessableEntity

func NewCreateMTOAgentUnprocessableEntity() *CreateMTOAgentUnprocessableEntity

NewCreateMTOAgentUnprocessableEntity creates CreateMTOAgentUnprocessableEntity with default headers values

func (*CreateMTOAgentUnprocessableEntity) SetPayload

SetPayload sets the payload to the create m t o agent unprocessable entity response

func (*CreateMTOAgentUnprocessableEntity) WithPayload

WithPayload adds the payload to the create m t o agent unprocessable entity response

func (*CreateMTOAgentUnprocessableEntity) WriteResponse

func (o *CreateMTOAgentUnprocessableEntity) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CreateMTOShipment

type CreateMTOShipment struct {
	Context *middleware.Context
	Handler CreateMTOShipmentHandler
}
CreateMTOShipment swagger:route POST /mto-shipments mtoShipment createMTOShipment

createMTOShipment

_[Deprecated: sunset on 2024-04-08]_ This endpoint is deprecated and will be removed in a future version. Please use the new endpoint at `/prime/v2/createMTOShipment` instead.

Creates a new shipment within the specified move. This endpoint should be used whenever the movers identify a need for an additional shipment. The new shipment will be submitted to the TOO for review, and the TOO must approve it before the contractor can proceed with billing.

**WIP**: The Prime should be notified by a push notification whenever the TOO approves a shipment connected to one of their moves. Otherwise, the Prime can fetch the related move using the [getMoveTaskOrder](#operation/getMoveTaskOrder) endpoint and see if this shipment has the status `"APPROVED"`.

func NewCreateMTOShipment

func NewCreateMTOShipment(ctx *middleware.Context, handler CreateMTOShipmentHandler) *CreateMTOShipment

NewCreateMTOShipment creates a new http.Handler for the create m t o shipment operation

func (*CreateMTOShipment) ServeHTTP

func (o *CreateMTOShipment) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type CreateMTOShipmentBadRequest

type CreateMTOShipmentBadRequest struct {

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

CreateMTOShipmentBadRequest The request payload is invalid.

swagger:response createMTOShipmentBadRequest

func NewCreateMTOShipmentBadRequest

func NewCreateMTOShipmentBadRequest() *CreateMTOShipmentBadRequest

NewCreateMTOShipmentBadRequest creates CreateMTOShipmentBadRequest with default headers values

func (*CreateMTOShipmentBadRequest) SetPayload

func (o *CreateMTOShipmentBadRequest) SetPayload(payload *primemessages.ClientError)

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

func (*CreateMTOShipmentBadRequest) WithPayload

WithPayload adds the payload to the create m t o shipment bad request response

func (*CreateMTOShipmentBadRequest) WriteResponse

func (o *CreateMTOShipmentBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CreateMTOShipmentHandler

type CreateMTOShipmentHandler interface {
	Handle(CreateMTOShipmentParams) middleware.Responder
}

CreateMTOShipmentHandler interface for that can handle valid create m t o shipment params

type CreateMTOShipmentHandlerFunc

type CreateMTOShipmentHandlerFunc func(CreateMTOShipmentParams) middleware.Responder

CreateMTOShipmentHandlerFunc turns a function with the right signature into a create m t o shipment handler

func (CreateMTOShipmentHandlerFunc) Handle

Handle executing the request and returning a response

type CreateMTOShipmentInternalServerError

type CreateMTOShipmentInternalServerError struct {

	/*
	  In: Body
	*/
	Payload *primemessages.Error `json:"body,omitempty"`
}

CreateMTOShipmentInternalServerError A server error occurred.

swagger:response createMTOShipmentInternalServerError

func NewCreateMTOShipmentInternalServerError

func NewCreateMTOShipmentInternalServerError() *CreateMTOShipmentInternalServerError

NewCreateMTOShipmentInternalServerError creates CreateMTOShipmentInternalServerError with default headers values

func (*CreateMTOShipmentInternalServerError) SetPayload

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

func (*CreateMTOShipmentInternalServerError) WithPayload

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

func (*CreateMTOShipmentInternalServerError) WriteResponse

WriteResponse to the client

type CreateMTOShipmentNotFound

type CreateMTOShipmentNotFound struct {

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

CreateMTOShipmentNotFound The requested resource wasn't found.

swagger:response createMTOShipmentNotFound

func NewCreateMTOShipmentNotFound

func NewCreateMTOShipmentNotFound() *CreateMTOShipmentNotFound

NewCreateMTOShipmentNotFound creates CreateMTOShipmentNotFound with default headers values

func (*CreateMTOShipmentNotFound) SetPayload

func (o *CreateMTOShipmentNotFound) SetPayload(payload *primemessages.ClientError)

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

func (*CreateMTOShipmentNotFound) WithPayload

WithPayload adds the payload to the create m t o shipment not found response

func (*CreateMTOShipmentNotFound) WriteResponse

func (o *CreateMTOShipmentNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CreateMTOShipmentOK

type CreateMTOShipmentOK struct {

	/*
	  In: Body
	*/
	Payload *primemessages.MTOShipment `json:"body,omitempty"`
}

CreateMTOShipmentOK Successfully created a MTO shipment.

swagger:response createMTOShipmentOK

func NewCreateMTOShipmentOK

func NewCreateMTOShipmentOK() *CreateMTOShipmentOK

NewCreateMTOShipmentOK creates CreateMTOShipmentOK with default headers values

func (*CreateMTOShipmentOK) SetPayload

func (o *CreateMTOShipmentOK) SetPayload(payload *primemessages.MTOShipment)

SetPayload sets the payload to the create m t o shipment o k response

func (*CreateMTOShipmentOK) WithPayload

WithPayload adds the payload to the create m t o shipment o k response

func (*CreateMTOShipmentOK) WriteResponse

func (o *CreateMTOShipmentOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CreateMTOShipmentParams

type CreateMTOShipmentParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*
	  In: body
	*/
	Body *primemessages.CreateMTOShipment
}

CreateMTOShipmentParams contains all the bound params for the create m t o shipment operation typically these are obtained from a http.Request

swagger:parameters createMTOShipment

func NewCreateMTOShipmentParams

func NewCreateMTOShipmentParams() CreateMTOShipmentParams

NewCreateMTOShipmentParams creates a new CreateMTOShipmentParams object

There are no default values defined in the spec.

func (*CreateMTOShipmentParams) BindRequest

func (o *CreateMTOShipmentParams) 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 NewCreateMTOShipmentParams() beforehand.

type CreateMTOShipmentURL

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

CreateMTOShipmentURL generates an URL for the create m t o shipment operation

func (*CreateMTOShipmentURL) Build

func (o *CreateMTOShipmentURL) Build() (*url.URL, error)

Build a url path and query string

func (*CreateMTOShipmentURL) BuildFull

func (o *CreateMTOShipmentURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*CreateMTOShipmentURL) Must

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

Must is a helper function to panic when the url builder returns an error

func (*CreateMTOShipmentURL) SetBasePath

func (o *CreateMTOShipmentURL) 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 (*CreateMTOShipmentURL) String

func (o *CreateMTOShipmentURL) String() string

String returns the string representation of the path with query string

func (*CreateMTOShipmentURL) StringFull

func (o *CreateMTOShipmentURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*CreateMTOShipmentURL) WithBasePath

func (o *CreateMTOShipmentURL) WithBasePath(bp string) *CreateMTOShipmentURL

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 CreateMTOShipmentUnprocessableEntity

type CreateMTOShipmentUnprocessableEntity struct {

	/*
	  In: Body
	*/
	Payload *primemessages.ValidationError `json:"body,omitempty"`
}

CreateMTOShipmentUnprocessableEntity The request was unprocessable, likely due to bad input from the requester.

swagger:response createMTOShipmentUnprocessableEntity

func NewCreateMTOShipmentUnprocessableEntity

func NewCreateMTOShipmentUnprocessableEntity() *CreateMTOShipmentUnprocessableEntity

NewCreateMTOShipmentUnprocessableEntity creates CreateMTOShipmentUnprocessableEntity with default headers values

func (*CreateMTOShipmentUnprocessableEntity) SetPayload

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

func (*CreateMTOShipmentUnprocessableEntity) WithPayload

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

func (*CreateMTOShipmentUnprocessableEntity) WriteResponse

WriteResponse to the client

type CreateSITExtension

type CreateSITExtension struct {
	Context *middleware.Context
	Handler CreateSITExtensionHandler
}
CreateSITExtension swagger:route POST /mto-shipments/{mtoShipmentID}/sit-extensions mtoShipment createSITExtension

createSITExtension

### Functionality This endpoint creates a storage in transit (SIT) extension request for a shipment. A SIT extension request is a request an increase in the shipment day allowance for the number of days a shipment is allowed to be in SIT. The total SIT day allowance includes time spent in both origin and destination SIT.

func NewCreateSITExtension

func NewCreateSITExtension(ctx *middleware.Context, handler CreateSITExtensionHandler) *CreateSITExtension

NewCreateSITExtension creates a new http.Handler for the create s i t extension operation

func (*CreateSITExtension) ServeHTTP

func (o *CreateSITExtension) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type CreateSITExtensionBadRequest

type CreateSITExtensionBadRequest struct {

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

CreateSITExtensionBadRequest The request payload is invalid.

swagger:response createSITExtensionBadRequest

func NewCreateSITExtensionBadRequest

func NewCreateSITExtensionBadRequest() *CreateSITExtensionBadRequest

NewCreateSITExtensionBadRequest creates CreateSITExtensionBadRequest with default headers values

func (*CreateSITExtensionBadRequest) SetPayload

func (o *CreateSITExtensionBadRequest) SetPayload(payload *primemessages.ClientError)

SetPayload sets the payload to the create s i t extension bad request response

func (*CreateSITExtensionBadRequest) WithPayload

WithPayload adds the payload to the create s i t extension bad request response

func (*CreateSITExtensionBadRequest) WriteResponse

func (o *CreateSITExtensionBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CreateSITExtensionConflict

type CreateSITExtensionConflict struct {

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

CreateSITExtensionConflict The request could not be processed because of conflict in the current state of the resource.

swagger:response createSITExtensionConflict

func NewCreateSITExtensionConflict

func NewCreateSITExtensionConflict() *CreateSITExtensionConflict

NewCreateSITExtensionConflict creates CreateSITExtensionConflict with default headers values

func (*CreateSITExtensionConflict) SetPayload

func (o *CreateSITExtensionConflict) SetPayload(payload *primemessages.ClientError)

SetPayload sets the payload to the create s i t extension conflict response

func (*CreateSITExtensionConflict) WithPayload

WithPayload adds the payload to the create s i t extension conflict response

func (*CreateSITExtensionConflict) WriteResponse

func (o *CreateSITExtensionConflict) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CreateSITExtensionCreated

type CreateSITExtensionCreated struct {

	/*
	  In: Body
	*/
	Payload *primemessages.SITExtension `json:"body,omitempty"`
}

CreateSITExtensionCreated Successfully created the sit extension request.

swagger:response createSITExtensionCreated

func NewCreateSITExtensionCreated

func NewCreateSITExtensionCreated() *CreateSITExtensionCreated

NewCreateSITExtensionCreated creates CreateSITExtensionCreated with default headers values

func (*CreateSITExtensionCreated) SetPayload

func (o *CreateSITExtensionCreated) SetPayload(payload *primemessages.SITExtension)

SetPayload sets the payload to the create s i t extension created response

func (*CreateSITExtensionCreated) WithPayload

WithPayload adds the payload to the create s i t extension created response

func (*CreateSITExtensionCreated) WriteResponse

func (o *CreateSITExtensionCreated) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CreateSITExtensionForbidden

type CreateSITExtensionForbidden struct {

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

CreateSITExtensionForbidden The request was denied.

swagger:response createSITExtensionForbidden

func NewCreateSITExtensionForbidden

func NewCreateSITExtensionForbidden() *CreateSITExtensionForbidden

NewCreateSITExtensionForbidden creates CreateSITExtensionForbidden with default headers values

func (*CreateSITExtensionForbidden) SetPayload

func (o *CreateSITExtensionForbidden) SetPayload(payload *primemessages.ClientError)

SetPayload sets the payload to the create s i t extension forbidden response

func (*CreateSITExtensionForbidden) WithPayload

WithPayload adds the payload to the create s i t extension forbidden response

func (*CreateSITExtensionForbidden) WriteResponse

func (o *CreateSITExtensionForbidden) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CreateSITExtensionHandler

type CreateSITExtensionHandler interface {
	Handle(CreateSITExtensionParams) middleware.Responder
}

CreateSITExtensionHandler interface for that can handle valid create s i t extension params

type CreateSITExtensionHandlerFunc

type CreateSITExtensionHandlerFunc func(CreateSITExtensionParams) middleware.Responder

CreateSITExtensionHandlerFunc turns a function with the right signature into a create s i t extension handler

func (CreateSITExtensionHandlerFunc) Handle

Handle executing the request and returning a response

type CreateSITExtensionInternalServerError

type CreateSITExtensionInternalServerError struct {

	/*
	  In: Body
	*/
	Payload *primemessages.Error `json:"body,omitempty"`
}

CreateSITExtensionInternalServerError A server error occurred.

swagger:response createSITExtensionInternalServerError

func NewCreateSITExtensionInternalServerError

func NewCreateSITExtensionInternalServerError() *CreateSITExtensionInternalServerError

NewCreateSITExtensionInternalServerError creates CreateSITExtensionInternalServerError with default headers values

func (*CreateSITExtensionInternalServerError) SetPayload

SetPayload sets the payload to the create s i t extension internal server error response

func (*CreateSITExtensionInternalServerError) WithPayload

WithPayload adds the payload to the create s i t extension internal server error response

func (*CreateSITExtensionInternalServerError) WriteResponse

WriteResponse to the client

type CreateSITExtensionNotFound

type CreateSITExtensionNotFound struct {

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

CreateSITExtensionNotFound The requested resource wasn't found.

swagger:response createSITExtensionNotFound

func NewCreateSITExtensionNotFound

func NewCreateSITExtensionNotFound() *CreateSITExtensionNotFound

NewCreateSITExtensionNotFound creates CreateSITExtensionNotFound with default headers values

func (*CreateSITExtensionNotFound) SetPayload

func (o *CreateSITExtensionNotFound) SetPayload(payload *primemessages.ClientError)

SetPayload sets the payload to the create s i t extension not found response

func (*CreateSITExtensionNotFound) WithPayload

WithPayload adds the payload to the create s i t extension not found response

func (*CreateSITExtensionNotFound) WriteResponse

func (o *CreateSITExtensionNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CreateSITExtensionParams

type CreateSITExtensionParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*
	  Required: true
	  In: body
	*/
	Body *primemessages.CreateSITExtension
	/*UUID of the shipment associated with the agent
	  Required: true
	  In: path
	*/
	MtoShipmentID strfmt.UUID
}

CreateSITExtensionParams contains all the bound params for the create s i t extension operation typically these are obtained from a http.Request

swagger:parameters createSITExtension

func NewCreateSITExtensionParams

func NewCreateSITExtensionParams() CreateSITExtensionParams

NewCreateSITExtensionParams creates a new CreateSITExtensionParams object

There are no default values defined in the spec.

func (*CreateSITExtensionParams) 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 NewCreateSITExtensionParams() beforehand.

type CreateSITExtensionURL

type CreateSITExtensionURL struct {
	MtoShipmentID strfmt.UUID
	// contains filtered or unexported fields
}

CreateSITExtensionURL generates an URL for the create s i t extension operation

func (*CreateSITExtensionURL) Build

func (o *CreateSITExtensionURL) Build() (*url.URL, error)

Build a url path and query string

func (*CreateSITExtensionURL) BuildFull

func (o *CreateSITExtensionURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*CreateSITExtensionURL) Must

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

Must is a helper function to panic when the url builder returns an error

func (*CreateSITExtensionURL) SetBasePath

func (o *CreateSITExtensionURL) 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 (*CreateSITExtensionURL) String

func (o *CreateSITExtensionURL) String() string

String returns the string representation of the path with query string

func (*CreateSITExtensionURL) StringFull

func (o *CreateSITExtensionURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*CreateSITExtensionURL) WithBasePath

func (o *CreateSITExtensionURL) WithBasePath(bp string) *CreateSITExtensionURL

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 CreateSITExtensionUnauthorized

type CreateSITExtensionUnauthorized struct {

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

CreateSITExtensionUnauthorized The request was denied.

swagger:response createSITExtensionUnauthorized

func NewCreateSITExtensionUnauthorized

func NewCreateSITExtensionUnauthorized() *CreateSITExtensionUnauthorized

NewCreateSITExtensionUnauthorized creates CreateSITExtensionUnauthorized with default headers values

func (*CreateSITExtensionUnauthorized) SetPayload

SetPayload sets the payload to the create s i t extension unauthorized response

func (*CreateSITExtensionUnauthorized) WithPayload

WithPayload adds the payload to the create s i t extension unauthorized response

func (*CreateSITExtensionUnauthorized) WriteResponse

func (o *CreateSITExtensionUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CreateSITExtensionUnprocessableEntity

type CreateSITExtensionUnprocessableEntity struct {

	/*
	  In: Body
	*/
	Payload *primemessages.ValidationError `json:"body,omitempty"`
}

CreateSITExtensionUnprocessableEntity The request was unprocessable, likely due to bad input from the requester.

swagger:response createSITExtensionUnprocessableEntity

func NewCreateSITExtensionUnprocessableEntity

func NewCreateSITExtensionUnprocessableEntity() *CreateSITExtensionUnprocessableEntity

NewCreateSITExtensionUnprocessableEntity creates CreateSITExtensionUnprocessableEntity with default headers values

func (*CreateSITExtensionUnprocessableEntity) SetPayload

SetPayload sets the payload to the create s i t extension unprocessable entity response

func (*CreateSITExtensionUnprocessableEntity) WithPayload

WithPayload adds the payload to the create s i t extension unprocessable entity response

func (*CreateSITExtensionUnprocessableEntity) WriteResponse

WriteResponse to the client

type DeleteMTOShipment

type DeleteMTOShipment struct {
	Context *middleware.Context
	Handler DeleteMTOShipmentHandler
}
DeleteMTOShipment swagger:route DELETE /mto-shipments/{mtoShipmentID} mtoShipment deleteMTOShipment

deleteMTOShipment

### Functionality This endpoint deletes an individual shipment by ID.

### Errors * The mtoShipment should be associated with an MTO that is available to prime. * The mtoShipment must be a PPM shipment. * Counseling should not have already been completed for the associated MTO.

func NewDeleteMTOShipment

func NewDeleteMTOShipment(ctx *middleware.Context, handler DeleteMTOShipmentHandler) *DeleteMTOShipment

NewDeleteMTOShipment creates a new http.Handler for the delete m t o shipment operation

func (*DeleteMTOShipment) ServeHTTP

func (o *DeleteMTOShipment) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type DeleteMTOShipmentBadRequest

type DeleteMTOShipmentBadRequest struct {

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

DeleteMTOShipmentBadRequest The request payload is invalid.

swagger:response deleteMTOShipmentBadRequest

func NewDeleteMTOShipmentBadRequest

func NewDeleteMTOShipmentBadRequest() *DeleteMTOShipmentBadRequest

NewDeleteMTOShipmentBadRequest creates DeleteMTOShipmentBadRequest with default headers values

func (*DeleteMTOShipmentBadRequest) SetPayload

func (o *DeleteMTOShipmentBadRequest) SetPayload(payload *primemessages.ClientError)

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

func (*DeleteMTOShipmentBadRequest) WithPayload

WithPayload adds the payload to the delete m t o shipment bad request response

func (*DeleteMTOShipmentBadRequest) WriteResponse

func (o *DeleteMTOShipmentBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type DeleteMTOShipmentConflict

type DeleteMTOShipmentConflict struct {

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

DeleteMTOShipmentConflict The request could not be processed because of conflict in the current state of the resource.

swagger:response deleteMTOShipmentConflict

func NewDeleteMTOShipmentConflict

func NewDeleteMTOShipmentConflict() *DeleteMTOShipmentConflict

NewDeleteMTOShipmentConflict creates DeleteMTOShipmentConflict with default headers values

func (*DeleteMTOShipmentConflict) SetPayload

func (o *DeleteMTOShipmentConflict) SetPayload(payload *primemessages.ClientError)

SetPayload sets the payload to the delete m t o shipment conflict response

func (*DeleteMTOShipmentConflict) WithPayload

WithPayload adds the payload to the delete m t o shipment conflict response

func (*DeleteMTOShipmentConflict) WriteResponse

func (o *DeleteMTOShipmentConflict) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type DeleteMTOShipmentForbidden

type DeleteMTOShipmentForbidden struct {

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

DeleteMTOShipmentForbidden The request was denied.

swagger:response deleteMTOShipmentForbidden

func NewDeleteMTOShipmentForbidden

func NewDeleteMTOShipmentForbidden() *DeleteMTOShipmentForbidden

NewDeleteMTOShipmentForbidden creates DeleteMTOShipmentForbidden with default headers values

func (*DeleteMTOShipmentForbidden) SetPayload

func (o *DeleteMTOShipmentForbidden) SetPayload(payload *primemessages.ClientError)

SetPayload sets the payload to the delete m t o shipment forbidden response

func (*DeleteMTOShipmentForbidden) WithPayload

WithPayload adds the payload to the delete m t o shipment forbidden response

func (*DeleteMTOShipmentForbidden) WriteResponse

func (o *DeleteMTOShipmentForbidden) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type DeleteMTOShipmentHandler

type DeleteMTOShipmentHandler interface {
	Handle(DeleteMTOShipmentParams) middleware.Responder
}

DeleteMTOShipmentHandler interface for that can handle valid delete m t o shipment params

type DeleteMTOShipmentHandlerFunc

type DeleteMTOShipmentHandlerFunc func(DeleteMTOShipmentParams) middleware.Responder

DeleteMTOShipmentHandlerFunc turns a function with the right signature into a delete m t o shipment handler

func (DeleteMTOShipmentHandlerFunc) Handle

Handle executing the request and returning a response

type DeleteMTOShipmentInternalServerError

type DeleteMTOShipmentInternalServerError struct {

	/*
	  In: Body
	*/
	Payload *primemessages.Error `json:"body,omitempty"`
}

DeleteMTOShipmentInternalServerError A server error occurred.

swagger:response deleteMTOShipmentInternalServerError

func NewDeleteMTOShipmentInternalServerError

func NewDeleteMTOShipmentInternalServerError() *DeleteMTOShipmentInternalServerError

NewDeleteMTOShipmentInternalServerError creates DeleteMTOShipmentInternalServerError with default headers values

func (*DeleteMTOShipmentInternalServerError) SetPayload

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

func (*DeleteMTOShipmentInternalServerError) WithPayload

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

func (*DeleteMTOShipmentInternalServerError) WriteResponse

WriteResponse to the client

type DeleteMTOShipmentNoContent

type DeleteMTOShipmentNoContent struct {
}

DeleteMTOShipmentNoContent Successfully deleted the MTO shipment.

swagger:response deleteMTOShipmentNoContent

func NewDeleteMTOShipmentNoContent

func NewDeleteMTOShipmentNoContent() *DeleteMTOShipmentNoContent

NewDeleteMTOShipmentNoContent creates DeleteMTOShipmentNoContent with default headers values

func (*DeleteMTOShipmentNoContent) WriteResponse

func (o *DeleteMTOShipmentNoContent) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type DeleteMTOShipmentNotFound

type DeleteMTOShipmentNotFound struct {

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

DeleteMTOShipmentNotFound The requested resource wasn't found.

swagger:response deleteMTOShipmentNotFound

func NewDeleteMTOShipmentNotFound

func NewDeleteMTOShipmentNotFound() *DeleteMTOShipmentNotFound

NewDeleteMTOShipmentNotFound creates DeleteMTOShipmentNotFound with default headers values

func (*DeleteMTOShipmentNotFound) SetPayload

func (o *DeleteMTOShipmentNotFound) SetPayload(payload *primemessages.ClientError)

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

func (*DeleteMTOShipmentNotFound) WithPayload

WithPayload adds the payload to the delete m t o shipment not found response

func (*DeleteMTOShipmentNotFound) WriteResponse

func (o *DeleteMTOShipmentNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type DeleteMTOShipmentParams

type DeleteMTOShipmentParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*UUID of the shipment to be deleted
	  Required: true
	  In: path
	*/
	MtoShipmentID strfmt.UUID
}

DeleteMTOShipmentParams contains all the bound params for the delete m t o shipment operation typically these are obtained from a http.Request

swagger:parameters deleteMTOShipment

func NewDeleteMTOShipmentParams

func NewDeleteMTOShipmentParams() DeleteMTOShipmentParams

NewDeleteMTOShipmentParams creates a new DeleteMTOShipmentParams object

There are no default values defined in the spec.

func (*DeleteMTOShipmentParams) BindRequest

func (o *DeleteMTOShipmentParams) 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 NewDeleteMTOShipmentParams() beforehand.

type DeleteMTOShipmentURL

type DeleteMTOShipmentURL struct {
	MtoShipmentID strfmt.UUID
	// contains filtered or unexported fields
}

DeleteMTOShipmentURL generates an URL for the delete m t o shipment operation

func (*DeleteMTOShipmentURL) Build

func (o *DeleteMTOShipmentURL) Build() (*url.URL, error)

Build a url path and query string

func (*DeleteMTOShipmentURL) BuildFull

func (o *DeleteMTOShipmentURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*DeleteMTOShipmentURL) Must

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

Must is a helper function to panic when the url builder returns an error

func (*DeleteMTOShipmentURL) SetBasePath

func (o *DeleteMTOShipmentURL) 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 (*DeleteMTOShipmentURL) String

func (o *DeleteMTOShipmentURL) String() string

String returns the string representation of the path with query string

func (*DeleteMTOShipmentURL) StringFull

func (o *DeleteMTOShipmentURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*DeleteMTOShipmentURL) WithBasePath

func (o *DeleteMTOShipmentURL) WithBasePath(bp string) *DeleteMTOShipmentURL

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 DeleteMTOShipmentUnprocessableEntity

type DeleteMTOShipmentUnprocessableEntity struct {

	/*
	  In: Body
	*/
	Payload *primemessages.ValidationError `json:"body,omitempty"`
}

DeleteMTOShipmentUnprocessableEntity The request was unprocessable, likely due to bad input from the requester.

swagger:response deleteMTOShipmentUnprocessableEntity

func NewDeleteMTOShipmentUnprocessableEntity

func NewDeleteMTOShipmentUnprocessableEntity() *DeleteMTOShipmentUnprocessableEntity

NewDeleteMTOShipmentUnprocessableEntity creates DeleteMTOShipmentUnprocessableEntity with default headers values

func (*DeleteMTOShipmentUnprocessableEntity) SetPayload

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

func (*DeleteMTOShipmentUnprocessableEntity) WithPayload

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

func (*DeleteMTOShipmentUnprocessableEntity) WriteResponse

WriteResponse to the client

type UpdateMTOAgent

type UpdateMTOAgent struct {
	Context *middleware.Context
	Handler UpdateMTOAgentHandler
}
UpdateMTOAgent swagger:route PUT /mto-shipments/{mtoShipmentID}/agents/{agentID} mtoShipment updateMTOAgent

updateMTOAgent

### Functionality This endpoint is used to **update** the agents for an MTO Shipment. Only the fields being modified need to be sent in the request body.

### Errors: The agent must always have a name and at least one method of contact (either `email` or `phone`).

The agent must be associated with the MTO shipment passed in the url.

The shipment should be associated with an MTO that is available to the Prime. If the caller requests an update to an agent, and the shipment is not on an available MTO, the caller will receive a **NotFound** response.

func NewUpdateMTOAgent

func NewUpdateMTOAgent(ctx *middleware.Context, handler UpdateMTOAgentHandler) *UpdateMTOAgent

NewUpdateMTOAgent creates a new http.Handler for the update m t o agent operation

func (*UpdateMTOAgent) ServeHTTP

func (o *UpdateMTOAgent) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type UpdateMTOAgentBadRequest

type UpdateMTOAgentBadRequest struct {

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

UpdateMTOAgentBadRequest The request payload is invalid.

swagger:response updateMTOAgentBadRequest

func NewUpdateMTOAgentBadRequest

func NewUpdateMTOAgentBadRequest() *UpdateMTOAgentBadRequest

NewUpdateMTOAgentBadRequest creates UpdateMTOAgentBadRequest with default headers values

func (*UpdateMTOAgentBadRequest) SetPayload

func (o *UpdateMTOAgentBadRequest) SetPayload(payload *primemessages.ClientError)

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

func (*UpdateMTOAgentBadRequest) WithPayload

WithPayload adds the payload to the update m t o agent bad request response

func (*UpdateMTOAgentBadRequest) WriteResponse

func (o *UpdateMTOAgentBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateMTOAgentForbidden

type UpdateMTOAgentForbidden struct {

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

UpdateMTOAgentForbidden The request was denied.

swagger:response updateMTOAgentForbidden

func NewUpdateMTOAgentForbidden

func NewUpdateMTOAgentForbidden() *UpdateMTOAgentForbidden

NewUpdateMTOAgentForbidden creates UpdateMTOAgentForbidden with default headers values

func (*UpdateMTOAgentForbidden) SetPayload

func (o *UpdateMTOAgentForbidden) SetPayload(payload *primemessages.ClientError)

SetPayload sets the payload to the update m t o agent forbidden response

func (*UpdateMTOAgentForbidden) WithPayload

WithPayload adds the payload to the update m t o agent forbidden response

func (*UpdateMTOAgentForbidden) WriteResponse

func (o *UpdateMTOAgentForbidden) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateMTOAgentHandler

type UpdateMTOAgentHandler interface {
	Handle(UpdateMTOAgentParams) middleware.Responder
}

UpdateMTOAgentHandler interface for that can handle valid update m t o agent params

type UpdateMTOAgentHandlerFunc

type UpdateMTOAgentHandlerFunc func(UpdateMTOAgentParams) middleware.Responder

UpdateMTOAgentHandlerFunc turns a function with the right signature into a update m t o agent handler

func (UpdateMTOAgentHandlerFunc) Handle

Handle executing the request and returning a response

type UpdateMTOAgentInternalServerError

type UpdateMTOAgentInternalServerError struct {

	/*
	  In: Body
	*/
	Payload *primemessages.Error `json:"body,omitempty"`
}

UpdateMTOAgentInternalServerError A server error occurred.

swagger:response updateMTOAgentInternalServerError

func NewUpdateMTOAgentInternalServerError

func NewUpdateMTOAgentInternalServerError() *UpdateMTOAgentInternalServerError

NewUpdateMTOAgentInternalServerError creates UpdateMTOAgentInternalServerError with default headers values

func (*UpdateMTOAgentInternalServerError) SetPayload

func (o *UpdateMTOAgentInternalServerError) SetPayload(payload *primemessages.Error)

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

func (*UpdateMTOAgentInternalServerError) WithPayload

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

func (*UpdateMTOAgentInternalServerError) WriteResponse

func (o *UpdateMTOAgentInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateMTOAgentNotFound

type UpdateMTOAgentNotFound struct {

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

UpdateMTOAgentNotFound The requested resource wasn't found.

swagger:response updateMTOAgentNotFound

func NewUpdateMTOAgentNotFound

func NewUpdateMTOAgentNotFound() *UpdateMTOAgentNotFound

NewUpdateMTOAgentNotFound creates UpdateMTOAgentNotFound with default headers values

func (*UpdateMTOAgentNotFound) SetPayload

func (o *UpdateMTOAgentNotFound) SetPayload(payload *primemessages.ClientError)

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

func (*UpdateMTOAgentNotFound) WithPayload

WithPayload adds the payload to the update m t o agent not found response

func (*UpdateMTOAgentNotFound) WriteResponse

func (o *UpdateMTOAgentNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateMTOAgentOK

type UpdateMTOAgentOK struct {

	/*
	  In: Body
	*/
	Payload *primemessages.MTOAgent `json:"body,omitempty"`
}

UpdateMTOAgentOK Successfully updated the agent.

swagger:response updateMTOAgentOK

func NewUpdateMTOAgentOK

func NewUpdateMTOAgentOK() *UpdateMTOAgentOK

NewUpdateMTOAgentOK creates UpdateMTOAgentOK with default headers values

func (*UpdateMTOAgentOK) SetPayload

func (o *UpdateMTOAgentOK) SetPayload(payload *primemessages.MTOAgent)

SetPayload sets the payload to the update m t o agent o k response

func (*UpdateMTOAgentOK) WithPayload

func (o *UpdateMTOAgentOK) WithPayload(payload *primemessages.MTOAgent) *UpdateMTOAgentOK

WithPayload adds the payload to the update m t o agent o k response

func (*UpdateMTOAgentOK) WriteResponse

func (o *UpdateMTOAgentOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateMTOAgentParams

type UpdateMTOAgentParams 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
	/*UUID of the agent being updated
	  Required: true
	  In: path
	*/
	AgentID strfmt.UUID
	/*
	  Required: true
	  In: body
	*/
	Body *primemessages.MTOAgent
	/*UUID of the shipment associated with the agent
	  Required: true
	  In: path
	*/
	MtoShipmentID strfmt.UUID
}

UpdateMTOAgentParams contains all the bound params for the update m t o agent operation typically these are obtained from a http.Request

swagger:parameters updateMTOAgent

func NewUpdateMTOAgentParams

func NewUpdateMTOAgentParams() UpdateMTOAgentParams

NewUpdateMTOAgentParams creates a new UpdateMTOAgentParams object

There are no default values defined in the spec.

func (*UpdateMTOAgentParams) BindRequest

func (o *UpdateMTOAgentParams) 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 NewUpdateMTOAgentParams() beforehand.

type UpdateMTOAgentPreconditionFailed

type UpdateMTOAgentPreconditionFailed struct {

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

UpdateMTOAgentPreconditionFailed Precondition failed, likely due to a stale eTag (If-Match). Fetch the request again to get the updated eTag value.

swagger:response updateMTOAgentPreconditionFailed

func NewUpdateMTOAgentPreconditionFailed

func NewUpdateMTOAgentPreconditionFailed() *UpdateMTOAgentPreconditionFailed

NewUpdateMTOAgentPreconditionFailed creates UpdateMTOAgentPreconditionFailed with default headers values

func (*UpdateMTOAgentPreconditionFailed) SetPayload

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

func (*UpdateMTOAgentPreconditionFailed) WithPayload

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

func (*UpdateMTOAgentPreconditionFailed) WriteResponse

func (o *UpdateMTOAgentPreconditionFailed) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateMTOAgentURL

type UpdateMTOAgentURL struct {
	AgentID       strfmt.UUID
	MtoShipmentID strfmt.UUID
	// contains filtered or unexported fields
}

UpdateMTOAgentURL generates an URL for the update m t o agent operation

func (*UpdateMTOAgentURL) Build

func (o *UpdateMTOAgentURL) Build() (*url.URL, error)

Build a url path and query string

func (*UpdateMTOAgentURL) BuildFull

func (o *UpdateMTOAgentURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*UpdateMTOAgentURL) Must

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

Must is a helper function to panic when the url builder returns an error

func (*UpdateMTOAgentURL) SetBasePath

func (o *UpdateMTOAgentURL) 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 (*UpdateMTOAgentURL) String

func (o *UpdateMTOAgentURL) String() string

String returns the string representation of the path with query string

func (*UpdateMTOAgentURL) StringFull

func (o *UpdateMTOAgentURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*UpdateMTOAgentURL) WithBasePath

func (o *UpdateMTOAgentURL) WithBasePath(bp string) *UpdateMTOAgentURL

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 UpdateMTOAgentUnauthorized

type UpdateMTOAgentUnauthorized struct {

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

UpdateMTOAgentUnauthorized The request was denied.

swagger:response updateMTOAgentUnauthorized

func NewUpdateMTOAgentUnauthorized

func NewUpdateMTOAgentUnauthorized() *UpdateMTOAgentUnauthorized

NewUpdateMTOAgentUnauthorized creates UpdateMTOAgentUnauthorized with default headers values

func (*UpdateMTOAgentUnauthorized) SetPayload

func (o *UpdateMTOAgentUnauthorized) SetPayload(payload *primemessages.ClientError)

SetPayload sets the payload to the update m t o agent unauthorized response

func (*UpdateMTOAgentUnauthorized) WithPayload

WithPayload adds the payload to the update m t o agent unauthorized response

func (*UpdateMTOAgentUnauthorized) WriteResponse

func (o *UpdateMTOAgentUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateMTOAgentUnprocessableEntity

type UpdateMTOAgentUnprocessableEntity struct {

	/*
	  In: Body
	*/
	Payload *primemessages.ValidationError `json:"body,omitempty"`
}

UpdateMTOAgentUnprocessableEntity The request was unprocessable, likely due to bad input from the requester.

swagger:response updateMTOAgentUnprocessableEntity

func NewUpdateMTOAgentUnprocessableEntity

func NewUpdateMTOAgentUnprocessableEntity() *UpdateMTOAgentUnprocessableEntity

NewUpdateMTOAgentUnprocessableEntity creates UpdateMTOAgentUnprocessableEntity with default headers values

func (*UpdateMTOAgentUnprocessableEntity) SetPayload

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

func (*UpdateMTOAgentUnprocessableEntity) WithPayload

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

func (*UpdateMTOAgentUnprocessableEntity) WriteResponse

func (o *UpdateMTOAgentUnprocessableEntity) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateMTOShipment

type UpdateMTOShipment struct {
	Context *middleware.Context
	Handler UpdateMTOShipmentHandler
}
UpdateMTOShipment swagger:route PATCH /mto-shipments/{mtoShipmentID} mtoShipment updateMTOShipment

updateMTOShipment

_[Deprecated: sunset on August 5th, 2024]_ This endpoint is deprecated and will be removed in a future version. Please use the new endpoint at `/prime/v2/updateMTOShipment` instead.

**DEPRECATION ON AUGUST 5TH, 2024** Following deprecation, there is an edge case scenario where a PPM shipment with no addresses could be updated and it would also update the final destination SIT address for SIT service items. This edge case has been removed as you should not be able to update items using this endpoint. Third-party APIs have confirmed they will require deprecation for this change.

Updates an existing shipment for a move.

Note that there are some restrictions on nested objects:

* Service items: You cannot add or update service items using this endpoint. Please use [createMTOServiceItem](#operation/createMTOServiceItem) and [updateMTOServiceItem](#operation/updateMTOServiceItem) instead. * Agents: You cannot add or update agents using this endpoint. Please use [createMTOAgent](#operation/createMTOAgent) and [updateMTOAgent](#operation/updateMTOAgent) instead. * Addresses: You can add new addresses using this endpoint (and must use this endpoint to do so), but you cannot update existing ones. Please use [updateMTOShipmentAddress](#operation/updateMTOShipmentAddress) instead.

These restrictions are due to our [optimistic locking/concurrency control](https://transcom.github.io/mymove-docs/docs/dev/contributing/backend/use-optimistic-locking) mechanism.

Note that some fields cannot be manually changed but will still be updated automatically, such as `primeEstimatedWeightRecordedDate` and `requiredDeliveryDate`.

func NewUpdateMTOShipment

func NewUpdateMTOShipment(ctx *middleware.Context, handler UpdateMTOShipmentHandler) *UpdateMTOShipment

NewUpdateMTOShipment creates a new http.Handler for the update m t o shipment operation

func (*UpdateMTOShipment) ServeHTTP

func (o *UpdateMTOShipment) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type UpdateMTOShipmentAddress

type UpdateMTOShipmentAddress struct {
	Context *middleware.Context
	Handler UpdateMTOShipmentAddressHandler
}
UpdateMTOShipmentAddress swagger:route PUT /mto-shipments/{mtoShipmentID}/addresses/{addressID} mtoShipment updateMTOShipmentAddress

updateMTOShipmentAddress

### Functionality This endpoint is used to **update** the pickup, secondary, and destination addresses on an MTO Shipment. mto-shipments/{mtoShipmentID}/shipment-address-updates is for updating a delivery address. The address details completely replace the original, except for the UUID. Therefore a complete address should be sent in the request. When a destination address on a shipment is updated, the destination SIT service items address ID will also be updated so that shipment and service item final destinations match.

This endpoint **cannot create** an address. To create an address on an MTO shipment, the caller must use [updateMTOShipment](#operation/updateMTOShipment) as the parent shipment has to be updated with the appropriate link to the address.

### Errors The address must be associated with the mtoShipment passed in the url. In other words, it should be listed as pickupAddress, destinationAddress, secondaryPickupAddress or secondaryDeliveryAddress on the mtoShipment provided. If it is not, caller will receive a **Conflict** Error.

The mtoShipment should be associated with an MTO that is available to prime. If the caller requests an update to an address, and the shipment is not on an available MTO, the caller will receive a **NotFound** Error.

func NewUpdateMTOShipmentAddress

func NewUpdateMTOShipmentAddress(ctx *middleware.Context, handler UpdateMTOShipmentAddressHandler) *UpdateMTOShipmentAddress

NewUpdateMTOShipmentAddress creates a new http.Handler for the update m t o shipment address operation

func (*UpdateMTOShipmentAddress) ServeHTTP

type UpdateMTOShipmentAddressBadRequest

type UpdateMTOShipmentAddressBadRequest struct {

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

UpdateMTOShipmentAddressBadRequest The request payload is invalid.

swagger:response updateMTOShipmentAddressBadRequest

func NewUpdateMTOShipmentAddressBadRequest

func NewUpdateMTOShipmentAddressBadRequest() *UpdateMTOShipmentAddressBadRequest

NewUpdateMTOShipmentAddressBadRequest creates UpdateMTOShipmentAddressBadRequest with default headers values

func (*UpdateMTOShipmentAddressBadRequest) SetPayload

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

func (*UpdateMTOShipmentAddressBadRequest) WithPayload

WithPayload adds the payload to the update m t o shipment address bad request response

func (*UpdateMTOShipmentAddressBadRequest) WriteResponse

WriteResponse to the client

type UpdateMTOShipmentAddressConflict

type UpdateMTOShipmentAddressConflict struct {

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

UpdateMTOShipmentAddressConflict The request could not be processed because of conflict in the current state of the resource.

swagger:response updateMTOShipmentAddressConflict

func NewUpdateMTOShipmentAddressConflict

func NewUpdateMTOShipmentAddressConflict() *UpdateMTOShipmentAddressConflict

NewUpdateMTOShipmentAddressConflict creates UpdateMTOShipmentAddressConflict with default headers values

func (*UpdateMTOShipmentAddressConflict) SetPayload

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

func (*UpdateMTOShipmentAddressConflict) WithPayload

WithPayload adds the payload to the update m t o shipment address conflict response

func (*UpdateMTOShipmentAddressConflict) WriteResponse

func (o *UpdateMTOShipmentAddressConflict) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateMTOShipmentAddressForbidden

type UpdateMTOShipmentAddressForbidden struct {

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

UpdateMTOShipmentAddressForbidden The request was denied.

swagger:response updateMTOShipmentAddressForbidden

func NewUpdateMTOShipmentAddressForbidden

func NewUpdateMTOShipmentAddressForbidden() *UpdateMTOShipmentAddressForbidden

NewUpdateMTOShipmentAddressForbidden creates UpdateMTOShipmentAddressForbidden with default headers values

func (*UpdateMTOShipmentAddressForbidden) SetPayload

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

func (*UpdateMTOShipmentAddressForbidden) WithPayload

WithPayload adds the payload to the update m t o shipment address forbidden response

func (*UpdateMTOShipmentAddressForbidden) WriteResponse

func (o *UpdateMTOShipmentAddressForbidden) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateMTOShipmentAddressHandler

type UpdateMTOShipmentAddressHandler interface {
	Handle(UpdateMTOShipmentAddressParams) middleware.Responder
}

UpdateMTOShipmentAddressHandler interface for that can handle valid update m t o shipment address params

type UpdateMTOShipmentAddressHandlerFunc

type UpdateMTOShipmentAddressHandlerFunc func(UpdateMTOShipmentAddressParams) middleware.Responder

UpdateMTOShipmentAddressHandlerFunc turns a function with the right signature into a update m t o shipment address handler

func (UpdateMTOShipmentAddressHandlerFunc) Handle

Handle executing the request and returning a response

type UpdateMTOShipmentAddressInternalServerError

type UpdateMTOShipmentAddressInternalServerError struct {

	/*
	  In: Body
	*/
	Payload *primemessages.Error `json:"body,omitempty"`
}

UpdateMTOShipmentAddressInternalServerError A server error occurred.

swagger:response updateMTOShipmentAddressInternalServerError

func NewUpdateMTOShipmentAddressInternalServerError

func NewUpdateMTOShipmentAddressInternalServerError() *UpdateMTOShipmentAddressInternalServerError

NewUpdateMTOShipmentAddressInternalServerError creates UpdateMTOShipmentAddressInternalServerError with default headers values

func (*UpdateMTOShipmentAddressInternalServerError) SetPayload

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

func (*UpdateMTOShipmentAddressInternalServerError) WithPayload

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

func (*UpdateMTOShipmentAddressInternalServerError) WriteResponse

WriteResponse to the client

type UpdateMTOShipmentAddressNotFound

type UpdateMTOShipmentAddressNotFound struct {

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

UpdateMTOShipmentAddressNotFound The requested resource wasn't found.

swagger:response updateMTOShipmentAddressNotFound

func NewUpdateMTOShipmentAddressNotFound

func NewUpdateMTOShipmentAddressNotFound() *UpdateMTOShipmentAddressNotFound

NewUpdateMTOShipmentAddressNotFound creates UpdateMTOShipmentAddressNotFound with default headers values

func (*UpdateMTOShipmentAddressNotFound) SetPayload

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

func (*UpdateMTOShipmentAddressNotFound) WithPayload

WithPayload adds the payload to the update m t o shipment address not found response

func (*UpdateMTOShipmentAddressNotFound) WriteResponse

func (o *UpdateMTOShipmentAddressNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateMTOShipmentAddressOK

type UpdateMTOShipmentAddressOK struct {

	/*
	  In: Body
	*/
	Payload *primemessages.Address `json:"body,omitempty"`
}

UpdateMTOShipmentAddressOK Successfully updated the address.

swagger:response updateMTOShipmentAddressOK

func NewUpdateMTOShipmentAddressOK

func NewUpdateMTOShipmentAddressOK() *UpdateMTOShipmentAddressOK

NewUpdateMTOShipmentAddressOK creates UpdateMTOShipmentAddressOK with default headers values

func (*UpdateMTOShipmentAddressOK) SetPayload

func (o *UpdateMTOShipmentAddressOK) SetPayload(payload *primemessages.Address)

SetPayload sets the payload to the update m t o shipment address o k response

func (*UpdateMTOShipmentAddressOK) WithPayload

WithPayload adds the payload to the update m t o shipment address o k response

func (*UpdateMTOShipmentAddressOK) WriteResponse

func (o *UpdateMTOShipmentAddressOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateMTOShipmentAddressParams

type UpdateMTOShipmentAddressParams 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
	/*UUID of the address being updated
	  Required: true
	  In: path
	*/
	AddressID strfmt.UUID
	/*
	  Required: true
	  In: body
	*/
	Body *primemessages.Address
	/*UUID of the shipment associated with the address
	  Required: true
	  In: path
	*/
	MtoShipmentID strfmt.UUID
}

UpdateMTOShipmentAddressParams contains all the bound params for the update m t o shipment address operation typically these are obtained from a http.Request

swagger:parameters updateMTOShipmentAddress

func NewUpdateMTOShipmentAddressParams

func NewUpdateMTOShipmentAddressParams() UpdateMTOShipmentAddressParams

NewUpdateMTOShipmentAddressParams creates a new UpdateMTOShipmentAddressParams object

There are no default values defined in the spec.

func (*UpdateMTOShipmentAddressParams) 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 NewUpdateMTOShipmentAddressParams() beforehand.

type UpdateMTOShipmentAddressPreconditionFailed

type UpdateMTOShipmentAddressPreconditionFailed struct {

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

UpdateMTOShipmentAddressPreconditionFailed Precondition failed, likely due to a stale eTag (If-Match). Fetch the request again to get the updated eTag value.

swagger:response updateMTOShipmentAddressPreconditionFailed

func NewUpdateMTOShipmentAddressPreconditionFailed

func NewUpdateMTOShipmentAddressPreconditionFailed() *UpdateMTOShipmentAddressPreconditionFailed

NewUpdateMTOShipmentAddressPreconditionFailed creates UpdateMTOShipmentAddressPreconditionFailed with default headers values

func (*UpdateMTOShipmentAddressPreconditionFailed) SetPayload

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

func (*UpdateMTOShipmentAddressPreconditionFailed) WithPayload

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

func (*UpdateMTOShipmentAddressPreconditionFailed) WriteResponse

WriteResponse to the client

type UpdateMTOShipmentAddressURL

type UpdateMTOShipmentAddressURL struct {
	AddressID     strfmt.UUID
	MtoShipmentID strfmt.UUID
	// contains filtered or unexported fields
}

UpdateMTOShipmentAddressURL generates an URL for the update m t o shipment address operation

func (*UpdateMTOShipmentAddressURL) Build

func (o *UpdateMTOShipmentAddressURL) Build() (*url.URL, error)

Build a url path and query string

func (*UpdateMTOShipmentAddressURL) BuildFull

func (o *UpdateMTOShipmentAddressURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*UpdateMTOShipmentAddressURL) Must

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

Must is a helper function to panic when the url builder returns an error

func (*UpdateMTOShipmentAddressURL) SetBasePath

func (o *UpdateMTOShipmentAddressURL) 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 (*UpdateMTOShipmentAddressURL) String

func (o *UpdateMTOShipmentAddressURL) String() string

String returns the string representation of the path with query string

func (*UpdateMTOShipmentAddressURL) StringFull

func (o *UpdateMTOShipmentAddressURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*UpdateMTOShipmentAddressURL) 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 UpdateMTOShipmentAddressUnauthorized

type UpdateMTOShipmentAddressUnauthorized struct {

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

UpdateMTOShipmentAddressUnauthorized The request was denied.

swagger:response updateMTOShipmentAddressUnauthorized

func NewUpdateMTOShipmentAddressUnauthorized

func NewUpdateMTOShipmentAddressUnauthorized() *UpdateMTOShipmentAddressUnauthorized

NewUpdateMTOShipmentAddressUnauthorized creates UpdateMTOShipmentAddressUnauthorized with default headers values

func (*UpdateMTOShipmentAddressUnauthorized) SetPayload

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

func (*UpdateMTOShipmentAddressUnauthorized) WithPayload

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

func (*UpdateMTOShipmentAddressUnauthorized) WriteResponse

WriteResponse to the client

type UpdateMTOShipmentAddressUnprocessableEntity

type UpdateMTOShipmentAddressUnprocessableEntity struct {

	/*
	  In: Body
	*/
	Payload *primemessages.ValidationError `json:"body,omitempty"`
}

UpdateMTOShipmentAddressUnprocessableEntity The request was unprocessable, likely due to bad input from the requester.

swagger:response updateMTOShipmentAddressUnprocessableEntity

func NewUpdateMTOShipmentAddressUnprocessableEntity

func NewUpdateMTOShipmentAddressUnprocessableEntity() *UpdateMTOShipmentAddressUnprocessableEntity

NewUpdateMTOShipmentAddressUnprocessableEntity creates UpdateMTOShipmentAddressUnprocessableEntity with default headers values

func (*UpdateMTOShipmentAddressUnprocessableEntity) SetPayload

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

func (*UpdateMTOShipmentAddressUnprocessableEntity) WithPayload

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

func (*UpdateMTOShipmentAddressUnprocessableEntity) WriteResponse

WriteResponse to the client

type UpdateMTOShipmentBadRequest

type UpdateMTOShipmentBadRequest struct {

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

UpdateMTOShipmentBadRequest The request payload is invalid.

swagger:response updateMTOShipmentBadRequest

func NewUpdateMTOShipmentBadRequest

func NewUpdateMTOShipmentBadRequest() *UpdateMTOShipmentBadRequest

NewUpdateMTOShipmentBadRequest creates UpdateMTOShipmentBadRequest with default headers values

func (*UpdateMTOShipmentBadRequest) SetPayload

func (o *UpdateMTOShipmentBadRequest) SetPayload(payload *primemessages.ClientError)

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

func (*UpdateMTOShipmentBadRequest) WithPayload

WithPayload adds the payload to the update m t o shipment bad request response

func (*UpdateMTOShipmentBadRequest) WriteResponse

func (o *UpdateMTOShipmentBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateMTOShipmentForbidden

type UpdateMTOShipmentForbidden struct {

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

UpdateMTOShipmentForbidden The request was denied.

swagger:response updateMTOShipmentForbidden

func NewUpdateMTOShipmentForbidden

func NewUpdateMTOShipmentForbidden() *UpdateMTOShipmentForbidden

NewUpdateMTOShipmentForbidden creates UpdateMTOShipmentForbidden with default headers values

func (*UpdateMTOShipmentForbidden) SetPayload

func (o *UpdateMTOShipmentForbidden) SetPayload(payload *primemessages.ClientError)

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

func (*UpdateMTOShipmentForbidden) WithPayload

WithPayload adds the payload to the update m t o shipment forbidden response

func (*UpdateMTOShipmentForbidden) WriteResponse

func (o *UpdateMTOShipmentForbidden) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateMTOShipmentHandler

type UpdateMTOShipmentHandler interface {
	Handle(UpdateMTOShipmentParams) middleware.Responder
}

UpdateMTOShipmentHandler interface for that can handle valid update m t o shipment params

type UpdateMTOShipmentHandlerFunc

type UpdateMTOShipmentHandlerFunc func(UpdateMTOShipmentParams) middleware.Responder

UpdateMTOShipmentHandlerFunc turns a function with the right signature into a update m t o shipment handler

func (UpdateMTOShipmentHandlerFunc) Handle

Handle executing the request and returning a response

type UpdateMTOShipmentInternalServerError

type UpdateMTOShipmentInternalServerError struct {

	/*
	  In: Body
	*/
	Payload *primemessages.Error `json:"body,omitempty"`
}

UpdateMTOShipmentInternalServerError A server error occurred.

swagger:response updateMTOShipmentInternalServerError

func NewUpdateMTOShipmentInternalServerError

func NewUpdateMTOShipmentInternalServerError() *UpdateMTOShipmentInternalServerError

NewUpdateMTOShipmentInternalServerError creates UpdateMTOShipmentInternalServerError with default headers values

func (*UpdateMTOShipmentInternalServerError) SetPayload

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

func (*UpdateMTOShipmentInternalServerError) WithPayload

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

func (*UpdateMTOShipmentInternalServerError) WriteResponse

WriteResponse to the client

type UpdateMTOShipmentNotFound

type UpdateMTOShipmentNotFound struct {

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

UpdateMTOShipmentNotFound The requested resource wasn't found.

swagger:response updateMTOShipmentNotFound

func NewUpdateMTOShipmentNotFound

func NewUpdateMTOShipmentNotFound() *UpdateMTOShipmentNotFound

NewUpdateMTOShipmentNotFound creates UpdateMTOShipmentNotFound with default headers values

func (*UpdateMTOShipmentNotFound) SetPayload

func (o *UpdateMTOShipmentNotFound) SetPayload(payload *primemessages.ClientError)

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

func (*UpdateMTOShipmentNotFound) WithPayload

WithPayload adds the payload to the update m t o shipment not found response

func (*UpdateMTOShipmentNotFound) WriteResponse

func (o *UpdateMTOShipmentNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateMTOShipmentOK

type UpdateMTOShipmentOK struct {

	/*
	  In: Body
	*/
	Payload *primemessages.MTOShipment `json:"body,omitempty"`
}

UpdateMTOShipmentOK Successfully updated the MTO shipment.

swagger:response updateMTOShipmentOK

func NewUpdateMTOShipmentOK

func NewUpdateMTOShipmentOK() *UpdateMTOShipmentOK

NewUpdateMTOShipmentOK creates UpdateMTOShipmentOK with default headers values

func (*UpdateMTOShipmentOK) SetPayload

func (o *UpdateMTOShipmentOK) SetPayload(payload *primemessages.MTOShipment)

SetPayload sets the payload to the update m t o shipment o k response

func (*UpdateMTOShipmentOK) WithPayload

WithPayload adds the payload to the update m t o shipment o k response

func (*UpdateMTOShipmentOK) WriteResponse

func (o *UpdateMTOShipmentOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateMTOShipmentParams

type UpdateMTOShipmentParams 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 *primemessages.UpdateMTOShipment
	/*UUID of the shipment being updated.
	  Required: true
	  In: path
	*/
	MtoShipmentID strfmt.UUID
}

UpdateMTOShipmentParams contains all the bound params for the update m t o shipment operation typically these are obtained from a http.Request

swagger:parameters updateMTOShipment

func NewUpdateMTOShipmentParams

func NewUpdateMTOShipmentParams() UpdateMTOShipmentParams

NewUpdateMTOShipmentParams creates a new UpdateMTOShipmentParams object

There are no default values defined in the spec.

func (*UpdateMTOShipmentParams) BindRequest

func (o *UpdateMTOShipmentParams) 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 NewUpdateMTOShipmentParams() beforehand.

type UpdateMTOShipmentPreconditionFailed

type UpdateMTOShipmentPreconditionFailed struct {

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

UpdateMTOShipmentPreconditionFailed Precondition failed, likely due to a stale eTag (If-Match). Fetch the request again to get the updated eTag value.

swagger:response updateMTOShipmentPreconditionFailed

func NewUpdateMTOShipmentPreconditionFailed

func NewUpdateMTOShipmentPreconditionFailed() *UpdateMTOShipmentPreconditionFailed

NewUpdateMTOShipmentPreconditionFailed creates UpdateMTOShipmentPreconditionFailed with default headers values

func (*UpdateMTOShipmentPreconditionFailed) SetPayload

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

func (*UpdateMTOShipmentPreconditionFailed) WithPayload

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

func (*UpdateMTOShipmentPreconditionFailed) WriteResponse

WriteResponse to the client

type UpdateMTOShipmentStatus

type UpdateMTOShipmentStatus struct {
	Context *middleware.Context
	Handler UpdateMTOShipmentStatusHandler
}
UpdateMTOShipmentStatus swagger:route PATCH /mto-shipments/{mtoShipmentID}/status mtoShipment updateMTOShipmentStatus

updateMTOShipmentStatus

### Functionality This endpoint should be used by the Prime to confirm the cancellation of a shipment. It allows the shipment status to be changed to "CANCELED." Currently, the Prime cannot update the shipment to any other status.

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 *primemessages.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 *primemessages.ClientError `json:"body,omitempty"`
}

UpdateMTOShipmentStatusConflict The request could not be processed because of conflict in the current state of the resource.

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 *primemessages.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 *primemessages.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 *primemessages.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 *primemessages.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 *primemessages.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 *primemessages.UpdateMTOShipmentStatus
	/*UUID of the shipment associated with the agent
	  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 *primemessages.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 *primemessages.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 *primemessages.ValidationError `json:"body,omitempty"`
}

UpdateMTOShipmentStatusUnprocessableEntity The request was unprocessable, likely due to bad input from the requester.

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

type UpdateMTOShipmentURL

type UpdateMTOShipmentURL struct {
	MtoShipmentID strfmt.UUID
	// contains filtered or unexported fields
}

UpdateMTOShipmentURL generates an URL for the update m t o shipment operation

func (*UpdateMTOShipmentURL) Build

func (o *UpdateMTOShipmentURL) Build() (*url.URL, error)

Build a url path and query string

func (*UpdateMTOShipmentURL) BuildFull

func (o *UpdateMTOShipmentURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*UpdateMTOShipmentURL) Must

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

Must is a helper function to panic when the url builder returns an error

func (*UpdateMTOShipmentURL) SetBasePath

func (o *UpdateMTOShipmentURL) 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 (*UpdateMTOShipmentURL) String

func (o *UpdateMTOShipmentURL) String() string

String returns the string representation of the path with query string

func (*UpdateMTOShipmentURL) StringFull

func (o *UpdateMTOShipmentURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*UpdateMTOShipmentURL) WithBasePath

func (o *UpdateMTOShipmentURL) WithBasePath(bp string) *UpdateMTOShipmentURL

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 UpdateMTOShipmentUnauthorized

type UpdateMTOShipmentUnauthorized struct {

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

UpdateMTOShipmentUnauthorized The request was denied.

swagger:response updateMTOShipmentUnauthorized

func NewUpdateMTOShipmentUnauthorized

func NewUpdateMTOShipmentUnauthorized() *UpdateMTOShipmentUnauthorized

NewUpdateMTOShipmentUnauthorized creates UpdateMTOShipmentUnauthorized with default headers values

func (*UpdateMTOShipmentUnauthorized) SetPayload

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

func (*UpdateMTOShipmentUnauthorized) WithPayload

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

func (*UpdateMTOShipmentUnauthorized) WriteResponse

func (o *UpdateMTOShipmentUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateMTOShipmentUnprocessableEntity

type UpdateMTOShipmentUnprocessableEntity struct {

	/*
	  In: Body
	*/
	Payload *primemessages.ValidationError `json:"body,omitempty"`
}

UpdateMTOShipmentUnprocessableEntity The request was unprocessable, likely due to bad input from the requester.

swagger:response updateMTOShipmentUnprocessableEntity

func NewUpdateMTOShipmentUnprocessableEntity

func NewUpdateMTOShipmentUnprocessableEntity() *UpdateMTOShipmentUnprocessableEntity

NewUpdateMTOShipmentUnprocessableEntity creates UpdateMTOShipmentUnprocessableEntity with default headers values

func (*UpdateMTOShipmentUnprocessableEntity) SetPayload

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

func (*UpdateMTOShipmentUnprocessableEntity) WithPayload

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

func (*UpdateMTOShipmentUnprocessableEntity) WriteResponse

WriteResponse to the client

type UpdateReweigh

type UpdateReweigh struct {
	Context *middleware.Context
	Handler UpdateReweighHandler
}
UpdateReweigh swagger:route PATCH /mto-shipments/{mtoShipmentID}/reweighs/{reweighID} mtoShipment updateReweigh

updateReweigh

### Functionality This endpoint can be used to update a reweigh with a new weight or to provide the reason why a reweigh did not occur. Only one of weight or verificationReason should be sent in the request body.

A reweigh is the second recorded weight for a shipment, as validated by certified weight tickets. Applies to one shipment. A reweigh can be triggered automatically, or requested by the customer or transportation office. Not all shipments are reweighed, so not all shipments will have a reweigh weight.

func NewUpdateReweigh

func NewUpdateReweigh(ctx *middleware.Context, handler UpdateReweighHandler) *UpdateReweigh

NewUpdateReweigh creates a new http.Handler for the update reweigh operation

func (*UpdateReweigh) ServeHTTP

func (o *UpdateReweigh) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type UpdateReweighBadRequest

type UpdateReweighBadRequest struct {

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

UpdateReweighBadRequest The request payload is invalid.

swagger:response updateReweighBadRequest

func NewUpdateReweighBadRequest

func NewUpdateReweighBadRequest() *UpdateReweighBadRequest

NewUpdateReweighBadRequest creates UpdateReweighBadRequest with default headers values

func (*UpdateReweighBadRequest) SetPayload

func (o *UpdateReweighBadRequest) SetPayload(payload *primemessages.ClientError)

SetPayload sets the payload to the update reweigh bad request response

func (*UpdateReweighBadRequest) WithPayload

WithPayload adds the payload to the update reweigh bad request response

func (*UpdateReweighBadRequest) WriteResponse

func (o *UpdateReweighBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateReweighConflict

type UpdateReweighConflict struct {

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

UpdateReweighConflict The request could not be processed because of conflict in the current state of the resource.

swagger:response updateReweighConflict

func NewUpdateReweighConflict

func NewUpdateReweighConflict() *UpdateReweighConflict

NewUpdateReweighConflict creates UpdateReweighConflict with default headers values

func (*UpdateReweighConflict) SetPayload

func (o *UpdateReweighConflict) SetPayload(payload *primemessages.ClientError)

SetPayload sets the payload to the update reweigh conflict response

func (*UpdateReweighConflict) WithPayload

WithPayload adds the payload to the update reweigh conflict response

func (*UpdateReweighConflict) WriteResponse

func (o *UpdateReweighConflict) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateReweighForbidden

type UpdateReweighForbidden struct {

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

UpdateReweighForbidden The request was denied.

swagger:response updateReweighForbidden

func NewUpdateReweighForbidden

func NewUpdateReweighForbidden() *UpdateReweighForbidden

NewUpdateReweighForbidden creates UpdateReweighForbidden with default headers values

func (*UpdateReweighForbidden) SetPayload

func (o *UpdateReweighForbidden) SetPayload(payload *primemessages.ClientError)

SetPayload sets the payload to the update reweigh forbidden response

func (*UpdateReweighForbidden) WithPayload

WithPayload adds the payload to the update reweigh forbidden response

func (*UpdateReweighForbidden) WriteResponse

func (o *UpdateReweighForbidden) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateReweighHandler

type UpdateReweighHandler interface {
	Handle(UpdateReweighParams) middleware.Responder
}

UpdateReweighHandler interface for that can handle valid update reweigh params

type UpdateReweighHandlerFunc

type UpdateReweighHandlerFunc func(UpdateReweighParams) middleware.Responder

UpdateReweighHandlerFunc turns a function with the right signature into a update reweigh handler

func (UpdateReweighHandlerFunc) Handle

Handle executing the request and returning a response

type UpdateReweighInternalServerError

type UpdateReweighInternalServerError struct {

	/*
	  In: Body
	*/
	Payload *primemessages.Error `json:"body,omitempty"`
}

UpdateReweighInternalServerError A server error occurred.

swagger:response updateReweighInternalServerError

func NewUpdateReweighInternalServerError

func NewUpdateReweighInternalServerError() *UpdateReweighInternalServerError

NewUpdateReweighInternalServerError creates UpdateReweighInternalServerError with default headers values

func (*UpdateReweighInternalServerError) SetPayload

func (o *UpdateReweighInternalServerError) SetPayload(payload *primemessages.Error)

SetPayload sets the payload to the update reweigh internal server error response

func (*UpdateReweighInternalServerError) WithPayload

WithPayload adds the payload to the update reweigh internal server error response

func (*UpdateReweighInternalServerError) WriteResponse

func (o *UpdateReweighInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateReweighNotFound

type UpdateReweighNotFound struct {

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

UpdateReweighNotFound The requested resource wasn't found.

swagger:response updateReweighNotFound

func NewUpdateReweighNotFound

func NewUpdateReweighNotFound() *UpdateReweighNotFound

NewUpdateReweighNotFound creates UpdateReweighNotFound with default headers values

func (*UpdateReweighNotFound) SetPayload

func (o *UpdateReweighNotFound) SetPayload(payload *primemessages.ClientError)

SetPayload sets the payload to the update reweigh not found response

func (*UpdateReweighNotFound) WithPayload

WithPayload adds the payload to the update reweigh not found response

func (*UpdateReweighNotFound) WriteResponse

func (o *UpdateReweighNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateReweighOK

type UpdateReweighOK struct {

	/*
	  In: Body
	*/
	Payload *primemessages.Reweigh `json:"body,omitempty"`
}

UpdateReweighOK Successfully updated the reweigh.

swagger:response updateReweighOK

func NewUpdateReweighOK

func NewUpdateReweighOK() *UpdateReweighOK

NewUpdateReweighOK creates UpdateReweighOK with default headers values

func (*UpdateReweighOK) SetPayload

func (o *UpdateReweighOK) SetPayload(payload *primemessages.Reweigh)

SetPayload sets the payload to the update reweigh o k response

func (*UpdateReweighOK) WithPayload

func (o *UpdateReweighOK) WithPayload(payload *primemessages.Reweigh) *UpdateReweighOK

WithPayload adds the payload to the update reweigh o k response

func (*UpdateReweighOK) WriteResponse

func (o *UpdateReweighOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateReweighParams

type UpdateReweighParams 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 *primemessages.UpdateReweigh
	/*UUID of the shipment associated with the reweigh
	  Required: true
	  In: path
	*/
	MtoShipmentID strfmt.UUID
	/*UUID of the reweigh being updated
	  Required: true
	  In: path
	*/
	ReweighID strfmt.UUID
}

UpdateReweighParams contains all the bound params for the update reweigh operation typically these are obtained from a http.Request

swagger:parameters updateReweigh

func NewUpdateReweighParams

func NewUpdateReweighParams() UpdateReweighParams

NewUpdateReweighParams creates a new UpdateReweighParams object

There are no default values defined in the spec.

func (*UpdateReweighParams) BindRequest

func (o *UpdateReweighParams) 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 NewUpdateReweighParams() beforehand.

type UpdateReweighPreconditionFailed

type UpdateReweighPreconditionFailed struct {

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

UpdateReweighPreconditionFailed Precondition failed, likely due to a stale eTag (If-Match). Fetch the request again to get the updated eTag value.

swagger:response updateReweighPreconditionFailed

func NewUpdateReweighPreconditionFailed

func NewUpdateReweighPreconditionFailed() *UpdateReweighPreconditionFailed

NewUpdateReweighPreconditionFailed creates UpdateReweighPreconditionFailed with default headers values

func (*UpdateReweighPreconditionFailed) SetPayload

SetPayload sets the payload to the update reweigh precondition failed response

func (*UpdateReweighPreconditionFailed) WithPayload

WithPayload adds the payload to the update reweigh precondition failed response

func (*UpdateReweighPreconditionFailed) WriteResponse

func (o *UpdateReweighPreconditionFailed) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateReweighURL

type UpdateReweighURL struct {
	MtoShipmentID strfmt.UUID
	ReweighID     strfmt.UUID
	// contains filtered or unexported fields
}

UpdateReweighURL generates an URL for the update reweigh operation

func (*UpdateReweighURL) Build

func (o *UpdateReweighURL) Build() (*url.URL, error)

Build a url path and query string

func (*UpdateReweighURL) BuildFull

func (o *UpdateReweighURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*UpdateReweighURL) Must

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

Must is a helper function to panic when the url builder returns an error

func (*UpdateReweighURL) SetBasePath

func (o *UpdateReweighURL) 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 (*UpdateReweighURL) String

func (o *UpdateReweighURL) String() string

String returns the string representation of the path with query string

func (*UpdateReweighURL) StringFull

func (o *UpdateReweighURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*UpdateReweighURL) WithBasePath

func (o *UpdateReweighURL) WithBasePath(bp string) *UpdateReweighURL

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 UpdateReweighUnauthorized

type UpdateReweighUnauthorized struct {

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

UpdateReweighUnauthorized The request was denied.

swagger:response updateReweighUnauthorized

func NewUpdateReweighUnauthorized

func NewUpdateReweighUnauthorized() *UpdateReweighUnauthorized

NewUpdateReweighUnauthorized creates UpdateReweighUnauthorized with default headers values

func (*UpdateReweighUnauthorized) SetPayload

func (o *UpdateReweighUnauthorized) SetPayload(payload *primemessages.ClientError)

SetPayload sets the payload to the update reweigh unauthorized response

func (*UpdateReweighUnauthorized) WithPayload

WithPayload adds the payload to the update reweigh unauthorized response

func (*UpdateReweighUnauthorized) WriteResponse

func (o *UpdateReweighUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateReweighUnprocessableEntity

type UpdateReweighUnprocessableEntity struct {

	/*
	  In: Body
	*/
	Payload *primemessages.ValidationError `json:"body,omitempty"`
}

UpdateReweighUnprocessableEntity The request was unprocessable, likely due to bad input from the requester.

swagger:response updateReweighUnprocessableEntity

func NewUpdateReweighUnprocessableEntity

func NewUpdateReweighUnprocessableEntity() *UpdateReweighUnprocessableEntity

NewUpdateReweighUnprocessableEntity creates UpdateReweighUnprocessableEntity with default headers values

func (*UpdateReweighUnprocessableEntity) SetPayload

SetPayload sets the payload to the update reweigh unprocessable entity response

func (*UpdateReweighUnprocessableEntity) WithPayload

WithPayload adds the payload to the update reweigh unprocessable entity response

func (*UpdateReweighUnprocessableEntity) WriteResponse

func (o *UpdateReweighUnprocessableEntity) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type UpdateShipmentDestinationAddress

type UpdateShipmentDestinationAddress struct {
	Context *middleware.Context
	Handler UpdateShipmentDestinationAddressHandler
}
UpdateShipmentDestinationAddress swagger:route POST /mto-shipments/{mtoShipmentID}/shipment-address-updates mtoShipment updateShipmentDestinationAddress

updateShipmentDestinationAddress

### Functionality This endpoint is used so the Prime can request an **update** for the destination address on an MTO Shipment, after the destination address has already been approved. If automatically approved or TOO approves, this will update the final destination address values for destination SIT service items to be the same as the changed destination address that was approved. Address updates will be automatically approved unless they change:

  • The service area
  • Mileage bracket for direct delivery
  • the address and the distance between the old and new address is > 50
  • Domestic Short Haul to Domestic Line Haul or vice versa
  • Shipments that start and end in one ZIP3 use Short Haul pricing
  • Shipments that start and end in different ZIP3s use Line Haul pricing

For those, changes will require TOO approval.

func NewUpdateShipmentDestinationAddress

func NewUpdateShipmentDestinationAddress(ctx *middleware.Context, handler UpdateShipmentDestinationAddressHandler) *UpdateShipmentDestinationAddress

NewUpdateShipmentDestinationAddress creates a new http.Handler for the update shipment destination address operation

func (*UpdateShipmentDestinationAddress) ServeHTTP

type UpdateShipmentDestinationAddressBadRequest

type UpdateShipmentDestinationAddressBadRequest struct {

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

UpdateShipmentDestinationAddressBadRequest The request payload is invalid.

swagger:response updateShipmentDestinationAddressBadRequest

func NewUpdateShipmentDestinationAddressBadRequest

func NewUpdateShipmentDestinationAddressBadRequest() *UpdateShipmentDestinationAddressBadRequest

NewUpdateShipmentDestinationAddressBadRequest creates UpdateShipmentDestinationAddressBadRequest with default headers values

func (*UpdateShipmentDestinationAddressBadRequest) SetPayload

SetPayload sets the payload to the update shipment destination address bad request response

func (*UpdateShipmentDestinationAddressBadRequest) WithPayload

WithPayload adds the payload to the update shipment destination address bad request response

func (*UpdateShipmentDestinationAddressBadRequest) WriteResponse

WriteResponse to the client

type UpdateShipmentDestinationAddressConflict

type UpdateShipmentDestinationAddressConflict struct {

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

UpdateShipmentDestinationAddressConflict The request could not be processed because of conflict in the current state of the resource.

swagger:response updateShipmentDestinationAddressConflict

func NewUpdateShipmentDestinationAddressConflict

func NewUpdateShipmentDestinationAddressConflict() *UpdateShipmentDestinationAddressConflict

NewUpdateShipmentDestinationAddressConflict creates UpdateShipmentDestinationAddressConflict with default headers values

func (*UpdateShipmentDestinationAddressConflict) SetPayload

SetPayload sets the payload to the update shipment destination address conflict response

func (*UpdateShipmentDestinationAddressConflict) WithPayload

WithPayload adds the payload to the update shipment destination address conflict response

func (*UpdateShipmentDestinationAddressConflict) WriteResponse

WriteResponse to the client

type UpdateShipmentDestinationAddressCreated

type UpdateShipmentDestinationAddressCreated struct {

	/*
	  In: Body
	*/
	Payload *primemessages.ShipmentAddressUpdate `json:"body,omitempty"`
}

UpdateShipmentDestinationAddressCreated Successfully created the address update request.

swagger:response updateShipmentDestinationAddressCreated

func NewUpdateShipmentDestinationAddressCreated

func NewUpdateShipmentDestinationAddressCreated() *UpdateShipmentDestinationAddressCreated

NewUpdateShipmentDestinationAddressCreated creates UpdateShipmentDestinationAddressCreated with default headers values

func (*UpdateShipmentDestinationAddressCreated) SetPayload

SetPayload sets the payload to the update shipment destination address created response

func (*UpdateShipmentDestinationAddressCreated) WithPayload

WithPayload adds the payload to the update shipment destination address created response

func (*UpdateShipmentDestinationAddressCreated) WriteResponse

WriteResponse to the client

type UpdateShipmentDestinationAddressForbidden

type UpdateShipmentDestinationAddressForbidden struct {

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

UpdateShipmentDestinationAddressForbidden The request was denied.

swagger:response updateShipmentDestinationAddressForbidden

func NewUpdateShipmentDestinationAddressForbidden

func NewUpdateShipmentDestinationAddressForbidden() *UpdateShipmentDestinationAddressForbidden

NewUpdateShipmentDestinationAddressForbidden creates UpdateShipmentDestinationAddressForbidden with default headers values

func (*UpdateShipmentDestinationAddressForbidden) SetPayload

SetPayload sets the payload to the update shipment destination address forbidden response

func (*UpdateShipmentDestinationAddressForbidden) WithPayload

WithPayload adds the payload to the update shipment destination address forbidden response

func (*UpdateShipmentDestinationAddressForbidden) WriteResponse

WriteResponse to the client

type UpdateShipmentDestinationAddressHandler

type UpdateShipmentDestinationAddressHandler interface {
	Handle(UpdateShipmentDestinationAddressParams) middleware.Responder
}

UpdateShipmentDestinationAddressHandler interface for that can handle valid update shipment destination address params

type UpdateShipmentDestinationAddressHandlerFunc

type UpdateShipmentDestinationAddressHandlerFunc func(UpdateShipmentDestinationAddressParams) middleware.Responder

UpdateShipmentDestinationAddressHandlerFunc turns a function with the right signature into a update shipment destination address handler

func (UpdateShipmentDestinationAddressHandlerFunc) Handle

Handle executing the request and returning a response

type UpdateShipmentDestinationAddressInternalServerError

type UpdateShipmentDestinationAddressInternalServerError struct {

	/*
	  In: Body
	*/
	Payload *primemessages.Error `json:"body,omitempty"`
}

UpdateShipmentDestinationAddressInternalServerError A server error occurred.

swagger:response updateShipmentDestinationAddressInternalServerError

func NewUpdateShipmentDestinationAddressInternalServerError

func NewUpdateShipmentDestinationAddressInternalServerError() *UpdateShipmentDestinationAddressInternalServerError

NewUpdateShipmentDestinationAddressInternalServerError creates UpdateShipmentDestinationAddressInternalServerError with default headers values

func (*UpdateShipmentDestinationAddressInternalServerError) SetPayload

SetPayload sets the payload to the update shipment destination address internal server error response

func (*UpdateShipmentDestinationAddressInternalServerError) WithPayload

WithPayload adds the payload to the update shipment destination address internal server error response

func (*UpdateShipmentDestinationAddressInternalServerError) WriteResponse

WriteResponse to the client

type UpdateShipmentDestinationAddressNotFound

type UpdateShipmentDestinationAddressNotFound struct {

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

UpdateShipmentDestinationAddressNotFound The requested resource wasn't found.

swagger:response updateShipmentDestinationAddressNotFound

func NewUpdateShipmentDestinationAddressNotFound

func NewUpdateShipmentDestinationAddressNotFound() *UpdateShipmentDestinationAddressNotFound

NewUpdateShipmentDestinationAddressNotFound creates UpdateShipmentDestinationAddressNotFound with default headers values

func (*UpdateShipmentDestinationAddressNotFound) SetPayload

SetPayload sets the payload to the update shipment destination address not found response

func (*UpdateShipmentDestinationAddressNotFound) WithPayload

WithPayload adds the payload to the update shipment destination address not found response

func (*UpdateShipmentDestinationAddressNotFound) WriteResponse

WriteResponse to the client

type UpdateShipmentDestinationAddressParams

type UpdateShipmentDestinationAddressParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*Needs to be the eTag of the mtoShipment. 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 *primemessages.UpdateShipmentDestinationAddress
	/*UUID of the shipment associated with the address
	  Required: true
	  In: path
	*/
	MtoShipmentID strfmt.UUID
}

UpdateShipmentDestinationAddressParams contains all the bound params for the update shipment destination address operation typically these are obtained from a http.Request

swagger:parameters updateShipmentDestinationAddress

func NewUpdateShipmentDestinationAddressParams

func NewUpdateShipmentDestinationAddressParams() UpdateShipmentDestinationAddressParams

NewUpdateShipmentDestinationAddressParams creates a new UpdateShipmentDestinationAddressParams object

There are no default values defined in the spec.

func (*UpdateShipmentDestinationAddressParams) 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 NewUpdateShipmentDestinationAddressParams() beforehand.

type UpdateShipmentDestinationAddressPreconditionFailed

type UpdateShipmentDestinationAddressPreconditionFailed struct {

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

UpdateShipmentDestinationAddressPreconditionFailed Precondition failed, likely due to a stale eTag (If-Match). Fetch the request again to get the updated eTag value.

swagger:response updateShipmentDestinationAddressPreconditionFailed

func NewUpdateShipmentDestinationAddressPreconditionFailed

func NewUpdateShipmentDestinationAddressPreconditionFailed() *UpdateShipmentDestinationAddressPreconditionFailed

NewUpdateShipmentDestinationAddressPreconditionFailed creates UpdateShipmentDestinationAddressPreconditionFailed with default headers values

func (*UpdateShipmentDestinationAddressPreconditionFailed) SetPayload

SetPayload sets the payload to the update shipment destination address precondition failed response

func (*UpdateShipmentDestinationAddressPreconditionFailed) WithPayload

WithPayload adds the payload to the update shipment destination address precondition failed response

func (*UpdateShipmentDestinationAddressPreconditionFailed) WriteResponse

WriteResponse to the client

type UpdateShipmentDestinationAddressURL

type UpdateShipmentDestinationAddressURL struct {
	MtoShipmentID strfmt.UUID
	// contains filtered or unexported fields
}

UpdateShipmentDestinationAddressURL generates an URL for the update shipment destination address operation

func (*UpdateShipmentDestinationAddressURL) Build

Build a url path and query string

func (*UpdateShipmentDestinationAddressURL) BuildFull

func (o *UpdateShipmentDestinationAddressURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*UpdateShipmentDestinationAddressURL) Must

Must is a helper function to panic when the url builder returns an error

func (*UpdateShipmentDestinationAddressURL) SetBasePath

func (o *UpdateShipmentDestinationAddressURL) 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 (*UpdateShipmentDestinationAddressURL) String

String returns the string representation of the path with query string

func (*UpdateShipmentDestinationAddressURL) StringFull

func (o *UpdateShipmentDestinationAddressURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*UpdateShipmentDestinationAddressURL) 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 UpdateShipmentDestinationAddressUnauthorized

type UpdateShipmentDestinationAddressUnauthorized struct {

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

UpdateShipmentDestinationAddressUnauthorized The request was denied.

swagger:response updateShipmentDestinationAddressUnauthorized

func NewUpdateShipmentDestinationAddressUnauthorized

func NewUpdateShipmentDestinationAddressUnauthorized() *UpdateShipmentDestinationAddressUnauthorized

NewUpdateShipmentDestinationAddressUnauthorized creates UpdateShipmentDestinationAddressUnauthorized with default headers values

func (*UpdateShipmentDestinationAddressUnauthorized) SetPayload

SetPayload sets the payload to the update shipment destination address unauthorized response

func (*UpdateShipmentDestinationAddressUnauthorized) WithPayload

WithPayload adds the payload to the update shipment destination address unauthorized response

func (*UpdateShipmentDestinationAddressUnauthorized) WriteResponse

WriteResponse to the client

type UpdateShipmentDestinationAddressUnprocessableEntity

type UpdateShipmentDestinationAddressUnprocessableEntity struct {

	/*
	  In: Body
	*/
	Payload *primemessages.ValidationError `json:"body,omitempty"`
}

UpdateShipmentDestinationAddressUnprocessableEntity The request was unprocessable, likely due to bad input from the requester.

swagger:response updateShipmentDestinationAddressUnprocessableEntity

func NewUpdateShipmentDestinationAddressUnprocessableEntity

func NewUpdateShipmentDestinationAddressUnprocessableEntity() *UpdateShipmentDestinationAddressUnprocessableEntity

NewUpdateShipmentDestinationAddressUnprocessableEntity creates UpdateShipmentDestinationAddressUnprocessableEntity with default headers values

func (*UpdateShipmentDestinationAddressUnprocessableEntity) SetPayload

SetPayload sets the payload to the update shipment destination address unprocessable entity response

func (*UpdateShipmentDestinationAddressUnprocessableEntity) WithPayload

WithPayload adds the payload to the update shipment destination address unprocessable entity response

func (*UpdateShipmentDestinationAddressUnprocessableEntity) WriteResponse

WriteResponse to the client

Jump to

Keyboard shortcuts

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