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: 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 sit address update API

func (*Client) CreateSITAddressUpdateRequest

func (a *Client) CreateSITAddressUpdateRequest(params *CreateSITAddressUpdateRequestParams, opts ...ClientOption) (*CreateSITAddressUpdateRequestCreated, error)
CreateSITAddressUpdateRequest creates s i t address update request

**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 (*Client) SetTransport

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

SetTransport changes the transport on the client

type ClientOption

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService

type ClientService interface {
	CreateSITAddressUpdateRequest(params *CreateSITAddressUpdateRequestParams, opts ...ClientOption) (*CreateSITAddressUpdateRequestCreated, 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 sit address update API client.

type CreateSITAddressUpdateRequestBadRequest

type CreateSITAddressUpdateRequestBadRequest struct {
	Payload *primemessages.ClientError
}

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

The request payload is invalid.

func NewCreateSITAddressUpdateRequestBadRequest

func NewCreateSITAddressUpdateRequestBadRequest() *CreateSITAddressUpdateRequestBadRequest

NewCreateSITAddressUpdateRequestBadRequest creates a CreateSITAddressUpdateRequestBadRequest with default headers values

func (*CreateSITAddressUpdateRequestBadRequest) Code

Code gets the status code for the create s i t address update request bad request response

func (*CreateSITAddressUpdateRequestBadRequest) Error

func (*CreateSITAddressUpdateRequestBadRequest) GetPayload

func (*CreateSITAddressUpdateRequestBadRequest) IsClientError

func (o *CreateSITAddressUpdateRequestBadRequest) IsClientError() bool

IsClientError returns true when this create s i t address update request bad request response has a 4xx status code

func (*CreateSITAddressUpdateRequestBadRequest) IsCode

IsCode returns true when this create s i t address update request bad request response a status code equal to that given

func (*CreateSITAddressUpdateRequestBadRequest) IsRedirect

IsRedirect returns true when this create s i t address update request bad request response has a 3xx status code

func (*CreateSITAddressUpdateRequestBadRequest) IsServerError

func (o *CreateSITAddressUpdateRequestBadRequest) IsServerError() bool

IsServerError returns true when this create s i t address update request bad request response has a 5xx status code

func (*CreateSITAddressUpdateRequestBadRequest) IsSuccess

IsSuccess returns true when this create s i t address update request bad request response has a 2xx status code

func (*CreateSITAddressUpdateRequestBadRequest) String

type CreateSITAddressUpdateRequestConflict

type CreateSITAddressUpdateRequestConflict struct {
	Payload *primemessages.ClientError
}

CreateSITAddressUpdateRequestConflict describes a response with status code 409, with default header values.

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

func NewCreateSITAddressUpdateRequestConflict

func NewCreateSITAddressUpdateRequestConflict() *CreateSITAddressUpdateRequestConflict

NewCreateSITAddressUpdateRequestConflict creates a CreateSITAddressUpdateRequestConflict with default headers values

func (*CreateSITAddressUpdateRequestConflict) Code

Code gets the status code for the create s i t address update request conflict response

func (*CreateSITAddressUpdateRequestConflict) Error

func (*CreateSITAddressUpdateRequestConflict) GetPayload

func (*CreateSITAddressUpdateRequestConflict) IsClientError

func (o *CreateSITAddressUpdateRequestConflict) IsClientError() bool

IsClientError returns true when this create s i t address update request conflict response has a 4xx status code

func (*CreateSITAddressUpdateRequestConflict) IsCode

IsCode returns true when this create s i t address update request conflict response a status code equal to that given

func (*CreateSITAddressUpdateRequestConflict) IsRedirect

IsRedirect returns true when this create s i t address update request conflict response has a 3xx status code

func (*CreateSITAddressUpdateRequestConflict) IsServerError

func (o *CreateSITAddressUpdateRequestConflict) IsServerError() bool

IsServerError returns true when this create s i t address update request conflict response has a 5xx status code

func (*CreateSITAddressUpdateRequestConflict) IsSuccess

IsSuccess returns true when this create s i t address update request conflict response has a 2xx status code

func (*CreateSITAddressUpdateRequestConflict) String

type CreateSITAddressUpdateRequestCreated

type CreateSITAddressUpdateRequestCreated struct {
	Payload *primemessages.SitAddressUpdate
}

CreateSITAddressUpdateRequestCreated describes a response with status code 201, with default header values.

Succesfully created a SIT address update request.

func NewCreateSITAddressUpdateRequestCreated

func NewCreateSITAddressUpdateRequestCreated() *CreateSITAddressUpdateRequestCreated

NewCreateSITAddressUpdateRequestCreated creates a CreateSITAddressUpdateRequestCreated with default headers values

func (*CreateSITAddressUpdateRequestCreated) Code

Code gets the status code for the create s i t address update request created response

func (*CreateSITAddressUpdateRequestCreated) Error

func (*CreateSITAddressUpdateRequestCreated) GetPayload

func (*CreateSITAddressUpdateRequestCreated) IsClientError

func (o *CreateSITAddressUpdateRequestCreated) IsClientError() bool

IsClientError returns true when this create s i t address update request created response has a 4xx status code

func (*CreateSITAddressUpdateRequestCreated) IsCode

IsCode returns true when this create s i t address update request created response a status code equal to that given

func (*CreateSITAddressUpdateRequestCreated) IsRedirect

IsRedirect returns true when this create s i t address update request created response has a 3xx status code

func (*CreateSITAddressUpdateRequestCreated) IsServerError

func (o *CreateSITAddressUpdateRequestCreated) IsServerError() bool

IsServerError returns true when this create s i t address update request created response has a 5xx status code

func (*CreateSITAddressUpdateRequestCreated) IsSuccess

IsSuccess returns true when this create s i t address update request created response has a 2xx status code

func (*CreateSITAddressUpdateRequestCreated) String

type CreateSITAddressUpdateRequestForbidden

type CreateSITAddressUpdateRequestForbidden struct {
	Payload *primemessages.ClientError
}

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

The request was denied.

func NewCreateSITAddressUpdateRequestForbidden

func NewCreateSITAddressUpdateRequestForbidden() *CreateSITAddressUpdateRequestForbidden

NewCreateSITAddressUpdateRequestForbidden creates a CreateSITAddressUpdateRequestForbidden with default headers values

func (*CreateSITAddressUpdateRequestForbidden) Code

Code gets the status code for the create s i t address update request forbidden response

func (*CreateSITAddressUpdateRequestForbidden) Error

func (*CreateSITAddressUpdateRequestForbidden) GetPayload

func (*CreateSITAddressUpdateRequestForbidden) IsClientError

func (o *CreateSITAddressUpdateRequestForbidden) IsClientError() bool

IsClientError returns true when this create s i t address update request forbidden response has a 4xx status code

func (*CreateSITAddressUpdateRequestForbidden) IsCode

IsCode returns true when this create s i t address update request forbidden response a status code equal to that given

func (*CreateSITAddressUpdateRequestForbidden) IsRedirect

IsRedirect returns true when this create s i t address update request forbidden response has a 3xx status code

func (*CreateSITAddressUpdateRequestForbidden) IsServerError

func (o *CreateSITAddressUpdateRequestForbidden) IsServerError() bool

IsServerError returns true when this create s i t address update request forbidden response has a 5xx status code

func (*CreateSITAddressUpdateRequestForbidden) IsSuccess

IsSuccess returns true when this create s i t address update request forbidden response has a 2xx status code

func (*CreateSITAddressUpdateRequestForbidden) String

type CreateSITAddressUpdateRequestInternalServerError

type CreateSITAddressUpdateRequestInternalServerError struct {
	Payload *primemessages.Error
}

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

A server error occurred.

func NewCreateSITAddressUpdateRequestInternalServerError

func NewCreateSITAddressUpdateRequestInternalServerError() *CreateSITAddressUpdateRequestInternalServerError

NewCreateSITAddressUpdateRequestInternalServerError creates a CreateSITAddressUpdateRequestInternalServerError with default headers values

func (*CreateSITAddressUpdateRequestInternalServerError) Code

Code gets the status code for the create s i t address update request internal server error response

func (*CreateSITAddressUpdateRequestInternalServerError) Error

func (*CreateSITAddressUpdateRequestInternalServerError) GetPayload

func (*CreateSITAddressUpdateRequestInternalServerError) IsClientError

IsClientError returns true when this create s i t address update request internal server error response has a 4xx status code

func (*CreateSITAddressUpdateRequestInternalServerError) IsCode

IsCode returns true when this create s i t address update request internal server error response a status code equal to that given

func (*CreateSITAddressUpdateRequestInternalServerError) IsRedirect

IsRedirect returns true when this create s i t address update request internal server error response has a 3xx status code

func (*CreateSITAddressUpdateRequestInternalServerError) IsServerError

IsServerError returns true when this create s i t address update request internal server error response has a 5xx status code

func (*CreateSITAddressUpdateRequestInternalServerError) IsSuccess

IsSuccess returns true when this create s i t address update request internal server error response has a 2xx status code

func (*CreateSITAddressUpdateRequestInternalServerError) String

type CreateSITAddressUpdateRequestNotFound

type CreateSITAddressUpdateRequestNotFound struct {
	Payload *primemessages.ClientError
}

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

The requested resource wasn't found.

func NewCreateSITAddressUpdateRequestNotFound

func NewCreateSITAddressUpdateRequestNotFound() *CreateSITAddressUpdateRequestNotFound

NewCreateSITAddressUpdateRequestNotFound creates a CreateSITAddressUpdateRequestNotFound with default headers values

func (*CreateSITAddressUpdateRequestNotFound) Code

Code gets the status code for the create s i t address update request not found response

func (*CreateSITAddressUpdateRequestNotFound) Error

func (*CreateSITAddressUpdateRequestNotFound) GetPayload

func (*CreateSITAddressUpdateRequestNotFound) IsClientError

func (o *CreateSITAddressUpdateRequestNotFound) IsClientError() bool

IsClientError returns true when this create s i t address update request not found response has a 4xx status code

func (*CreateSITAddressUpdateRequestNotFound) IsCode

IsCode returns true when this create s i t address update request not found response a status code equal to that given

func (*CreateSITAddressUpdateRequestNotFound) IsRedirect

IsRedirect returns true when this create s i t address update request not found response has a 3xx status code

func (*CreateSITAddressUpdateRequestNotFound) IsServerError

func (o *CreateSITAddressUpdateRequestNotFound) IsServerError() bool

IsServerError returns true when this create s i t address update request not found response has a 5xx status code

func (*CreateSITAddressUpdateRequestNotFound) IsSuccess

IsSuccess returns true when this create s i t address update request not found response has a 2xx status code

func (*CreateSITAddressUpdateRequestNotFound) String

type CreateSITAddressUpdateRequestParams

type CreateSITAddressUpdateRequestParams struct {

	// Body.
	Body *primemessages.CreateSITAddressUpdateRequest

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

CreateSITAddressUpdateRequestParams contains all the parameters to send to the API endpoint

for the create s i t address update request operation.

Typically these are written to a http.Request.

func NewCreateSITAddressUpdateRequestParams

func NewCreateSITAddressUpdateRequestParams() *CreateSITAddressUpdateRequestParams

NewCreateSITAddressUpdateRequestParams creates a new CreateSITAddressUpdateRequestParams 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 NewCreateSITAddressUpdateRequestParamsWithContext

func NewCreateSITAddressUpdateRequestParamsWithContext(ctx context.Context) *CreateSITAddressUpdateRequestParams

NewCreateSITAddressUpdateRequestParamsWithContext creates a new CreateSITAddressUpdateRequestParams object with the ability to set a context for a request.

func NewCreateSITAddressUpdateRequestParamsWithHTTPClient

func NewCreateSITAddressUpdateRequestParamsWithHTTPClient(client *http.Client) *CreateSITAddressUpdateRequestParams

NewCreateSITAddressUpdateRequestParamsWithHTTPClient creates a new CreateSITAddressUpdateRequestParams object with the ability to set a custom HTTPClient for a request.

func NewCreateSITAddressUpdateRequestParamsWithTimeout

func NewCreateSITAddressUpdateRequestParamsWithTimeout(timeout time.Duration) *CreateSITAddressUpdateRequestParams

NewCreateSITAddressUpdateRequestParamsWithTimeout creates a new CreateSITAddressUpdateRequestParams object with the ability to set a timeout on a request.

func (*CreateSITAddressUpdateRequestParams) SetBody

SetBody adds the body to the create s i t address update request params

func (*CreateSITAddressUpdateRequestParams) SetContext

SetContext adds the context to the create s i t address update request params

func (*CreateSITAddressUpdateRequestParams) SetDefaults

func (o *CreateSITAddressUpdateRequestParams) SetDefaults()

SetDefaults hydrates default values in the create s i t address update request params (not the query body).

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

func (*CreateSITAddressUpdateRequestParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the create s i t address update request params

func (*CreateSITAddressUpdateRequestParams) SetTimeout

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

SetTimeout adds the timeout to the create s i t address update request params

func (*CreateSITAddressUpdateRequestParams) WithBody

WithBody adds the body to the create s i t address update request params

func (*CreateSITAddressUpdateRequestParams) WithContext

WithContext adds the context to the create s i t address update request params

func (*CreateSITAddressUpdateRequestParams) WithDefaults

WithDefaults hydrates default values in the create s i t address update request params (not the query body).

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

func (*CreateSITAddressUpdateRequestParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the create s i t address update request params

func (*CreateSITAddressUpdateRequestParams) WithTimeout

WithTimeout adds the timeout to the create s i t address update request params

func (*CreateSITAddressUpdateRequestParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type CreateSITAddressUpdateRequestReader

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

CreateSITAddressUpdateRequestReader is a Reader for the CreateSITAddressUpdateRequest structure.

func (*CreateSITAddressUpdateRequestReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type CreateSITAddressUpdateRequestUnauthorized

type CreateSITAddressUpdateRequestUnauthorized struct {
	Payload *primemessages.ClientError
}

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

The request was denied.

func NewCreateSITAddressUpdateRequestUnauthorized

func NewCreateSITAddressUpdateRequestUnauthorized() *CreateSITAddressUpdateRequestUnauthorized

NewCreateSITAddressUpdateRequestUnauthorized creates a CreateSITAddressUpdateRequestUnauthorized with default headers values

func (*CreateSITAddressUpdateRequestUnauthorized) Code

Code gets the status code for the create s i t address update request unauthorized response

func (*CreateSITAddressUpdateRequestUnauthorized) Error

func (*CreateSITAddressUpdateRequestUnauthorized) GetPayload

func (*CreateSITAddressUpdateRequestUnauthorized) IsClientError

IsClientError returns true when this create s i t address update request unauthorized response has a 4xx status code

func (*CreateSITAddressUpdateRequestUnauthorized) IsCode

IsCode returns true when this create s i t address update request unauthorized response a status code equal to that given

func (*CreateSITAddressUpdateRequestUnauthorized) IsRedirect

IsRedirect returns true when this create s i t address update request unauthorized response has a 3xx status code

func (*CreateSITAddressUpdateRequestUnauthorized) IsServerError

IsServerError returns true when this create s i t address update request unauthorized response has a 5xx status code

func (*CreateSITAddressUpdateRequestUnauthorized) IsSuccess

IsSuccess returns true when this create s i t address update request unauthorized response has a 2xx status code

func (*CreateSITAddressUpdateRequestUnauthorized) String

type CreateSITAddressUpdateRequestUnprocessableEntity

type CreateSITAddressUpdateRequestUnprocessableEntity struct {
	Payload *primemessages.ValidationError
}

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

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

func NewCreateSITAddressUpdateRequestUnprocessableEntity

func NewCreateSITAddressUpdateRequestUnprocessableEntity() *CreateSITAddressUpdateRequestUnprocessableEntity

NewCreateSITAddressUpdateRequestUnprocessableEntity creates a CreateSITAddressUpdateRequestUnprocessableEntity with default headers values

func (*CreateSITAddressUpdateRequestUnprocessableEntity) Code

Code gets the status code for the create s i t address update request unprocessable entity response

func (*CreateSITAddressUpdateRequestUnprocessableEntity) Error

func (*CreateSITAddressUpdateRequestUnprocessableEntity) GetPayload

func (*CreateSITAddressUpdateRequestUnprocessableEntity) IsClientError

IsClientError returns true when this create s i t address update request unprocessable entity response has a 4xx status code

func (*CreateSITAddressUpdateRequestUnprocessableEntity) IsCode

IsCode returns true when this create s i t address update request unprocessable entity response a status code equal to that given

func (*CreateSITAddressUpdateRequestUnprocessableEntity) IsRedirect

IsRedirect returns true when this create s i t address update request unprocessable entity response has a 3xx status code

func (*CreateSITAddressUpdateRequestUnprocessableEntity) IsServerError

IsServerError returns true when this create s i t address update request unprocessable entity response has a 5xx status code

func (*CreateSITAddressUpdateRequestUnprocessableEntity) IsSuccess

IsSuccess returns true when this create s i t address update request unprocessable entity response has a 2xx status code

func (*CreateSITAddressUpdateRequestUnprocessableEntity) String

Jump to

Keyboard shortcuts

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