package
2.85.0+incompatible
Repository: https://github.com/transcom/mymove.git
Documentation: pkg.go.dev
# Functions
NewCreateMTOShipment creates a new http.Handler for the create m t o shipment operation.
NewCreateMTOShipmentBadRequest creates CreateMTOShipmentBadRequest with default headers values.
NewCreateMTOShipmentForbidden creates CreateMTOShipmentForbidden with default headers values.
NewCreateMTOShipmentInternalServerError creates CreateMTOShipmentInternalServerError with default headers values.
NewCreateMTOShipmentNotFound creates CreateMTOShipmentNotFound with default headers values.
NewCreateMTOShipmentOK creates CreateMTOShipmentOK with default headers values.
NewCreateMTOShipmentParams creates a new CreateMTOShipmentParams object
There are no default values defined in the spec.
NewCreateMTOShipmentUnauthorized creates CreateMTOShipmentUnauthorized with default headers values.
NewCreateMTOShipmentUnprocessableEntity creates CreateMTOShipmentUnprocessableEntity with default headers values.
NewDeleteShipment creates a new http.Handler for the delete shipment operation.
NewDeleteShipmentBadRequest creates DeleteShipmentBadRequest with default headers values.
NewDeleteShipmentConflict creates DeleteShipmentConflict with default headers values.
NewDeleteShipmentForbidden creates DeleteShipmentForbidden with default headers values.
NewDeleteShipmentInternalServerError creates DeleteShipmentInternalServerError with default headers values.
NewDeleteShipmentNoContent creates DeleteShipmentNoContent with default headers values.
NewDeleteShipmentNotFound creates DeleteShipmentNotFound with default headers values.
NewDeleteShipmentParams creates a new DeleteShipmentParams object
There are no default values defined in the spec.
NewDeleteShipmentUnprocessableEntity creates DeleteShipmentUnprocessableEntity with default headers values.
NewListMTOShipments creates a new http.Handler for the list m t o shipments operation.
NewListMTOShipmentsBadRequest creates ListMTOShipmentsBadRequest with default headers values.
NewListMTOShipmentsInternalServerError creates ListMTOShipmentsInternalServerError with default headers values.
NewListMTOShipmentsNotFound creates ListMTOShipmentsNotFound with default headers values.
NewListMTOShipmentsOK creates ListMTOShipmentsOK with default headers values.
NewListMTOShipmentsParams creates a new ListMTOShipmentsParams object
There are no default values defined in the spec.
NewListMTOShipmentsUnauthorized creates ListMTOShipmentsUnauthorized with default headers values.
NewUpdateMTOShipment creates a new http.Handler for the update m t o shipment operation.
NewUpdateMTOShipmentBadRequest creates UpdateMTOShipmentBadRequest with default headers values.
NewUpdateMTOShipmentForbidden creates UpdateMTOShipmentForbidden with default headers values.
NewUpdateMTOShipmentInternalServerError creates UpdateMTOShipmentInternalServerError with default headers values.
NewUpdateMTOShipmentNotFound creates UpdateMTOShipmentNotFound with default headers values.
NewUpdateMTOShipmentOK creates UpdateMTOShipmentOK with default headers values.
NewUpdateMTOShipmentParams creates a new UpdateMTOShipmentParams object
There are no default values defined in the spec.
NewUpdateMTOShipmentPreconditionFailed creates UpdateMTOShipmentPreconditionFailed with default headers values.
NewUpdateMTOShipmentUnauthorized creates UpdateMTOShipmentUnauthorized with default headers values.
NewUpdateMTOShipmentUnprocessableEntity creates UpdateMTOShipmentUnprocessableEntity with default headers values.
# Constants
CreateMTOShipmentBadRequestCode is the HTTP code returned for type CreateMTOShipmentBadRequest.
CreateMTOShipmentForbiddenCode is the HTTP code returned for type CreateMTOShipmentForbidden.
CreateMTOShipmentInternalServerErrorCode is the HTTP code returned for type CreateMTOShipmentInternalServerError.
CreateMTOShipmentNotFoundCode is the HTTP code returned for type CreateMTOShipmentNotFound.
CreateMTOShipmentOKCode is the HTTP code returned for type CreateMTOShipmentOK.
CreateMTOShipmentUnauthorizedCode is the HTTP code returned for type CreateMTOShipmentUnauthorized.
CreateMTOShipmentUnprocessableEntityCode is the HTTP code returned for type CreateMTOShipmentUnprocessableEntity.
DeleteShipmentBadRequestCode is the HTTP code returned for type DeleteShipmentBadRequest.
DeleteShipmentConflictCode is the HTTP code returned for type DeleteShipmentConflict.
DeleteShipmentForbiddenCode is the HTTP code returned for type DeleteShipmentForbidden.
DeleteShipmentInternalServerErrorCode is the HTTP code returned for type DeleteShipmentInternalServerError.
DeleteShipmentNoContentCode is the HTTP code returned for type DeleteShipmentNoContent.
DeleteShipmentNotFoundCode is the HTTP code returned for type DeleteShipmentNotFound.
DeleteShipmentUnprocessableEntityCode is the HTTP code returned for type DeleteShipmentUnprocessableEntity.
ListMTOShipmentsBadRequestCode is the HTTP code returned for type ListMTOShipmentsBadRequest.
ListMTOShipmentsInternalServerErrorCode is the HTTP code returned for type ListMTOShipmentsInternalServerError.
ListMTOShipmentsNotFoundCode is the HTTP code returned for type ListMTOShipmentsNotFound.
ListMTOShipmentsOKCode is the HTTP code returned for type ListMTOShipmentsOK.
ListMTOShipmentsUnauthorizedCode is the HTTP code returned for type ListMTOShipmentsUnauthorized.
UpdateMTOShipmentBadRequestCode is the HTTP code returned for type UpdateMTOShipmentBadRequest.
UpdateMTOShipmentForbiddenCode is the HTTP code returned for type UpdateMTOShipmentForbidden.
UpdateMTOShipmentInternalServerErrorCode is the HTTP code returned for type UpdateMTOShipmentInternalServerError.
UpdateMTOShipmentNotFoundCode is the HTTP code returned for type UpdateMTOShipmentNotFound.
UpdateMTOShipmentOKCode is the HTTP code returned for type UpdateMTOShipmentOK.
UpdateMTOShipmentPreconditionFailedCode is the HTTP code returned for type UpdateMTOShipmentPreconditionFailed.
UpdateMTOShipmentUnauthorizedCode is the HTTP code returned for type UpdateMTOShipmentUnauthorized.
UpdateMTOShipmentUnprocessableEntityCode is the HTTP code returned for type UpdateMTOShipmentUnprocessableEntity.
# Structs
CreateMTOShipment swagger:route POST /mto_shipments mtoShipment createMTOShipment
createMTOShipment
Creates a MTO shipment for the specified Move Task Order.
CreateMTOShipmentBadRequest The request payload is invalid.
CreateMTOShipmentForbidden The request was denied.
CreateMTOShipmentInternalServerError A server error occurred.
CreateMTOShipmentNotFound The requested resource wasn't found.
CreateMTOShipmentOK Successfully created a MTO shipment.
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.
CreateMTOShipmentUnauthorized The request was denied.
CreateMTOShipmentUnprocessableEntity The payload was unprocessable.
CreateMTOShipmentURL generates an URL for the create m t o shipment operation.
DeleteShipment swagger:route DELETE /mto-shipments/{mtoShipmentId} mtoShipment deleteShipment
# Soft deletes a shipment by ID
Soft deletes a shipment by ID
*/.
DeleteShipmentBadRequest The request payload is invalid.
DeleteShipmentConflict The request could not be processed because of conflict in the current state of the resource.
DeleteShipmentForbidden The request was denied.
DeleteShipmentInternalServerError A server error occurred.
DeleteShipmentNoContent Successfully soft deleted the shipment
swagger:response deleteShipmentNoContent
*/.
DeleteShipmentNotFound The requested resource wasn't found.
DeleteShipmentParams contains all the bound params for the delete shipment operation typically these are obtained from a http.Request
swagger:parameters deleteShipment.
DeleteShipmentUnprocessableEntity The payload was unprocessable.
DeleteShipmentURL generates an URL for the delete shipment operation.
ListMTOShipments swagger:route GET /moves/{moveTaskOrderID}/mto_shipments mtoShipment listMTOShipments
# Gets all shipments for a move task order
Gets all MTO shipments for the specified Move Task Order.
ListMTOShipmentsBadRequest The request payload is invalid.
ListMTOShipmentsInternalServerError A server error occurred.
ListMTOShipmentsNotFound The requested resource wasn't found.
ListMTOShipmentsOK Successfully retrieved all mto shipments for a move task order.
ListMTOShipmentsParams contains all the bound params for the list m t o shipments operation typically these are obtained from a http.Request
swagger:parameters listMTOShipments.
ListMTOShipmentsUnauthorized The request was denied.
ListMTOShipmentsURL generates an URL for the list m t o shipments operation.
UpdateMTOShipment swagger:route PATCH /mto-shipments/{mtoShipmentId} mtoShipment updateMTOShipment
updateMTOShipment
Updates a specified MTO shipment.
UpdateMTOShipmentBadRequest The request payload is invalid.
UpdateMTOShipmentForbidden The request was denied.
UpdateMTOShipmentInternalServerError A server error occurred.
UpdateMTOShipmentNotFound The requested resource wasn't found.
UpdateMTOShipmentOK Successfully updated the specified MTO shipment.
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.
UpdateMTOShipmentPreconditionFailed Precondition failed, likely due to a stale eTag (If-Match).
UpdateMTOShipmentUnauthorized The request was denied.
UpdateMTOShipmentUnprocessableEntity The payload was unprocessable.
UpdateMTOShipmentURL generates an URL for the update m t o shipment operation.
# Interfaces
CreateMTOShipmentHandler interface for that can handle valid create m t o shipment params.
DeleteShipmentHandler interface for that can handle valid delete shipment params.
ListMTOShipmentsHandler interface for that can handle valid list m t o shipments params.
UpdateMTOShipmentHandler interface for that can handle valid update m t o shipment params.
# Type aliases
CreateMTOShipmentHandlerFunc turns a function with the right signature into a create m t o shipment handler.
DeleteShipmentHandlerFunc turns a function with the right signature into a delete shipment handler.
ListMTOShipmentsHandlerFunc turns a function with the right signature into a list m t o shipments handler.
UpdateMTOShipmentHandlerFunc turns a function with the right signature into a update m t o shipment handler.