o_t_p

package
v0.0.0-...-b7c6b38 Latest Latest
Warning

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

Go to latest
Published: Jul 30, 2024 License: Apache-2.0 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 o t p API

func (*Client) CompleteAddressVerification

func (a *Client) CompleteAddressVerification(params *CompleteAddressVerificationParams, opts ...ClientOption) (*CompleteAddressVerificationNoContent, error)
CompleteAddressVerification completes address verification

Completes unverified address verification by checking if code is valid or not.

Both address and code must be provided. Fails if address is not user's address or is user's verified or is someone's verified address. If the OTP is valid it is removed and a successful response is returned. Endpoint is protected by Brute Force mechanism.

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 {
	CompleteAddressVerification(params *CompleteAddressVerificationParams, opts ...ClientOption) (*CompleteAddressVerificationNoContent, 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 o t p API client.

type CompleteAddressVerificationBadRequest

type CompleteAddressVerificationBadRequest struct {
	Payload *models.Error
}

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

Bad request

func NewCompleteAddressVerificationBadRequest

func NewCompleteAddressVerificationBadRequest() *CompleteAddressVerificationBadRequest

NewCompleteAddressVerificationBadRequest creates a CompleteAddressVerificationBadRequest with default headers values

func (*CompleteAddressVerificationBadRequest) Code

Code gets the status code for the complete address verification bad request response

func (*CompleteAddressVerificationBadRequest) Error

func (*CompleteAddressVerificationBadRequest) GetPayload

func (*CompleteAddressVerificationBadRequest) IsClientError

func (o *CompleteAddressVerificationBadRequest) IsClientError() bool

IsClientError returns true when this complete address verification bad request response has a 4xx status code

func (*CompleteAddressVerificationBadRequest) IsCode

IsCode returns true when this complete address verification bad request response a status code equal to that given

func (*CompleteAddressVerificationBadRequest) IsRedirect

IsRedirect returns true when this complete address verification bad request response has a 3xx status code

func (*CompleteAddressVerificationBadRequest) IsServerError

func (o *CompleteAddressVerificationBadRequest) IsServerError() bool

IsServerError returns true when this complete address verification bad request response has a 5xx status code

func (*CompleteAddressVerificationBadRequest) IsSuccess

IsSuccess returns true when this complete address verification bad request response has a 2xx status code

func (*CompleteAddressVerificationBadRequest) String

type CompleteAddressVerificationConflict

type CompleteAddressVerificationConflict struct {
	Payload *models.Error
}

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

Conflict

func NewCompleteAddressVerificationConflict

func NewCompleteAddressVerificationConflict() *CompleteAddressVerificationConflict

NewCompleteAddressVerificationConflict creates a CompleteAddressVerificationConflict with default headers values

func (*CompleteAddressVerificationConflict) Code

Code gets the status code for the complete address verification conflict response

func (*CompleteAddressVerificationConflict) Error

func (*CompleteAddressVerificationConflict) GetPayload

func (*CompleteAddressVerificationConflict) IsClientError

func (o *CompleteAddressVerificationConflict) IsClientError() bool

IsClientError returns true when this complete address verification conflict response has a 4xx status code

func (*CompleteAddressVerificationConflict) IsCode

IsCode returns true when this complete address verification conflict response a status code equal to that given

func (*CompleteAddressVerificationConflict) IsRedirect

func (o *CompleteAddressVerificationConflict) IsRedirect() bool

IsRedirect returns true when this complete address verification conflict response has a 3xx status code

func (*CompleteAddressVerificationConflict) IsServerError

func (o *CompleteAddressVerificationConflict) IsServerError() bool

IsServerError returns true when this complete address verification conflict response has a 5xx status code

func (*CompleteAddressVerificationConflict) IsSuccess

IsSuccess returns true when this complete address verification conflict response has a 2xx status code

func (*CompleteAddressVerificationConflict) String

type CompleteAddressVerificationNoContent

type CompleteAddressVerificationNoContent struct {

	/* The ETag HTTP header is an identifier for a specific version of a resource

	in:header

	     Format: etag
	*/
	Etag string
}

CompleteAddressVerificationNoContent describes a response with status code 204, with default header values.

Address verification completed

func NewCompleteAddressVerificationNoContent

func NewCompleteAddressVerificationNoContent() *CompleteAddressVerificationNoContent

NewCompleteAddressVerificationNoContent creates a CompleteAddressVerificationNoContent with default headers values

func (*CompleteAddressVerificationNoContent) Code

Code gets the status code for the complete address verification no content response

func (*CompleteAddressVerificationNoContent) Error

func (*CompleteAddressVerificationNoContent) IsClientError

func (o *CompleteAddressVerificationNoContent) IsClientError() bool

IsClientError returns true when this complete address verification no content response has a 4xx status code

func (*CompleteAddressVerificationNoContent) IsCode

IsCode returns true when this complete address verification no content response a status code equal to that given

func (*CompleteAddressVerificationNoContent) IsRedirect

IsRedirect returns true when this complete address verification no content response has a 3xx status code

func (*CompleteAddressVerificationNoContent) IsServerError

func (o *CompleteAddressVerificationNoContent) IsServerError() bool

IsServerError returns true when this complete address verification no content response has a 5xx status code

func (*CompleteAddressVerificationNoContent) IsSuccess

IsSuccess returns true when this complete address verification no content response has a 2xx status code

func (*CompleteAddressVerificationNoContent) String

type CompleteAddressVerificationNotFound

type CompleteAddressVerificationNotFound struct {
	Payload *models.Error
}

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

Not found

func NewCompleteAddressVerificationNotFound

func NewCompleteAddressVerificationNotFound() *CompleteAddressVerificationNotFound

NewCompleteAddressVerificationNotFound creates a CompleteAddressVerificationNotFound with default headers values

func (*CompleteAddressVerificationNotFound) Code

Code gets the status code for the complete address verification not found response

func (*CompleteAddressVerificationNotFound) Error

func (*CompleteAddressVerificationNotFound) GetPayload

func (*CompleteAddressVerificationNotFound) IsClientError

func (o *CompleteAddressVerificationNotFound) IsClientError() bool

IsClientError returns true when this complete address verification not found response has a 4xx status code

func (*CompleteAddressVerificationNotFound) IsCode

IsCode returns true when this complete address verification not found response a status code equal to that given

func (*CompleteAddressVerificationNotFound) IsRedirect

func (o *CompleteAddressVerificationNotFound) IsRedirect() bool

IsRedirect returns true when this complete address verification not found response has a 3xx status code

func (*CompleteAddressVerificationNotFound) IsServerError

func (o *CompleteAddressVerificationNotFound) IsServerError() bool

IsServerError returns true when this complete address verification not found response has a 5xx status code

func (*CompleteAddressVerificationNotFound) IsSuccess

IsSuccess returns true when this complete address verification not found response has a 2xx status code

func (*CompleteAddressVerificationNotFound) String

type CompleteAddressVerificationParams

type CompleteAddressVerificationParams struct {

	// CompleteAddressVerification.
	CompleteAddressVerification *models.CompleteAddressVerification

	/* IfMatch.

	   A server will only return requested resources if the resource matches one of the listed ETag value

	   Format: etag
	*/
	IfMatch *string

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

CompleteAddressVerificationParams contains all the parameters to send to the API endpoint

for the complete address verification operation.

Typically these are written to a http.Request.

func NewCompleteAddressVerificationParams

func NewCompleteAddressVerificationParams() *CompleteAddressVerificationParams

NewCompleteAddressVerificationParams creates a new CompleteAddressVerificationParams 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 NewCompleteAddressVerificationParamsWithContext

func NewCompleteAddressVerificationParamsWithContext(ctx context.Context) *CompleteAddressVerificationParams

NewCompleteAddressVerificationParamsWithContext creates a new CompleteAddressVerificationParams object with the ability to set a context for a request.

func NewCompleteAddressVerificationParamsWithHTTPClient

func NewCompleteAddressVerificationParamsWithHTTPClient(client *http.Client) *CompleteAddressVerificationParams

NewCompleteAddressVerificationParamsWithHTTPClient creates a new CompleteAddressVerificationParams object with the ability to set a custom HTTPClient for a request.

func NewCompleteAddressVerificationParamsWithTimeout

func NewCompleteAddressVerificationParamsWithTimeout(timeout time.Duration) *CompleteAddressVerificationParams

NewCompleteAddressVerificationParamsWithTimeout creates a new CompleteAddressVerificationParams object with the ability to set a timeout on a request.

func (*CompleteAddressVerificationParams) SetCompleteAddressVerification

func (o *CompleteAddressVerificationParams) SetCompleteAddressVerification(completeAddressVerification *models.CompleteAddressVerification)

SetCompleteAddressVerification adds the completeAddressVerification to the complete address verification params

func (*CompleteAddressVerificationParams) SetContext

SetContext adds the context to the complete address verification params

func (*CompleteAddressVerificationParams) SetDefaults

func (o *CompleteAddressVerificationParams) SetDefaults()

SetDefaults hydrates default values in the complete address verification params (not the query body).

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

func (*CompleteAddressVerificationParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the complete address verification params

func (*CompleteAddressVerificationParams) SetIfMatch

func (o *CompleteAddressVerificationParams) SetIfMatch(ifMatch *string)

SetIfMatch adds the ifMatch to the complete address verification params

func (*CompleteAddressVerificationParams) SetTimeout

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

SetTimeout adds the timeout to the complete address verification params

func (*CompleteAddressVerificationParams) WithCompleteAddressVerification

func (o *CompleteAddressVerificationParams) WithCompleteAddressVerification(completeAddressVerification *models.CompleteAddressVerification) *CompleteAddressVerificationParams

WithCompleteAddressVerification adds the completeAddressVerification to the complete address verification params

func (*CompleteAddressVerificationParams) WithContext

WithContext adds the context to the complete address verification params

func (*CompleteAddressVerificationParams) WithDefaults

WithDefaults hydrates default values in the complete address verification params (not the query body).

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

func (*CompleteAddressVerificationParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the complete address verification params

func (*CompleteAddressVerificationParams) WithIfMatch

WithIfMatch adds the ifMatch to the complete address verification params

func (*CompleteAddressVerificationParams) WithTimeout

WithTimeout adds the timeout to the complete address verification params

func (*CompleteAddressVerificationParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type CompleteAddressVerificationPreconditionFailed

type CompleteAddressVerificationPreconditionFailed struct {
	Payload *models.Error
}

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

Payload too large

func NewCompleteAddressVerificationPreconditionFailed

func NewCompleteAddressVerificationPreconditionFailed() *CompleteAddressVerificationPreconditionFailed

NewCompleteAddressVerificationPreconditionFailed creates a CompleteAddressVerificationPreconditionFailed with default headers values

func (*CompleteAddressVerificationPreconditionFailed) Code

Code gets the status code for the complete address verification precondition failed response

func (*CompleteAddressVerificationPreconditionFailed) Error

func (*CompleteAddressVerificationPreconditionFailed) GetPayload

func (*CompleteAddressVerificationPreconditionFailed) IsClientError

IsClientError returns true when this complete address verification precondition failed response has a 4xx status code

func (*CompleteAddressVerificationPreconditionFailed) IsCode

IsCode returns true when this complete address verification precondition failed response a status code equal to that given

func (*CompleteAddressVerificationPreconditionFailed) IsRedirect

IsRedirect returns true when this complete address verification precondition failed response has a 3xx status code

func (*CompleteAddressVerificationPreconditionFailed) IsServerError

IsServerError returns true when this complete address verification precondition failed response has a 5xx status code

func (*CompleteAddressVerificationPreconditionFailed) IsSuccess

IsSuccess returns true when this complete address verification precondition failed response has a 2xx status code

func (*CompleteAddressVerificationPreconditionFailed) String

type CompleteAddressVerificationReader

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

CompleteAddressVerificationReader is a Reader for the CompleteAddressVerification structure.

func (*CompleteAddressVerificationReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type CompleteAddressVerificationUnauthorized

type CompleteAddressVerificationUnauthorized struct {
	Payload *models.Error
}

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

Unauthorized

func NewCompleteAddressVerificationUnauthorized

func NewCompleteAddressVerificationUnauthorized() *CompleteAddressVerificationUnauthorized

NewCompleteAddressVerificationUnauthorized creates a CompleteAddressVerificationUnauthorized with default headers values

func (*CompleteAddressVerificationUnauthorized) Code

Code gets the status code for the complete address verification unauthorized response

func (*CompleteAddressVerificationUnauthorized) Error

func (*CompleteAddressVerificationUnauthorized) GetPayload

func (*CompleteAddressVerificationUnauthorized) IsClientError

func (o *CompleteAddressVerificationUnauthorized) IsClientError() bool

IsClientError returns true when this complete address verification unauthorized response has a 4xx status code

func (*CompleteAddressVerificationUnauthorized) IsCode

IsCode returns true when this complete address verification unauthorized response a status code equal to that given

func (*CompleteAddressVerificationUnauthorized) IsRedirect

IsRedirect returns true when this complete address verification unauthorized response has a 3xx status code

func (*CompleteAddressVerificationUnauthorized) IsServerError

func (o *CompleteAddressVerificationUnauthorized) IsServerError() bool

IsServerError returns true when this complete address verification unauthorized response has a 5xx status code

func (*CompleteAddressVerificationUnauthorized) IsSuccess

IsSuccess returns true when this complete address verification unauthorized response has a 2xx status code

func (*CompleteAddressVerificationUnauthorized) String

type CompleteAddressVerificationUnprocessableEntity

type CompleteAddressVerificationUnprocessableEntity struct {
	Payload *models.Error
}

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

Unprocessable entity

func NewCompleteAddressVerificationUnprocessableEntity

func NewCompleteAddressVerificationUnprocessableEntity() *CompleteAddressVerificationUnprocessableEntity

NewCompleteAddressVerificationUnprocessableEntity creates a CompleteAddressVerificationUnprocessableEntity with default headers values

func (*CompleteAddressVerificationUnprocessableEntity) Code

Code gets the status code for the complete address verification unprocessable entity response

func (*CompleteAddressVerificationUnprocessableEntity) Error

func (*CompleteAddressVerificationUnprocessableEntity) GetPayload

func (*CompleteAddressVerificationUnprocessableEntity) IsClientError

IsClientError returns true when this complete address verification unprocessable entity response has a 4xx status code

func (*CompleteAddressVerificationUnprocessableEntity) IsCode

IsCode returns true when this complete address verification unprocessable entity response a status code equal to that given

func (*CompleteAddressVerificationUnprocessableEntity) IsRedirect

IsRedirect returns true when this complete address verification unprocessable entity response has a 3xx status code

func (*CompleteAddressVerificationUnprocessableEntity) IsServerError

IsServerError returns true when this complete address verification unprocessable entity response has a 5xx status code

func (*CompleteAddressVerificationUnprocessableEntity) IsSuccess

IsSuccess returns true when this complete address verification unprocessable entity response has a 2xx status code

func (*CompleteAddressVerificationUnprocessableEntity) String

Jump to

Keyboard shortcuts

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