mto_shipment

package
v0.0.0-...-c486877 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 18, 2024 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

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

Client for mto shipment API

func (*Client) CreateMTOShipment 

func (a *Client) CreateMTOShipment(params *CreateMTOShipmentParams, opts ...ClientOption) (*CreateMTOShipmentOK, error)
CreateMTOShipment creates m t o shipment

Creates a new shipment within the specified move. This endpoint should be used whenever the movers identify a

need for an additional shipment. The new shipment will be submitted to the TOO for review, and the TOO must approve it before the contractor can proceed with billing.

**NOTE**: When creating a child shipment diversion, you can no longer specify the `primeActualWeight`. If you create a new diverted shipment with the `diversion` and `divertedFromShipmentId` parameter, it will automatically inherit the primeActualWeight of its `divertedFromShipmentId` parent. Payment requests created on a diverted shipment "chain" will utilize the lowest weight possible in the chain to prevent overcharging as they are still separate shipments.

**WIP**: The Prime should be notified by a push notification whenever the TOO approves a shipment connected to one of their moves. Otherwise, the Prime can fetch the related move using the [getMoveTaskOrder](#operation/getMoveTaskOrder) endpoint and see if this shipment has the status `"APPROVED"`.

func (*Client) SetTransport 

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

func (*Client) UpdateMTOShipment 

func (a *Client) UpdateMTOShipment(params *UpdateMTOShipmentParams, opts ...ClientOption) (*UpdateMTOShipmentOK, error)
UpdateMTOShipment updates m t o shipment

Updates an existing shipment for a move.

Note that there are some restrictions on nested objects:

* Service items: You cannot add or update service items using this endpoint. Please use [createMTOServiceItem](#operation/createMTOServiceItem) and [updateMTOServiceItem](#operation/updateMTOServiceItem) instead. * Agents: You cannot add or update agents using this endpoint. Please use [createMTOAgent](#operation/createMTOAgent) and [updateMTOAgent](#operation/updateMTOAgent) instead. * Addresses: You can add new addresses using this endpoint (and must use this endpoint to do so), but you cannot update existing ones. Please use [updateMTOShipmentAddress](#operation/updateMTOShipmentAddress) instead.

These restrictions are due to our [optimistic locking/concurrency control](https://transcom.github.io/mymove-docs/docs/dev/contributing/backend/use-optimistic-locking) mechanism.

Note that some fields cannot be manually changed but will still be updated automatically, such as `primeEstimatedWeightRecordedDate` and `requiredDeliveryDate`.

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService 

type ClientService interface {
	CreateMTOShipment(params *CreateMTOShipmentParams, opts ...ClientOption) (*CreateMTOShipmentOK, error)

	UpdateMTOShipment(params *UpdateMTOShipmentParams, opts ...ClientOption) (*UpdateMTOShipmentOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New 

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new mto shipment API client.

type CreateMTOShipmentBadRequest 

type CreateMTOShipmentBadRequest struct {
	Payload *primev3messages.ClientError
}

CreateMTOShipmentBadRequest describes a response with status code 400, with default header values.

The request payload is invalid.

func NewCreateMTOShipmentBadRequest 

func NewCreateMTOShipmentBadRequest() *CreateMTOShipmentBadRequest

NewCreateMTOShipmentBadRequest creates a CreateMTOShipmentBadRequest with default headers values

func (*CreateMTOShipmentBadRequest) Code 

func (o *CreateMTOShipmentBadRequest) Code() int

Code gets the status code for the create m t o shipment bad request response

func (*CreateMTOShipmentBadRequest) Error 

func (o *CreateMTOShipmentBadRequest) Error() string

func (*CreateMTOShipmentBadRequest) GetPayload 

func (o *CreateMTOShipmentBadRequest) GetPayload() *primev3messages.ClientError

func (*CreateMTOShipmentBadRequest) IsClientError 

func (o *CreateMTOShipmentBadRequest) IsClientError() bool

IsClientError returns true when this create m t o shipment bad request response has a 4xx status code

func (*CreateMTOShipmentBadRequest) IsCode 

func (o *CreateMTOShipmentBadRequest) IsCode(code int) bool

IsCode returns true when this create m t o shipment bad request response a status code equal to that given

func (*CreateMTOShipmentBadRequest) IsRedirect 

func (o *CreateMTOShipmentBadRequest) IsRedirect() bool

IsRedirect returns true when this create m t o shipment bad request response has a 3xx status code

func (*CreateMTOShipmentBadRequest) IsServerError 

func (o *CreateMTOShipmentBadRequest) IsServerError() bool

IsServerError returns true when this create m t o shipment bad request response has a 5xx status code

func (*CreateMTOShipmentBadRequest) IsSuccess 

func (o *CreateMTOShipmentBadRequest) IsSuccess() bool

IsSuccess returns true when this create m t o shipment bad request response has a 2xx status code

func (*CreateMTOShipmentBadRequest) String 

func (o *CreateMTOShipmentBadRequest) String() string

type CreateMTOShipmentInternalServerError 

type CreateMTOShipmentInternalServerError struct {
	Payload *primev3messages.Error
}

CreateMTOShipmentInternalServerError describes a response with status code 500, with default header values.

A server error occurred.

func NewCreateMTOShipmentInternalServerError 

func NewCreateMTOShipmentInternalServerError() *CreateMTOShipmentInternalServerError

NewCreateMTOShipmentInternalServerError creates a CreateMTOShipmentInternalServerError with default headers values

func (*CreateMTOShipmentInternalServerError) Code 

func (o *CreateMTOShipmentInternalServerError) Code() int

Code gets the status code for the create m t o shipment internal server error response

func (*CreateMTOShipmentInternalServerError) Error 

func (o *CreateMTOShipmentInternalServerError) Error() string

func (*CreateMTOShipmentInternalServerError) GetPayload 

func (o *CreateMTOShipmentInternalServerError) GetPayload() *primev3messages.Error

func (*CreateMTOShipmentInternalServerError) IsClientError 

func (o *CreateMTOShipmentInternalServerError) IsClientError() bool

IsClientError returns true when this create m t o shipment internal server error response has a 4xx status code

func (*CreateMTOShipmentInternalServerError) IsCode 

func (o *CreateMTOShipmentInternalServerError) IsCode(code int) bool

IsCode returns true when this create m t o shipment internal server error response a status code equal to that given

func (*CreateMTOShipmentInternalServerError) IsRedirect 

func (o *CreateMTOShipmentInternalServerError) IsRedirect() bool

IsRedirect returns true when this create m t o shipment internal server error response has a 3xx status code

func (*CreateMTOShipmentInternalServerError) IsServerError 

func (o *CreateMTOShipmentInternalServerError) IsServerError() bool

IsServerError returns true when this create m t o shipment internal server error response has a 5xx status code

func (*CreateMTOShipmentInternalServerError) IsSuccess 

func (o *CreateMTOShipmentInternalServerError) IsSuccess() bool

IsSuccess returns true when this create m t o shipment internal server error response has a 2xx status code

func (*CreateMTOShipmentInternalServerError) String 

func (o *CreateMTOShipmentInternalServerError) String() string

type CreateMTOShipmentNotFound 

type CreateMTOShipmentNotFound struct {
	Payload *primev3messages.ClientError
}

CreateMTOShipmentNotFound describes a response with status code 404, with default header values.

The requested resource wasn't found.

func NewCreateMTOShipmentNotFound 

func NewCreateMTOShipmentNotFound() *CreateMTOShipmentNotFound

NewCreateMTOShipmentNotFound creates a CreateMTOShipmentNotFound with default headers values

func (*CreateMTOShipmentNotFound) Code 

func (o *CreateMTOShipmentNotFound) Code() int

Code gets the status code for the create m t o shipment not found response

func (*CreateMTOShipmentNotFound) Error 

func (o *CreateMTOShipmentNotFound) Error() string

func (*CreateMTOShipmentNotFound) GetPayload 

func (o *CreateMTOShipmentNotFound) GetPayload() *primev3messages.ClientError

func (*CreateMTOShipmentNotFound) IsClientError 

func (o *CreateMTOShipmentNotFound) IsClientError() bool

IsClientError returns true when this create m t o shipment not found response has a 4xx status code

func (*CreateMTOShipmentNotFound) IsCode 

func (o *CreateMTOShipmentNotFound) IsCode(code int) bool

IsCode returns true when this create m t o shipment not found response a status code equal to that given

func (*CreateMTOShipmentNotFound) IsRedirect 

func (o *CreateMTOShipmentNotFound) IsRedirect() bool

IsRedirect returns true when this create m t o shipment not found response has a 3xx status code

func (*CreateMTOShipmentNotFound) IsServerError 

func (o *CreateMTOShipmentNotFound) IsServerError() bool

IsServerError returns true when this create m t o shipment not found response has a 5xx status code

func (*CreateMTOShipmentNotFound) IsSuccess 

func (o *CreateMTOShipmentNotFound) IsSuccess() bool

IsSuccess returns true when this create m t o shipment not found response has a 2xx status code

func (*CreateMTOShipmentNotFound) String 

func (o *CreateMTOShipmentNotFound) String() string

type CreateMTOShipmentOK 

type CreateMTOShipmentOK struct {
	Payload *primev3messages.MTOShipment
}

CreateMTOShipmentOK describes a response with status code 200, with default header values.

Successfully created a MTO shipment.

func NewCreateMTOShipmentOK 

func NewCreateMTOShipmentOK() *CreateMTOShipmentOK

NewCreateMTOShipmentOK creates a CreateMTOShipmentOK with default headers values

func (*CreateMTOShipmentOK) Code 

func (o *CreateMTOShipmentOK) Code() int

Code gets the status code for the create m t o shipment o k response

func (*CreateMTOShipmentOK) Error 

func (o *CreateMTOShipmentOK) Error() string

func (*CreateMTOShipmentOK) GetPayload 

func (o *CreateMTOShipmentOK) GetPayload() *primev3messages.MTOShipment

func (*CreateMTOShipmentOK) IsClientError 

func (o *CreateMTOShipmentOK) IsClientError() bool

IsClientError returns true when this create m t o shipment o k response has a 4xx status code

func (*CreateMTOShipmentOK) IsCode 

func (o *CreateMTOShipmentOK) IsCode(code int) bool

IsCode returns true when this create m t o shipment o k response a status code equal to that given

func (*CreateMTOShipmentOK) IsRedirect 

func (o *CreateMTOShipmentOK) IsRedirect() bool

IsRedirect returns true when this create m t o shipment o k response has a 3xx status code

func (*CreateMTOShipmentOK) IsServerError 

func (o *CreateMTOShipmentOK) IsServerError() bool

IsServerError returns true when this create m t o shipment o k response has a 5xx status code

func (*CreateMTOShipmentOK) IsSuccess 

func (o *CreateMTOShipmentOK) IsSuccess() bool

IsSuccess returns true when this create m t o shipment o k response has a 2xx status code

func (*CreateMTOShipmentOK) String 

func (o *CreateMTOShipmentOK) String() string

type CreateMTOShipmentParams 

type CreateMTOShipmentParams struct {

	// Body.
	Body *primev3messages.CreateMTOShipment

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

CreateMTOShipmentParams contains all the parameters to send to the API endpoint 

for the create m t o shipment operation.

Typically these are written to a http.Request.

func NewCreateMTOShipmentParams 

func NewCreateMTOShipmentParams() *CreateMTOShipmentParams

NewCreateMTOShipmentParams creates a new CreateMTOShipmentParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewCreateMTOShipmentParamsWithContext 

func NewCreateMTOShipmentParamsWithContext(ctx context.Context) *CreateMTOShipmentParams

NewCreateMTOShipmentParamsWithContext creates a new CreateMTOShipmentParams object with the ability to set a context for a request.

func NewCreateMTOShipmentParamsWithHTTPClient 

func NewCreateMTOShipmentParamsWithHTTPClient(client *http.Client) *CreateMTOShipmentParams

NewCreateMTOShipmentParamsWithHTTPClient creates a new CreateMTOShipmentParams object with the ability to set a custom HTTPClient for a request.

func NewCreateMTOShipmentParamsWithTimeout 

func NewCreateMTOShipmentParamsWithTimeout(timeout time.Duration) *CreateMTOShipmentParams

NewCreateMTOShipmentParamsWithTimeout creates a new CreateMTOShipmentParams object with the ability to set a timeout on a request.

func (*CreateMTOShipmentParams) SetBody 

func (o *CreateMTOShipmentParams) SetBody(body *primev3messages.CreateMTOShipment)

SetBody adds the body to the create m t o shipment params

func (*CreateMTOShipmentParams) SetContext 

func (o *CreateMTOShipmentParams) SetContext(ctx context.Context)

SetContext adds the context to the create m t o shipment params

func (*CreateMTOShipmentParams) SetDefaults 

func (o *CreateMTOShipmentParams) SetDefaults()

SetDefaults hydrates default values in the create m t o shipment params (not the query body).

All values with no default are reset to their zero value.

func (*CreateMTOShipmentParams) SetHTTPClient 

func (o *CreateMTOShipmentParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the create m t o shipment params

func (*CreateMTOShipmentParams) SetTimeout 

func (o *CreateMTOShipmentParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the create m t o shipment params

func (*CreateMTOShipmentParams) WithBody 

func (o *CreateMTOShipmentParams) WithBody(body *primev3messages.CreateMTOShipment) *CreateMTOShipmentParams

WithBody adds the body to the create m t o shipment params

func (*CreateMTOShipmentParams) WithContext 

func (o *CreateMTOShipmentParams) WithContext(ctx context.Context) *CreateMTOShipmentParams

WithContext adds the context to the create m t o shipment params

func (*CreateMTOShipmentParams) WithDefaults 

func (o *CreateMTOShipmentParams) WithDefaults() *CreateMTOShipmentParams

WithDefaults hydrates default values in the create m t o shipment params (not the query body).

All values with no default are reset to their zero value.

func (*CreateMTOShipmentParams) WithHTTPClient 

func (o *CreateMTOShipmentParams) WithHTTPClient(client *http.Client) *CreateMTOShipmentParams

WithHTTPClient adds the HTTPClient to the create m t o shipment params

func (*CreateMTOShipmentParams) WithTimeout 

func (o *CreateMTOShipmentParams) WithTimeout(timeout time.Duration) *CreateMTOShipmentParams

WithTimeout adds the timeout to the create m t o shipment params

func (*CreateMTOShipmentParams) WriteToRequest 

func (o *CreateMTOShipmentParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type CreateMTOShipmentReader 

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

CreateMTOShipmentReader is a Reader for the CreateMTOShipment structure.

func (*CreateMTOShipmentReader) ReadResponse 

func (o *CreateMTOShipmentReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type CreateMTOShipmentUnprocessableEntity 

type CreateMTOShipmentUnprocessableEntity struct {
	Payload *primev3messages.ValidationError
}

CreateMTOShipmentUnprocessableEntity describes a response with status code 422, with default header values.

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

func NewCreateMTOShipmentUnprocessableEntity 

func NewCreateMTOShipmentUnprocessableEntity() *CreateMTOShipmentUnprocessableEntity

NewCreateMTOShipmentUnprocessableEntity creates a CreateMTOShipmentUnprocessableEntity with default headers values

func (*CreateMTOShipmentUnprocessableEntity) Code 

func (o *CreateMTOShipmentUnprocessableEntity) Code() int

Code gets the status code for the create m t o shipment unprocessable entity response

func (*CreateMTOShipmentUnprocessableEntity) Error 

func (o *CreateMTOShipmentUnprocessableEntity) Error() string

func (*CreateMTOShipmentUnprocessableEntity) GetPayload 

func (o *CreateMTOShipmentUnprocessableEntity) GetPayload() *primev3messages.ValidationError

func (*CreateMTOShipmentUnprocessableEntity) IsClientError 

func (o *CreateMTOShipmentUnprocessableEntity) IsClientError() bool

IsClientError returns true when this create m t o shipment unprocessable entity response has a 4xx status code

func (*CreateMTOShipmentUnprocessableEntity) IsCode 

func (o *CreateMTOShipmentUnprocessableEntity) IsCode(code int) bool

IsCode returns true when this create m t o shipment unprocessable entity response a status code equal to that given

func (*CreateMTOShipmentUnprocessableEntity) IsRedirect 

func (o *CreateMTOShipmentUnprocessableEntity) IsRedirect() bool

IsRedirect returns true when this create m t o shipment unprocessable entity response has a 3xx status code

func (*CreateMTOShipmentUnprocessableEntity) IsServerError 

func (o *CreateMTOShipmentUnprocessableEntity) IsServerError() bool

IsServerError returns true when this create m t o shipment unprocessable entity response has a 5xx status code

func (*CreateMTOShipmentUnprocessableEntity) IsSuccess 

func (o *CreateMTOShipmentUnprocessableEntity) IsSuccess() bool

IsSuccess returns true when this create m t o shipment unprocessable entity response has a 2xx status code

func (*CreateMTOShipmentUnprocessableEntity) String 

func (o *CreateMTOShipmentUnprocessableEntity) String() string

type UpdateMTOShipmentBadRequest 

type UpdateMTOShipmentBadRequest struct {
	Payload *primev3messages.ClientError
}

UpdateMTOShipmentBadRequest describes a response with status code 400, with default header values.

The request payload is invalid.

func NewUpdateMTOShipmentBadRequest 

func NewUpdateMTOShipmentBadRequest() *UpdateMTOShipmentBadRequest

NewUpdateMTOShipmentBadRequest creates a UpdateMTOShipmentBadRequest with default headers values

func (*UpdateMTOShipmentBadRequest) Code 

func (o *UpdateMTOShipmentBadRequest) Code() int

Code gets the status code for the update m t o shipment bad request response

func (*UpdateMTOShipmentBadRequest) Error 

func (o *UpdateMTOShipmentBadRequest) Error() string

func (*UpdateMTOShipmentBadRequest) GetPayload 

func (o *UpdateMTOShipmentBadRequest) GetPayload() *primev3messages.ClientError

func (*UpdateMTOShipmentBadRequest) IsClientError 

func (o *UpdateMTOShipmentBadRequest) IsClientError() bool

IsClientError returns true when this update m t o shipment bad request response has a 4xx status code

func (*UpdateMTOShipmentBadRequest) IsCode 

func (o *UpdateMTOShipmentBadRequest) IsCode(code int) bool

IsCode returns true when this update m t o shipment bad request response a status code equal to that given

func (*UpdateMTOShipmentBadRequest) IsRedirect 

func (o *UpdateMTOShipmentBadRequest) IsRedirect() bool

IsRedirect returns true when this update m t o shipment bad request response has a 3xx status code

func (*UpdateMTOShipmentBadRequest) IsServerError 

func (o *UpdateMTOShipmentBadRequest) IsServerError() bool

IsServerError returns true when this update m t o shipment bad request response has a 5xx status code

func (*UpdateMTOShipmentBadRequest) IsSuccess 

func (o *UpdateMTOShipmentBadRequest) IsSuccess() bool

IsSuccess returns true when this update m t o shipment bad request response has a 2xx status code

func (*UpdateMTOShipmentBadRequest) String 

func (o *UpdateMTOShipmentBadRequest) String() string

type UpdateMTOShipmentForbidden 

type UpdateMTOShipmentForbidden struct {
	Payload *primev3messages.ClientError
}

UpdateMTOShipmentForbidden describes a response with status code 403, with default header values.

The request was denied.

func NewUpdateMTOShipmentForbidden 

func NewUpdateMTOShipmentForbidden() *UpdateMTOShipmentForbidden

NewUpdateMTOShipmentForbidden creates a UpdateMTOShipmentForbidden with default headers values

func (*UpdateMTOShipmentForbidden) Code 

func (o *UpdateMTOShipmentForbidden) Code() int

Code gets the status code for the update m t o shipment forbidden response

func (*UpdateMTOShipmentForbidden) Error 

func (o *UpdateMTOShipmentForbidden) Error() string

func (*UpdateMTOShipmentForbidden) GetPayload 

func (o *UpdateMTOShipmentForbidden) GetPayload() *primev3messages.ClientError

func (*UpdateMTOShipmentForbidden) IsClientError 

func (o *UpdateMTOShipmentForbidden) IsClientError() bool

IsClientError returns true when this update m t o shipment forbidden response has a 4xx status code

func (*UpdateMTOShipmentForbidden) IsCode 

func (o *UpdateMTOShipmentForbidden) IsCode(code int) bool

IsCode returns true when this update m t o shipment forbidden response a status code equal to that given

func (*UpdateMTOShipmentForbidden) IsRedirect 

func (o *UpdateMTOShipmentForbidden) IsRedirect() bool

IsRedirect returns true when this update m t o shipment forbidden response has a 3xx status code

func (*UpdateMTOShipmentForbidden) IsServerError 

func (o *UpdateMTOShipmentForbidden) IsServerError() bool

IsServerError returns true when this update m t o shipment forbidden response has a 5xx status code

func (*UpdateMTOShipmentForbidden) IsSuccess 

func (o *UpdateMTOShipmentForbidden) IsSuccess() bool

IsSuccess returns true when this update m t o shipment forbidden response has a 2xx status code

func (*UpdateMTOShipmentForbidden) String 

func (o *UpdateMTOShipmentForbidden) String() string

type UpdateMTOShipmentInternalServerError 

type UpdateMTOShipmentInternalServerError struct {
	Payload *primev3messages.Error
}

UpdateMTOShipmentInternalServerError describes a response with status code 500, with default header values.

A server error occurred.

func NewUpdateMTOShipmentInternalServerError 

func NewUpdateMTOShipmentInternalServerError() *UpdateMTOShipmentInternalServerError

NewUpdateMTOShipmentInternalServerError creates a UpdateMTOShipmentInternalServerError with default headers values

func (*UpdateMTOShipmentInternalServerError) Code 

func (o *UpdateMTOShipmentInternalServerError) Code() int

Code gets the status code for the update m t o shipment internal server error response

func (*UpdateMTOShipmentInternalServerError) Error 

func (o *UpdateMTOShipmentInternalServerError) Error() string

func (*UpdateMTOShipmentInternalServerError) GetPayload 

func (o *UpdateMTOShipmentInternalServerError) GetPayload() *primev3messages.Error

func (*UpdateMTOShipmentInternalServerError) IsClientError 

func (o *UpdateMTOShipmentInternalServerError) IsClientError() bool

IsClientError returns true when this update m t o shipment internal server error response has a 4xx status code

func (*UpdateMTOShipmentInternalServerError) IsCode 

func (o *UpdateMTOShipmentInternalServerError) IsCode(code int) bool

IsCode returns true when this update m t o shipment internal server error response a status code equal to that given

func (*UpdateMTOShipmentInternalServerError) IsRedirect 

func (o *UpdateMTOShipmentInternalServerError) IsRedirect() bool

IsRedirect returns true when this update m t o shipment internal server error response has a 3xx status code

func (*UpdateMTOShipmentInternalServerError) IsServerError 

func (o *UpdateMTOShipmentInternalServerError) IsServerError() bool

IsServerError returns true when this update m t o shipment internal server error response has a 5xx status code

func (*UpdateMTOShipmentInternalServerError) IsSuccess 

func (o *UpdateMTOShipmentInternalServerError) IsSuccess() bool

IsSuccess returns true when this update m t o shipment internal server error response has a 2xx status code

func (*UpdateMTOShipmentInternalServerError) String 

func (o *UpdateMTOShipmentInternalServerError) String() string

type UpdateMTOShipmentNotFound 

type UpdateMTOShipmentNotFound struct {
	Payload *primev3messages.ClientError
}

UpdateMTOShipmentNotFound describes a response with status code 404, with default header values.

The requested resource wasn't found.

func NewUpdateMTOShipmentNotFound 

func NewUpdateMTOShipmentNotFound() *UpdateMTOShipmentNotFound

NewUpdateMTOShipmentNotFound creates a UpdateMTOShipmentNotFound with default headers values

func (*UpdateMTOShipmentNotFound) Code 

func (o *UpdateMTOShipmentNotFound) Code() int

Code gets the status code for the update m t o shipment not found response

func (*UpdateMTOShipmentNotFound) Error 

func (o *UpdateMTOShipmentNotFound) Error() string

func (*UpdateMTOShipmentNotFound) GetPayload 

func (o *UpdateMTOShipmentNotFound) GetPayload() *primev3messages.ClientError

func (*UpdateMTOShipmentNotFound) IsClientError 

func (o *UpdateMTOShipmentNotFound) IsClientError() bool

IsClientError returns true when this update m t o shipment not found response has a 4xx status code

func (*UpdateMTOShipmentNotFound) IsCode 

func (o *UpdateMTOShipmentNotFound) IsCode(code int) bool

IsCode returns true when this update m t o shipment not found response a status code equal to that given

func (*UpdateMTOShipmentNotFound) IsRedirect 

func (o *UpdateMTOShipmentNotFound) IsRedirect() bool

IsRedirect returns true when this update m t o shipment not found response has a 3xx status code

func (*UpdateMTOShipmentNotFound) IsServerError 

func (o *UpdateMTOShipmentNotFound) IsServerError() bool

IsServerError returns true when this update m t o shipment not found response has a 5xx status code

func (*UpdateMTOShipmentNotFound) IsSuccess 

func (o *UpdateMTOShipmentNotFound) IsSuccess() bool

IsSuccess returns true when this update m t o shipment not found response has a 2xx status code

func (*UpdateMTOShipmentNotFound) String 

func (o *UpdateMTOShipmentNotFound) String() string

type UpdateMTOShipmentOK 

type UpdateMTOShipmentOK struct {
	Payload *primev3messages.MTOShipment
}

UpdateMTOShipmentOK describes a response with status code 200, with default header values.

Successfully updated the MTO shipment.

func NewUpdateMTOShipmentOK 

func NewUpdateMTOShipmentOK() *UpdateMTOShipmentOK

NewUpdateMTOShipmentOK creates a UpdateMTOShipmentOK with default headers values

func (*UpdateMTOShipmentOK) Code 

func (o *UpdateMTOShipmentOK) Code() int

Code gets the status code for the update m t o shipment o k response

func (*UpdateMTOShipmentOK) Error 

func (o *UpdateMTOShipmentOK) Error() string

func (*UpdateMTOShipmentOK) GetPayload 

func (o *UpdateMTOShipmentOK) GetPayload() *primev3messages.MTOShipment

func (*UpdateMTOShipmentOK) IsClientError 

func (o *UpdateMTOShipmentOK) IsClientError() bool

IsClientError returns true when this update m t o shipment o k response has a 4xx status code

func (*UpdateMTOShipmentOK) IsCode 

func (o *UpdateMTOShipmentOK) IsCode(code int) bool

IsCode returns true when this update m t o shipment o k response a status code equal to that given

func (*UpdateMTOShipmentOK) IsRedirect 

func (o *UpdateMTOShipmentOK) IsRedirect() bool

IsRedirect returns true when this update m t o shipment o k response has a 3xx status code

func (*UpdateMTOShipmentOK) IsServerError 

func (o *UpdateMTOShipmentOK) IsServerError() bool

IsServerError returns true when this update m t o shipment o k response has a 5xx status code

func (*UpdateMTOShipmentOK) IsSuccess 

func (o *UpdateMTOShipmentOK) IsSuccess() bool

IsSuccess returns true when this update m t o shipment o k response has a 2xx status code

func (*UpdateMTOShipmentOK) String 

func (o *UpdateMTOShipmentOK) String() string

type UpdateMTOShipmentParams 

type UpdateMTOShipmentParams struct {

	/* IfMatch.

	   Optimistic locking is implemented via the `If-Match` header. If the ETag header does not match the value of the resource on the server, the server rejects the change with a `412 Precondition Failed` error.

	*/
	IfMatch string

	// Body.
	Body *primev3messages.UpdateMTOShipment

	/* MtoShipmentID.

	   UUID of the shipment being updated.

	   Format: uuid
	*/
	MtoShipmentID strfmt.UUID

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

UpdateMTOShipmentParams contains all the parameters to send to the API endpoint 

for the update m t o shipment operation.

Typically these are written to a http.Request.

func NewUpdateMTOShipmentParams 

func NewUpdateMTOShipmentParams() *UpdateMTOShipmentParams

NewUpdateMTOShipmentParams creates a new UpdateMTOShipmentParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewUpdateMTOShipmentParamsWithContext 

func NewUpdateMTOShipmentParamsWithContext(ctx context.Context) *UpdateMTOShipmentParams

NewUpdateMTOShipmentParamsWithContext creates a new UpdateMTOShipmentParams object with the ability to set a context for a request.

func NewUpdateMTOShipmentParamsWithHTTPClient 

func NewUpdateMTOShipmentParamsWithHTTPClient(client *http.Client) *UpdateMTOShipmentParams

NewUpdateMTOShipmentParamsWithHTTPClient creates a new UpdateMTOShipmentParams object with the ability to set a custom HTTPClient for a request.

func NewUpdateMTOShipmentParamsWithTimeout 

func NewUpdateMTOShipmentParamsWithTimeout(timeout time.Duration) *UpdateMTOShipmentParams

NewUpdateMTOShipmentParamsWithTimeout creates a new UpdateMTOShipmentParams object with the ability to set a timeout on a request.

func (*UpdateMTOShipmentParams) SetBody 

func (o *UpdateMTOShipmentParams) SetBody(body *primev3messages.UpdateMTOShipment)

SetBody adds the body to the update m t o shipment params

func (*UpdateMTOShipmentParams) SetContext 

func (o *UpdateMTOShipmentParams) SetContext(ctx context.Context)

SetContext adds the context to the update m t o shipment params

func (*UpdateMTOShipmentParams) SetDefaults 

func (o *UpdateMTOShipmentParams) SetDefaults()

SetDefaults hydrates default values in the update m t o shipment params (not the query body).

All values with no default are reset to their zero value.

func (*UpdateMTOShipmentParams) SetHTTPClient 

func (o *UpdateMTOShipmentParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the update m t o shipment params

func (*UpdateMTOShipmentParams) SetIfMatch 

func (o *UpdateMTOShipmentParams) SetIfMatch(ifMatch string)

SetIfMatch adds the ifMatch to the update m t o shipment params

func (*UpdateMTOShipmentParams) SetMtoShipmentID 

func (o *UpdateMTOShipmentParams) SetMtoShipmentID(mtoShipmentID strfmt.UUID)

SetMtoShipmentID adds the mtoShipmentId to the update m t o shipment params

func (*UpdateMTOShipmentParams) SetTimeout 

func (o *UpdateMTOShipmentParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the update m t o shipment params

func (*UpdateMTOShipmentParams) WithBody 

func (o *UpdateMTOShipmentParams) WithBody(body *primev3messages.UpdateMTOShipment) *UpdateMTOShipmentParams

WithBody adds the body to the update m t o shipment params

func (*UpdateMTOShipmentParams) WithContext 

func (o *UpdateMTOShipmentParams) WithContext(ctx context.Context) *UpdateMTOShipmentParams

WithContext adds the context to the update m t o shipment params

func (*UpdateMTOShipmentParams) WithDefaults 

func (o *UpdateMTOShipmentParams) WithDefaults() *UpdateMTOShipmentParams

WithDefaults hydrates default values in the update m t o shipment params (not the query body).

All values with no default are reset to their zero value.

func (*UpdateMTOShipmentParams) WithHTTPClient 

func (o *UpdateMTOShipmentParams) WithHTTPClient(client *http.Client) *UpdateMTOShipmentParams

WithHTTPClient adds the HTTPClient to the update m t o shipment params

func (*UpdateMTOShipmentParams) WithIfMatch 

func (o *UpdateMTOShipmentParams) WithIfMatch(ifMatch string) *UpdateMTOShipmentParams

WithIfMatch adds the ifMatch to the update m t o shipment params

func (*UpdateMTOShipmentParams) WithMtoShipmentID 

func (o *UpdateMTOShipmentParams) WithMtoShipmentID(mtoShipmentID strfmt.UUID) *UpdateMTOShipmentParams

WithMtoShipmentID adds the mtoShipmentID to the update m t o shipment params

func (*UpdateMTOShipmentParams) WithTimeout 

func (o *UpdateMTOShipmentParams) WithTimeout(timeout time.Duration) *UpdateMTOShipmentParams

WithTimeout adds the timeout to the update m t o shipment params

func (*UpdateMTOShipmentParams) WriteToRequest 

func (o *UpdateMTOShipmentParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type UpdateMTOShipmentPreconditionFailed 

type UpdateMTOShipmentPreconditionFailed struct {
	Payload *primev3messages.ClientError
}

UpdateMTOShipmentPreconditionFailed describes a response with status code 412, with default header values.

Precondition failed, likely due to a stale eTag (If-Match). Fetch the request again to get the updated eTag value.

func NewUpdateMTOShipmentPreconditionFailed 

func NewUpdateMTOShipmentPreconditionFailed() *UpdateMTOShipmentPreconditionFailed

NewUpdateMTOShipmentPreconditionFailed creates a UpdateMTOShipmentPreconditionFailed with default headers values

func (*UpdateMTOShipmentPreconditionFailed) Code 

func (o *UpdateMTOShipmentPreconditionFailed) Code() int

Code gets the status code for the update m t o shipment precondition failed response

func (*UpdateMTOShipmentPreconditionFailed) Error 

func (o *UpdateMTOShipmentPreconditionFailed) Error() string

func (*UpdateMTOShipmentPreconditionFailed) GetPayload 

func (o *UpdateMTOShipmentPreconditionFailed) GetPayload() *primev3messages.ClientError

func (*UpdateMTOShipmentPreconditionFailed) IsClientError 

func (o *UpdateMTOShipmentPreconditionFailed) IsClientError() bool

IsClientError returns true when this update m t o shipment precondition failed response has a 4xx status code

func (*UpdateMTOShipmentPreconditionFailed) IsCode 

func (o *UpdateMTOShipmentPreconditionFailed) IsCode(code int) bool

IsCode returns true when this update m t o shipment precondition failed response a status code equal to that given

func (*UpdateMTOShipmentPreconditionFailed) IsRedirect 

func (o *UpdateMTOShipmentPreconditionFailed) IsRedirect() bool

IsRedirect returns true when this update m t o shipment precondition failed response has a 3xx status code

func (*UpdateMTOShipmentPreconditionFailed) IsServerError 

func (o *UpdateMTOShipmentPreconditionFailed) IsServerError() bool

IsServerError returns true when this update m t o shipment precondition failed response has a 5xx status code

func (*UpdateMTOShipmentPreconditionFailed) IsSuccess 

func (o *UpdateMTOShipmentPreconditionFailed) IsSuccess() bool

IsSuccess returns true when this update m t o shipment precondition failed response has a 2xx status code

func (*UpdateMTOShipmentPreconditionFailed) String 

func (o *UpdateMTOShipmentPreconditionFailed) String() string

type UpdateMTOShipmentReader 

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

UpdateMTOShipmentReader is a Reader for the UpdateMTOShipment structure.

func (*UpdateMTOShipmentReader) ReadResponse 

func (o *UpdateMTOShipmentReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type UpdateMTOShipmentUnauthorized 

type UpdateMTOShipmentUnauthorized struct {
	Payload *primev3messages.ClientError
}

UpdateMTOShipmentUnauthorized describes a response with status code 401, with default header values.

The request was denied.

func NewUpdateMTOShipmentUnauthorized 

func NewUpdateMTOShipmentUnauthorized() *UpdateMTOShipmentUnauthorized

NewUpdateMTOShipmentUnauthorized creates a UpdateMTOShipmentUnauthorized with default headers values

func (*UpdateMTOShipmentUnauthorized) Code 

func (o *UpdateMTOShipmentUnauthorized) Code() int

Code gets the status code for the update m t o shipment unauthorized response

func (*UpdateMTOShipmentUnauthorized) Error 

func (o *UpdateMTOShipmentUnauthorized) Error() string

func (*UpdateMTOShipmentUnauthorized) GetPayload 

func (o *UpdateMTOShipmentUnauthorized) GetPayload() *primev3messages.ClientError

func (*UpdateMTOShipmentUnauthorized) IsClientError 

func (o *UpdateMTOShipmentUnauthorized) IsClientError() bool

IsClientError returns true when this update m t o shipment unauthorized response has a 4xx status code

func (*UpdateMTOShipmentUnauthorized) IsCode 

func (o *UpdateMTOShipmentUnauthorized) IsCode(code int) bool

IsCode returns true when this update m t o shipment unauthorized response a status code equal to that given

func (*UpdateMTOShipmentUnauthorized) IsRedirect 

func (o *UpdateMTOShipmentUnauthorized) IsRedirect() bool

IsRedirect returns true when this update m t o shipment unauthorized response has a 3xx status code

func (*UpdateMTOShipmentUnauthorized) IsServerError 

func (o *UpdateMTOShipmentUnauthorized) IsServerError() bool

IsServerError returns true when this update m t o shipment unauthorized response has a 5xx status code

func (*UpdateMTOShipmentUnauthorized) IsSuccess 

func (o *UpdateMTOShipmentUnauthorized) IsSuccess() bool

IsSuccess returns true when this update m t o shipment unauthorized response has a 2xx status code

func (*UpdateMTOShipmentUnauthorized) String 

func (o *UpdateMTOShipmentUnauthorized) String() string

type UpdateMTOShipmentUnprocessableEntity 

type UpdateMTOShipmentUnprocessableEntity struct {
	Payload *primev3messages.ValidationError
}

UpdateMTOShipmentUnprocessableEntity describes a response with status code 422, with default header values.

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

func NewUpdateMTOShipmentUnprocessableEntity 

func NewUpdateMTOShipmentUnprocessableEntity() *UpdateMTOShipmentUnprocessableEntity

NewUpdateMTOShipmentUnprocessableEntity creates a UpdateMTOShipmentUnprocessableEntity with default headers values

func (*UpdateMTOShipmentUnprocessableEntity) Code 

func (o *UpdateMTOShipmentUnprocessableEntity) Code() int

Code gets the status code for the update m t o shipment unprocessable entity response

func (*UpdateMTOShipmentUnprocessableEntity) Error 

func (o *UpdateMTOShipmentUnprocessableEntity) Error() string

func (*UpdateMTOShipmentUnprocessableEntity) GetPayload 

func (o *UpdateMTOShipmentUnprocessableEntity) GetPayload() *primev3messages.ValidationError

func (*UpdateMTOShipmentUnprocessableEntity) IsClientError 

func (o *UpdateMTOShipmentUnprocessableEntity) IsClientError() bool

IsClientError returns true when this update m t o shipment unprocessable entity response has a 4xx status code

func (*UpdateMTOShipmentUnprocessableEntity) IsCode 

func (o *UpdateMTOShipmentUnprocessableEntity) IsCode(code int) bool

IsCode returns true when this update m t o shipment unprocessable entity response a status code equal to that given

func (*UpdateMTOShipmentUnprocessableEntity) IsRedirect 

func (o *UpdateMTOShipmentUnprocessableEntity) IsRedirect() bool

IsRedirect returns true when this update m t o shipment unprocessable entity response has a 3xx status code

func (*UpdateMTOShipmentUnprocessableEntity) IsServerError 

func (o *UpdateMTOShipmentUnprocessableEntity) IsServerError() bool

IsServerError returns true when this update m t o shipment unprocessable entity response has a 5xx status code

func (*UpdateMTOShipmentUnprocessableEntity) IsSuccess 

func (o *UpdateMTOShipmentUnprocessableEntity) IsSuccess() bool

IsSuccess returns true when this update m t o shipment unprocessable entity response has a 2xx status code

func (*UpdateMTOShipmentUnprocessableEntity) String 

func (o *UpdateMTOShipmentUnprocessableEntity) String() string

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.