supportoperations

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: 16 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

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

	// MoveTaskOrderCreateMoveTaskOrderHandler sets the operation handler for the create move task order operation
	MoveTaskOrderCreateMoveTaskOrderHandler move_task_order.CreateMoveTaskOrderHandler
	// WebhookCreateWebhookNotificationHandler sets the operation handler for the create webhook notification operation
	WebhookCreateWebhookNotificationHandler webhook.CreateWebhookNotificationHandler
	// MoveTaskOrderGetMoveTaskOrderHandler sets the operation handler for the get move task order operation
	MoveTaskOrderGetMoveTaskOrderHandler move_task_order.GetMoveTaskOrderHandler
	// PaymentRequestGetPaymentRequestEDIHandler sets the operation handler for the get payment request e d i operation
	PaymentRequestGetPaymentRequestEDIHandler payment_request.GetPaymentRequestEDIHandler
	// MoveTaskOrderHideNonFakeMoveTaskOrdersHandler sets the operation handler for the hide non fake move task orders operation
	MoveTaskOrderHideNonFakeMoveTaskOrdersHandler move_task_order.HideNonFakeMoveTaskOrdersHandler
	// PaymentRequestListMTOPaymentRequestsHandler sets the operation handler for the list m t o payment requests operation
	PaymentRequestListMTOPaymentRequestsHandler payment_request.ListMTOPaymentRequestsHandler
	// MoveTaskOrderListMTOsHandler sets the operation handler for the list m t os operation
	MoveTaskOrderListMTOsHandler move_task_order.ListMTOsHandler
	// MoveTaskOrderMakeMoveTaskOrderAvailableHandler sets the operation handler for the make move task order available operation
	MoveTaskOrderMakeMoveTaskOrderAvailableHandler move_task_order.MakeMoveTaskOrderAvailableHandler
	// PaymentRequestProcessReviewedPaymentRequestsHandler sets the operation handler for the process reviewed payment requests operation
	PaymentRequestProcessReviewedPaymentRequestsHandler payment_request.ProcessReviewedPaymentRequestsHandler
	// PaymentRequestRecalculatePaymentRequestHandler sets the operation handler for the recalculate payment request operation
	PaymentRequestRecalculatePaymentRequestHandler payment_request.RecalculatePaymentRequestHandler
	// WebhookReceiveWebhookNotificationHandler sets the operation handler for the receive webhook notification operation
	WebhookReceiveWebhookNotificationHandler webhook.ReceiveWebhookNotificationHandler
	// MtoServiceItemUpdateMTOServiceItemStatusHandler sets the operation handler for the update m t o service item status operation
	MtoServiceItemUpdateMTOServiceItemStatusHandler mto_service_item.UpdateMTOServiceItemStatusHandler
	// MtoShipmentUpdateMTOShipmentStatusHandler sets the operation handler for the update m t o shipment status operation
	MtoShipmentUpdateMTOShipmentStatusHandler mto_shipment.UpdateMTOShipmentStatusHandler
	// PaymentRequestUpdatePaymentRequestStatusHandler sets the operation handler for the update payment request status operation
	PaymentRequestUpdatePaymentRequestStatusHandler payment_request.UpdatePaymentRequestStatusHandler

	// 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 Support API gives you programmatic access to support functionality useful for testing and debugging. **This API is not available in the Production environment**.

All endpoints are located at `/support/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

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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