package
2.85.0+incompatible
Repository: https://github.com/transcom/mymove.git
Documentation: pkg.go.dev
# Functions
NewCreateGenericMoveDocument creates a new http.Handler for the create generic move document operation.
NewCreateGenericMoveDocumentBadRequest creates CreateGenericMoveDocumentBadRequest with default headers values.
NewCreateGenericMoveDocumentForbidden creates CreateGenericMoveDocumentForbidden with default headers values.
NewCreateGenericMoveDocumentInternalServerError creates CreateGenericMoveDocumentInternalServerError with default headers values.
NewCreateGenericMoveDocumentOK creates CreateGenericMoveDocumentOK with default headers values.
NewCreateGenericMoveDocumentParams creates a new CreateGenericMoveDocumentParams object
There are no default values defined in the spec.
NewCreateGenericMoveDocumentUnauthorized creates CreateGenericMoveDocumentUnauthorized with default headers values.
NewCreateWeightTicketDocument creates a new http.Handler for the create weight ticket document operation.
NewCreateWeightTicketDocumentBadRequest creates CreateWeightTicketDocumentBadRequest with default headers values.
NewCreateWeightTicketDocumentForbidden creates CreateWeightTicketDocumentForbidden with default headers values.
NewCreateWeightTicketDocumentInternalServerError creates CreateWeightTicketDocumentInternalServerError with default headers values.
NewCreateWeightTicketDocumentOK creates CreateWeightTicketDocumentOK with default headers values.
NewCreateWeightTicketDocumentParams creates a new CreateWeightTicketDocumentParams object
There are no default values defined in the spec.
NewCreateWeightTicketDocumentUnauthorized creates CreateWeightTicketDocumentUnauthorized with default headers values.
NewDeleteMoveDocument creates a new http.Handler for the delete move document operation.
NewDeleteMoveDocumentBadRequest creates DeleteMoveDocumentBadRequest with default headers values.
NewDeleteMoveDocumentForbidden creates DeleteMoveDocumentForbidden with default headers values.
NewDeleteMoveDocumentInternalServerError creates DeleteMoveDocumentInternalServerError with default headers values.
NewDeleteMoveDocumentNoContent creates DeleteMoveDocumentNoContent with default headers values.
NewDeleteMoveDocumentNotFound creates DeleteMoveDocumentNotFound with default headers values.
NewDeleteMoveDocumentParams creates a new DeleteMoveDocumentParams object
There are no default values defined in the spec.
NewIndexMoveDocuments creates a new http.Handler for the index move documents operation.
NewIndexMoveDocumentsBadRequest creates IndexMoveDocumentsBadRequest with default headers values.
NewIndexMoveDocumentsForbidden creates IndexMoveDocumentsForbidden with default headers values.
NewIndexMoveDocumentsOK creates IndexMoveDocumentsOK with default headers values.
NewIndexMoveDocumentsParams creates a new IndexMoveDocumentsParams object
There are no default values defined in the spec.
NewIndexMoveDocumentsUnauthorized creates IndexMoveDocumentsUnauthorized with default headers values.
NewUpdateMoveDocument creates a new http.Handler for the update move document operation.
NewUpdateMoveDocumentBadRequest creates UpdateMoveDocumentBadRequest with default headers values.
NewUpdateMoveDocumentForbidden creates UpdateMoveDocumentForbidden with default headers values.
NewUpdateMoveDocumentInternalServerError creates UpdateMoveDocumentInternalServerError with default headers values.
NewUpdateMoveDocumentNotFound creates UpdateMoveDocumentNotFound with default headers values.
NewUpdateMoveDocumentOK creates UpdateMoveDocumentOK with default headers values.
NewUpdateMoveDocumentParams creates a new UpdateMoveDocumentParams object
There are no default values defined in the spec.
NewUpdateMoveDocumentUnauthorized creates UpdateMoveDocumentUnauthorized with default headers values.
# Constants
CreateGenericMoveDocumentBadRequestCode is the HTTP code returned for type CreateGenericMoveDocumentBadRequest.
CreateGenericMoveDocumentForbiddenCode is the HTTP code returned for type CreateGenericMoveDocumentForbidden.
CreateGenericMoveDocumentInternalServerErrorCode is the HTTP code returned for type CreateGenericMoveDocumentInternalServerError.
CreateGenericMoveDocumentOKCode is the HTTP code returned for type CreateGenericMoveDocumentOK.
CreateGenericMoveDocumentUnauthorizedCode is the HTTP code returned for type CreateGenericMoveDocumentUnauthorized.
CreateWeightTicketDocumentBadRequestCode is the HTTP code returned for type CreateWeightTicketDocumentBadRequest.
CreateWeightTicketDocumentForbiddenCode is the HTTP code returned for type CreateWeightTicketDocumentForbidden.
CreateWeightTicketDocumentInternalServerErrorCode is the HTTP code returned for type CreateWeightTicketDocumentInternalServerError.
CreateWeightTicketDocumentOKCode is the HTTP code returned for type CreateWeightTicketDocumentOK.
CreateWeightTicketDocumentUnauthorizedCode is the HTTP code returned for type CreateWeightTicketDocumentUnauthorized.
DeleteMoveDocumentBadRequestCode is the HTTP code returned for type DeleteMoveDocumentBadRequest.
DeleteMoveDocumentForbiddenCode is the HTTP code returned for type DeleteMoveDocumentForbidden.
DeleteMoveDocumentInternalServerErrorCode is the HTTP code returned for type DeleteMoveDocumentInternalServerError.
DeleteMoveDocumentNoContentCode is the HTTP code returned for type DeleteMoveDocumentNoContent.
DeleteMoveDocumentNotFoundCode is the HTTP code returned for type DeleteMoveDocumentNotFound.
IndexMoveDocumentsBadRequestCode is the HTTP code returned for type IndexMoveDocumentsBadRequest.
IndexMoveDocumentsForbiddenCode is the HTTP code returned for type IndexMoveDocumentsForbidden.
IndexMoveDocumentsOKCode is the HTTP code returned for type IndexMoveDocumentsOK.
IndexMoveDocumentsUnauthorizedCode is the HTTP code returned for type IndexMoveDocumentsUnauthorized.
UpdateMoveDocumentBadRequestCode is the HTTP code returned for type UpdateMoveDocumentBadRequest.
UpdateMoveDocumentForbiddenCode is the HTTP code returned for type UpdateMoveDocumentForbidden.
UpdateMoveDocumentInternalServerErrorCode is the HTTP code returned for type UpdateMoveDocumentInternalServerError.
UpdateMoveDocumentNotFoundCode is the HTTP code returned for type UpdateMoveDocumentNotFound.
UpdateMoveDocumentOKCode is the HTTP code returned for type UpdateMoveDocumentOK.
UpdateMoveDocumentUnauthorizedCode is the HTTP code returned for type UpdateMoveDocumentUnauthorized.
# Structs
CreateGenericMoveDocument swagger:route POST /moves/{moveId}/move_documents move_docs createGenericMoveDocument
# Creates a move document
Created a move document with the given information
*/.
CreateGenericMoveDocumentBadRequest invalid request
swagger:response createGenericMoveDocumentBadRequest
*/.
CreateGenericMoveDocumentForbidden not authorized to modify this move
swagger:response createGenericMoveDocumentForbidden
*/.
CreateGenericMoveDocumentInternalServerError server error
swagger:response createGenericMoveDocumentInternalServerError
*/.
CreateGenericMoveDocumentOK returns new move document object
swagger:response createGenericMoveDocumentOK
*/.
CreateGenericMoveDocumentParams contains all the bound params for the create generic move document operation typically these are obtained from a http.Request
swagger:parameters createGenericMoveDocument.
CreateGenericMoveDocumentUnauthorized must be authenticated to use this endpoint
swagger:response createGenericMoveDocumentUnauthorized
*/.
CreateGenericMoveDocumentURL generates an URL for the create generic move document operation.
CreateWeightTicketDocument swagger:route POST /moves/{moveId}/weight_ticket move_docs createWeightTicketDocument
# Creates a weight ticket document
Created a weight ticket document with the given information
*/.
CreateWeightTicketDocumentBadRequest invalid request
swagger:response createWeightTicketDocumentBadRequest
*/.
CreateWeightTicketDocumentForbidden not authorized to modify this move
swagger:response createWeightTicketDocumentForbidden
*/.
CreateWeightTicketDocumentInternalServerError server error
swagger:response createWeightTicketDocumentInternalServerError
*/.
CreateWeightTicketDocumentOK returns new weight ticket document object
swagger:response createWeightTicketDocumentOK
*/.
CreateWeightTicketDocumentParams contains all the bound params for the create weight ticket document operation typically these are obtained from a http.Request
swagger:parameters createWeightTicketDocument.
CreateWeightTicketDocumentUnauthorized must be authenticated to use this endpoint
swagger:response createWeightTicketDocumentUnauthorized
*/.
CreateWeightTicketDocumentURL generates an URL for the create weight ticket document operation.
DeleteMoveDocument swagger:route DELETE /move_documents/{moveDocumentId} move_docs deleteMoveDocument
# Deletes a move document
Deletes a move document with the given information
*/.
DeleteMoveDocumentBadRequest invalid request
swagger:response deleteMoveDocumentBadRequest
*/.
DeleteMoveDocumentForbidden not authorized
swagger:response deleteMoveDocumentForbidden
*/.
DeleteMoveDocumentInternalServerError server error
swagger:response deleteMoveDocumentInternalServerError
*/.
DeleteMoveDocumentNoContent deleted
swagger:response deleteMoveDocumentNoContent
*/.
DeleteMoveDocumentNotFound not found
swagger:response deleteMoveDocumentNotFound
*/.
DeleteMoveDocumentParams contains all the bound params for the delete move document operation typically these are obtained from a http.Request
swagger:parameters deleteMoveDocument.
DeleteMoveDocumentURL generates an URL for the delete move document operation.
IndexMoveDocuments swagger:route GET /moves/{moveId}/move_documents move_docs indexMoveDocuments
# Returns a list of all Move Documents associated with this move
Returns a list of all Move Documents associated with this move
*/.
IndexMoveDocumentsBadRequest invalid request
swagger:response indexMoveDocumentsBadRequest
*/.
IndexMoveDocumentsForbidden user is not authorized
swagger:response indexMoveDocumentsForbidden
*/.
IndexMoveDocumentsOK returns list of move douments
swagger:response indexMoveDocumentsOK
*/.
IndexMoveDocumentsParams contains all the bound params for the index move documents operation typically these are obtained from a http.Request
swagger:parameters indexMoveDocuments.
IndexMoveDocumentsUnauthorized request requires user authentication
swagger:response indexMoveDocumentsUnauthorized
*/.
IndexMoveDocumentsURL generates an URL for the index move documents operation.
UpdateMoveDocument swagger:route PUT /move_documents/{moveDocumentId} move_docs updateMoveDocument
# Updates a move document
Update a move document with the given information
*/.
UpdateMoveDocumentBadRequest invalid request
swagger:response updateMoveDocumentBadRequest
*/.
UpdateMoveDocumentForbidden user is not authorized
swagger:response updateMoveDocumentForbidden
*/.
UpdateMoveDocumentInternalServerError internal server error
swagger:response updateMoveDocumentInternalServerError
*/.
UpdateMoveDocumentNotFound move document not found
swagger:response updateMoveDocumentNotFound
*/.
UpdateMoveDocumentOK updated instance of move document
swagger:response updateMoveDocumentOK
*/.
UpdateMoveDocumentParams contains all the bound params for the update move document operation typically these are obtained from a http.Request
swagger:parameters updateMoveDocument.
UpdateMoveDocumentUnauthorized request requires user authentication
swagger:response updateMoveDocumentUnauthorized
*/.
UpdateMoveDocumentURL generates an URL for the update move document operation.
# Interfaces
CreateGenericMoveDocumentHandler interface for that can handle valid create generic move document params.
CreateWeightTicketDocumentHandler interface for that can handle valid create weight ticket document params.
DeleteMoveDocumentHandler interface for that can handle valid delete move document params.
IndexMoveDocumentsHandler interface for that can handle valid index move documents params.
UpdateMoveDocumentHandler interface for that can handle valid update move document params.
# Type aliases
CreateGenericMoveDocumentHandlerFunc turns a function with the right signature into a create generic move document handler.
CreateWeightTicketDocumentHandlerFunc turns a function with the right signature into a create weight ticket document handler.
DeleteMoveDocumentHandlerFunc turns a function with the right signature into a delete move document handler.
IndexMoveDocumentsHandlerFunc turns a function with the right signature into a index move documents handler.
UpdateMoveDocumentHandlerFunc turns a function with the right signature into a update move document handler.