sit_address_update

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

Documentation

Index

Constants

View Source 
const CreateSITAddressUpdateRequestBadRequestCode int = 400

CreateSITAddressUpdateRequestBadRequestCode is the HTTP code returned for type CreateSITAddressUpdateRequestBadRequest

View Source 
const CreateSITAddressUpdateRequestConflictCode int = 409

CreateSITAddressUpdateRequestConflictCode is the HTTP code returned for type CreateSITAddressUpdateRequestConflict

View Source 
const CreateSITAddressUpdateRequestCreatedCode int = 201

CreateSITAddressUpdateRequestCreatedCode is the HTTP code returned for type CreateSITAddressUpdateRequestCreated

View Source 
const CreateSITAddressUpdateRequestForbiddenCode int = 403

CreateSITAddressUpdateRequestForbiddenCode is the HTTP code returned for type CreateSITAddressUpdateRequestForbidden

View Source 
const CreateSITAddressUpdateRequestInternalServerErrorCode int = 500

CreateSITAddressUpdateRequestInternalServerErrorCode is the HTTP code returned for type CreateSITAddressUpdateRequestInternalServerError

View Source 
const CreateSITAddressUpdateRequestNotFoundCode int = 404

CreateSITAddressUpdateRequestNotFoundCode is the HTTP code returned for type CreateSITAddressUpdateRequestNotFound

View Source 
const CreateSITAddressUpdateRequestUnauthorizedCode int = 401

CreateSITAddressUpdateRequestUnauthorizedCode is the HTTP code returned for type CreateSITAddressUpdateRequestUnauthorized

View Source 
const CreateSITAddressUpdateRequestUnprocessableEntityCode int = 422

CreateSITAddressUpdateRequestUnprocessableEntityCode is the HTTP code returned for type CreateSITAddressUpdateRequestUnprocessableEntity

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateSITAddressUpdateRequest 

type CreateSITAddressUpdateRequest struct {
	Context *middleware.Context
	Handler CreateSITAddressUpdateRequestHandler
}
CreateSITAddressUpdateRequest swagger:route POST /sit-address-updates sitAddressUpdate createSITAddressUpdateRequest

createSITAddressUpdateRequest

**Functionality:** Creates an update request for a SIT service item's final delivery address. A newly created update request is assigned the status 'REQUESTED' if the change in address is > 50 miles and automatically approved otherwise.

**Limitations:** The update can be requested for APPROVED SIT service items only. Only ONE request is allowed per approved SIT service item.

**DEPRECATION ON AUGUST 5TH, 2024** Following deprecation, when updating a service item's final delivery address, you will need to update the shipment's destination address. This will update the destination SIT service items' final delivery address upon approval. For `APPROVED` shipments, you can use [updateShipmentDestinationAddress](#mtoShipment/updateShipmentDestinationAddress) For shipments in any other status, you can use [updateMTOShipmentAddress](#mtoShipment/updateMTOShipmentAddress)

func NewCreateSITAddressUpdateRequest 

func NewCreateSITAddressUpdateRequest(ctx *middleware.Context, handler CreateSITAddressUpdateRequestHandler) *CreateSITAddressUpdateRequest

NewCreateSITAddressUpdateRequest creates a new http.Handler for the create s i t address update request operation

func (*CreateSITAddressUpdateRequest) ServeHTTP 

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

type CreateSITAddressUpdateRequestBadRequest 

type CreateSITAddressUpdateRequestBadRequest struct {

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

CreateSITAddressUpdateRequestBadRequest The request payload is invalid.

swagger:response createSITAddressUpdateRequestBadRequest

func NewCreateSITAddressUpdateRequestBadRequest 

func NewCreateSITAddressUpdateRequestBadRequest() *CreateSITAddressUpdateRequestBadRequest

NewCreateSITAddressUpdateRequestBadRequest creates CreateSITAddressUpdateRequestBadRequest with default headers values

func (*CreateSITAddressUpdateRequestBadRequest) SetPayload 

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

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

func (*CreateSITAddressUpdateRequestBadRequest) WithPayload 

func (o *CreateSITAddressUpdateRequestBadRequest) WithPayload(payload *primemessages.ClientError) *CreateSITAddressUpdateRequestBadRequest

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

func (*CreateSITAddressUpdateRequestBadRequest) WriteResponse 

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

WriteResponse to the client

type CreateSITAddressUpdateRequestConflict 

type CreateSITAddressUpdateRequestConflict struct {

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

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

swagger:response createSITAddressUpdateRequestConflict

func NewCreateSITAddressUpdateRequestConflict 

func NewCreateSITAddressUpdateRequestConflict() *CreateSITAddressUpdateRequestConflict

NewCreateSITAddressUpdateRequestConflict creates CreateSITAddressUpdateRequestConflict with default headers values

func (*CreateSITAddressUpdateRequestConflict) SetPayload 

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

SetPayload sets the payload to the create s i t address update request conflict response

func (*CreateSITAddressUpdateRequestConflict) WithPayload 

func (o *CreateSITAddressUpdateRequestConflict) WithPayload(payload *primemessages.ClientError) *CreateSITAddressUpdateRequestConflict

WithPayload adds the payload to the create s i t address update request conflict response

func (*CreateSITAddressUpdateRequestConflict) WriteResponse 

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

WriteResponse to the client

type CreateSITAddressUpdateRequestCreated 

type CreateSITAddressUpdateRequestCreated struct {

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

CreateSITAddressUpdateRequestCreated Succesfully created a SIT address update request.

swagger:response createSITAddressUpdateRequestCreated

func NewCreateSITAddressUpdateRequestCreated 

func NewCreateSITAddressUpdateRequestCreated() *CreateSITAddressUpdateRequestCreated

NewCreateSITAddressUpdateRequestCreated creates CreateSITAddressUpdateRequestCreated with default headers values

func (*CreateSITAddressUpdateRequestCreated) SetPayload 

func (o *CreateSITAddressUpdateRequestCreated) SetPayload(payload *primemessages.SitAddressUpdate)

SetPayload sets the payload to the create s i t address update request created response

func (*CreateSITAddressUpdateRequestCreated) WithPayload 

func (o *CreateSITAddressUpdateRequestCreated) WithPayload(payload *primemessages.SitAddressUpdate) *CreateSITAddressUpdateRequestCreated

WithPayload adds the payload to the create s i t address update request created response

func (*CreateSITAddressUpdateRequestCreated) WriteResponse 

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

WriteResponse to the client

type CreateSITAddressUpdateRequestForbidden 

type CreateSITAddressUpdateRequestForbidden struct {

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

CreateSITAddressUpdateRequestForbidden The request was denied.

swagger:response createSITAddressUpdateRequestForbidden

func NewCreateSITAddressUpdateRequestForbidden 

func NewCreateSITAddressUpdateRequestForbidden() *CreateSITAddressUpdateRequestForbidden

NewCreateSITAddressUpdateRequestForbidden creates CreateSITAddressUpdateRequestForbidden with default headers values

func (*CreateSITAddressUpdateRequestForbidden) SetPayload 

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

SetPayload sets the payload to the create s i t address update request forbidden response

func (*CreateSITAddressUpdateRequestForbidden) WithPayload 

func (o *CreateSITAddressUpdateRequestForbidden) WithPayload(payload *primemessages.ClientError) *CreateSITAddressUpdateRequestForbidden

WithPayload adds the payload to the create s i t address update request forbidden response

func (*CreateSITAddressUpdateRequestForbidden) WriteResponse 

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

WriteResponse to the client

type CreateSITAddressUpdateRequestHandler 

type CreateSITAddressUpdateRequestHandler interface {
	Handle(CreateSITAddressUpdateRequestParams) middleware.Responder
}

CreateSITAddressUpdateRequestHandler interface for that can handle valid create s i t address update request params

type CreateSITAddressUpdateRequestHandlerFunc 

type CreateSITAddressUpdateRequestHandlerFunc func(CreateSITAddressUpdateRequestParams) middleware.Responder

CreateSITAddressUpdateRequestHandlerFunc turns a function with the right signature into a create s i t address update request handler

func (CreateSITAddressUpdateRequestHandlerFunc) Handle 

func (fn CreateSITAddressUpdateRequestHandlerFunc) Handle(params CreateSITAddressUpdateRequestParams) middleware.Responder

Handle executing the request and returning a response

type CreateSITAddressUpdateRequestInternalServerError 

type CreateSITAddressUpdateRequestInternalServerError struct {

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

CreateSITAddressUpdateRequestInternalServerError A server error occurred.

swagger:response createSITAddressUpdateRequestInternalServerError

func NewCreateSITAddressUpdateRequestInternalServerError 

func NewCreateSITAddressUpdateRequestInternalServerError() *CreateSITAddressUpdateRequestInternalServerError

NewCreateSITAddressUpdateRequestInternalServerError creates CreateSITAddressUpdateRequestInternalServerError with default headers values

func (*CreateSITAddressUpdateRequestInternalServerError) SetPayload 

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

SetPayload sets the payload to the create s i t address update request internal server error response

func (*CreateSITAddressUpdateRequestInternalServerError) WithPayload 

func (o *CreateSITAddressUpdateRequestInternalServerError) WithPayload(payload *primemessages.Error) *CreateSITAddressUpdateRequestInternalServerError

WithPayload adds the payload to the create s i t address update request internal server error response

func (*CreateSITAddressUpdateRequestInternalServerError) WriteResponse 

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

WriteResponse to the client

type CreateSITAddressUpdateRequestNotFound 

type CreateSITAddressUpdateRequestNotFound struct {

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

CreateSITAddressUpdateRequestNotFound The requested resource wasn't found.

swagger:response createSITAddressUpdateRequestNotFound

func NewCreateSITAddressUpdateRequestNotFound 

func NewCreateSITAddressUpdateRequestNotFound() *CreateSITAddressUpdateRequestNotFound

NewCreateSITAddressUpdateRequestNotFound creates CreateSITAddressUpdateRequestNotFound with default headers values

func (*CreateSITAddressUpdateRequestNotFound) SetPayload 

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

SetPayload sets the payload to the create s i t address update request not found response

func (*CreateSITAddressUpdateRequestNotFound) WithPayload 

func (o *CreateSITAddressUpdateRequestNotFound) WithPayload(payload *primemessages.ClientError) *CreateSITAddressUpdateRequestNotFound

WithPayload adds the payload to the create s i t address update request not found response

func (*CreateSITAddressUpdateRequestNotFound) WriteResponse 

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

WriteResponse to the client

type CreateSITAddressUpdateRequestParams 

type CreateSITAddressUpdateRequestParams struct {

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

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

CreateSITAddressUpdateRequestParams contains all the bound params for the create s i t address update request operation typically these are obtained from a http.Request

swagger:parameters createSITAddressUpdateRequest

func NewCreateSITAddressUpdateRequestParams 

func NewCreateSITAddressUpdateRequestParams() CreateSITAddressUpdateRequestParams

NewCreateSITAddressUpdateRequestParams creates a new CreateSITAddressUpdateRequestParams object

There are no default values defined in the spec.

func (*CreateSITAddressUpdateRequestParams) BindRequest 

func (o *CreateSITAddressUpdateRequestParams) 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 NewCreateSITAddressUpdateRequestParams() beforehand.

type CreateSITAddressUpdateRequestURL 

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

CreateSITAddressUpdateRequestURL generates an URL for the create s i t address update request operation

func (*CreateSITAddressUpdateRequestURL) Build 

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

Build a url path and query string

func (*CreateSITAddressUpdateRequestURL) BuildFull 

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

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

func (*CreateSITAddressUpdateRequestURL) Must 

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

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

func (*CreateSITAddressUpdateRequestURL) SetBasePath 

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

func (o *CreateSITAddressUpdateRequestURL) String() string

String returns the string representation of the path with query string

func (*CreateSITAddressUpdateRequestURL) StringFull 

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

StringFull returns the string representation of a complete url

func (*CreateSITAddressUpdateRequestURL) WithBasePath 

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

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 CreateSITAddressUpdateRequestUnauthorized 

type CreateSITAddressUpdateRequestUnauthorized struct {

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

CreateSITAddressUpdateRequestUnauthorized The request was denied.

swagger:response createSITAddressUpdateRequestUnauthorized

func NewCreateSITAddressUpdateRequestUnauthorized 

func NewCreateSITAddressUpdateRequestUnauthorized() *CreateSITAddressUpdateRequestUnauthorized

NewCreateSITAddressUpdateRequestUnauthorized creates CreateSITAddressUpdateRequestUnauthorized with default headers values

func (*CreateSITAddressUpdateRequestUnauthorized) SetPayload 

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

SetPayload sets the payload to the create s i t address update request unauthorized response

func (*CreateSITAddressUpdateRequestUnauthorized) WithPayload 

func (o *CreateSITAddressUpdateRequestUnauthorized) WithPayload(payload *primemessages.ClientError) *CreateSITAddressUpdateRequestUnauthorized

WithPayload adds the payload to the create s i t address update request unauthorized response

func (*CreateSITAddressUpdateRequestUnauthorized) WriteResponse 

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

WriteResponse to the client

type CreateSITAddressUpdateRequestUnprocessableEntity 

type CreateSITAddressUpdateRequestUnprocessableEntity struct {

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

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

swagger:response createSITAddressUpdateRequestUnprocessableEntity

func NewCreateSITAddressUpdateRequestUnprocessableEntity 

func NewCreateSITAddressUpdateRequestUnprocessableEntity() *CreateSITAddressUpdateRequestUnprocessableEntity

NewCreateSITAddressUpdateRequestUnprocessableEntity creates CreateSITAddressUpdateRequestUnprocessableEntity with default headers values

func (*CreateSITAddressUpdateRequestUnprocessableEntity) SetPayload 

func (o *CreateSITAddressUpdateRequestUnprocessableEntity) SetPayload(payload *primemessages.ValidationError)

SetPayload sets the payload to the create s i t address update request unprocessable entity response

func (*CreateSITAddressUpdateRequestUnprocessableEntity) WithPayload 

func (o *CreateSITAddressUpdateRequestUnprocessableEntity) WithPayload(payload *primemessages.ValidationError) *CreateSITAddressUpdateRequestUnprocessableEntity

WithPayload adds the payload to the create s i t address update request unprocessable entity response

func (*CreateSITAddressUpdateRequestUnprocessableEntity) WriteResponse 

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

WriteResponse to the client

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.