ghcoperations

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: 31 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type MymoveAPI

type MymoveAPI struct {
	Middleware func(middleware.Builder) http.Handler

	// BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	BasicAuthenticator func(security.UserPassAuthentication) runtime.Authenticator

	// APIKeyAuthenticator generates a runtime.Authenticator from the supplied token auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	APIKeyAuthenticator func(string, string, security.TokenAuthentication) runtime.Authenticator

	// BearerAuthenticator generates a runtime.Authenticator from the supplied bearer token auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	BearerAuthenticator func(string, security.ScopedTokenAuthentication) runtime.Authenticator

	// JSONConsumer registers a consumer for the following mime types:
	//   - application/json
	JSONConsumer runtime.Consumer
	// MultipartformConsumer registers a consumer for the following mime types:
	//   - multipart/form-data
	MultipartformConsumer runtime.Consumer

	// BinProducer registers a producer for the following mime types:
	//   - application/pdf
	BinProducer runtime.Producer
	// JSONProducer registers a producer for the following mime types:
	//   - application/json
	JSONProducer runtime.Producer

	// OrderAcknowledgeExcessWeightRiskHandler sets the operation handler for the acknowledge excess weight risk operation
	OrderAcknowledgeExcessWeightRiskHandler order.AcknowledgeExcessWeightRiskHandler
	// ShipmentApproveSITExtensionHandler sets the operation handler for the approve s i t extension operation
	ShipmentApproveSITExtensionHandler shipment.ApproveSITExtensionHandler
	// ShipmentApproveShipmentHandler sets the operation handler for the approve shipment operation
	ShipmentApproveShipmentHandler shipment.ApproveShipmentHandler
	// ShipmentApproveShipmentDiversionHandler sets the operation handler for the approve shipment diversion operation
	ShipmentApproveShipmentDiversionHandler shipment.ApproveShipmentDiversionHandler
	// ReportViolationsAssociateReportViolationsHandler sets the operation handler for the associate report violations operation
	ReportViolationsAssociateReportViolationsHandler report_violations.AssociateReportViolationsHandler
	// OrderCounselingUpdateAllowanceHandler sets the operation handler for the counseling update allowance operation
	OrderCounselingUpdateAllowanceHandler order.CounselingUpdateAllowanceHandler
	// OrderCounselingUpdateOrderHandler sets the operation handler for the counseling update order operation
	OrderCounselingUpdateOrderHandler order.CounselingUpdateOrderHandler
	// ShipmentCreateApprovedSITDurationUpdateHandler sets the operation handler for the create approved s i t duration update operation
	ShipmentCreateApprovedSITDurationUpdateHandler shipment.CreateApprovedSITDurationUpdateHandler
	// CustomerSupportRemarksCreateCustomerSupportRemarkForMoveHandler sets the operation handler for the create customer support remark for move operation
	CustomerSupportRemarksCreateCustomerSupportRemarkForMoveHandler customer_support_remarks.CreateCustomerSupportRemarkForMoveHandler
	// CustomerCreateCustomerWithOktaOptionHandler sets the operation handler for the create customer with okta option operation
	CustomerCreateCustomerWithOktaOptionHandler customer.CreateCustomerWithOktaOptionHandler
	// EvaluationReportsCreateEvaluationReportHandler sets the operation handler for the create evaluation report operation
	EvaluationReportsCreateEvaluationReportHandler evaluation_reports.CreateEvaluationReportHandler
	// MtoShipmentCreateMTOShipmentHandler sets the operation handler for the create m t o shipment operation
	MtoShipmentCreateMTOShipmentHandler mto_shipment.CreateMTOShipmentHandler
	// OrderCreateOrderHandler sets the operation handler for the create order operation
	OrderCreateOrderHandler order.CreateOrderHandler
	// UploadsCreateUploadHandler sets the operation handler for the create upload operation
	UploadsCreateUploadHandler uploads.CreateUploadHandler
	// CustomerSupportRemarksDeleteCustomerSupportRemarkHandler sets the operation handler for the delete customer support remark operation
	CustomerSupportRemarksDeleteCustomerSupportRemarkHandler customer_support_remarks.DeleteCustomerSupportRemarkHandler
	// EvaluationReportsDeleteEvaluationReportHandler sets the operation handler for the delete evaluation report operation
	EvaluationReportsDeleteEvaluationReportHandler evaluation_reports.DeleteEvaluationReportHandler
	// ShipmentDeleteShipmentHandler sets the operation handler for the delete shipment operation
	ShipmentDeleteShipmentHandler shipment.DeleteShipmentHandler
	// ShipmentDenySITExtensionHandler sets the operation handler for the deny s i t extension operation
	ShipmentDenySITExtensionHandler shipment.DenySITExtensionHandler
	// EvaluationReportsDownloadEvaluationReportHandler sets the operation handler for the download evaluation report operation
	EvaluationReportsDownloadEvaluationReportHandler evaluation_reports.DownloadEvaluationReportHandler
	// MtoAgentFetchMTOAgentListHandler sets the operation handler for the fetch m t o agent list operation
	MtoAgentFetchMTOAgentListHandler mto_agent.FetchMTOAgentListHandler
	// PpmFinishDocumentReviewHandler sets the operation handler for the finish document review operation
	PpmFinishDocumentReviewHandler ppm.FinishDocumentReviewHandler
	// CustomerGetCustomerHandler sets the operation handler for the get customer operation
	CustomerGetCustomerHandler customer.GetCustomerHandler
	// CustomerSupportRemarksGetCustomerSupportRemarksForMoveHandler sets the operation handler for the get customer support remarks for move operation
	CustomerSupportRemarksGetCustomerSupportRemarksForMoveHandler customer_support_remarks.GetCustomerSupportRemarksForMoveHandler
	// GhcDocumentsGetDocumentHandler sets the operation handler for the get document operation
	GhcDocumentsGetDocumentHandler ghc_documents.GetDocumentHandler
	// MoveTaskOrderGetEntitlementsHandler sets the operation handler for the get entitlements operation
	MoveTaskOrderGetEntitlementsHandler move_task_order.GetEntitlementsHandler
	// EvaluationReportsGetEvaluationReportHandler sets the operation handler for the get evaluation report operation
	EvaluationReportsGetEvaluationReportHandler evaluation_reports.GetEvaluationReportHandler
	// MtoServiceItemGetMTOServiceItemHandler sets the operation handler for the get m t o service item operation
	MtoServiceItemGetMTOServiceItemHandler mto_service_item.GetMTOServiceItemHandler
	// MoveGetMoveHandler sets the operation handler for the get move operation
	MoveGetMoveHandler move.GetMoveHandler
	// MoveGetMoveCounselingEvaluationReportsListHandler sets the operation handler for the get move counseling evaluation reports list operation
	MoveGetMoveCounselingEvaluationReportsListHandler move.GetMoveCounselingEvaluationReportsListHandler
	// MoveGetMoveHistoryHandler sets the operation handler for the get move history operation
	MoveGetMoveHistoryHandler move.GetMoveHistoryHandler
	// MoveGetMoveShipmentEvaluationReportsListHandler sets the operation handler for the get move shipment evaluation reports list operation
	MoveGetMoveShipmentEvaluationReportsListHandler move.GetMoveShipmentEvaluationReportsListHandler
	// MoveTaskOrderGetMoveTaskOrderHandler sets the operation handler for the get move task order operation
	MoveTaskOrderGetMoveTaskOrderHandler move_task_order.GetMoveTaskOrderHandler
	// QueuesGetMovesQueueHandler sets the operation handler for the get moves queue operation
	QueuesGetMovesQueueHandler queues.GetMovesQueueHandler
	// OrderGetOrderHandler sets the operation handler for the get order operation
	OrderGetOrderHandler order.GetOrderHandler
	// PpmGetPPMActualWeightHandler sets the operation handler for the get p p m actual weight operation
	PpmGetPPMActualWeightHandler ppm.GetPPMActualWeightHandler
	// PpmGetPPMCloseoutHandler sets the operation handler for the get p p m closeout operation
	PpmGetPPMCloseoutHandler ppm.GetPPMCloseoutHandler
	// PpmGetPPMDocumentsHandler sets the operation handler for the get p p m documents operation
	PpmGetPPMDocumentsHandler ppm.GetPPMDocumentsHandler
	// PwsViolationsGetPWSViolationsHandler sets the operation handler for the get p w s violations operation
	PwsViolationsGetPWSViolationsHandler pws_violations.GetPWSViolationsHandler
	// PaymentRequestsGetPaymentRequestHandler sets the operation handler for the get payment request operation
	PaymentRequestsGetPaymentRequestHandler payment_requests.GetPaymentRequestHandler
	// PaymentRequestsGetPaymentRequestsForMoveHandler sets the operation handler for the get payment requests for move operation
	PaymentRequestsGetPaymentRequestsForMoveHandler payment_requests.GetPaymentRequestsForMoveHandler
	// QueuesGetPaymentRequestsQueueHandler sets the operation handler for the get payment requests queue operation
	QueuesGetPaymentRequestsQueueHandler queues.GetPaymentRequestsQueueHandler
	// ReportViolationsGetReportViolationsByReportIDHandler sets the operation handler for the get report violations by report ID operation
	ReportViolationsGetReportViolationsByReportIDHandler report_violations.GetReportViolationsByReportIDHandler
	// QueuesGetServicesCounselingQueueHandler sets the operation handler for the get services counseling queue operation
	QueuesGetServicesCounselingQueueHandler queues.GetServicesCounselingQueueHandler
	// MtoShipmentGetShipmentHandler sets the operation handler for the get shipment operation
	MtoShipmentGetShipmentHandler mto_shipment.GetShipmentHandler
	// PaymentRequestsGetShipmentsPaymentSITBalanceHandler sets the operation handler for the get shipments payment s i t balance operation
	PaymentRequestsGetShipmentsPaymentSITBalanceHandler payment_requests.GetShipmentsPaymentSITBalanceHandler
	// TransportationOfficeGetTransportationOfficesHandler sets the operation handler for the get transportation offices operation
	TransportationOfficeGetTransportationOfficesHandler transportation_office.GetTransportationOfficesHandler
	// TransportationOfficeGetTransportationOfficesOpenHandler sets the operation handler for the get transportation offices open operation
	TransportationOfficeGetTransportationOfficesOpenHandler transportation_office.GetTransportationOfficesOpenHandler
	// MtoServiceItemListMTOServiceItemsHandler sets the operation handler for the list m t o service items operation
	MtoServiceItemListMTOServiceItemsHandler mto_service_item.ListMTOServiceItemsHandler
	// MtoShipmentListMTOShipmentsHandler sets the operation handler for the list m t o shipments operation
	MtoShipmentListMTOShipmentsHandler mto_shipment.ListMTOShipmentsHandler
	// QueuesListPrimeMovesHandler sets the operation handler for the list prime moves operation
	QueuesListPrimeMovesHandler queues.ListPrimeMovesHandler
	// ShipmentRejectShipmentHandler sets the operation handler for the reject shipment operation
	ShipmentRejectShipmentHandler shipment.RejectShipmentHandler
	// ShipmentRequestShipmentCancellationHandler sets the operation handler for the request shipment cancellation operation
	ShipmentRequestShipmentCancellationHandler shipment.RequestShipmentCancellationHandler
	// ShipmentRequestShipmentDiversionHandler sets the operation handler for the request shipment diversion operation
	ShipmentRequestShipmentDiversionHandler shipment.RequestShipmentDiversionHandler
	// ShipmentRequestShipmentReweighHandler sets the operation handler for the request shipment reweigh operation
	ShipmentRequestShipmentReweighHandler shipment.RequestShipmentReweighHandler
	// ShipmentReviewShipmentAddressUpdateHandler sets the operation handler for the review shipment address update operation
	ShipmentReviewShipmentAddressUpdateHandler shipment.ReviewShipmentAddressUpdateHandler
	// EvaluationReportsSaveEvaluationReportHandler sets the operation handler for the save evaluation report operation
	EvaluationReportsSaveEvaluationReportHandler evaluation_reports.SaveEvaluationReportHandler
	// MoveSearchMovesHandler sets the operation handler for the search moves operation
	MoveSearchMovesHandler move.SearchMovesHandler
	// MoveSetFinancialReviewFlagHandler sets the operation handler for the set financial review flag operation
	MoveSetFinancialReviewFlagHandler move.SetFinancialReviewFlagHandler
	// PpmShowAOAPacketHandler sets the operation handler for the show a o a packet operation
	PpmShowAOAPacketHandler ppm.ShowAOAPacketHandler
	// PpmShowPaymentPacketHandler sets the operation handler for the show payment packet operation
	PpmShowPaymentPacketHandler ppm.ShowPaymentPacketHandler
	// EvaluationReportsSubmitEvaluationReportHandler sets the operation handler for the submit evaluation report operation
	EvaluationReportsSubmitEvaluationReportHandler evaluation_reports.SubmitEvaluationReportHandler
	// TacTacValidationHandler sets the operation handler for the tac validation operation
	TacTacValidationHandler tac.TacValidationHandler
	// OrderUpdateAllowanceHandler sets the operation handler for the update allowance operation
	OrderUpdateAllowanceHandler order.UpdateAllowanceHandler
	// OrderUpdateBillableWeightHandler sets the operation handler for the update billable weight operation
	OrderUpdateBillableWeightHandler order.UpdateBillableWeightHandler
	// MoveUpdateCloseoutOfficeHandler sets the operation handler for the update closeout office operation
	MoveUpdateCloseoutOfficeHandler move.UpdateCloseoutOfficeHandler
	// CustomerUpdateCustomerHandler sets the operation handler for the update customer operation
	CustomerUpdateCustomerHandler customer.UpdateCustomerHandler
	// CustomerSupportRemarksUpdateCustomerSupportRemarkForMoveHandler sets the operation handler for the update customer support remark for move operation
	CustomerSupportRemarksUpdateCustomerSupportRemarkForMoveHandler customer_support_remarks.UpdateCustomerSupportRemarkForMoveHandler
	// MoveTaskOrderUpdateMTOReviewedBillableWeightsAtHandler sets the operation handler for the update m t o reviewed billable weights at operation
	MoveTaskOrderUpdateMTOReviewedBillableWeightsAtHandler move_task_order.UpdateMTOReviewedBillableWeightsAtHandler
	// MtoServiceItemUpdateMTOServiceItemStatusHandler sets the operation handler for the update m t o service item status operation
	MtoServiceItemUpdateMTOServiceItemStatusHandler mto_service_item.UpdateMTOServiceItemStatusHandler
	// MtoShipmentUpdateMTOShipmentHandler sets the operation handler for the update m t o shipment operation
	MtoShipmentUpdateMTOShipmentHandler mto_shipment.UpdateMTOShipmentHandler
	// MoveTaskOrderUpdateMTOStatusServiceCounselingCompletedHandler sets the operation handler for the update m t o status service counseling completed operation
	MoveTaskOrderUpdateMTOStatusServiceCounselingCompletedHandler move_task_order.UpdateMTOStatusServiceCounselingCompletedHandler
	// OrderUpdateMaxBillableWeightAsTIOHandler sets the operation handler for the update max billable weight as t i o operation
	OrderUpdateMaxBillableWeightAsTIOHandler order.UpdateMaxBillableWeightAsTIOHandler
	// MoveTaskOrderUpdateMoveTIORemarksHandler sets the operation handler for the update move t i o remarks operation
	MoveTaskOrderUpdateMoveTIORemarksHandler move_task_order.UpdateMoveTIORemarksHandler
	// MoveTaskOrderUpdateMoveTaskOrderStatusHandler sets the operation handler for the update move task order status operation
	MoveTaskOrderUpdateMoveTaskOrderStatusHandler move_task_order.UpdateMoveTaskOrderStatusHandler
	// PpmUpdateMovingExpenseHandler sets the operation handler for the update moving expense operation
	PpmUpdateMovingExpenseHandler ppm.UpdateMovingExpenseHandler
	// OrderUpdateOrderHandler sets the operation handler for the update order operation
	OrderUpdateOrderHandler order.UpdateOrderHandler
	// PaymentRequestsUpdatePaymentRequestStatusHandler sets the operation handler for the update payment request status operation
	PaymentRequestsUpdatePaymentRequestStatusHandler payment_requests.UpdatePaymentRequestStatusHandler
	// PaymentServiceItemUpdatePaymentServiceItemStatusHandler sets the operation handler for the update payment service item status operation
	PaymentServiceItemUpdatePaymentServiceItemStatusHandler payment_service_item.UpdatePaymentServiceItemStatusHandler
	// PpmUpdateProGearWeightTicketHandler sets the operation handler for the update pro gear weight ticket operation
	PpmUpdateProGearWeightTicketHandler ppm.UpdateProGearWeightTicketHandler
	// ShipmentUpdateSITServiceItemCustomerExpenseHandler sets the operation handler for the update s i t service item customer expense operation
	ShipmentUpdateSITServiceItemCustomerExpenseHandler shipment.UpdateSITServiceItemCustomerExpenseHandler
	// MtoServiceItemUpdateServiceItemSitEntryDateHandler sets the operation handler for the update service item sit entry date operation
	MtoServiceItemUpdateServiceItemSitEntryDateHandler mto_service_item.UpdateServiceItemSitEntryDateHandler
	// PpmUpdateWeightTicketHandler sets the operation handler for the update weight ticket operation
	PpmUpdateWeightTicketHandler ppm.UpdateWeightTicketHandler

	// ServeError is called when an error is received, there is a default handler
	// but you can set your own with this
	ServeError func(http.ResponseWriter, *http.Request, error)

	// PreServerShutdown is called before the HTTP(S) server is shutdown
	// This allows for custom functions to get executed before the HTTP(S) server stops accepting traffic
	PreServerShutdown func()

	// ServerShutdown is called when the HTTP(S) server is shut down and done
	// handling all active connections and does not accept connections any more
	ServerShutdown func()

	// Custom command line argument groups with their descriptions
	CommandLineOptionsGroups []swag.CommandLineOptionsGroup

	// User defined logger function.
	Logger func(string, ...interface{})
	// contains filtered or unexported fields
}

MymoveAPI The GHC API is a RESTful API that enables the Office application for MilMove.

All endpoints are located under `/ghc/v1`.

func NewMymoveAPI

func NewMymoveAPI(spec *loads.Document) *MymoveAPI

NewMymoveAPI creates a new Mymove instance

func (*MymoveAPI) AddMiddlewareFor

func (o *MymoveAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)

AddMiddlewareFor adds a http middleware to existing handler

func (*MymoveAPI) AuthenticatorsFor

func (o *MymoveAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*MymoveAPI) Authorizer

func (o *MymoveAPI) Authorizer() runtime.Authorizer

Authorizer returns the registered authorizer

func (*MymoveAPI) ConsumersFor

func (o *MymoveAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer

ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.

func (*MymoveAPI) Context

func (o *MymoveAPI) Context() *middleware.Context

Context returns the middleware context for the mymove API

func (*MymoveAPI) DefaultConsumes

func (o *MymoveAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*MymoveAPI) DefaultProduces

func (o *MymoveAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*MymoveAPI) Formats

func (o *MymoveAPI) Formats() strfmt.Registry

Formats returns the registered string formats

func (*MymoveAPI) HandlerFor

func (o *MymoveAPI) HandlerFor(method, path string) (http.Handler, bool)

HandlerFor gets a http.Handler for the provided operation method and path

func (*MymoveAPI) Init

func (o *MymoveAPI) Init()

Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit

func (*MymoveAPI) ProducersFor

func (o *MymoveAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer

ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.

func (*MymoveAPI) RegisterConsumer

func (o *MymoveAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)

RegisterConsumer allows you to add (or override) a consumer for a media type.

func (*MymoveAPI) RegisterFormat

func (o *MymoveAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)

RegisterFormat registers a custom format validator

func (*MymoveAPI) RegisterProducer

func (o *MymoveAPI) RegisterProducer(mediaType string, producer runtime.Producer)

RegisterProducer allows you to add (or override) a producer for a media type.

func (*MymoveAPI) Serve

func (o *MymoveAPI) Serve(builder middleware.Builder) http.Handler

Serve creates a http handler to serve the API over HTTP can be used directly in http.ListenAndServe(":8000", api.Serve(nil))

func (*MymoveAPI) ServeErrorFor

func (o *MymoveAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)

ServeErrorFor gets a error handler for a given operation id

func (*MymoveAPI) SetDefaultConsumes

func (o *MymoveAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*MymoveAPI) SetDefaultProduces

func (o *MymoveAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*MymoveAPI) SetSpec

func (o *MymoveAPI) SetSpec(spec *loads.Document)

SetSpec sets a spec that will be served for the clients.

func (*MymoveAPI) UseRedoc

func (o *MymoveAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*MymoveAPI) UseSwaggerUI

func (o *MymoveAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*MymoveAPI) Validate

func (o *MymoveAPI) Validate() error

Validate validates the registrations in the MymoveAPI

Jump to

Keyboard shortcuts

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