customers

package
v0.0.0-...-1fb28bd Latest Latest
Warning

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

Go to latest
Published: Jul 29, 2024 License: Apache-2.0 Imports: 11 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 customers API

func (*Client) Create

func (a *Client) Create(params *CreateParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CreateCreated, error)

Create creates a new customer to track

func (*Client) GetID

func (a *Client) GetID(params *GetIDParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetIDOK, error)

GetID gets a customer Id given an s s n

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 {
	Create(params *CreateParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CreateCreated, error)

	GetID(params *GetIDParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetIDOK, 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 customers API client.

func NewClientWithBasicAuth

func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService

New creates a new customers API client with basic auth credentials. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - user: user for basic authentication header. - password: password for basic authentication header.

func NewClientWithBearerToken

func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService

New creates a new customers API client with a bearer token for authentication. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - bearerToken: bearer token for Bearer authentication header.

type CreateCreated

type CreateCreated struct {
	Payload *models.Customer
}

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

created

func NewCreateCreated

func NewCreateCreated() *CreateCreated

NewCreateCreated creates a CreateCreated with default headers values

func (*CreateCreated) Code

func (o *CreateCreated) Code() int

Code gets the status code for the create created response

func (*CreateCreated) Error

func (o *CreateCreated) Error() string

func (*CreateCreated) GetPayload

func (o *CreateCreated) GetPayload() *models.Customer

func (*CreateCreated) IsClientError

func (o *CreateCreated) IsClientError() bool

IsClientError returns true when this create created response has a 4xx status code

func (*CreateCreated) IsCode

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

IsCode returns true when this create created response a status code equal to that given

func (*CreateCreated) IsRedirect

func (o *CreateCreated) IsRedirect() bool

IsRedirect returns true when this create created response has a 3xx status code

func (*CreateCreated) IsServerError

func (o *CreateCreated) IsServerError() bool

IsServerError returns true when this create created response has a 5xx status code

func (*CreateCreated) IsSuccess

func (o *CreateCreated) IsSuccess() bool

IsSuccess returns true when this create created response has a 2xx status code

func (*CreateCreated) String

func (o *CreateCreated) String() string

type CreateDefault

type CreateDefault struct {
	Payload *models.Error
	// contains filtered or unexported fields
}

CreateDefault describes a response with status code -1, with default header values.

error

func NewCreateDefault

func NewCreateDefault(code int) *CreateDefault

NewCreateDefault creates a CreateDefault with default headers values

func (*CreateDefault) Code

func (o *CreateDefault) Code() int

Code gets the status code for the create default response

func (*CreateDefault) Error

func (o *CreateDefault) Error() string

func (*CreateDefault) GetPayload

func (o *CreateDefault) GetPayload() *models.Error

func (*CreateDefault) IsClientError

func (o *CreateDefault) IsClientError() bool

IsClientError returns true when this create default response has a 4xx status code

func (*CreateDefault) IsCode

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

IsCode returns true when this create default response a status code equal to that given

func (*CreateDefault) IsRedirect

func (o *CreateDefault) IsRedirect() bool

IsRedirect returns true when this create default response has a 3xx status code

func (*CreateDefault) IsServerError

func (o *CreateDefault) IsServerError() bool

IsServerError returns true when this create default response has a 5xx status code

func (*CreateDefault) IsSuccess

func (o *CreateDefault) IsSuccess() bool

IsSuccess returns true when this create default response has a 2xx status code

func (*CreateDefault) String

func (o *CreateDefault) String() string

type CreateParams

type CreateParams struct {

	// Info.
	Info *models.Customer

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

CreateParams contains all the parameters to send to the API endpoint

for the create operation.

Typically these are written to a http.Request.

func NewCreateParams

func NewCreateParams() *CreateParams

NewCreateParams creates a new CreateParams 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 NewCreateParamsWithContext

func NewCreateParamsWithContext(ctx context.Context) *CreateParams

NewCreateParamsWithContext creates a new CreateParams object with the ability to set a context for a request.

func NewCreateParamsWithHTTPClient

func NewCreateParamsWithHTTPClient(client *http.Client) *CreateParams

NewCreateParamsWithHTTPClient creates a new CreateParams object with the ability to set a custom HTTPClient for a request.

func NewCreateParamsWithTimeout

func NewCreateParamsWithTimeout(timeout time.Duration) *CreateParams

NewCreateParamsWithTimeout creates a new CreateParams object with the ability to set a timeout on a request.

func (*CreateParams) SetContext

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

SetContext adds the context to the create params

func (*CreateParams) SetDefaults

func (o *CreateParams) SetDefaults()

SetDefaults hydrates default values in the create params (not the query body).

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

func (*CreateParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the create params

func (*CreateParams) SetInfo

func (o *CreateParams) SetInfo(info *models.Customer)

SetInfo adds the info to the create params

func (*CreateParams) SetTimeout

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

SetTimeout adds the timeout to the create params

func (*CreateParams) WithContext

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

WithContext adds the context to the create params

func (*CreateParams) WithDefaults

func (o *CreateParams) WithDefaults() *CreateParams

WithDefaults hydrates default values in the create params (not the query body).

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

func (*CreateParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the create params

func (*CreateParams) WithInfo

func (o *CreateParams) WithInfo(info *models.Customer) *CreateParams

WithInfo adds the info to the create params

func (*CreateParams) WithTimeout

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

WithTimeout adds the timeout to the create params

func (*CreateParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type CreateReader

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

CreateReader is a Reader for the Create structure.

func (*CreateReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type GetIDDefault

type GetIDDefault struct {
	Payload *models.Error
	// contains filtered or unexported fields
}

GetIDDefault describes a response with status code -1, with default header values.

error

func NewGetIDDefault

func NewGetIDDefault(code int) *GetIDDefault

NewGetIDDefault creates a GetIDDefault with default headers values

func (*GetIDDefault) Code

func (o *GetIDDefault) Code() int

Code gets the status code for the get Id default response

func (*GetIDDefault) Error

func (o *GetIDDefault) Error() string

func (*GetIDDefault) GetPayload

func (o *GetIDDefault) GetPayload() *models.Error

func (*GetIDDefault) IsClientError

func (o *GetIDDefault) IsClientError() bool

IsClientError returns true when this get Id default response has a 4xx status code

func (*GetIDDefault) IsCode

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

IsCode returns true when this get Id default response a status code equal to that given

func (*GetIDDefault) IsRedirect

func (o *GetIDDefault) IsRedirect() bool

IsRedirect returns true when this get Id default response has a 3xx status code

func (*GetIDDefault) IsServerError

func (o *GetIDDefault) IsServerError() bool

IsServerError returns true when this get Id default response has a 5xx status code

func (*GetIDDefault) IsSuccess

func (o *GetIDDefault) IsSuccess() bool

IsSuccess returns true when this get Id default response has a 2xx status code

func (*GetIDDefault) String

func (o *GetIDDefault) String() string

type GetIDNotFound

type GetIDNotFound struct {
	Payload *models.Error
}

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

resource not found

func NewGetIDNotFound

func NewGetIDNotFound() *GetIDNotFound

NewGetIDNotFound creates a GetIDNotFound with default headers values

func (*GetIDNotFound) Code

func (o *GetIDNotFound) Code() int

Code gets the status code for the get Id not found response

func (*GetIDNotFound) Error

func (o *GetIDNotFound) Error() string

func (*GetIDNotFound) GetPayload

func (o *GetIDNotFound) GetPayload() *models.Error

func (*GetIDNotFound) IsClientError

func (o *GetIDNotFound) IsClientError() bool

IsClientError returns true when this get Id not found response has a 4xx status code

func (*GetIDNotFound) IsCode

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

IsCode returns true when this get Id not found response a status code equal to that given

func (*GetIDNotFound) IsRedirect

func (o *GetIDNotFound) IsRedirect() bool

IsRedirect returns true when this get Id not found response has a 3xx status code

func (*GetIDNotFound) IsServerError

func (o *GetIDNotFound) IsServerError() bool

IsServerError returns true when this get Id not found response has a 5xx status code

func (*GetIDNotFound) IsSuccess

func (o *GetIDNotFound) IsSuccess() bool

IsSuccess returns true when this get Id not found response has a 2xx status code

func (*GetIDNotFound) String

func (o *GetIDNotFound) String() string

type GetIDOK

type GetIDOK struct {
	Payload *models.Customer
}

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

OK

func NewGetIDOK

func NewGetIDOK() *GetIDOK

NewGetIDOK creates a GetIDOK with default headers values

func (*GetIDOK) Code

func (o *GetIDOK) Code() int

Code gets the status code for the get Id o k response

func (*GetIDOK) Error

func (o *GetIDOK) Error() string

func (*GetIDOK) GetPayload

func (o *GetIDOK) GetPayload() *models.Customer

func (*GetIDOK) IsClientError

func (o *GetIDOK) IsClientError() bool

IsClientError returns true when this get Id o k response has a 4xx status code

func (*GetIDOK) IsCode

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

IsCode returns true when this get Id o k response a status code equal to that given

func (*GetIDOK) IsRedirect

func (o *GetIDOK) IsRedirect() bool

IsRedirect returns true when this get Id o k response has a 3xx status code

func (*GetIDOK) IsServerError

func (o *GetIDOK) IsServerError() bool

IsServerError returns true when this get Id o k response has a 5xx status code

func (*GetIDOK) IsSuccess

func (o *GetIDOK) IsSuccess() bool

IsSuccess returns true when this get Id o k response has a 2xx status code

func (*GetIDOK) String

func (o *GetIDOK) String() string

type GetIDParams

type GetIDParams struct {

	// Info.
	Info *models.SocialID

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

GetIDParams contains all the parameters to send to the API endpoint

for the get Id operation.

Typically these are written to a http.Request.

func NewGetIDParams

func NewGetIDParams() *GetIDParams

NewGetIDParams creates a new GetIDParams 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 NewGetIDParamsWithContext

func NewGetIDParamsWithContext(ctx context.Context) *GetIDParams

NewGetIDParamsWithContext creates a new GetIDParams object with the ability to set a context for a request.

func NewGetIDParamsWithHTTPClient

func NewGetIDParamsWithHTTPClient(client *http.Client) *GetIDParams

NewGetIDParamsWithHTTPClient creates a new GetIDParams object with the ability to set a custom HTTPClient for a request.

func NewGetIDParamsWithTimeout

func NewGetIDParamsWithTimeout(timeout time.Duration) *GetIDParams

NewGetIDParamsWithTimeout creates a new GetIDParams object with the ability to set a timeout on a request.

func (*GetIDParams) SetContext

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

SetContext adds the context to the get Id params

func (*GetIDParams) SetDefaults

func (o *GetIDParams) SetDefaults()

SetDefaults hydrates default values in the get Id params (not the query body).

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

func (*GetIDParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get Id params

func (*GetIDParams) SetInfo

func (o *GetIDParams) SetInfo(info *models.SocialID)

SetInfo adds the info to the get Id params

func (*GetIDParams) SetTimeout

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

SetTimeout adds the timeout to the get Id params

func (*GetIDParams) WithContext

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

WithContext adds the context to the get Id params

func (*GetIDParams) WithDefaults

func (o *GetIDParams) WithDefaults() *GetIDParams

WithDefaults hydrates default values in the get Id params (not the query body).

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

func (*GetIDParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the get Id params

func (*GetIDParams) WithInfo

func (o *GetIDParams) WithInfo(info *models.SocialID) *GetIDParams

WithInfo adds the info to the get Id params

func (*GetIDParams) WithTimeout

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

WithTimeout adds the timeout to the get Id params

func (*GetIDParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type GetIDReader

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

GetIDReader is a Reader for the GetID structure.

func (*GetIDReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type GetIDUnauthorized

type GetIDUnauthorized struct {
	Payload *models.Error
}

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

unauthorized

func NewGetIDUnauthorized

func NewGetIDUnauthorized() *GetIDUnauthorized

NewGetIDUnauthorized creates a GetIDUnauthorized with default headers values

func (*GetIDUnauthorized) Code

func (o *GetIDUnauthorized) Code() int

Code gets the status code for the get Id unauthorized response

func (*GetIDUnauthorized) Error

func (o *GetIDUnauthorized) Error() string

func (*GetIDUnauthorized) GetPayload

func (o *GetIDUnauthorized) GetPayload() *models.Error

func (*GetIDUnauthorized) IsClientError

func (o *GetIDUnauthorized) IsClientError() bool

IsClientError returns true when this get Id unauthorized response has a 4xx status code

func (*GetIDUnauthorized) IsCode

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

IsCode returns true when this get Id unauthorized response a status code equal to that given

func (*GetIDUnauthorized) IsRedirect

func (o *GetIDUnauthorized) IsRedirect() bool

IsRedirect returns true when this get Id unauthorized response has a 3xx status code

func (*GetIDUnauthorized) IsServerError

func (o *GetIDUnauthorized) IsServerError() bool

IsServerError returns true when this get Id unauthorized response has a 5xx status code

func (*GetIDUnauthorized) IsSuccess

func (o *GetIDUnauthorized) IsSuccess() bool

IsSuccess returns true when this get Id unauthorized response has a 2xx status code

func (*GetIDUnauthorized) String

func (o *GetIDUnauthorized) String() string

Jump to

Keyboard shortcuts

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