payment_request

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

Documentation

Index

Constants

View Source 
const CreatePaymentRequestBadRequestCode int = 400

CreatePaymentRequestBadRequestCode is the HTTP code returned for type CreatePaymentRequestBadRequest

View Source 
const CreatePaymentRequestConflictCode int = 409

CreatePaymentRequestConflictCode is the HTTP code returned for type CreatePaymentRequestConflict

View Source 
const CreatePaymentRequestCreatedCode int = 201

CreatePaymentRequestCreatedCode is the HTTP code returned for type CreatePaymentRequestCreated

View Source 
const CreatePaymentRequestForbiddenCode int = 403

CreatePaymentRequestForbiddenCode is the HTTP code returned for type CreatePaymentRequestForbidden

View Source 
const CreatePaymentRequestInternalServerErrorCode int = 500

CreatePaymentRequestInternalServerErrorCode is the HTTP code returned for type CreatePaymentRequestInternalServerError

View Source 
const CreatePaymentRequestNotFoundCode int = 404

CreatePaymentRequestNotFoundCode is the HTTP code returned for type CreatePaymentRequestNotFound

View Source 
const CreatePaymentRequestUnauthorizedCode int = 401

CreatePaymentRequestUnauthorizedCode is the HTTP code returned for type CreatePaymentRequestUnauthorized

View Source 
const CreatePaymentRequestUnprocessableEntityCode int = 422

CreatePaymentRequestUnprocessableEntityCode is the HTTP code returned for type CreatePaymentRequestUnprocessableEntity

View Source 
const CreateUploadBadRequestCode int = 400

CreateUploadBadRequestCode is the HTTP code returned for type CreateUploadBadRequest

View Source 
const CreateUploadCreatedCode int = 201

CreateUploadCreatedCode is the HTTP code returned for type CreateUploadCreated

View Source 
const CreateUploadForbiddenCode int = 403

CreateUploadForbiddenCode is the HTTP code returned for type CreateUploadForbidden

View Source 
const CreateUploadInternalServerErrorCode int = 500

CreateUploadInternalServerErrorCode is the HTTP code returned for type CreateUploadInternalServerError

View Source 
const CreateUploadNotFoundCode int = 404

CreateUploadNotFoundCode is the HTTP code returned for type CreateUploadNotFound

View Source 
const CreateUploadUnauthorizedCode int = 401

CreateUploadUnauthorizedCode is the HTTP code returned for type CreateUploadUnauthorized

View Source 
const CreateUploadUnprocessableEntityCode int = 422

CreateUploadUnprocessableEntityCode is the HTTP code returned for type CreateUploadUnprocessableEntity

Variables

View Source 
var CreateUploadMaxParseMemory int64 = 32 << 20

CreateUploadMaxParseMemory sets the maximum size in bytes for the multipart form parser for this operation.

The default value is 32 MB. The multipart parser stores up to this + 10MB.

Functions

This section is empty.

Types

type CreatePaymentRequest 

type CreatePaymentRequest struct {
	Context *middleware.Context
	Handler CreatePaymentRequestHandler
}
CreatePaymentRequest swagger:route POST /payment-requests paymentRequest createPaymentRequest

createPaymentRequest

Creates a new instance of a paymentRequest and is assigned the status `PENDING`. A move task order can have multiple payment requests, and a final payment request can be marked using boolean `isFinal`.

If a `PENDING` payment request is recalculated, a new payment request is created and the original request is marked with the status `DEPRECATED`.

**NOTE**: In order to create a payment request for most service items, the shipment *must* be updated with the `PrimeActualWeight` value via [updateMTOShipment](#operation/updateMTOShipment).

**FSC - Fuel Surcharge** service items require `ActualPickupDate` to be updated on the shipment.

A service item can be on several payment requests in the case of partial payment requests and payments.

In the request, if no params are necessary, then just the `serviceItem` `id` is required. For example: ```json 

{
  "isFinal": false,
  "moveTaskOrderID": "uuid",
  "serviceItems": [
    {
      "id": "uuid",
    },
    {
      "id": "uuid",
      "params": [
        {
          "key": "Service Item Parameter Name",
          "value": "Service Item Parameter Value"
        }
      ]
    }
  ],
  "pointOfContact": "string"
}

```

SIT Service Items & Accepted Payment Request Parameters: --- If `WeightBilled` is not provided then the full shipment weight (`PrimeActualWeight`) will be considered in the calculation.

**NOTE**: Diversions have a unique calcuation for payment requests without a `WeightBilled` parameter.

If you created a payment request for a diversion and `WeightBilled` is not provided, then the following will be used in the calculation: - The lowest shipment weight (`PrimeActualWeight`) found in the diverted shipment chain. - The lowest reweigh weight found in the diverted shipment chain.

The diverted shipment chain is created by referencing the `diversion` boolean, `divertedFromShipmentId` UUID, and matching destination to pickup addresses. If the chain cannot be established it will fall back to the `PrimeActualWeight` of the current shipment. This is utilized because diverted shipments are all one single shipment, but going to different locations. The lowest weight found is the true shipment weight, and thus we search the chain of shipments for the lowest weight found.

**DOFSIT - Domestic origin 1st day SIT** ```json 

"params": [
  {
    "key": "WeightBilled",
    "value": "integer"
  }
]

```

**DOASIT - Domestic origin add'l SIT** *(SITPaymentRequestStart & SITPaymentRequestEnd are **REQUIRED**)* *To create a paymentRequest for this service item, the `SITPaymentRequestStart` and `SITPaymentRequestEnd` dates must not overlap previously requested SIT dates.* ```json 

"params": [
  {
    "key": "WeightBilled",
    "value": "integer"
  },
  {
    "key": "SITPaymentRequestStart",
    "value": "date"
  },
  {
    "key": "SITPaymentRequestEnd",
    "value": "date"
  }
]

```

**DOPSIT - Domestic origin SIT pickup** ```json 

"params": [
  {
    "key": "WeightBilled",
    "value": "integer"
  }
]

```

**DOSHUT - Domestic origin shuttle service** ```json 

"params": [
  {
    "key": "WeightBilled",
    "value": "integer"
  }
]

```

**DDFSIT - Domestic destination 1st day SIT** ```json 

"params": [
  {
    "key": "WeightBilled",
    "value": "integer"
  }
]

```

**DDASIT - Domestic destination add'l SIT** *(SITPaymentRequestStart & SITPaymentRequestEnd are **REQUIRED**)* *To create a paymentRequest for this service item, the `SITPaymentRequestStart` and `SITPaymentRequestEnd` dates must not overlap previously requested SIT dates.* ```json 

"params": [
  {
    "key": "WeightBilled",
    "value": "integer"
  },
  {
    "key": "SITPaymentRequestStart",
    "value": "date"
  },
  {
    "key": "SITPaymentRequestEnd",
    "value": "date"
  }
]

```

**DDDSIT - Domestic destination SIT delivery** *To create a paymentRequest for this service item, it must first have a final address set via [updateMTOServiceItem](#operation/updateMTOServiceItem).* ```json 

"params": [
  {
    "key": "WeightBilled",
    "value": "integer"
  }
]

```

**DDSHUT - Domestic destination shuttle service** ```json 

"params": [
  {
    "key": "WeightBilled",
    "value": "integer"
  }
]

``` ---

func NewCreatePaymentRequest 

func NewCreatePaymentRequest(ctx *middleware.Context, handler CreatePaymentRequestHandler) *CreatePaymentRequest

NewCreatePaymentRequest creates a new http.Handler for the create payment request operation

func (*CreatePaymentRequest) ServeHTTP 

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

type CreatePaymentRequestBadRequest 

type CreatePaymentRequestBadRequest struct {

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

CreatePaymentRequestBadRequest Request payload is invalid.

swagger:response createPaymentRequestBadRequest

func NewCreatePaymentRequestBadRequest 

func NewCreatePaymentRequestBadRequest() *CreatePaymentRequestBadRequest

NewCreatePaymentRequestBadRequest creates CreatePaymentRequestBadRequest with default headers values

func (*CreatePaymentRequestBadRequest) SetPayload 

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

SetPayload sets the payload to the create payment request bad request response

func (*CreatePaymentRequestBadRequest) WithPayload 

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

WithPayload adds the payload to the create payment request bad request response

func (*CreatePaymentRequestBadRequest) WriteResponse 

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

WriteResponse to the client

type CreatePaymentRequestConflict 

type CreatePaymentRequestConflict struct {

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

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

swagger:response createPaymentRequestConflict

func NewCreatePaymentRequestConflict 

func NewCreatePaymentRequestConflict() *CreatePaymentRequestConflict

NewCreatePaymentRequestConflict creates CreatePaymentRequestConflict with default headers values

func (*CreatePaymentRequestConflict) SetPayload 

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

SetPayload sets the payload to the create payment request conflict response

func (*CreatePaymentRequestConflict) WithPayload 

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

WithPayload adds the payload to the create payment request conflict response

func (*CreatePaymentRequestConflict) WriteResponse 

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

WriteResponse to the client

type CreatePaymentRequestCreated 

type CreatePaymentRequestCreated struct {

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

CreatePaymentRequestCreated Successfully created a paymentRequest object.

swagger:response createPaymentRequestCreated

func NewCreatePaymentRequestCreated 

func NewCreatePaymentRequestCreated() *CreatePaymentRequestCreated

NewCreatePaymentRequestCreated creates CreatePaymentRequestCreated with default headers values

func (*CreatePaymentRequestCreated) SetPayload 

func (o *CreatePaymentRequestCreated) SetPayload(payload *primemessages.PaymentRequest)

SetPayload sets the payload to the create payment request created response

func (*CreatePaymentRequestCreated) WithPayload 

func (o *CreatePaymentRequestCreated) WithPayload(payload *primemessages.PaymentRequest) *CreatePaymentRequestCreated

WithPayload adds the payload to the create payment request created response

func (*CreatePaymentRequestCreated) WriteResponse 

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

WriteResponse to the client

type CreatePaymentRequestForbidden 

type CreatePaymentRequestForbidden struct {

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

CreatePaymentRequestForbidden The request was denied.

swagger:response createPaymentRequestForbidden

func NewCreatePaymentRequestForbidden 

func NewCreatePaymentRequestForbidden() *CreatePaymentRequestForbidden

NewCreatePaymentRequestForbidden creates CreatePaymentRequestForbidden with default headers values

func (*CreatePaymentRequestForbidden) SetPayload 

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

SetPayload sets the payload to the create payment request forbidden response

func (*CreatePaymentRequestForbidden) WithPayload 

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

WithPayload adds the payload to the create payment request forbidden response

func (*CreatePaymentRequestForbidden) WriteResponse 

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

WriteResponse to the client

type CreatePaymentRequestHandler 

type CreatePaymentRequestHandler interface {
	Handle(CreatePaymentRequestParams) middleware.Responder
}

CreatePaymentRequestHandler interface for that can handle valid create payment request params

type CreatePaymentRequestHandlerFunc 

type CreatePaymentRequestHandlerFunc func(CreatePaymentRequestParams) middleware.Responder

CreatePaymentRequestHandlerFunc turns a function with the right signature into a create payment request handler

func (CreatePaymentRequestHandlerFunc) Handle 

func (fn CreatePaymentRequestHandlerFunc) Handle(params CreatePaymentRequestParams) middleware.Responder

Handle executing the request and returning a response

type CreatePaymentRequestInternalServerError 

type CreatePaymentRequestInternalServerError struct {

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

CreatePaymentRequestInternalServerError A server error occurred.

swagger:response createPaymentRequestInternalServerError

func NewCreatePaymentRequestInternalServerError 

func NewCreatePaymentRequestInternalServerError() *CreatePaymentRequestInternalServerError

NewCreatePaymentRequestInternalServerError creates CreatePaymentRequestInternalServerError with default headers values

func (*CreatePaymentRequestInternalServerError) SetPayload 

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

SetPayload sets the payload to the create payment request internal server error response

func (*CreatePaymentRequestInternalServerError) WithPayload 

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

WithPayload adds the payload to the create payment request internal server error response

func (*CreatePaymentRequestInternalServerError) WriteResponse 

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

WriteResponse to the client

type CreatePaymentRequestNotFound 

type CreatePaymentRequestNotFound struct {

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

CreatePaymentRequestNotFound The requested resource wasn't found.

swagger:response createPaymentRequestNotFound

func NewCreatePaymentRequestNotFound 

func NewCreatePaymentRequestNotFound() *CreatePaymentRequestNotFound

NewCreatePaymentRequestNotFound creates CreatePaymentRequestNotFound with default headers values

func (*CreatePaymentRequestNotFound) SetPayload 

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

SetPayload sets the payload to the create payment request not found response

func (*CreatePaymentRequestNotFound) WithPayload 

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

WithPayload adds the payload to the create payment request not found response

func (*CreatePaymentRequestNotFound) WriteResponse 

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

WriteResponse to the client

type CreatePaymentRequestParams 

type CreatePaymentRequestParams struct {

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

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

CreatePaymentRequestParams contains all the bound params for the create payment request operation typically these are obtained from a http.Request

swagger:parameters createPaymentRequest

func NewCreatePaymentRequestParams 

func NewCreatePaymentRequestParams() CreatePaymentRequestParams

NewCreatePaymentRequestParams creates a new CreatePaymentRequestParams object

There are no default values defined in the spec.

func (*CreatePaymentRequestParams) BindRequest 

func (o *CreatePaymentRequestParams) 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 NewCreatePaymentRequestParams() beforehand.

type CreatePaymentRequestURL 

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

CreatePaymentRequestURL generates an URL for the create payment request operation

func (*CreatePaymentRequestURL) Build 

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

Build a url path and query string

func (*CreatePaymentRequestURL) BuildFull 

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

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

func (*CreatePaymentRequestURL) Must 

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

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

func (*CreatePaymentRequestURL) SetBasePath 

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

func (o *CreatePaymentRequestURL) String() string

String returns the string representation of the path with query string

func (*CreatePaymentRequestURL) StringFull 

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

StringFull returns the string representation of a complete url

func (*CreatePaymentRequestURL) WithBasePath 

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

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 CreatePaymentRequestUnauthorized 

type CreatePaymentRequestUnauthorized struct {

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

CreatePaymentRequestUnauthorized The request was denied.

swagger:response createPaymentRequestUnauthorized

func NewCreatePaymentRequestUnauthorized 

func NewCreatePaymentRequestUnauthorized() *CreatePaymentRequestUnauthorized

NewCreatePaymentRequestUnauthorized creates CreatePaymentRequestUnauthorized with default headers values

func (*CreatePaymentRequestUnauthorized) SetPayload 

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

SetPayload sets the payload to the create payment request unauthorized response

func (*CreatePaymentRequestUnauthorized) WithPayload 

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

WithPayload adds the payload to the create payment request unauthorized response

func (*CreatePaymentRequestUnauthorized) WriteResponse 

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

WriteResponse to the client

type CreatePaymentRequestUnprocessableEntity 

type CreatePaymentRequestUnprocessableEntity struct {

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

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

swagger:response createPaymentRequestUnprocessableEntity

func NewCreatePaymentRequestUnprocessableEntity 

func NewCreatePaymentRequestUnprocessableEntity() *CreatePaymentRequestUnprocessableEntity

NewCreatePaymentRequestUnprocessableEntity creates CreatePaymentRequestUnprocessableEntity with default headers values

func (*CreatePaymentRequestUnprocessableEntity) SetPayload 

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

SetPayload sets the payload to the create payment request unprocessable entity response

func (*CreatePaymentRequestUnprocessableEntity) WithPayload 

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

WithPayload adds the payload to the create payment request unprocessable entity response

func (*CreatePaymentRequestUnprocessableEntity) WriteResponse 

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

WriteResponse to the client

type CreateUpload 

type CreateUpload struct {
	Context *middleware.Context
	Handler CreateUploadHandler
}
CreateUpload swagger:route POST /payment-requests/{paymentRequestID}/uploads paymentRequest createUpload

createUpload

### Functionality This endpoint **uploads** a Proof of Service document for a PaymentRequest.

The PaymentRequest should already exist.

Optional key of **isWeightTicket** indicates if the document is a weight ticket or not. This will be used for partial and full deliveries and makes it easier for the Task Invoicing Officers to locate and review service item documents. If left empty, it will assume it is NOT a weight ticket.

The formdata in the body of the POST request that is sent should look like this if it IS a weight ticket being attached to an existing payment request: 

```json
{
  "file": "filePath",
  "isWeightTicket": true
}
```
If the proof of service doc is NOT a weight ticket, it will look like this - or you can leave it empty:
```json
{
  "file": "filePath",
  "isWeightTicket": false
}
```
```json
{
  "file": "filePath",
}
```

PaymentRequests are created with the [createPaymentRequest](#operation/createPaymentRequest) endpoint.

func NewCreateUpload 

func NewCreateUpload(ctx *middleware.Context, handler CreateUploadHandler) *CreateUpload

NewCreateUpload creates a new http.Handler for the create upload operation

func (*CreateUpload) ServeHTTP 

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

type CreateUploadBadRequest 

type CreateUploadBadRequest struct {

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

CreateUploadBadRequest The request payload is invalid.

swagger:response createUploadBadRequest

func NewCreateUploadBadRequest 

func NewCreateUploadBadRequest() *CreateUploadBadRequest

NewCreateUploadBadRequest creates CreateUploadBadRequest with default headers values

func (*CreateUploadBadRequest) SetPayload 

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

SetPayload sets the payload to the create upload bad request response

func (*CreateUploadBadRequest) WithPayload 

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

WithPayload adds the payload to the create upload bad request response

func (*CreateUploadBadRequest) WriteResponse 

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

WriteResponse to the client

type CreateUploadCreated 

type CreateUploadCreated struct {

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

CreateUploadCreated Successfully created upload of digital file.

swagger:response createUploadCreated

func NewCreateUploadCreated 

func NewCreateUploadCreated() *CreateUploadCreated

NewCreateUploadCreated creates CreateUploadCreated with default headers values

func (*CreateUploadCreated) SetPayload 

func (o *CreateUploadCreated) SetPayload(payload *primemessages.UploadWithOmissions)

SetPayload sets the payload to the create upload created response

func (*CreateUploadCreated) WithPayload 

func (o *CreateUploadCreated) WithPayload(payload *primemessages.UploadWithOmissions) *CreateUploadCreated

WithPayload adds the payload to the create upload created response

func (*CreateUploadCreated) WriteResponse 

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

WriteResponse to the client

type CreateUploadForbidden 

type CreateUploadForbidden struct {

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

CreateUploadForbidden The request was denied.

swagger:response createUploadForbidden

func NewCreateUploadForbidden 

func NewCreateUploadForbidden() *CreateUploadForbidden

NewCreateUploadForbidden creates CreateUploadForbidden with default headers values

func (*CreateUploadForbidden) SetPayload 

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

SetPayload sets the payload to the create upload forbidden response

func (*CreateUploadForbidden) WithPayload 

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

WithPayload adds the payload to the create upload forbidden response

func (*CreateUploadForbidden) WriteResponse 

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

WriteResponse to the client

type CreateUploadHandler 

type CreateUploadHandler interface {
	Handle(CreateUploadParams) middleware.Responder
}

CreateUploadHandler interface for that can handle valid create upload params

type CreateUploadHandlerFunc 

type CreateUploadHandlerFunc func(CreateUploadParams) middleware.Responder

CreateUploadHandlerFunc turns a function with the right signature into a create upload handler

func (CreateUploadHandlerFunc) Handle 

func (fn CreateUploadHandlerFunc) Handle(params CreateUploadParams) middleware.Responder

Handle executing the request and returning a response

type CreateUploadInternalServerError 

type CreateUploadInternalServerError struct {

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

CreateUploadInternalServerError A server error occurred.

swagger:response createUploadInternalServerError

func NewCreateUploadInternalServerError 

func NewCreateUploadInternalServerError() *CreateUploadInternalServerError

NewCreateUploadInternalServerError creates CreateUploadInternalServerError with default headers values

func (*CreateUploadInternalServerError) SetPayload 

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

SetPayload sets the payload to the create upload internal server error response

func (*CreateUploadInternalServerError) WithPayload 

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

WithPayload adds the payload to the create upload internal server error response

func (*CreateUploadInternalServerError) WriteResponse 

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

WriteResponse to the client

type CreateUploadNotFound 

type CreateUploadNotFound struct {

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

CreateUploadNotFound The requested resource wasn't found.

swagger:response createUploadNotFound

func NewCreateUploadNotFound 

func NewCreateUploadNotFound() *CreateUploadNotFound

NewCreateUploadNotFound creates CreateUploadNotFound with default headers values

func (*CreateUploadNotFound) SetPayload 

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

SetPayload sets the payload to the create upload not found response

func (*CreateUploadNotFound) WithPayload 

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

WithPayload adds the payload to the create upload not found response

func (*CreateUploadNotFound) WriteResponse 

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

WriteResponse to the client

type CreateUploadParams 

type CreateUploadParams struct {

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

	/*The file to upload.
	  Required: true
	  In: formData
	*/
	File io.ReadCloser
	/*Indicates whether the file is a weight ticket.
	  In: formData
	*/
	IsWeightTicket *bool
	/*UUID of payment request to use.
	  Required: true
	  In: path
	*/
	PaymentRequestID string
}

CreateUploadParams contains all the bound params for the create upload operation typically these are obtained from a http.Request

swagger:parameters createUpload

func NewCreateUploadParams 

func NewCreateUploadParams() CreateUploadParams

NewCreateUploadParams creates a new CreateUploadParams object

There are no default values defined in the spec.

func (*CreateUploadParams) BindRequest 

func (o *CreateUploadParams) 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 NewCreateUploadParams() beforehand.

type CreateUploadURL 

type CreateUploadURL struct {
	PaymentRequestID string
	// contains filtered or unexported fields
}

CreateUploadURL generates an URL for the create upload operation

func (*CreateUploadURL) Build 

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

Build a url path and query string

func (*CreateUploadURL) BuildFull 

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

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

func (*CreateUploadURL) Must 

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

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

func (*CreateUploadURL) SetBasePath 

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

func (o *CreateUploadURL) String() string

String returns the string representation of the path with query string

func (*CreateUploadURL) StringFull 

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

StringFull returns the string representation of a complete url

func (*CreateUploadURL) WithBasePath 

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

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 CreateUploadUnauthorized 

type CreateUploadUnauthorized struct {

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

CreateUploadUnauthorized The request was denied.

swagger:response createUploadUnauthorized

func NewCreateUploadUnauthorized 

func NewCreateUploadUnauthorized() *CreateUploadUnauthorized

NewCreateUploadUnauthorized creates CreateUploadUnauthorized with default headers values

func (*CreateUploadUnauthorized) SetPayload 

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

SetPayload sets the payload to the create upload unauthorized response

func (*CreateUploadUnauthorized) WithPayload 

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

WithPayload adds the payload to the create upload unauthorized response

func (*CreateUploadUnauthorized) WriteResponse 

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

WriteResponse to the client

type CreateUploadUnprocessableEntity 

type CreateUploadUnprocessableEntity struct {

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

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

swagger:response createUploadUnprocessableEntity

func NewCreateUploadUnprocessableEntity 

func NewCreateUploadUnprocessableEntity() *CreateUploadUnprocessableEntity

NewCreateUploadUnprocessableEntity creates CreateUploadUnprocessableEntity with default headers values

func (*CreateUploadUnprocessableEntity) SetPayload 

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

SetPayload sets the payload to the create upload unprocessable entity response

func (*CreateUploadUnprocessableEntity) WithPayload 

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

WithPayload adds the payload to the create upload unprocessable entity response

func (*CreateUploadUnprocessableEntity) WriteResponse 

func (o *CreateUploadUnprocessableEntity) 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.