users

package
v0.19.2 Latest Latest
Warning

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

Go to latest
Published: Jun 3, 2022 License: MIT 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 users API

func (*Client) GetUserByID

func (a *Client) GetUserByID(params *GetUserByIDParams, authInfo runtime.ClientAuthInfoWriter) (*GetUserByIDOK, error)

GetUserByID fetches a user by id

Fetch a user by id.

func (*Client) ListUsers

func (a *Client) ListUsers(params *ListUsersParams, authInfo runtime.ClientAuthInfoWriter) (*ListUsersOK, error)

ListUsers lists details for all users

List details for all users.

func (*Client) SetTransport

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

SetTransport changes the transport on the client

type ClientService

type ClientService interface {
	GetUserByID(params *GetUserByIDParams, authInfo runtime.ClientAuthInfoWriter) (*GetUserByIDOK, error)

	ListUsers(params *ListUsersParams, authInfo runtime.ClientAuthInfoWriter) (*ListUsersOK, 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 GetUserByEmailBadRequest

type GetUserByEmailBadRequest struct {
	Payload *models.BadRequestError
}

GetUserByEmailBadRequest handles this case with default header values.

Bad request error.

func NewGetUserByEmailBadRequest

func NewGetUserByEmailBadRequest() *GetUserByEmailBadRequest

NewGetUserByEmailBadRequest creates a GetUserByEmailBadRequest with default headers values

func (*GetUserByEmailBadRequest) Error

func (o *GetUserByEmailBadRequest) Error() string

func (*GetUserByEmailBadRequest) GetPayload

type GetUserByEmailForbidden

type GetUserByEmailForbidden struct {
	Payload *models.AuthorizationError
}

GetUserByEmailForbidden handles this case with default header values.

Authorization error.

func NewGetUserByEmailForbidden

func NewGetUserByEmailForbidden() *GetUserByEmailForbidden

NewGetUserByEmailForbidden creates a GetUserByEmailForbidden with default headers values

func (*GetUserByEmailForbidden) Error

func (o *GetUserByEmailForbidden) Error() string

func (*GetUserByEmailForbidden) GetPayload

type GetUserByEmailInternalServerError

type GetUserByEmailInternalServerError struct {
	Payload *models.InternalServerError
}

GetUserByEmailInternalServerError handles this case with default header values.

Internal server error.

func NewGetUserByEmailInternalServerError

func NewGetUserByEmailInternalServerError() *GetUserByEmailInternalServerError

NewGetUserByEmailInternalServerError creates a GetUserByEmailInternalServerError with default headers values

func (*GetUserByEmailInternalServerError) Error

func (*GetUserByEmailInternalServerError) GetPayload

type GetUserByEmailNotFound

type GetUserByEmailNotFound struct {
	Payload *models.NotFoundError
}

GetUserByEmailNotFound handles this case with default header values.

Not found error.

func NewGetUserByEmailNotFound

func NewGetUserByEmailNotFound() *GetUserByEmailNotFound

NewGetUserByEmailNotFound creates a GetUserByEmailNotFound with default headers values

func (*GetUserByEmailNotFound) Error

func (o *GetUserByEmailNotFound) Error() string

func (*GetUserByEmailNotFound) GetPayload

func (o *GetUserByEmailNotFound) GetPayload() *models.NotFoundError

type GetUserByEmailOK

type GetUserByEmailOK struct {
	Payload *models.User
}

GetUserByEmailOK handles this case with default header values.

User details.

func NewGetUserByEmailOK

func NewGetUserByEmailOK() *GetUserByEmailOK

NewGetUserByEmailOK creates a GetUserByEmailOK with default headers values

func (*GetUserByEmailOK) Error

func (o *GetUserByEmailOK) Error() string

func (*GetUserByEmailOK) GetPayload

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

type GetUserByEmailParams

type GetUserByEmailParams struct {

	/*Email
	  email address of the user

	*/
	Email string

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

GetUserByEmailParams contains all the parameters to send to the API endpoint for the get user by email operation typically these are written to a http.Request

func NewGetUserByEmailParams

func NewGetUserByEmailParams() *GetUserByEmailParams

NewGetUserByEmailParams creates a new GetUserByEmailParams object with the default values initialized.

func NewGetUserByEmailParamsWithContext

func NewGetUserByEmailParamsWithContext(ctx context.Context) *GetUserByEmailParams

NewGetUserByEmailParamsWithContext creates a new GetUserByEmailParams object with the default values initialized, and the ability to set a context for a request

func NewGetUserByEmailParamsWithHTTPClient

func NewGetUserByEmailParamsWithHTTPClient(client *http.Client) *GetUserByEmailParams

NewGetUserByEmailParamsWithHTTPClient creates a new GetUserByEmailParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewGetUserByEmailParamsWithTimeout

func NewGetUserByEmailParamsWithTimeout(timeout time.Duration) *GetUserByEmailParams

NewGetUserByEmailParamsWithTimeout creates a new GetUserByEmailParams object with the default values initialized, and the ability to set a timeout on a request

func (*GetUserByEmailParams) SetContext

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

SetContext adds the context to the get user by email params

func (*GetUserByEmailParams) SetEmail

func (o *GetUserByEmailParams) SetEmail(email string)

SetEmail adds the email to the get user by email params

func (*GetUserByEmailParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get user by email params

func (*GetUserByEmailParams) SetTimeout

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

SetTimeout adds the timeout to the get user by email params

func (*GetUserByEmailParams) WithContext

WithContext adds the context to the get user by email params

func (*GetUserByEmailParams) WithEmail

func (o *GetUserByEmailParams) WithEmail(email string) *GetUserByEmailParams

WithEmail adds the email to the get user by email params

func (*GetUserByEmailParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the get user by email params

func (*GetUserByEmailParams) WithTimeout

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

WithTimeout adds the timeout to the get user by email params

func (*GetUserByEmailParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type GetUserByEmailReader

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

GetUserByEmailReader is a Reader for the GetUserByEmail structure.

func (*GetUserByEmailReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type GetUserByEmailUnauthorized

type GetUserByEmailUnauthorized struct {
	Payload *models.AuthenticationError
}

GetUserByEmailUnauthorized handles this case with default header values.

Authentication error.

func NewGetUserByEmailUnauthorized

func NewGetUserByEmailUnauthorized() *GetUserByEmailUnauthorized

NewGetUserByEmailUnauthorized creates a GetUserByEmailUnauthorized with default headers values

func (*GetUserByEmailUnauthorized) Error

func (*GetUserByEmailUnauthorized) GetPayload

type GetUserByIDBadRequest

type GetUserByIDBadRequest struct {
	Payload *models.BadRequestError
}

GetUserByIDBadRequest handles this case with default header values.

BadRequestError

func NewGetUserByIDBadRequest

func NewGetUserByIDBadRequest() *GetUserByIDBadRequest

NewGetUserByIDBadRequest creates a GetUserByIDBadRequest with default headers values

func (*GetUserByIDBadRequest) Error

func (o *GetUserByIDBadRequest) Error() string

func (*GetUserByIDBadRequest) GetPayload

func (o *GetUserByIDBadRequest) GetPayload() *models.BadRequestError

type GetUserByIDForbidden

type GetUserByIDForbidden struct {
	Payload *models.AuthorizationError
}

GetUserByIDForbidden handles this case with default header values.

AuthorizationError

func NewGetUserByIDForbidden

func NewGetUserByIDForbidden() *GetUserByIDForbidden

NewGetUserByIDForbidden creates a GetUserByIDForbidden with default headers values

func (*GetUserByIDForbidden) Error

func (o *GetUserByIDForbidden) Error() string

func (*GetUserByIDForbidden) GetPayload

type GetUserByIDInternalServerError

type GetUserByIDInternalServerError struct {
	Payload *models.InternalServerError
}

GetUserByIDInternalServerError handles this case with default header values.

InternalServerError

func NewGetUserByIDInternalServerError

func NewGetUserByIDInternalServerError() *GetUserByIDInternalServerError

NewGetUserByIDInternalServerError creates a GetUserByIDInternalServerError with default headers values

func (*GetUserByIDInternalServerError) Error

func (*GetUserByIDInternalServerError) GetPayload

type GetUserByIDNotFound

type GetUserByIDNotFound struct {
	Payload *models.NotFoundError
}

GetUserByIDNotFound handles this case with default header values.

NotFoundError

func NewGetUserByIDNotFound

func NewGetUserByIDNotFound() *GetUserByIDNotFound

NewGetUserByIDNotFound creates a GetUserByIDNotFound with default headers values

func (*GetUserByIDNotFound) Error

func (o *GetUserByIDNotFound) Error() string

func (*GetUserByIDNotFound) GetPayload

func (o *GetUserByIDNotFound) GetPayload() *models.NotFoundError

type GetUserByIDOK

type GetUserByIDOK struct {
	Payload *models.User
}

GetUserByIDOK handles this case with default header values.

User details.

func NewGetUserByIDOK

func NewGetUserByIDOK() *GetUserByIDOK

NewGetUserByIDOK creates a GetUserByIDOK with default headers values

func (*GetUserByIDOK) Error

func (o *GetUserByIDOK) Error() string

func (*GetUserByIDOK) GetPayload

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

type GetUserByIDParams

type GetUserByIDParams struct {

	/*UserID
	  id of the user

	*/
	UserID string

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

GetUserByIDParams contains all the parameters to send to the API endpoint for the get user by Id operation typically these are written to a http.Request

func NewGetUserByIDParams

func NewGetUserByIDParams() *GetUserByIDParams

NewGetUserByIDParams creates a new GetUserByIDParams object with the default values initialized.

func NewGetUserByIDParamsWithContext

func NewGetUserByIDParamsWithContext(ctx context.Context) *GetUserByIDParams

NewGetUserByIDParamsWithContext creates a new GetUserByIDParams object with the default values initialized, and the ability to set a context for a request

func NewGetUserByIDParamsWithHTTPClient

func NewGetUserByIDParamsWithHTTPClient(client *http.Client) *GetUserByIDParams

NewGetUserByIDParamsWithHTTPClient creates a new GetUserByIDParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewGetUserByIDParamsWithTimeout

func NewGetUserByIDParamsWithTimeout(timeout time.Duration) *GetUserByIDParams

NewGetUserByIDParamsWithTimeout creates a new GetUserByIDParams object with the default values initialized, and the ability to set a timeout on a request

func (*GetUserByIDParams) SetContext

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

SetContext adds the context to the get user by Id params

func (*GetUserByIDParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get user by Id params

func (*GetUserByIDParams) SetTimeout

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

SetTimeout adds the timeout to the get user by Id params

func (*GetUserByIDParams) SetUserID

func (o *GetUserByIDParams) SetUserID(userID string)

SetUserID adds the userId to the get user by Id params

func (*GetUserByIDParams) WithContext

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

WithContext adds the context to the get user by Id params

func (*GetUserByIDParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the get user by Id params

func (*GetUserByIDParams) WithTimeout

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

WithTimeout adds the timeout to the get user by Id params

func (*GetUserByIDParams) WithUserID

func (o *GetUserByIDParams) WithUserID(userID string) *GetUserByIDParams

WithUserID adds the userID to the get user by Id params

func (*GetUserByIDParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type GetUserByIDReader

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

GetUserByIDReader is a Reader for the GetUserByID structure.

func (*GetUserByIDReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type GetUserByIDUnauthorized

type GetUserByIDUnauthorized struct {
	Payload *models.AuthenticationError
}

GetUserByIDUnauthorized handles this case with default header values.

AuthenticationError

func NewGetUserByIDUnauthorized

func NewGetUserByIDUnauthorized() *GetUserByIDUnauthorized

NewGetUserByIDUnauthorized creates a GetUserByIDUnauthorized with default headers values

func (*GetUserByIDUnauthorized) Error

func (o *GetUserByIDUnauthorized) Error() string

func (*GetUserByIDUnauthorized) GetPayload

type ListUsersBadRequest

type ListUsersBadRequest struct {
	Payload *models.BadRequestError
}

ListUsersBadRequest handles this case with default header values.

BadRequestError

func NewListUsersBadRequest

func NewListUsersBadRequest() *ListUsersBadRequest

NewListUsersBadRequest creates a ListUsersBadRequest with default headers values

func (*ListUsersBadRequest) Error

func (o *ListUsersBadRequest) Error() string

func (*ListUsersBadRequest) GetPayload

func (o *ListUsersBadRequest) GetPayload() *models.BadRequestError

type ListUsersForbidden

type ListUsersForbidden struct {
	Payload *models.AuthorizationError
}

ListUsersForbidden handles this case with default header values.

AuthorizationError

func NewListUsersForbidden

func NewListUsersForbidden() *ListUsersForbidden

NewListUsersForbidden creates a ListUsersForbidden with default headers values

func (*ListUsersForbidden) Error

func (o *ListUsersForbidden) Error() string

func (*ListUsersForbidden) GetPayload

func (o *ListUsersForbidden) GetPayload() *models.AuthorizationError

type ListUsersInternalServerError

type ListUsersInternalServerError struct {
	Payload *models.InternalServerError
}

ListUsersInternalServerError handles this case with default header values.

InternalServerError

func NewListUsersInternalServerError

func NewListUsersInternalServerError() *ListUsersInternalServerError

NewListUsersInternalServerError creates a ListUsersInternalServerError with default headers values

func (*ListUsersInternalServerError) Error

func (*ListUsersInternalServerError) GetPayload

type ListUsersNotFound

type ListUsersNotFound struct {
	Payload *models.NotFoundError
}

ListUsersNotFound handles this case with default header values.

NotFoundError

func NewListUsersNotFound

func NewListUsersNotFound() *ListUsersNotFound

NewListUsersNotFound creates a ListUsersNotFound with default headers values

func (*ListUsersNotFound) Error

func (o *ListUsersNotFound) Error() string

func (*ListUsersNotFound) GetPayload

func (o *ListUsersNotFound) GetPayload() *models.NotFoundError

type ListUsersOK

type ListUsersOK struct {
	Payload *models.Users
}

ListUsersOK handles this case with default header values.

User details.

func NewListUsersOK

func NewListUsersOK() *ListUsersOK

NewListUsersOK creates a ListUsersOK with default headers values

func (*ListUsersOK) Error

func (o *ListUsersOK) Error() string

func (*ListUsersOK) GetPayload

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

type ListUsersParams

type ListUsersParams struct {

	/*Email
	  Used to filter list to a single invite by email.

	*/
	Email *string
	/*MaxItems
	  Maximum number of items to return.

	*/
	MaxItems *int64
	/*Offset
	  Number of items to skip before returning. This parameter is used when the number of items spans multiple pages.

	*/
	Offset *int64
	/*OrderDirection
	  Direction to sort the items in.

	*/
	OrderDirection *string

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

ListUsersParams contains all the parameters to send to the API endpoint for the list users operation typically these are written to a http.Request

func NewListUsersParams

func NewListUsersParams() *ListUsersParams

NewListUsersParams creates a new ListUsersParams object with the default values initialized.

func NewListUsersParamsWithContext

func NewListUsersParamsWithContext(ctx context.Context) *ListUsersParams

NewListUsersParamsWithContext creates a new ListUsersParams object with the default values initialized, and the ability to set a context for a request

func NewListUsersParamsWithHTTPClient

func NewListUsersParamsWithHTTPClient(client *http.Client) *ListUsersParams

NewListUsersParamsWithHTTPClient creates a new ListUsersParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewListUsersParamsWithTimeout

func NewListUsersParamsWithTimeout(timeout time.Duration) *ListUsersParams

NewListUsersParamsWithTimeout creates a new ListUsersParams object with the default values initialized, and the ability to set a timeout on a request

func (*ListUsersParams) SetContext

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

SetContext adds the context to the list users params

func (*ListUsersParams) SetEmail

func (o *ListUsersParams) SetEmail(email *string)

SetEmail adds the email to the list users params

func (*ListUsersParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the list users params

func (*ListUsersParams) SetMaxItems

func (o *ListUsersParams) SetMaxItems(maxItems *int64)

SetMaxItems adds the maxItems to the list users params

func (*ListUsersParams) SetOffset

func (o *ListUsersParams) SetOffset(offset *int64)

SetOffset adds the offset to the list users params

func (*ListUsersParams) SetOrderDirection

func (o *ListUsersParams) SetOrderDirection(orderDirection *string)

SetOrderDirection adds the orderDirection to the list users params

func (*ListUsersParams) SetTimeout

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

SetTimeout adds the timeout to the list users params

func (*ListUsersParams) WithContext

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

WithContext adds the context to the list users params

func (*ListUsersParams) WithEmail

func (o *ListUsersParams) WithEmail(email *string) *ListUsersParams

WithEmail adds the email to the list users params

func (*ListUsersParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the list users params

func (*ListUsersParams) WithMaxItems

func (o *ListUsersParams) WithMaxItems(maxItems *int64) *ListUsersParams

WithMaxItems adds the maxItems to the list users params

func (*ListUsersParams) WithOffset

func (o *ListUsersParams) WithOffset(offset *int64) *ListUsersParams

WithOffset adds the offset to the list users params

func (*ListUsersParams) WithOrderDirection

func (o *ListUsersParams) WithOrderDirection(orderDirection *string) *ListUsersParams

WithOrderDirection adds the orderDirection to the list users params

func (*ListUsersParams) WithTimeout

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

WithTimeout adds the timeout to the list users params

func (*ListUsersParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type ListUsersReader

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

ListUsersReader is a Reader for the ListUsers structure.

func (*ListUsersReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type ListUsersUnauthorized

type ListUsersUnauthorized struct {
	Payload *models.AuthenticationError
}

ListUsersUnauthorized handles this case with default header values.

AuthenticationError

func NewListUsersUnauthorized

func NewListUsersUnauthorized() *ListUsersUnauthorized

NewListUsersUnauthorized creates a ListUsersUnauthorized with default headers values

func (*ListUsersUnauthorized) Error

func (o *ListUsersUnauthorized) Error() string

func (*ListUsersUnauthorized) GetPayload

Jump to

Keyboard shortcuts

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