users

package
v0.0.0-...-417219d Latest Latest
Warning

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

 Go to latest Published: Jan 25, 2024 License: MIT Imports: 11 Imported by: 1

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 users API

func (*Client) GetUser 

func (a *Client) GetUser(params *GetUserParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetUserOK, error)

GetUser Return a specific User.

func (*Client) GetUsers 

func (a *Client) GetUsers(params *GetUsersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetUsersOK, error)

GetUsers Return all Users that the current API token has access to.

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 {
	GetUser(params *GetUserParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetUserOK, error)

	GetUsers(params *GetUsersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetUsersOK, 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 users API client.

type GetUserNotFound 

type GetUserNotFound struct {
	Payload *models.Errors
}

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

NotFound

func NewGetUserNotFound 

func NewGetUserNotFound() *GetUserNotFound

NewGetUserNotFound creates a GetUserNotFound with default headers values

func (*GetUserNotFound) Code 

func (o *GetUserNotFound) Code() int

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

func (*GetUserNotFound) Error 

func (o *GetUserNotFound) Error() string

func (*GetUserNotFound) GetPayload 

func (o *GetUserNotFound) GetPayload() *models.Errors

func (*GetUserNotFound) IsClientError 

func (o *GetUserNotFound) IsClientError() bool

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

func (*GetUserNotFound) IsCode 

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

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

func (*GetUserNotFound) IsRedirect 

func (o *GetUserNotFound) IsRedirect() bool

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

func (*GetUserNotFound) IsServerError 

func (o *GetUserNotFound) IsServerError() bool

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

func (*GetUserNotFound) IsSuccess 

func (o *GetUserNotFound) IsSuccess() bool

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

func (*GetUserNotFound) String 

func (o *GetUserNotFound) String() string

type GetUserOK 

type GetUserOK struct {
	Payload *models.User
}

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

GetUserOK get user o k

func NewGetUserOK 

func NewGetUserOK() *GetUserOK

NewGetUserOK creates a GetUserOK with default headers values

func (*GetUserOK) Code 

func (o *GetUserOK) Code() int

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

func (*GetUserOK) Error 

func (o *GetUserOK) Error() string

func (*GetUserOK) GetPayload 

func (o *GetUserOK) GetPayload() *models.User

func (*GetUserOK) IsClientError 

func (o *GetUserOK) IsClientError() bool

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

func (*GetUserOK) IsCode 

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

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

func (*GetUserOK) IsRedirect 

func (o *GetUserOK) IsRedirect() bool

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

func (*GetUserOK) IsServerError 

func (o *GetUserOK) IsServerError() bool

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

func (*GetUserOK) IsSuccess 

func (o *GetUserOK) IsSuccess() bool

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

func (*GetUserOK) String 

func (o *GetUserOK) String() string

type GetUserParams 

type GetUserParams struct {

	// UserToken.
	UserToken string

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

GetUserParams contains all the parameters to send to the API endpoint 

for the get user operation.

Typically these are written to a http.Request.

func NewGetUserParams 

func NewGetUserParams() *GetUserParams

NewGetUserParams creates a new GetUserParams 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 NewGetUserParamsWithContext 

func NewGetUserParamsWithContext(ctx context.Context) *GetUserParams

NewGetUserParamsWithContext creates a new GetUserParams object with the ability to set a context for a request.

func NewGetUserParamsWithHTTPClient 

func NewGetUserParamsWithHTTPClient(client *http.Client) *GetUserParams

NewGetUserParamsWithHTTPClient creates a new GetUserParams object with the ability to set a custom HTTPClient for a request.

func NewGetUserParamsWithTimeout 

func NewGetUserParamsWithTimeout(timeout time.Duration) *GetUserParams

NewGetUserParamsWithTimeout creates a new GetUserParams object with the ability to set a timeout on a request.

func (*GetUserParams) SetContext 

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

SetContext adds the context to the get user params

func (*GetUserParams) SetDefaults 

func (o *GetUserParams) SetDefaults()

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

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

func (*GetUserParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get user params

func (*GetUserParams) SetTimeout 

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

SetTimeout adds the timeout to the get user params

func (*GetUserParams) SetUserToken 

func (o *GetUserParams) SetUserToken(userToken string)

SetUserToken adds the userToken to the get user params

func (*GetUserParams) WithContext 

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

WithContext adds the context to the get user params

func (*GetUserParams) WithDefaults 

func (o *GetUserParams) WithDefaults() *GetUserParams

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

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

func (*GetUserParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get user params

func (*GetUserParams) WithTimeout 

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

WithTimeout adds the timeout to the get user params

func (*GetUserParams) WithUserToken 

func (o *GetUserParams) WithUserToken(userToken string) *GetUserParams

WithUserToken adds the userToken to the get user params

func (*GetUserParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetUserReader 

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

GetUserReader is a Reader for the GetUser structure.

func (*GetUserReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type GetUsersForbidden 

type GetUsersForbidden struct {
	Payload *models.Errors
}

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

Forbidden

func NewGetUsersForbidden 

func NewGetUsersForbidden() *GetUsersForbidden

NewGetUsersForbidden creates a GetUsersForbidden with default headers values

func (*GetUsersForbidden) Code 

func (o *GetUsersForbidden) Code() int

Code gets the status code for the get users forbidden response

func (*GetUsersForbidden) Error 

func (o *GetUsersForbidden) Error() string

func (*GetUsersForbidden) GetPayload 

func (o *GetUsersForbidden) GetPayload() *models.Errors

func (*GetUsersForbidden) IsClientError 

func (o *GetUsersForbidden) IsClientError() bool

IsClientError returns true when this get users forbidden response has a 4xx status code

func (*GetUsersForbidden) IsCode 

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

IsCode returns true when this get users forbidden response a status code equal to that given

func (*GetUsersForbidden) IsRedirect 

func (o *GetUsersForbidden) IsRedirect() bool

IsRedirect returns true when this get users forbidden response has a 3xx status code

func (*GetUsersForbidden) IsServerError 

func (o *GetUsersForbidden) IsServerError() bool

IsServerError returns true when this get users forbidden response has a 5xx status code

func (*GetUsersForbidden) IsSuccess 

func (o *GetUsersForbidden) IsSuccess() bool

IsSuccess returns true when this get users forbidden response has a 2xx status code

func (*GetUsersForbidden) String 

func (o *GetUsersForbidden) String() string

type GetUsersOK 

type GetUsersOK struct {
	Payload *models.Users
}

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

GetUsersOK get users o k

func NewGetUsersOK 

func NewGetUsersOK() *GetUsersOK

NewGetUsersOK creates a GetUsersOK with default headers values

func (*GetUsersOK) Code 

func (o *GetUsersOK) Code() int

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

func (*GetUsersOK) Error 

func (o *GetUsersOK) Error() string

func (*GetUsersOK) GetPayload 

func (o *GetUsersOK) GetPayload() *models.Users

func (*GetUsersOK) IsClientError 

func (o *GetUsersOK) IsClientError() bool

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

func (*GetUsersOK) IsCode 

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

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

func (*GetUsersOK) IsRedirect 

func (o *GetUsersOK) IsRedirect() bool

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

func (*GetUsersOK) IsServerError 

func (o *GetUsersOK) IsServerError() bool

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

func (*GetUsersOK) IsSuccess 

func (o *GetUsersOK) IsSuccess() bool

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

func (*GetUsersOK) String 

func (o *GetUsersOK) String() string

type GetUsersParams 

type GetUsersParams struct {

	/* Limit.

	   The amount of results to return. The maximum is 1000.

	   Format: int32
	*/
	Limit *int32

	/* Page.

	   The page of results to return.

	   Format: int32
	*/
	Page *int32

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

GetUsersParams contains all the parameters to send to the API endpoint 

for the get users operation.

Typically these are written to a http.Request.

func NewGetUsersParams 

func NewGetUsersParams() *GetUsersParams

NewGetUsersParams creates a new GetUsersParams 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 NewGetUsersParamsWithContext 

func NewGetUsersParamsWithContext(ctx context.Context) *GetUsersParams

NewGetUsersParamsWithContext creates a new GetUsersParams object with the ability to set a context for a request.

func NewGetUsersParamsWithHTTPClient 

func NewGetUsersParamsWithHTTPClient(client *http.Client) *GetUsersParams

NewGetUsersParamsWithHTTPClient creates a new GetUsersParams object with the ability to set a custom HTTPClient for a request.

func NewGetUsersParamsWithTimeout 

func NewGetUsersParamsWithTimeout(timeout time.Duration) *GetUsersParams

NewGetUsersParamsWithTimeout creates a new GetUsersParams object with the ability to set a timeout on a request.

func (*GetUsersParams) SetContext 

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

SetContext adds the context to the get users params

func (*GetUsersParams) SetDefaults 

func (o *GetUsersParams) SetDefaults()

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

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

func (*GetUsersParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get users params

func (*GetUsersParams) SetLimit 

func (o *GetUsersParams) SetLimit(limit *int32)

SetLimit adds the limit to the get users params

func (*GetUsersParams) SetPage 

func (o *GetUsersParams) SetPage(page *int32)

SetPage adds the page to the get users params

func (*GetUsersParams) SetTimeout 

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

SetTimeout adds the timeout to the get users params

func (*GetUsersParams) WithContext 

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

WithContext adds the context to the get users params

func (*GetUsersParams) WithDefaults 

func (o *GetUsersParams) WithDefaults() *GetUsersParams

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

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

func (*GetUsersParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get users params

func (*GetUsersParams) WithLimit 

func (o *GetUsersParams) WithLimit(limit *int32) *GetUsersParams

WithLimit adds the limit to the get users params

func (*GetUsersParams) WithPage 

func (o *GetUsersParams) WithPage(page *int32) *GetUsersParams

WithPage adds the page to the get users params

func (*GetUsersParams) WithTimeout 

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

WithTimeout adds the timeout to the get users params

func (*GetUsersParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetUsersReader 

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

GetUsersReader is a Reader for the GetUsers structure.

func (*GetUsersReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

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.