user_preferences

package
v0.0.0-...-d4d7cce Latest Latest
Warning

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

 Go to latest Published: Nov 22, 2023 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 user preferences API

func (*Client) GetUserPreferences 

func (a *Client) GetUserPreferences(params *GetUserPreferencesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetUserPreferencesOK, error)

GetUserPreferences gets user preferences

func (*Client) PatchUserPreferences 

func (a *Client) PatchUserPreferences(params *PatchUserPreferencesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PatchUserPreferencesOK, error)

PatchUserPreferences patches user preferences

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

func (*Client) UpdateUserPreferences 

func (a *Client) UpdateUserPreferences(params *UpdateUserPreferencesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UpdateUserPreferencesOK, error)

UpdateUserPreferences updates user preferences

Omitting a key (`theme`, `homeDashboardId`, `timezone`) will cause the current value to be replaced with the system default value.

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService 

type ClientService interface {
	GetUserPreferences(params *GetUserPreferencesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetUserPreferencesOK, error)

	PatchUserPreferences(params *PatchUserPreferencesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PatchUserPreferencesOK, error)

	UpdateUserPreferences(params *UpdateUserPreferencesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UpdateUserPreferencesOK, 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 user preferences API client.

type GetUserPreferencesInternalServerError 

type GetUserPreferencesInternalServerError struct {
	Payload *models.ErrorResponseBody
}

GetUserPreferencesInternalServerError describes a response with status code 500, with default header values.

InternalServerError is a general error indicating something went wrong internally.

func NewGetUserPreferencesInternalServerError 

func NewGetUserPreferencesInternalServerError() *GetUserPreferencesInternalServerError

NewGetUserPreferencesInternalServerError creates a GetUserPreferencesInternalServerError with default headers values

func (*GetUserPreferencesInternalServerError) Error 

func (o *GetUserPreferencesInternalServerError) Error() string

func (*GetUserPreferencesInternalServerError) GetPayload 

func (o *GetUserPreferencesInternalServerError) GetPayload() *models.ErrorResponseBody

type GetUserPreferencesOK 

type GetUserPreferencesOK struct {
	Payload *models.Spec
}

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

(empty)

func NewGetUserPreferencesOK 

func NewGetUserPreferencesOK() *GetUserPreferencesOK

NewGetUserPreferencesOK creates a GetUserPreferencesOK with default headers values

func (*GetUserPreferencesOK) Error 

func (o *GetUserPreferencesOK) Error() string

func (*GetUserPreferencesOK) GetPayload 

func (o *GetUserPreferencesOK) GetPayload() *models.Spec

type GetUserPreferencesParams 

type GetUserPreferencesParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetUserPreferencesParams contains all the parameters to send to the API endpoint 

for the get user preferences operation.

Typically these are written to a http.Request.

func NewGetUserPreferencesParams 

func NewGetUserPreferencesParams() *GetUserPreferencesParams

NewGetUserPreferencesParams creates a new GetUserPreferencesParams 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 NewGetUserPreferencesParamsWithContext 

func NewGetUserPreferencesParamsWithContext(ctx context.Context) *GetUserPreferencesParams

NewGetUserPreferencesParamsWithContext creates a new GetUserPreferencesParams object with the ability to set a context for a request.

func NewGetUserPreferencesParamsWithHTTPClient 

func NewGetUserPreferencesParamsWithHTTPClient(client *http.Client) *GetUserPreferencesParams

NewGetUserPreferencesParamsWithHTTPClient creates a new GetUserPreferencesParams object with the ability to set a custom HTTPClient for a request.

func NewGetUserPreferencesParamsWithTimeout 

func NewGetUserPreferencesParamsWithTimeout(timeout time.Duration) *GetUserPreferencesParams

NewGetUserPreferencesParamsWithTimeout creates a new GetUserPreferencesParams object with the ability to set a timeout on a request.

func (*GetUserPreferencesParams) SetContext 

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

SetContext adds the context to the get user preferences params

func (*GetUserPreferencesParams) SetDefaults 

func (o *GetUserPreferencesParams) SetDefaults()

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

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

func (*GetUserPreferencesParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get user preferences params

func (*GetUserPreferencesParams) SetTimeout 

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

SetTimeout adds the timeout to the get user preferences params

func (*GetUserPreferencesParams) WithContext 

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

WithContext adds the context to the get user preferences params

func (*GetUserPreferencesParams) WithDefaults 

func (o *GetUserPreferencesParams) WithDefaults() *GetUserPreferencesParams

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

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

func (*GetUserPreferencesParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get user preferences params

func (*GetUserPreferencesParams) WithTimeout 

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

WithTimeout adds the timeout to the get user preferences params

func (*GetUserPreferencesParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetUserPreferencesReader 

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

GetUserPreferencesReader is a Reader for the GetUserPreferences structure.

func (*GetUserPreferencesReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type GetUserPreferencesUnauthorized 

type GetUserPreferencesUnauthorized struct {
	Payload *models.ErrorResponseBody
}

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

UnauthorizedError is returned when the request is not authenticated.

func NewGetUserPreferencesUnauthorized 

func NewGetUserPreferencesUnauthorized() *GetUserPreferencesUnauthorized

NewGetUserPreferencesUnauthorized creates a GetUserPreferencesUnauthorized with default headers values

func (*GetUserPreferencesUnauthorized) Error 

func (o *GetUserPreferencesUnauthorized) Error() string

func (*GetUserPreferencesUnauthorized) GetPayload 

func (o *GetUserPreferencesUnauthorized) GetPayload() *models.ErrorResponseBody

type PatchUserPreferencesBadRequest 

type PatchUserPreferencesBadRequest struct {
	Payload *models.ErrorResponseBody
}

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

BadRequestError is returned when the request is invalid and it cannot be processed.

func NewPatchUserPreferencesBadRequest 

func NewPatchUserPreferencesBadRequest() *PatchUserPreferencesBadRequest

NewPatchUserPreferencesBadRequest creates a PatchUserPreferencesBadRequest with default headers values

func (*PatchUserPreferencesBadRequest) Error 

func (o *PatchUserPreferencesBadRequest) Error() string

func (*PatchUserPreferencesBadRequest) GetPayload 

func (o *PatchUserPreferencesBadRequest) GetPayload() *models.ErrorResponseBody

type PatchUserPreferencesInternalServerError 

type PatchUserPreferencesInternalServerError struct {
	Payload *models.ErrorResponseBody
}

PatchUserPreferencesInternalServerError describes a response with status code 500, with default header values.

InternalServerError is a general error indicating something went wrong internally.

func NewPatchUserPreferencesInternalServerError 

func NewPatchUserPreferencesInternalServerError() *PatchUserPreferencesInternalServerError

NewPatchUserPreferencesInternalServerError creates a PatchUserPreferencesInternalServerError with default headers values

func (*PatchUserPreferencesInternalServerError) Error 

func (o *PatchUserPreferencesInternalServerError) Error() string

func (*PatchUserPreferencesInternalServerError) GetPayload 

func (o *PatchUserPreferencesInternalServerError) GetPayload() *models.ErrorResponseBody

type PatchUserPreferencesOK 

type PatchUserPreferencesOK struct {
	Payload *models.SuccessResponseBody
}

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

An OKResponse is returned if the request was successful.

func NewPatchUserPreferencesOK 

func NewPatchUserPreferencesOK() *PatchUserPreferencesOK

NewPatchUserPreferencesOK creates a PatchUserPreferencesOK with default headers values

func (*PatchUserPreferencesOK) Error 

func (o *PatchUserPreferencesOK) Error() string

func (*PatchUserPreferencesOK) GetPayload 

func (o *PatchUserPreferencesOK) GetPayload() *models.SuccessResponseBody

type PatchUserPreferencesParams 

type PatchUserPreferencesParams struct {

	// Body.
	Body *models.PatchPrefsCmd

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

PatchUserPreferencesParams contains all the parameters to send to the API endpoint 

for the patch user preferences operation.

Typically these are written to a http.Request.

func NewPatchUserPreferencesParams 

func NewPatchUserPreferencesParams() *PatchUserPreferencesParams

NewPatchUserPreferencesParams creates a new PatchUserPreferencesParams 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 NewPatchUserPreferencesParamsWithContext 

func NewPatchUserPreferencesParamsWithContext(ctx context.Context) *PatchUserPreferencesParams

NewPatchUserPreferencesParamsWithContext creates a new PatchUserPreferencesParams object with the ability to set a context for a request.

func NewPatchUserPreferencesParamsWithHTTPClient 

func NewPatchUserPreferencesParamsWithHTTPClient(client *http.Client) *PatchUserPreferencesParams

NewPatchUserPreferencesParamsWithHTTPClient creates a new PatchUserPreferencesParams object with the ability to set a custom HTTPClient for a request.

func NewPatchUserPreferencesParamsWithTimeout 

func NewPatchUserPreferencesParamsWithTimeout(timeout time.Duration) *PatchUserPreferencesParams

NewPatchUserPreferencesParamsWithTimeout creates a new PatchUserPreferencesParams object with the ability to set a timeout on a request.

func (*PatchUserPreferencesParams) SetBody 

func (o *PatchUserPreferencesParams) SetBody(body *models.PatchPrefsCmd)

SetBody adds the body to the patch user preferences params

func (*PatchUserPreferencesParams) SetContext 

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

SetContext adds the context to the patch user preferences params

func (*PatchUserPreferencesParams) SetDefaults 

func (o *PatchUserPreferencesParams) SetDefaults()

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

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

func (*PatchUserPreferencesParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the patch user preferences params

func (*PatchUserPreferencesParams) SetTimeout 

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

SetTimeout adds the timeout to the patch user preferences params

func (*PatchUserPreferencesParams) WithBody 

func (o *PatchUserPreferencesParams) WithBody(body *models.PatchPrefsCmd) *PatchUserPreferencesParams

WithBody adds the body to the patch user preferences params

func (*PatchUserPreferencesParams) WithContext 

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

WithContext adds the context to the patch user preferences params

func (*PatchUserPreferencesParams) WithDefaults 

func (o *PatchUserPreferencesParams) WithDefaults() *PatchUserPreferencesParams

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

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

func (*PatchUserPreferencesParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the patch user preferences params

func (*PatchUserPreferencesParams) WithTimeout 

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

WithTimeout adds the timeout to the patch user preferences params

func (*PatchUserPreferencesParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type PatchUserPreferencesReader 

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

PatchUserPreferencesReader is a Reader for the PatchUserPreferences structure.

func (*PatchUserPreferencesReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type PatchUserPreferencesUnauthorized 

type PatchUserPreferencesUnauthorized struct {
	Payload *models.ErrorResponseBody
}

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

UnauthorizedError is returned when the request is not authenticated.

func NewPatchUserPreferencesUnauthorized 

func NewPatchUserPreferencesUnauthorized() *PatchUserPreferencesUnauthorized

NewPatchUserPreferencesUnauthorized creates a PatchUserPreferencesUnauthorized with default headers values

func (*PatchUserPreferencesUnauthorized) Error 

func (o *PatchUserPreferencesUnauthorized) Error() string

func (*PatchUserPreferencesUnauthorized) GetPayload 

func (o *PatchUserPreferencesUnauthorized) GetPayload() *models.ErrorResponseBody

type UpdateUserPreferencesBadRequest 

type UpdateUserPreferencesBadRequest struct {
	Payload *models.ErrorResponseBody
}

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

BadRequestError is returned when the request is invalid and it cannot be processed.

func NewUpdateUserPreferencesBadRequest 

func NewUpdateUserPreferencesBadRequest() *UpdateUserPreferencesBadRequest

NewUpdateUserPreferencesBadRequest creates a UpdateUserPreferencesBadRequest with default headers values

func (*UpdateUserPreferencesBadRequest) Error 

func (o *UpdateUserPreferencesBadRequest) Error() string

func (*UpdateUserPreferencesBadRequest) GetPayload 

func (o *UpdateUserPreferencesBadRequest) GetPayload() *models.ErrorResponseBody

type UpdateUserPreferencesInternalServerError 

type UpdateUserPreferencesInternalServerError struct {
	Payload *models.ErrorResponseBody
}

UpdateUserPreferencesInternalServerError describes a response with status code 500, with default header values.

InternalServerError is a general error indicating something went wrong internally.

func NewUpdateUserPreferencesInternalServerError 

func NewUpdateUserPreferencesInternalServerError() *UpdateUserPreferencesInternalServerError

NewUpdateUserPreferencesInternalServerError creates a UpdateUserPreferencesInternalServerError with default headers values

func (*UpdateUserPreferencesInternalServerError) Error 

func (o *UpdateUserPreferencesInternalServerError) Error() string

func (*UpdateUserPreferencesInternalServerError) GetPayload 

func (o *UpdateUserPreferencesInternalServerError) GetPayload() *models.ErrorResponseBody

type UpdateUserPreferencesOK 

type UpdateUserPreferencesOK struct {
	Payload *models.SuccessResponseBody
}

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

An OKResponse is returned if the request was successful.

func NewUpdateUserPreferencesOK 

func NewUpdateUserPreferencesOK() *UpdateUserPreferencesOK

NewUpdateUserPreferencesOK creates a UpdateUserPreferencesOK with default headers values

func (*UpdateUserPreferencesOK) Error 

func (o *UpdateUserPreferencesOK) Error() string

func (*UpdateUserPreferencesOK) GetPayload 

func (o *UpdateUserPreferencesOK) GetPayload() *models.SuccessResponseBody

type UpdateUserPreferencesParams 

type UpdateUserPreferencesParams struct {

	// Body.
	Body *models.UpdatePrefsCmd

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

UpdateUserPreferencesParams contains all the parameters to send to the API endpoint 

for the update user preferences operation.

Typically these are written to a http.Request.

func NewUpdateUserPreferencesParams 

func NewUpdateUserPreferencesParams() *UpdateUserPreferencesParams

NewUpdateUserPreferencesParams creates a new UpdateUserPreferencesParams 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 NewUpdateUserPreferencesParamsWithContext 

func NewUpdateUserPreferencesParamsWithContext(ctx context.Context) *UpdateUserPreferencesParams

NewUpdateUserPreferencesParamsWithContext creates a new UpdateUserPreferencesParams object with the ability to set a context for a request.

func NewUpdateUserPreferencesParamsWithHTTPClient 

func NewUpdateUserPreferencesParamsWithHTTPClient(client *http.Client) *UpdateUserPreferencesParams

NewUpdateUserPreferencesParamsWithHTTPClient creates a new UpdateUserPreferencesParams object with the ability to set a custom HTTPClient for a request.

func NewUpdateUserPreferencesParamsWithTimeout 

func NewUpdateUserPreferencesParamsWithTimeout(timeout time.Duration) *UpdateUserPreferencesParams

NewUpdateUserPreferencesParamsWithTimeout creates a new UpdateUserPreferencesParams object with the ability to set a timeout on a request.

func (*UpdateUserPreferencesParams) SetBody 

func (o *UpdateUserPreferencesParams) SetBody(body *models.UpdatePrefsCmd)

SetBody adds the body to the update user preferences params

func (*UpdateUserPreferencesParams) SetContext 

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

SetContext adds the context to the update user preferences params

func (*UpdateUserPreferencesParams) SetDefaults 

func (o *UpdateUserPreferencesParams) SetDefaults()

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

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

func (*UpdateUserPreferencesParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the update user preferences params

func (*UpdateUserPreferencesParams) SetTimeout 

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

SetTimeout adds the timeout to the update user preferences params

func (*UpdateUserPreferencesParams) WithBody 

func (o *UpdateUserPreferencesParams) WithBody(body *models.UpdatePrefsCmd) *UpdateUserPreferencesParams

WithBody adds the body to the update user preferences params

func (*UpdateUserPreferencesParams) WithContext 

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

WithContext adds the context to the update user preferences params

func (*UpdateUserPreferencesParams) WithDefaults 

func (o *UpdateUserPreferencesParams) WithDefaults() *UpdateUserPreferencesParams

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

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

func (*UpdateUserPreferencesParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the update user preferences params

func (*UpdateUserPreferencesParams) WithTimeout 

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

WithTimeout adds the timeout to the update user preferences params

func (*UpdateUserPreferencesParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type UpdateUserPreferencesReader 

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

UpdateUserPreferencesReader is a Reader for the UpdateUserPreferences structure.

func (*UpdateUserPreferencesReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type UpdateUserPreferencesUnauthorized 

type UpdateUserPreferencesUnauthorized struct {
	Payload *models.ErrorResponseBody
}

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

UnauthorizedError is returned when the request is not authenticated.

func NewUpdateUserPreferencesUnauthorized 

func NewUpdateUserPreferencesUnauthorized() *UpdateUserPreferencesUnauthorized

NewUpdateUserPreferencesUnauthorized creates a UpdateUserPreferencesUnauthorized with default headers values

func (*UpdateUserPreferencesUnauthorized) Error 

func (o *UpdateUserPreferencesUnauthorized) Error() string

func (*UpdateUserPreferencesUnauthorized) GetPayload 

func (o *UpdateUserPreferencesUnauthorized) GetPayload() *models.ErrorResponseBody

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.