users

package
v0.0.0-...-d3fc958 Latest Latest
Warning

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

Go to latest
Published: May 2, 2024 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) GetV1Users

func (a *Client) GetV1Users(params *GetV1UsersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetV1UsersOK, error)

GetV1Users lists users

Retrieve a list of all users in an organization

func (*Client) GetV1UsersIDServices

func (a *Client) GetV1UsersIDServices(params *GetV1UsersIDServicesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetV1UsersIDServicesOK, error)

GetV1UsersIDServices retrieves a list of services owned by the teams a user is on

Retrieves a list of services owned by the teams a user is on

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 {
	GetV1Users(params *GetV1UsersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetV1UsersOK, error)

	GetV1UsersIDServices(params *GetV1UsersIDServicesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetV1UsersIDServicesOK, 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 GetV1UsersIDServicesOK

type GetV1UsersIDServicesOK struct {
	Payload []*models.TeamEntityPaginated
}

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

Retrieves a list of services owned by the teams a user is on

func NewGetV1UsersIDServicesOK

func NewGetV1UsersIDServicesOK() *GetV1UsersIDServicesOK

NewGetV1UsersIDServicesOK creates a GetV1UsersIDServicesOK with default headers values

func (*GetV1UsersIDServicesOK) Error

func (o *GetV1UsersIDServicesOK) Error() string

func (*GetV1UsersIDServicesOK) GetPayload

func (*GetV1UsersIDServicesOK) IsClientError

func (o *GetV1UsersIDServicesOK) IsClientError() bool

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

func (*GetV1UsersIDServicesOK) IsCode

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

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

func (*GetV1UsersIDServicesOK) IsRedirect

func (o *GetV1UsersIDServicesOK) IsRedirect() bool

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

func (*GetV1UsersIDServicesOK) IsServerError

func (o *GetV1UsersIDServicesOK) IsServerError() bool

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

func (*GetV1UsersIDServicesOK) IsSuccess

func (o *GetV1UsersIDServicesOK) IsSuccess() bool

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

func (*GetV1UsersIDServicesOK) String

func (o *GetV1UsersIDServicesOK) String() string

type GetV1UsersIDServicesParams

type GetV1UsersIDServicesParams struct {

	// ID.
	//
	// Format: int32
	ID int32

	// Page.
	//
	// Format: int32
	Page *int32

	// PerPage.
	//
	// Format: int32
	PerPage *int32

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

GetV1UsersIDServicesParams contains all the parameters to send to the API endpoint

for the get v1 users Id services operation.

Typically these are written to a http.Request.

func NewGetV1UsersIDServicesParams

func NewGetV1UsersIDServicesParams() *GetV1UsersIDServicesParams

NewGetV1UsersIDServicesParams creates a new GetV1UsersIDServicesParams 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 NewGetV1UsersIDServicesParamsWithContext

func NewGetV1UsersIDServicesParamsWithContext(ctx context.Context) *GetV1UsersIDServicesParams

NewGetV1UsersIDServicesParamsWithContext creates a new GetV1UsersIDServicesParams object with the ability to set a context for a request.

func NewGetV1UsersIDServicesParamsWithHTTPClient

func NewGetV1UsersIDServicesParamsWithHTTPClient(client *http.Client) *GetV1UsersIDServicesParams

NewGetV1UsersIDServicesParamsWithHTTPClient creates a new GetV1UsersIDServicesParams object with the ability to set a custom HTTPClient for a request.

func NewGetV1UsersIDServicesParamsWithTimeout

func NewGetV1UsersIDServicesParamsWithTimeout(timeout time.Duration) *GetV1UsersIDServicesParams

NewGetV1UsersIDServicesParamsWithTimeout creates a new GetV1UsersIDServicesParams object with the ability to set a timeout on a request.

func (*GetV1UsersIDServicesParams) SetContext

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

SetContext adds the context to the get v1 users Id services params

func (*GetV1UsersIDServicesParams) SetDefaults

func (o *GetV1UsersIDServicesParams) SetDefaults()

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

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

func (*GetV1UsersIDServicesParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get v1 users Id services params

func (*GetV1UsersIDServicesParams) SetID

func (o *GetV1UsersIDServicesParams) SetID(id int32)

SetID adds the id to the get v1 users Id services params

func (*GetV1UsersIDServicesParams) SetPage

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

SetPage adds the page to the get v1 users Id services params

func (*GetV1UsersIDServicesParams) SetPerPage

func (o *GetV1UsersIDServicesParams) SetPerPage(perPage *int32)

SetPerPage adds the perPage to the get v1 users Id services params

func (*GetV1UsersIDServicesParams) SetTimeout

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

SetTimeout adds the timeout to the get v1 users Id services params

func (*GetV1UsersIDServicesParams) WithContext

WithContext adds the context to the get v1 users Id services params

func (*GetV1UsersIDServicesParams) WithDefaults

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

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

func (*GetV1UsersIDServicesParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the get v1 users Id services params

func (*GetV1UsersIDServicesParams) WithID

WithID adds the id to the get v1 users Id services params

func (*GetV1UsersIDServicesParams) WithPage

WithPage adds the page to the get v1 users Id services params

func (*GetV1UsersIDServicesParams) WithPerPage

WithPerPage adds the perPage to the get v1 users Id services params

func (*GetV1UsersIDServicesParams) WithTimeout

WithTimeout adds the timeout to the get v1 users Id services params

func (*GetV1UsersIDServicesParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type GetV1UsersIDServicesReader

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

GetV1UsersIDServicesReader is a Reader for the GetV1UsersIDServices structure.

func (*GetV1UsersIDServicesReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type GetV1UsersOK

type GetV1UsersOK struct {
	Payload *models.UserEntityPaginated
}

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

Retrieve a list of all users in an organization

func NewGetV1UsersOK

func NewGetV1UsersOK() *GetV1UsersOK

NewGetV1UsersOK creates a GetV1UsersOK with default headers values

func (*GetV1UsersOK) Error

func (o *GetV1UsersOK) Error() string

func (*GetV1UsersOK) GetPayload

func (o *GetV1UsersOK) GetPayload() *models.UserEntityPaginated

func (*GetV1UsersOK) IsClientError

func (o *GetV1UsersOK) IsClientError() bool

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

func (*GetV1UsersOK) IsCode

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

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

func (*GetV1UsersOK) IsRedirect

func (o *GetV1UsersOK) IsRedirect() bool

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

func (*GetV1UsersOK) IsServerError

func (o *GetV1UsersOK) IsServerError() bool

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

func (*GetV1UsersOK) IsSuccess

func (o *GetV1UsersOK) IsSuccess() bool

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

func (*GetV1UsersOK) String

func (o *GetV1UsersOK) String() string

type GetV1UsersParams

type GetV1UsersParams struct {

	/* Name.

	   Text string of a query to filter users by name
	*/
	Name *string

	// Page.
	//
	// Format: int32
	Page *int32

	// PerPage.
	//
	// Format: int32
	PerPage *int32

	/* Query.

	   Text string of a query to filter users by name or email
	*/
	Query *string

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

GetV1UsersParams contains all the parameters to send to the API endpoint

for the get v1 users operation.

Typically these are written to a http.Request.

func NewGetV1UsersParams

func NewGetV1UsersParams() *GetV1UsersParams

NewGetV1UsersParams creates a new GetV1UsersParams 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 NewGetV1UsersParamsWithContext

func NewGetV1UsersParamsWithContext(ctx context.Context) *GetV1UsersParams

NewGetV1UsersParamsWithContext creates a new GetV1UsersParams object with the ability to set a context for a request.

func NewGetV1UsersParamsWithHTTPClient

func NewGetV1UsersParamsWithHTTPClient(client *http.Client) *GetV1UsersParams

NewGetV1UsersParamsWithHTTPClient creates a new GetV1UsersParams object with the ability to set a custom HTTPClient for a request.

func NewGetV1UsersParamsWithTimeout

func NewGetV1UsersParamsWithTimeout(timeout time.Duration) *GetV1UsersParams

NewGetV1UsersParamsWithTimeout creates a new GetV1UsersParams object with the ability to set a timeout on a request.

func (*GetV1UsersParams) SetContext

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

SetContext adds the context to the get v1 users params

func (*GetV1UsersParams) SetDefaults

func (o *GetV1UsersParams) SetDefaults()

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

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

func (*GetV1UsersParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get v1 users params

func (*GetV1UsersParams) SetName

func (o *GetV1UsersParams) SetName(name *string)

SetName adds the name to the get v1 users params

func (*GetV1UsersParams) SetPage

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

SetPage adds the page to the get v1 users params

func (*GetV1UsersParams) SetPerPage

func (o *GetV1UsersParams) SetPerPage(perPage *int32)

SetPerPage adds the perPage to the get v1 users params

func (*GetV1UsersParams) SetQuery

func (o *GetV1UsersParams) SetQuery(query *string)

SetQuery adds the query to the get v1 users params

func (*GetV1UsersParams) SetTimeout

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

SetTimeout adds the timeout to the get v1 users params

func (*GetV1UsersParams) WithContext

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

WithContext adds the context to the get v1 users params

func (*GetV1UsersParams) WithDefaults

func (o *GetV1UsersParams) WithDefaults() *GetV1UsersParams

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

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

func (*GetV1UsersParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the get v1 users params

func (*GetV1UsersParams) WithName

func (o *GetV1UsersParams) WithName(name *string) *GetV1UsersParams

WithName adds the name to the get v1 users params

func (*GetV1UsersParams) WithPage

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

WithPage adds the page to the get v1 users params

func (*GetV1UsersParams) WithPerPage

func (o *GetV1UsersParams) WithPerPage(perPage *int32) *GetV1UsersParams

WithPerPage adds the perPage to the get v1 users params

func (*GetV1UsersParams) WithQuery

func (o *GetV1UsersParams) WithQuery(query *string) *GetV1UsersParams

WithQuery adds the query to the get v1 users params

func (*GetV1UsersParams) WithTimeout

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

WithTimeout adds the timeout to the get v1 users params

func (*GetV1UsersParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type GetV1UsersReader

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

GetV1UsersReader is a Reader for the GetV1Users structure.

func (*GetV1UsersReader) ReadResponse

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

ReadResponse reads a server response into the received o.

Jump to

Keyboard shortcuts

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