Documentation
¶
Overview ¶
Package auth provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.8.0 DO NOT EDIT.
Index ¶
- func GetSpec() (swagger *openapi3.T, err error)
- func GetSpecJSON() ([]byte, error)
- func GetSwagger() (*openapi3.T, error)deprecated
- func NewLoginRequest(server string, body LoginJSONRequestBody) (*http.Request, error)
- func NewLoginRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewLogoutRequest(server string, body LogoutJSONRequestBody) (*http.Request, error)
- func NewLogoutRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewRefreshRequest(server string, body RefreshJSONRequestBody) (*http.Request, error)
- func NewRefreshRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewSignupRequest(server string, body SignupJSONRequestBody) (*http.Request, error)
- func NewSignupRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewUsersCreateRequest(server string, body UsersCreateJSONRequestBody) (*http.Request, error)
- func NewUsersCreateRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewUsersDeleteRequest(server string, uuid openapi_types.UUID) (*http.Request, error)
- func NewUsersGetRequest(server string, uuid openapi_types.UUID) (*http.Request, error)
- func NewUsersListRequest(server string, params *UsersListParams) (*http.Request, error)
- func NewUsersMeReadRequest(server string) (*http.Request, error)
- func NewUsersMeUpdateRequest(server string, body UsersMeUpdateJSONRequestBody) (*http.Request, error)
- func NewUsersMeUpdateRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewUsersUpdateRequest(server string, uuid openapi_types.UUID, body UsersUpdateJSONRequestBody) (*http.Request, error)
- func NewUsersUpdateRequestWithBody(server string, uuid openapi_types.UUID, contentType string, body io.Reader) (*http.Request, error)
- func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
- type AuthenticationUnavailable
- type Client
- func (c *Client) Login(ctx context.Context, body LoginJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) LoginWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) Logout(ctx context.Context, body LogoutJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) LogoutWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) Refresh(ctx context.Context, body RefreshJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) RefreshWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) Signup(ctx context.Context, body SignupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) SignupWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) UsersCreate(ctx context.Context, body UsersCreateJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) UsersCreateWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) UsersDelete(ctx context.Context, uuid openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) UsersGet(ctx context.Context, uuid openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) UsersList(ctx context.Context, params *UsersListParams, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) UsersMeRead(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) UsersMeUpdate(ctx context.Context, body UsersMeUpdateJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) UsersMeUpdateWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) UsersUpdate(ctx context.Context, uuid openapi_types.UUID, body UsersUpdateJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) UsersUpdateWithBody(ctx context.Context, uuid openapi_types.UUID, contentType string, ...) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) LoginWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*LoginResponse, error)
- func (c *ClientWithResponses) LoginWithResponse(ctx context.Context, body LoginJSONRequestBody, reqEditors ...RequestEditorFn) (*LoginResponse, error)
- func (c *ClientWithResponses) LogoutWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*LogoutResponse, error)
- func (c *ClientWithResponses) LogoutWithResponse(ctx context.Context, body LogoutJSONRequestBody, reqEditors ...RequestEditorFn) (*LogoutResponse, error)
- func (c *ClientWithResponses) RefreshWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*RefreshResponse, error)
- func (c *ClientWithResponses) RefreshWithResponse(ctx context.Context, body RefreshJSONRequestBody, ...) (*RefreshResponse, error)
- func (c *ClientWithResponses) SignupWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*SignupResponse, error)
- func (c *ClientWithResponses) SignupWithResponse(ctx context.Context, body SignupJSONRequestBody, reqEditors ...RequestEditorFn) (*SignupResponse, error)
- func (c *ClientWithResponses) UsersCreateWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*UsersCreateResponse, error)
- func (c *ClientWithResponses) UsersCreateWithResponse(ctx context.Context, body UsersCreateJSONRequestBody, ...) (*UsersCreateResponse, error)
- func (c *ClientWithResponses) UsersDeleteWithResponse(ctx context.Context, uuid openapi_types.UUID, reqEditors ...RequestEditorFn) (*UsersDeleteResponse, error)
- func (c *ClientWithResponses) UsersGetWithResponse(ctx context.Context, uuid openapi_types.UUID, reqEditors ...RequestEditorFn) (*UsersGetResponse, error)
- func (c *ClientWithResponses) UsersListWithResponse(ctx context.Context, params *UsersListParams, reqEditors ...RequestEditorFn) (*UsersListResponse, error)
- func (c *ClientWithResponses) UsersMeReadWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*UsersMeReadResponse, error)
- func (c *ClientWithResponses) UsersMeUpdateWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*UsersMeUpdateResponse, error)
- func (c *ClientWithResponses) UsersMeUpdateWithResponse(ctx context.Context, body UsersMeUpdateJSONRequestBody, ...) (*UsersMeUpdateResponse, error)
- func (c *ClientWithResponses) UsersUpdateWithBodyWithResponse(ctx context.Context, uuid openapi_types.UUID, contentType string, ...) (*UsersUpdateResponse, error)
- func (c *ClientWithResponses) UsersUpdateWithResponse(ctx context.Context, uuid openapi_types.UUID, body UsersUpdateJSONRequestBody, ...) (*UsersUpdateResponse, error)
- type ClientWithResponsesInterface
- type CreateUserRequest
- type Error
- type Forbidden
- type HttpRequestDoer
- type LoginJSONRequestBody
- type LoginRequest
- type LoginResponse
- func (r LoginResponse) ContentType() string
- func (r LoginResponse) GetApplicationproblemJSON400() *Error
- func (r LoginResponse) GetApplicationproblemJSON429() *RateLimited
- func (r LoginResponse) GetApplicationproblemJSON503() *AuthenticationUnavailable
- func (r LoginResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
- func (r LoginResponse) GetBody() []byte
- func (r LoginResponse) GetJSON200() *Tokens
- func (r LoginResponse) Status() string
- func (r LoginResponse) StatusCode() int
- type LogoutJSONRequestBody
- type LogoutRequest
- type LogoutResponse
- func (r LogoutResponse) ContentType() string
- func (r LogoutResponse) GetApplicationproblemJSON400() *Error
- func (r LogoutResponse) GetApplicationproblemJSON401() *Error
- func (r LogoutResponse) GetApplicationproblemJSON503() *AuthenticationUnavailable
- func (r LogoutResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
- func (r LogoutResponse) GetBody() []byte
- func (r LogoutResponse) Status() string
- func (r LogoutResponse) StatusCode() int
- type RateLimited
- type RefreshJSONRequestBody
- type RefreshRequest
- type RefreshResponse
- func (r RefreshResponse) ContentType() string
- func (r RefreshResponse) GetApplicationproblemJSON400() *Error
- func (r RefreshResponse) GetApplicationproblemJSON401() *Error
- func (r RefreshResponse) GetApplicationproblemJSON429() *RateLimited
- func (r RefreshResponse) GetApplicationproblemJSON503() *AuthenticationUnavailable
- func (r RefreshResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
- func (r RefreshResponse) GetBody() []byte
- func (r RefreshResponse) GetJSON200() *Tokens
- func (r RefreshResponse) Status() string
- func (r RefreshResponse) StatusCode() int
- type RequestEditorFn
- type SignUpRequest
- type SignupJSONRequestBody
- type SignupResponse
- func (r SignupResponse) ContentType() string
- func (r SignupResponse) GetApplicationproblemJSON400() *Error
- func (r SignupResponse) GetApplicationproblemJSON409() *UserConflict
- func (r SignupResponse) GetApplicationproblemJSON429() *RateLimited
- func (r SignupResponse) GetApplicationproblemJSON503() *AuthenticationUnavailable
- func (r SignupResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
- func (r SignupResponse) GetBody() []byte
- func (r SignupResponse) GetJSON201() *User
- func (r SignupResponse) Status() string
- func (r SignupResponse) StatusCode() int
- type Tokens
- type UnexpectedResponse
- type UpdateSelfRequest
- type UpdateUserRequest
- type User
- type UserConflict
- type UsersCreateJSONRequestBody
- type UsersCreateResponse
- func (r UsersCreateResponse) ContentType() string
- func (r UsersCreateResponse) GetApplicationproblemJSON400() *Error
- func (r UsersCreateResponse) GetApplicationproblemJSON401() *Error
- func (r UsersCreateResponse) GetApplicationproblemJSON403() *Forbidden
- func (r UsersCreateResponse) GetApplicationproblemJSON409() *UserConflict
- func (r UsersCreateResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
- func (r UsersCreateResponse) GetBody() []byte
- func (r UsersCreateResponse) GetJSON201() *User
- func (r UsersCreateResponse) Status() string
- func (r UsersCreateResponse) StatusCode() int
- type UsersDeleteResponse
- func (r UsersDeleteResponse) ContentType() string
- func (r UsersDeleteResponse) GetApplicationproblemJSON400() *Error
- func (r UsersDeleteResponse) GetApplicationproblemJSON401() *Error
- func (r UsersDeleteResponse) GetApplicationproblemJSON403() *Forbidden
- func (r UsersDeleteResponse) GetApplicationproblemJSON404() *Error
- func (r UsersDeleteResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
- func (r UsersDeleteResponse) GetBody() []byte
- func (r UsersDeleteResponse) Status() string
- func (r UsersDeleteResponse) StatusCode() int
- type UsersGetResponse
- func (r UsersGetResponse) ContentType() string
- func (r UsersGetResponse) GetApplicationproblemJSON400() *Error
- func (r UsersGetResponse) GetApplicationproblemJSON401() *Error
- func (r UsersGetResponse) GetApplicationproblemJSON403() *Forbidden
- func (r UsersGetResponse) GetApplicationproblemJSON404() *Error
- func (r UsersGetResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
- func (r UsersGetResponse) GetBody() []byte
- func (r UsersGetResponse) GetJSON200() *User
- func (r UsersGetResponse) Status() string
- func (r UsersGetResponse) StatusCode() int
- type UsersListParams
- type UsersListResponse
- func (r UsersListResponse) ContentType() string
- func (r UsersListResponse) GetApplicationproblemJSON400() *Error
- func (r UsersListResponse) GetApplicationproblemJSON401() *Error
- func (r UsersListResponse) GetApplicationproblemJSON403() *Forbidden
- func (r UsersListResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
- func (r UsersListResponse) GetBody() []byte
- func (r UsersListResponse) GetJSON200() *[]User
- func (r UsersListResponse) Status() string
- func (r UsersListResponse) StatusCode() int
- type UsersMeReadResponse
- func (r UsersMeReadResponse) ContentType() string
- func (r UsersMeReadResponse) GetApplicationproblemJSON401() *Error
- func (r UsersMeReadResponse) GetApplicationproblemJSON403() *Forbidden
- func (r UsersMeReadResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
- func (r UsersMeReadResponse) GetBody() []byte
- func (r UsersMeReadResponse) GetJSON200() *User
- func (r UsersMeReadResponse) Status() string
- func (r UsersMeReadResponse) StatusCode() int
- type UsersMeUpdateJSONRequestBody
- type UsersMeUpdateResponse
- func (r UsersMeUpdateResponse) ContentType() string
- func (r UsersMeUpdateResponse) GetApplicationproblemJSON400() *Error
- func (r UsersMeUpdateResponse) GetApplicationproblemJSON401() *Error
- func (r UsersMeUpdateResponse) GetApplicationproblemJSON403() *Forbidden
- func (r UsersMeUpdateResponse) GetApplicationproblemJSON409() *UserConflict
- func (r UsersMeUpdateResponse) GetApplicationproblemJSON429() *RateLimited
- func (r UsersMeUpdateResponse) GetApplicationproblemJSON503() *AuthenticationUnavailable
- func (r UsersMeUpdateResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
- func (r UsersMeUpdateResponse) GetBody() []byte
- func (r UsersMeUpdateResponse) Status() string
- func (r UsersMeUpdateResponse) StatusCode() int
- type UsersUpdateJSONRequestBody
- type UsersUpdateResponse
- func (r UsersUpdateResponse) ContentType() string
- func (r UsersUpdateResponse) GetApplicationproblemJSON400() *Error
- func (r UsersUpdateResponse) GetApplicationproblemJSON401() *Error
- func (r UsersUpdateResponse) GetApplicationproblemJSON403() *Forbidden
- func (r UsersUpdateResponse) GetApplicationproblemJSON404() *Error
- func (r UsersUpdateResponse) GetApplicationproblemJSON409() *UserConflict
- func (r UsersUpdateResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
- func (r UsersUpdateResponse) GetBody() []byte
- func (r UsersUpdateResponse) Status() string
- func (r UsersUpdateResponse) StatusCode() int
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetSpec ¶
GetSpec returns the OpenAPI specification corresponding to the generated code in this file. External references in the spec are resolved through PathToRawSpec; externally-referenced files must be embedded in their corresponding Go packages (via the import-mapping feature). URL-based external refs are not supported.
func GetSpecJSON ¶
GetSpecJSON returns the raw JSON bytes of the embedded OpenAPI specification: decompressed but not unmarshaled. External references are not resolved here; the bytes are the spec exactly as embedded by codegen. The result is cached at package init time, so repeated calls are cheap.
func GetSwagger
deprecated
func NewLoginRequest ¶
func NewLoginRequest(server string, body LoginJSONRequestBody) (*http.Request, error)
NewLoginRequest calls the generic Login builder with application/json body
func NewLoginRequestWithBody ¶
func NewLoginRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewLoginRequestWithBody constructs an http.Request for the Login method, with any body, and a specified content type
func NewLogoutRequest ¶
func NewLogoutRequest(server string, body LogoutJSONRequestBody) (*http.Request, error)
NewLogoutRequest calls the generic Logout builder with application/json body
func NewLogoutRequestWithBody ¶
func NewLogoutRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewLogoutRequestWithBody constructs an http.Request for the Logout method, with any body, and a specified content type
func NewRefreshRequest ¶
func NewRefreshRequest(server string, body RefreshJSONRequestBody) (*http.Request, error)
NewRefreshRequest calls the generic Refresh builder with application/json body
func NewRefreshRequestWithBody ¶
func NewRefreshRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewRefreshRequestWithBody constructs an http.Request for the Refresh method, with any body, and a specified content type
func NewSignupRequest ¶
func NewSignupRequest(server string, body SignupJSONRequestBody) (*http.Request, error)
NewSignupRequest calls the generic Signup builder with application/json body
func NewSignupRequestWithBody ¶
func NewSignupRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewSignupRequestWithBody constructs an http.Request for the Signup method, with any body, and a specified content type
func NewUsersCreateRequest ¶
func NewUsersCreateRequest(server string, body UsersCreateJSONRequestBody) (*http.Request, error)
NewUsersCreateRequest calls the generic UsersCreate builder with application/json body
func NewUsersCreateRequestWithBody ¶
func NewUsersCreateRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewUsersCreateRequestWithBody constructs an http.Request for the UsersCreate method, with any body, and a specified content type
func NewUsersDeleteRequest ¶
NewUsersDeleteRequest constructs an http.Request for the UsersDelete method
func NewUsersGetRequest ¶
NewUsersGetRequest constructs an http.Request for the UsersGet method
func NewUsersListRequest ¶
func NewUsersListRequest(server string, params *UsersListParams) (*http.Request, error)
NewUsersListRequest constructs an http.Request for the UsersList method
func NewUsersMeReadRequest ¶
NewUsersMeReadRequest constructs an http.Request for the UsersMeRead method
func NewUsersMeUpdateRequest ¶
func NewUsersMeUpdateRequest(server string, body UsersMeUpdateJSONRequestBody) (*http.Request, error)
NewUsersMeUpdateRequest calls the generic UsersMeUpdate builder with application/json body
func NewUsersMeUpdateRequestWithBody ¶
func NewUsersMeUpdateRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewUsersMeUpdateRequestWithBody constructs an http.Request for the UsersMeUpdate method, with any body, and a specified content type
func NewUsersUpdateRequest ¶
func NewUsersUpdateRequest(server string, uuid openapi_types.UUID, body UsersUpdateJSONRequestBody) (*http.Request, error)
NewUsersUpdateRequest calls the generic UsersUpdate builder with application/json body
Types ¶
type AuthenticationUnavailable ¶ added in v0.9.79
type AuthenticationUnavailable = Error
AuthenticationUnavailable defines model for AuthenticationUnavailable.
type Client ¶
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example. This can contain a path relative
// to the server, such as https://api.deepmap.com/dev-test, and all the
// paths in the swagger spec will be appended to the server.
Server string
// Doer for performing requests, typically a *http.Client with any
// customized settings, such as certificate chains.
Client HttpRequestDoer
// A list of callbacks for modifying requests which are generated before sending over
// the network.
RequestEditors []RequestEditorFn
}
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) Login ¶
func (c *Client) Login(ctx context.Context, body LoginJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
Login Login an existing user
Unknown email, incorrect password, and inactive accounts receive the same generic 400 response.
Takes a body of the `application/json` content type.
Corresponds with POST /auth/login (the `Login` operationId).
func (*Client) LoginWithBody ¶
func (c *Client) LoginWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
LoginWithBody Login an existing user
Unknown email, incorrect password, and inactive accounts receive the same generic 400 response.
Takes any type of body and a specified content type.
Corresponds with POST /auth/login (the `Login` operationId).
func (*Client) Logout ¶
func (c *Client) Logout(ctx context.Context, body LogoutJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
Logout End the session
The refresh token identifies the session. Repeated logout succeeds, including after access-token expiry.
Takes a body of the `application/json` content type.
Corresponds with POST /auth/logout (the `Logout` operationId).
func (*Client) LogoutWithBody ¶
func (c *Client) LogoutWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
LogoutWithBody End the session
The refresh token identifies the session. Repeated logout succeeds, including after access-token expiry.
Takes any type of body and a specified content type.
Corresponds with POST /auth/logout (the `Logout` operationId).
func (*Client) Refresh ¶
func (c *Client) Refresh(ctx context.Context, body RefreshJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
Refresh Rotate the session refresh token
Refresh tokens are single-use. Reusing one ends that session, including successor tokens.
Takes a body of the `application/json` content type.
Corresponds with POST /auth/refresh (the `Refresh` operationId).
func (*Client) RefreshWithBody ¶
func (c *Client) RefreshWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
RefreshWithBody Rotate the session refresh token
Refresh tokens are single-use. Reusing one ends that session, including successor tokens.
Takes any type of body and a specified content type.
Corresponds with POST /auth/refresh (the `Refresh` operationId).
func (*Client) Signup ¶
func (c *Client) Signup(ctx context.Context, body SignupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
Signup Create a new user
Takes a body of the `application/json` content type.
Corresponds with POST /auth/signup (the `Signup` operationId).
func (*Client) SignupWithBody ¶
func (c *Client) SignupWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
SignupWithBody Create a new user
Takes any type of body and a specified content type.
Corresponds with POST /auth/signup (the `Signup` operationId).
func (*Client) UsersCreate ¶
func (c *Client) UsersCreate(ctx context.Context, body UsersCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
UsersCreate Create a new user
Takes a body of the `application/json` content type.
Corresponds with POST /users (the `UsersCreate` operationId).
func (*Client) UsersCreateWithBody ¶
func (c *Client) UsersCreateWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UsersCreateWithBody Create a new user
Takes any type of body and a specified content type.
Corresponds with POST /users (the `UsersCreate` operationId).
func (*Client) UsersDelete ¶
func (c *Client) UsersDelete(ctx context.Context, uuid openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
UsersDelete Delete user
Corresponds with DELETE /users/{uuid} (the `UsersDelete` operationId).
func (*Client) UsersGet ¶
func (c *Client) UsersGet(ctx context.Context, uuid openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
UsersGet Get user by UUID
Corresponds with GET /users/{uuid} (the `UsersGet` operationId).
func (*Client) UsersList ¶
func (c *Client) UsersList(ctx context.Context, params *UsersListParams, reqEditors ...RequestEditorFn) (*http.Response, error)
UsersList List users
Corresponds with GET /users (the `UsersList` operationId).
func (*Client) UsersMeRead ¶
func (c *Client) UsersMeRead(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
UsersMeRead Retrieve current user information
Corresponds with GET /users/me (the `UsersMeRead` operationId).
func (*Client) UsersMeUpdate ¶
func (c *Client) UsersMeUpdate(ctx context.Context, body UsersMeUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
UsersMeUpdate Update current user credentials
Requires the current password when a non-null email or password is supplied, including an unchanged email. Omitted or null email/password fields leave those credentials unchanged. A request with neither credential supplied is a successful no-op. Changing email or password ends all existing JWT sessions.
Takes a body of the `application/json` content type.
Corresponds with PUT /users/me (the `UsersMeUpdate` operationId).
func (*Client) UsersMeUpdateWithBody ¶
func (c *Client) UsersMeUpdateWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UsersMeUpdateWithBody Update current user credentials
Requires the current password when a non-null email or password is supplied, including an unchanged email. Omitted or null email/password fields leave those credentials unchanged. A request with neither credential supplied is a successful no-op. Changing email or password ends all existing JWT sessions.
Takes any type of body and a specified content type.
Corresponds with PUT /users/me (the `UsersMeUpdate` operationId).
func (*Client) UsersUpdate ¶
func (c *Client) UsersUpdate(ctx context.Context, uuid openapi_types.UUID, body UsersUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
UsersUpdate Update user
Takes a body of the `application/json` content type.
Corresponds with PUT /users/{uuid} (the `UsersUpdate` operationId).
func (*Client) UsersUpdateWithBody ¶
func (c *Client) UsersUpdateWithBody(ctx context.Context, uuid openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UsersUpdateWithBody Update user
Takes any type of body and a specified content type.
Corresponds with PUT /users/{uuid} (the `UsersUpdate` operationId).
type ClientInterface ¶
type ClientInterface interface {
// LoginWithBody Login an existing user
//
// Unknown email, incorrect password, and inactive accounts receive the same generic 400 response.
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /auth/login (the `Login` operationId).
LoginWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// Login Login an existing user
//
// Unknown email, incorrect password, and inactive accounts receive the same generic 400 response.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /auth/login (the `Login` operationId).
Login(ctx context.Context, body LoginJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// LogoutWithBody End the session
//
// The refresh token identifies the session. Repeated logout succeeds, including after access-token expiry.
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /auth/logout (the `Logout` operationId).
LogoutWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// Logout End the session
//
// The refresh token identifies the session. Repeated logout succeeds, including after access-token expiry.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /auth/logout (the `Logout` operationId).
Logout(ctx context.Context, body LogoutJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// RefreshWithBody Rotate the session refresh token
//
// Refresh tokens are single-use. Reusing one ends that session, including successor tokens.
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /auth/refresh (the `Refresh` operationId).
RefreshWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// Refresh Rotate the session refresh token
//
// Refresh tokens are single-use. Reusing one ends that session, including successor tokens.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /auth/refresh (the `Refresh` operationId).
Refresh(ctx context.Context, body RefreshJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// SignupWithBody Create a new user
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /auth/signup (the `Signup` operationId).
SignupWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// Signup Create a new user
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /auth/signup (the `Signup` operationId).
Signup(ctx context.Context, body SignupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// UsersList List users
//
// Corresponds with GET /users (the `UsersList` operationId).
UsersList(ctx context.Context, params *UsersListParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// UsersCreateWithBody Create a new user
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /users (the `UsersCreate` operationId).
UsersCreateWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// UsersCreate Create a new user
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /users (the `UsersCreate` operationId).
UsersCreate(ctx context.Context, body UsersCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// UsersMeRead Retrieve current user information
//
// Corresponds with GET /users/me (the `UsersMeRead` operationId).
UsersMeRead(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// UsersMeUpdateWithBody Update current user credentials
//
// Requires the current password when a non-null email or password is supplied, including an unchanged email. Omitted or null email/password fields leave those credentials unchanged. A request with neither credential supplied is a successful no-op. Changing email or password ends all existing JWT sessions.
//
// Takes any type of body and a specified content type.
//
// Corresponds with PUT /users/me (the `UsersMeUpdate` operationId).
UsersMeUpdateWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// UsersMeUpdate Update current user credentials
//
// Requires the current password when a non-null email or password is supplied, including an unchanged email. Omitted or null email/password fields leave those credentials unchanged. A request with neither credential supplied is a successful no-op. Changing email or password ends all existing JWT sessions.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with PUT /users/me (the `UsersMeUpdate` operationId).
UsersMeUpdate(ctx context.Context, body UsersMeUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// UsersDelete Delete user
//
// Corresponds with DELETE /users/{uuid} (the `UsersDelete` operationId).
UsersDelete(ctx context.Context, uuid openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
// UsersGet Get user by UUID
//
// Corresponds with GET /users/{uuid} (the `UsersGet` operationId).
UsersGet(ctx context.Context, uuid openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
// UsersUpdateWithBody Update user
//
// Takes any type of body and a specified content type.
//
// Corresponds with PUT /users/{uuid} (the `UsersUpdate` operationId).
UsersUpdateWithBody(ctx context.Context, uuid openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// UsersUpdate Update user
//
// Takes a body of the `application/json` content type.
//
// Corresponds with PUT /users/{uuid} (the `UsersUpdate` operationId).
UsersUpdate(ctx context.Context, uuid openapi_types.UUID, body UsersUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) LoginWithBodyWithResponse ¶
func (c *ClientWithResponses) LoginWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*LoginResponse, error)
LoginWithBodyWithResponse Login an existing user
Unknown email, incorrect password, and inactive accounts receive the same generic 400 response.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /auth/login (the `Login` operationId).
func (*ClientWithResponses) LoginWithResponse ¶
func (c *ClientWithResponses) LoginWithResponse(ctx context.Context, body LoginJSONRequestBody, reqEditors ...RequestEditorFn) (*LoginResponse, error)
LoginWithResponse Login an existing user
Unknown email, incorrect password, and inactive accounts receive the same generic 400 response.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /auth/login (the `Login` operationId).
func (*ClientWithResponses) LogoutWithBodyWithResponse ¶
func (c *ClientWithResponses) LogoutWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*LogoutResponse, error)
LogoutWithBodyWithResponse End the session
The refresh token identifies the session. Repeated logout succeeds, including after access-token expiry.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /auth/logout (the `Logout` operationId).
func (*ClientWithResponses) LogoutWithResponse ¶
func (c *ClientWithResponses) LogoutWithResponse(ctx context.Context, body LogoutJSONRequestBody, reqEditors ...RequestEditorFn) (*LogoutResponse, error)
LogoutWithResponse End the session
The refresh token identifies the session. Repeated logout succeeds, including after access-token expiry.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /auth/logout (the `Logout` operationId).
func (*ClientWithResponses) RefreshWithBodyWithResponse ¶
func (c *ClientWithResponses) RefreshWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RefreshResponse, error)
RefreshWithBodyWithResponse Rotate the session refresh token
Refresh tokens are single-use. Reusing one ends that session, including successor tokens.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /auth/refresh (the `Refresh` operationId).
func (*ClientWithResponses) RefreshWithResponse ¶
func (c *ClientWithResponses) RefreshWithResponse(ctx context.Context, body RefreshJSONRequestBody, reqEditors ...RequestEditorFn) (*RefreshResponse, error)
RefreshWithResponse Rotate the session refresh token
Refresh tokens are single-use. Reusing one ends that session, including successor tokens.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /auth/refresh (the `Refresh` operationId).
func (*ClientWithResponses) SignupWithBodyWithResponse ¶
func (c *ClientWithResponses) SignupWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SignupResponse, error)
SignupWithBodyWithResponse Create a new user
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /auth/signup (the `Signup` operationId).
func (*ClientWithResponses) SignupWithResponse ¶
func (c *ClientWithResponses) SignupWithResponse(ctx context.Context, body SignupJSONRequestBody, reqEditors ...RequestEditorFn) (*SignupResponse, error)
SignupWithResponse Create a new user
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /auth/signup (the `Signup` operationId).
func (*ClientWithResponses) UsersCreateWithBodyWithResponse ¶
func (c *ClientWithResponses) UsersCreateWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UsersCreateResponse, error)
UsersCreateWithBodyWithResponse Create a new user
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /users (the `UsersCreate` operationId).
func (*ClientWithResponses) UsersCreateWithResponse ¶
func (c *ClientWithResponses) UsersCreateWithResponse(ctx context.Context, body UsersCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*UsersCreateResponse, error)
UsersCreateWithResponse Create a new user
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /users (the `UsersCreate` operationId).
func (*ClientWithResponses) UsersDeleteWithResponse ¶
func (c *ClientWithResponses) UsersDeleteWithResponse(ctx context.Context, uuid openapi_types.UUID, reqEditors ...RequestEditorFn) (*UsersDeleteResponse, error)
UsersDeleteWithResponse Delete user
Returns a wrapper object for the known response body format(s).
Corresponds with DELETE /users/{uuid} (the `UsersDelete` operationId).
func (*ClientWithResponses) UsersGetWithResponse ¶
func (c *ClientWithResponses) UsersGetWithResponse(ctx context.Context, uuid openapi_types.UUID, reqEditors ...RequestEditorFn) (*UsersGetResponse, error)
UsersGetWithResponse Get user by UUID
Returns a wrapper object for the known response body format(s).
Corresponds with GET /users/{uuid} (the `UsersGet` operationId).
func (*ClientWithResponses) UsersListWithResponse ¶
func (c *ClientWithResponses) UsersListWithResponse(ctx context.Context, params *UsersListParams, reqEditors ...RequestEditorFn) (*UsersListResponse, error)
UsersListWithResponse List users
Returns a wrapper object for the known response body format(s).
Corresponds with GET /users (the `UsersList` operationId).
func (*ClientWithResponses) UsersMeReadWithResponse ¶
func (c *ClientWithResponses) UsersMeReadWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*UsersMeReadResponse, error)
UsersMeReadWithResponse Retrieve current user information
Returns a wrapper object for the known response body format(s).
Corresponds with GET /users/me (the `UsersMeRead` operationId).
func (*ClientWithResponses) UsersMeUpdateWithBodyWithResponse ¶
func (c *ClientWithResponses) UsersMeUpdateWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UsersMeUpdateResponse, error)
UsersMeUpdateWithBodyWithResponse Update current user credentials
Requires the current password when a non-null email or password is supplied, including an unchanged email. Omitted or null email/password fields leave those credentials unchanged. A request with neither credential supplied is a successful no-op. Changing email or password ends all existing JWT sessions.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with PUT /users/me (the `UsersMeUpdate` operationId).
func (*ClientWithResponses) UsersMeUpdateWithResponse ¶
func (c *ClientWithResponses) UsersMeUpdateWithResponse(ctx context.Context, body UsersMeUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*UsersMeUpdateResponse, error)
UsersMeUpdateWithResponse Update current user credentials
Requires the current password when a non-null email or password is supplied, including an unchanged email. Omitted or null email/password fields leave those credentials unchanged. A request with neither credential supplied is a successful no-op. Changing email or password ends all existing JWT sessions.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with PUT /users/me (the `UsersMeUpdate` operationId).
func (*ClientWithResponses) UsersUpdateWithBodyWithResponse ¶
func (c *ClientWithResponses) UsersUpdateWithBodyWithResponse(ctx context.Context, uuid openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UsersUpdateResponse, error)
UsersUpdateWithBodyWithResponse Update user
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with PUT /users/{uuid} (the `UsersUpdate` operationId).
func (*ClientWithResponses) UsersUpdateWithResponse ¶
func (c *ClientWithResponses) UsersUpdateWithResponse(ctx context.Context, uuid openapi_types.UUID, body UsersUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*UsersUpdateResponse, error)
UsersUpdateWithResponse Update user
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with PUT /users/{uuid} (the `UsersUpdate` operationId).
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// LoginWithBodyWithResponse Login an existing user
//
// Unknown email, incorrect password, and inactive accounts receive the same generic 400 response.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /auth/login (the `Login` operationId).
LoginWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*LoginResponse, error)
// LoginWithResponse Login an existing user
//
// Unknown email, incorrect password, and inactive accounts receive the same generic 400 response.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /auth/login (the `Login` operationId).
LoginWithResponse(ctx context.Context, body LoginJSONRequestBody, reqEditors ...RequestEditorFn) (*LoginResponse, error)
// LogoutWithBodyWithResponse End the session
//
// The refresh token identifies the session. Repeated logout succeeds, including after access-token expiry.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /auth/logout (the `Logout` operationId).
LogoutWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*LogoutResponse, error)
// LogoutWithResponse End the session
//
// The refresh token identifies the session. Repeated logout succeeds, including after access-token expiry.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /auth/logout (the `Logout` operationId).
LogoutWithResponse(ctx context.Context, body LogoutJSONRequestBody, reqEditors ...RequestEditorFn) (*LogoutResponse, error)
// RefreshWithBodyWithResponse Rotate the session refresh token
//
// Refresh tokens are single-use. Reusing one ends that session, including successor tokens.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /auth/refresh (the `Refresh` operationId).
RefreshWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RefreshResponse, error)
// RefreshWithResponse Rotate the session refresh token
//
// Refresh tokens are single-use. Reusing one ends that session, including successor tokens.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /auth/refresh (the `Refresh` operationId).
RefreshWithResponse(ctx context.Context, body RefreshJSONRequestBody, reqEditors ...RequestEditorFn) (*RefreshResponse, error)
// SignupWithBodyWithResponse Create a new user
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /auth/signup (the `Signup` operationId).
SignupWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SignupResponse, error)
// SignupWithResponse Create a new user
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /auth/signup (the `Signup` operationId).
SignupWithResponse(ctx context.Context, body SignupJSONRequestBody, reqEditors ...RequestEditorFn) (*SignupResponse, error)
// UsersListWithResponse List users
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /users (the `UsersList` operationId).
UsersListWithResponse(ctx context.Context, params *UsersListParams, reqEditors ...RequestEditorFn) (*UsersListResponse, error)
// UsersCreateWithBodyWithResponse Create a new user
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /users (the `UsersCreate` operationId).
UsersCreateWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UsersCreateResponse, error)
// UsersCreateWithResponse Create a new user
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /users (the `UsersCreate` operationId).
UsersCreateWithResponse(ctx context.Context, body UsersCreateJSONRequestBody, reqEditors ...RequestEditorFn) (*UsersCreateResponse, error)
// UsersMeReadWithResponse Retrieve current user information
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /users/me (the `UsersMeRead` operationId).
UsersMeReadWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*UsersMeReadResponse, error)
// UsersMeUpdateWithBodyWithResponse Update current user credentials
//
// Requires the current password when a non-null email or password is supplied, including an unchanged email. Omitted or null email/password fields leave those credentials unchanged. A request with neither credential supplied is a successful no-op. Changing email or password ends all existing JWT sessions.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PUT /users/me (the `UsersMeUpdate` operationId).
UsersMeUpdateWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UsersMeUpdateResponse, error)
// UsersMeUpdateWithResponse Update current user credentials
//
// Requires the current password when a non-null email or password is supplied, including an unchanged email. Omitted or null email/password fields leave those credentials unchanged. A request with neither credential supplied is a successful no-op. Changing email or password ends all existing JWT sessions.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PUT /users/me (the `UsersMeUpdate` operationId).
UsersMeUpdateWithResponse(ctx context.Context, body UsersMeUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*UsersMeUpdateResponse, error)
// UsersDeleteWithResponse Delete user
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with DELETE /users/{uuid} (the `UsersDelete` operationId).
UsersDeleteWithResponse(ctx context.Context, uuid openapi_types.UUID, reqEditors ...RequestEditorFn) (*UsersDeleteResponse, error)
// UsersGetWithResponse Get user by UUID
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /users/{uuid} (the `UsersGet` operationId).
UsersGetWithResponse(ctx context.Context, uuid openapi_types.UUID, reqEditors ...RequestEditorFn) (*UsersGetResponse, error)
// UsersUpdateWithBodyWithResponse Update user
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PUT /users/{uuid} (the `UsersUpdate` operationId).
UsersUpdateWithBodyWithResponse(ctx context.Context, uuid openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UsersUpdateResponse, error)
// UsersUpdateWithResponse Update user
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PUT /users/{uuid} (the `UsersUpdate` operationId).
UsersUpdateWithResponse(ctx context.Context, uuid openapi_types.UUID, body UsersUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*UsersUpdateResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type CreateUserRequest ¶
type CreateUserRequest struct {
// Email Trimmed, lowercased, then validated as an email address by the service.
//
// Example: user@example.com
Email string `json:"email"`
// Password At least 8 Unicode characters and at most 72 UTF-8 bytes. Used exactly as supplied, including whitespace. New passwords must also meet the configured strength requirement.
//
// Example: 12#$abCD%$
Password string `json:"password"`
}
CreateUserRequest defines model for CreateUserRequest.
type Error ¶
type Error struct {
// Detail A human-readable explanation specific to this occurrence of the problem.
Detail *string `json:"detail,omitempty"`
// Errors Optional list of additional error details.
Errors *[]map[string]interface{} `json:"errors,omitempty"`
// Instance A URI reference that identifies the specific occurrence of the problem.
Instance *string `json:"instance,omitempty"`
// Status The HTTP status code generated by the origin server.
Status int32 `json:"status"`
// Title A short, human-readable summary of the problem type.
Title string `json:"title"`
// Type A URI reference that identifies the problem type.
Type string `json:"type"`
}
Error defines model for Error.
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type LoginJSONRequestBody ¶
type LoginJSONRequestBody = LoginRequest
LoginJSONRequestBody defines body for Login for application/json ContentType.
type LoginRequest ¶
type LoginRequest struct {
// Email Trimmed, lowercased, then validated as an email address by the service.
//
// Example: user@example.com
Email string `json:"email"`
// Password At least 8 Unicode characters and at most 72 UTF-8 bytes. Used exactly as supplied, including whitespace.
//
// Example: 12#$abCD%$
Password string `json:"password"`
}
LoginRequest defines model for LoginRequest.
type LoginResponse ¶
type LoginResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *Tokens
// ApplicationproblemJSON400 the response for an HTTP 400 `application/problem+json` response
ApplicationproblemJSON400 *Error
// ApplicationproblemJSON429 the response for an HTTP 429 `application/problem+json` response
ApplicationproblemJSON429 *RateLimited
// ApplicationproblemJSON503 the response for an HTTP 503 `application/problem+json` response
ApplicationproblemJSON503 *AuthenticationUnavailable
// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
ApplicationproblemJSONDefault *UnexpectedResponse
}
func ParseLoginResponse ¶
func ParseLoginResponse(rsp *http.Response) (*LoginResponse, error)
ParseLoginResponse parses an HTTP response from a LoginWithResponse call
func (LoginResponse) ContentType ¶
func (r LoginResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (LoginResponse) GetApplicationproblemJSON400 ¶ added in v0.9.79
func (r LoginResponse) GetApplicationproblemJSON400() *Error
GetApplicationproblemJSON400 returns the response for an HTTP 400 `application/problem+json` response
func (LoginResponse) GetApplicationproblemJSON429 ¶ added in v0.9.79
func (r LoginResponse) GetApplicationproblemJSON429() *RateLimited
GetApplicationproblemJSON429 returns the response for an HTTP 429 `application/problem+json` response
func (LoginResponse) GetApplicationproblemJSON503 ¶ added in v0.9.79
func (r LoginResponse) GetApplicationproblemJSON503() *AuthenticationUnavailable
GetApplicationproblemJSON503 returns the response for an HTTP 503 `application/problem+json` response
func (LoginResponse) GetApplicationproblemJSONDefault ¶ added in v0.9.79
func (r LoginResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response
func (LoginResponse) GetBody ¶
func (r LoginResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (LoginResponse) GetJSON200 ¶
func (r LoginResponse) GetJSON200() *Tokens
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (LoginResponse) Status ¶
func (r LoginResponse) Status() string
Status returns HTTPResponse.Status
func (LoginResponse) StatusCode ¶
func (r LoginResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type LogoutJSONRequestBody ¶
type LogoutJSONRequestBody = LogoutRequest
LogoutJSONRequestBody defines body for Logout for application/json ContentType.
type LogoutRequest ¶
type LogoutRequest struct {
// AccessToken Optional; logout uses the refresh token to identify the session.
AccessToken *string `json:"access_token,omitempty"`
// RefreshToken Nonempty refresh token. Nonempty invalid tokens return 401.
RefreshToken string `json:"refresh_token"`
}
LogoutRequest defines model for LogoutRequest.
type LogoutResponse ¶
type LogoutResponse struct {
Body []byte
HTTPResponse *http.Response
// ApplicationproblemJSON400 the response for an HTTP 400 `application/problem+json` response
ApplicationproblemJSON400 *Error
// ApplicationproblemJSON401 the response for an HTTP 401 `application/problem+json` response
ApplicationproblemJSON401 *Error
// ApplicationproblemJSON503 the response for an HTTP 503 `application/problem+json` response
ApplicationproblemJSON503 *AuthenticationUnavailable
// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
ApplicationproblemJSONDefault *UnexpectedResponse
}
func ParseLogoutResponse ¶
func ParseLogoutResponse(rsp *http.Response) (*LogoutResponse, error)
ParseLogoutResponse parses an HTTP response from a LogoutWithResponse call
func (LogoutResponse) ContentType ¶
func (r LogoutResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (LogoutResponse) GetApplicationproblemJSON400 ¶ added in v0.9.79
func (r LogoutResponse) GetApplicationproblemJSON400() *Error
GetApplicationproblemJSON400 returns the response for an HTTP 400 `application/problem+json` response
func (LogoutResponse) GetApplicationproblemJSON401 ¶ added in v0.9.79
func (r LogoutResponse) GetApplicationproblemJSON401() *Error
GetApplicationproblemJSON401 returns the response for an HTTP 401 `application/problem+json` response
func (LogoutResponse) GetApplicationproblemJSON503 ¶ added in v0.9.79
func (r LogoutResponse) GetApplicationproblemJSON503() *AuthenticationUnavailable
GetApplicationproblemJSON503 returns the response for an HTTP 503 `application/problem+json` response
func (LogoutResponse) GetApplicationproblemJSONDefault ¶ added in v0.9.79
func (r LogoutResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response
func (LogoutResponse) GetBody ¶
func (r LogoutResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (LogoutResponse) Status ¶
func (r LogoutResponse) Status() string
Status returns HTTPResponse.Status
func (LogoutResponse) StatusCode ¶
func (r LogoutResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RateLimited ¶ added in v0.9.79
type RateLimited = Error
RateLimited defines model for RateLimited.
type RefreshJSONRequestBody ¶
type RefreshJSONRequestBody = RefreshRequest
RefreshJSONRequestBody defines body for Refresh for application/json ContentType.
type RefreshRequest ¶
type RefreshRequest struct {
// Token Nonempty refresh token. Nonempty invalid tokens return 401.
Token string `json:"token"`
}
RefreshRequest defines model for RefreshRequest.
type RefreshResponse ¶
type RefreshResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *Tokens
// ApplicationproblemJSON400 the response for an HTTP 400 `application/problem+json` response
ApplicationproblemJSON400 *Error
// ApplicationproblemJSON401 the response for an HTTP 401 `application/problem+json` response
ApplicationproblemJSON401 *Error
// ApplicationproblemJSON429 the response for an HTTP 429 `application/problem+json` response
ApplicationproblemJSON429 *RateLimited
// ApplicationproblemJSON503 the response for an HTTP 503 `application/problem+json` response
ApplicationproblemJSON503 *AuthenticationUnavailable
// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
ApplicationproblemJSONDefault *UnexpectedResponse
}
func ParseRefreshResponse ¶
func ParseRefreshResponse(rsp *http.Response) (*RefreshResponse, error)
ParseRefreshResponse parses an HTTP response from a RefreshWithResponse call
func (RefreshResponse) ContentType ¶
func (r RefreshResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (RefreshResponse) GetApplicationproblemJSON400 ¶ added in v0.9.79
func (r RefreshResponse) GetApplicationproblemJSON400() *Error
GetApplicationproblemJSON400 returns the response for an HTTP 400 `application/problem+json` response
func (RefreshResponse) GetApplicationproblemJSON401 ¶ added in v0.9.79
func (r RefreshResponse) GetApplicationproblemJSON401() *Error
GetApplicationproblemJSON401 returns the response for an HTTP 401 `application/problem+json` response
func (RefreshResponse) GetApplicationproblemJSON429 ¶ added in v0.9.79
func (r RefreshResponse) GetApplicationproblemJSON429() *RateLimited
GetApplicationproblemJSON429 returns the response for an HTTP 429 `application/problem+json` response
func (RefreshResponse) GetApplicationproblemJSON503 ¶ added in v0.9.79
func (r RefreshResponse) GetApplicationproblemJSON503() *AuthenticationUnavailable
GetApplicationproblemJSON503 returns the response for an HTTP 503 `application/problem+json` response
func (RefreshResponse) GetApplicationproblemJSONDefault ¶ added in v0.9.79
func (r RefreshResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response
func (RefreshResponse) GetBody ¶
func (r RefreshResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (RefreshResponse) GetJSON200 ¶
func (r RefreshResponse) GetJSON200() *Tokens
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (RefreshResponse) Status ¶
func (r RefreshResponse) Status() string
Status returns HTTPResponse.Status
func (RefreshResponse) StatusCode ¶
func (r RefreshResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type SignUpRequest ¶
type SignUpRequest struct {
// Email Trimmed, lowercased, then validated as an email address by the service.
//
// Example: user@example.com
Email string `json:"email"`
// Password At least 8 Unicode characters and at most 72 UTF-8 bytes. Used exactly as supplied, including whitespace. New passwords must also meet the configured strength requirement.
//
// Example: 12#$abCD%$
Password string `json:"password"`
}
SignUpRequest defines model for SignUpRequest.
type SignupJSONRequestBody ¶
type SignupJSONRequestBody = SignUpRequest
SignupJSONRequestBody defines body for Signup for application/json ContentType.
type SignupResponse ¶
type SignupResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON201 the response for an HTTP 201 `application/json` response
JSON201 *User
// ApplicationproblemJSON400 the response for an HTTP 400 `application/problem+json` response
ApplicationproblemJSON400 *Error
// ApplicationproblemJSON409 the response for an HTTP 409 `application/problem+json` response
ApplicationproblemJSON409 *UserConflict
// ApplicationproblemJSON429 the response for an HTTP 429 `application/problem+json` response
ApplicationproblemJSON429 *RateLimited
// ApplicationproblemJSON503 the response for an HTTP 503 `application/problem+json` response
ApplicationproblemJSON503 *AuthenticationUnavailable
// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
ApplicationproblemJSONDefault *UnexpectedResponse
}
func ParseSignupResponse ¶
func ParseSignupResponse(rsp *http.Response) (*SignupResponse, error)
ParseSignupResponse parses an HTTP response from a SignupWithResponse call
func (SignupResponse) ContentType ¶
func (r SignupResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (SignupResponse) GetApplicationproblemJSON400 ¶ added in v0.9.79
func (r SignupResponse) GetApplicationproblemJSON400() *Error
GetApplicationproblemJSON400 returns the response for an HTTP 400 `application/problem+json` response
func (SignupResponse) GetApplicationproblemJSON409 ¶ added in v0.9.79
func (r SignupResponse) GetApplicationproblemJSON409() *UserConflict
GetApplicationproblemJSON409 returns the response for an HTTP 409 `application/problem+json` response
func (SignupResponse) GetApplicationproblemJSON429 ¶ added in v0.9.79
func (r SignupResponse) GetApplicationproblemJSON429() *RateLimited
GetApplicationproblemJSON429 returns the response for an HTTP 429 `application/problem+json` response
func (SignupResponse) GetApplicationproblemJSON503 ¶ added in v0.9.79
func (r SignupResponse) GetApplicationproblemJSON503() *AuthenticationUnavailable
GetApplicationproblemJSON503 returns the response for an HTTP 503 `application/problem+json` response
func (SignupResponse) GetApplicationproblemJSONDefault ¶ added in v0.9.79
func (r SignupResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response
func (SignupResponse) GetBody ¶
func (r SignupResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (SignupResponse) GetJSON201 ¶
func (r SignupResponse) GetJSON201() *User
GetJSON201 returns the response for an HTTP 201 `application/json` response
func (SignupResponse) Status ¶
func (r SignupResponse) Status() string
Status returns HTTPResponse.Status
func (SignupResponse) StatusCode ¶
func (r SignupResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Tokens ¶
type Tokens struct {
AccessToken *string `json:"access_token,omitempty"`
ExpiresIn *int `json:"expires_in,omitempty"`
RefreshToken *string `json:"refresh_token,omitempty"`
}
Tokens defines model for Tokens.
type UnexpectedResponse ¶
type UnexpectedResponse = Error
UnexpectedResponse defines model for UnexpectedResponse.
type UpdateSelfRequest ¶
type UpdateSelfRequest struct {
// CurrentPassword Existing password, used exactly as supplied. When changing credentials, at least 8 Unicode characters and at most 72 UTF-8 bytes. Ignored when neither email nor password is supplied with a non-null value.
CurrentPassword *string `json:"current_password,omitempty"`
// Email Trimmed, lowercased, then validated as an email address by the service.
//
// Example: user@example.com
Email *string `json:"email,omitempty"`
// Password At least 8 Unicode characters and at most 72 UTF-8 bytes. Used exactly as supplied, including whitespace. New passwords must also meet the configured strength requirement.
//
// Example: 12#$abCD%$
Password *string `json:"password,omitempty"`
}
UpdateSelfRequest The correct current_password is required when email or password is non-null, even for an unchanged email. Omitted or null email/password fields are ignored. With neither credential supplied, the request succeeds without verifying current_password or changing credentials or sessions.
type UpdateUserRequest ¶
type UpdateUserRequest struct {
// Email Trimmed, lowercased, then validated as an email address by the service.
//
// Example: user@example.com
Email *string `json:"email,omitempty"`
// Password At least 8 Unicode characters and at most 72 UTF-8 bytes. Used exactly as supplied, including whitespace. New passwords must also meet the configured strength requirement.
//
// Example: 12#$abCD%$
Password *string `json:"password,omitempty"`
}
UpdateUserRequest defines model for UpdateUserRequest.
type User ¶
type User struct {
CreatedAt *string `json:"created_at,omitempty"`
Email *string `json:"email,omitempty"`
Permissions *[]string `json:"permissions,omitempty"`
Roles *[]string `json:"roles,omitempty"`
Uuid *string `json:"uuid,omitempty"`
}
User defines model for User.
type UserConflict ¶ added in v0.9.81
type UserConflict = Error
UserConflict defines model for UserConflict.
type UsersCreateJSONRequestBody ¶
type UsersCreateJSONRequestBody = CreateUserRequest
UsersCreateJSONRequestBody defines body for UsersCreate for application/json ContentType.
type UsersCreateResponse ¶
type UsersCreateResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON201 the response for an HTTP 201 `application/json` response
JSON201 *User
// ApplicationproblemJSON400 the response for an HTTP 400 `application/problem+json` response
ApplicationproblemJSON400 *Error
// ApplicationproblemJSON401 the response for an HTTP 401 `application/problem+json` response
ApplicationproblemJSON401 *Error
// ApplicationproblemJSON403 the response for an HTTP 403 `application/problem+json` response
ApplicationproblemJSON403 *Forbidden
// ApplicationproblemJSON409 the response for an HTTP 409 `application/problem+json` response
ApplicationproblemJSON409 *UserConflict
// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
ApplicationproblemJSONDefault *UnexpectedResponse
}
func ParseUsersCreateResponse ¶
func ParseUsersCreateResponse(rsp *http.Response) (*UsersCreateResponse, error)
ParseUsersCreateResponse parses an HTTP response from a UsersCreateWithResponse call
func (UsersCreateResponse) ContentType ¶
func (r UsersCreateResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (UsersCreateResponse) GetApplicationproblemJSON400 ¶ added in v0.9.79
func (r UsersCreateResponse) GetApplicationproblemJSON400() *Error
GetApplicationproblemJSON400 returns the response for an HTTP 400 `application/problem+json` response
func (UsersCreateResponse) GetApplicationproblemJSON401 ¶ added in v0.9.79
func (r UsersCreateResponse) GetApplicationproblemJSON401() *Error
GetApplicationproblemJSON401 returns the response for an HTTP 401 `application/problem+json` response
func (UsersCreateResponse) GetApplicationproblemJSON403 ¶ added in v0.9.81
func (r UsersCreateResponse) GetApplicationproblemJSON403() *Forbidden
GetApplicationproblemJSON403 returns the response for an HTTP 403 `application/problem+json` response
func (UsersCreateResponse) GetApplicationproblemJSON409 ¶ added in v0.9.81
func (r UsersCreateResponse) GetApplicationproblemJSON409() *UserConflict
GetApplicationproblemJSON409 returns the response for an HTTP 409 `application/problem+json` response
func (UsersCreateResponse) GetApplicationproblemJSONDefault ¶ added in v0.9.79
func (r UsersCreateResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response
func (UsersCreateResponse) GetBody ¶
func (r UsersCreateResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (UsersCreateResponse) GetJSON201 ¶
func (r UsersCreateResponse) GetJSON201() *User
GetJSON201 returns the response for an HTTP 201 `application/json` response
func (UsersCreateResponse) Status ¶
func (r UsersCreateResponse) Status() string
Status returns HTTPResponse.Status
func (UsersCreateResponse) StatusCode ¶
func (r UsersCreateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UsersDeleteResponse ¶
type UsersDeleteResponse struct {
Body []byte
HTTPResponse *http.Response
// ApplicationproblemJSON400 the response for an HTTP 400 `application/problem+json` response
ApplicationproblemJSON400 *Error
// ApplicationproblemJSON401 the response for an HTTP 401 `application/problem+json` response
ApplicationproblemJSON401 *Error
// ApplicationproblemJSON403 the response for an HTTP 403 `application/problem+json` response
ApplicationproblemJSON403 *Forbidden
// ApplicationproblemJSON404 the response for an HTTP 404 `application/problem+json` response
ApplicationproblemJSON404 *Error
// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
ApplicationproblemJSONDefault *UnexpectedResponse
}
func ParseUsersDeleteResponse ¶
func ParseUsersDeleteResponse(rsp *http.Response) (*UsersDeleteResponse, error)
ParseUsersDeleteResponse parses an HTTP response from a UsersDeleteWithResponse call
func (UsersDeleteResponse) ContentType ¶
func (r UsersDeleteResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (UsersDeleteResponse) GetApplicationproblemJSON400 ¶ added in v0.9.79
func (r UsersDeleteResponse) GetApplicationproblemJSON400() *Error
GetApplicationproblemJSON400 returns the response for an HTTP 400 `application/problem+json` response
func (UsersDeleteResponse) GetApplicationproblemJSON401 ¶ added in v0.9.79
func (r UsersDeleteResponse) GetApplicationproblemJSON401() *Error
GetApplicationproblemJSON401 returns the response for an HTTP 401 `application/problem+json` response
func (UsersDeleteResponse) GetApplicationproblemJSON403 ¶ added in v0.9.81
func (r UsersDeleteResponse) GetApplicationproblemJSON403() *Forbidden
GetApplicationproblemJSON403 returns the response for an HTTP 403 `application/problem+json` response
func (UsersDeleteResponse) GetApplicationproblemJSON404 ¶ added in v0.9.79
func (r UsersDeleteResponse) GetApplicationproblemJSON404() *Error
GetApplicationproblemJSON404 returns the response for an HTTP 404 `application/problem+json` response
func (UsersDeleteResponse) GetApplicationproblemJSONDefault ¶ added in v0.9.79
func (r UsersDeleteResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response
func (UsersDeleteResponse) GetBody ¶
func (r UsersDeleteResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (UsersDeleteResponse) Status ¶
func (r UsersDeleteResponse) Status() string
Status returns HTTPResponse.Status
func (UsersDeleteResponse) StatusCode ¶
func (r UsersDeleteResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UsersGetResponse ¶
type UsersGetResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *User
// ApplicationproblemJSON400 the response for an HTTP 400 `application/problem+json` response
ApplicationproblemJSON400 *Error
// ApplicationproblemJSON401 the response for an HTTP 401 `application/problem+json` response
ApplicationproblemJSON401 *Error
// ApplicationproblemJSON403 the response for an HTTP 403 `application/problem+json` response
ApplicationproblemJSON403 *Forbidden
// ApplicationproblemJSON404 the response for an HTTP 404 `application/problem+json` response
ApplicationproblemJSON404 *Error
// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
ApplicationproblemJSONDefault *UnexpectedResponse
}
func ParseUsersGetResponse ¶
func ParseUsersGetResponse(rsp *http.Response) (*UsersGetResponse, error)
ParseUsersGetResponse parses an HTTP response from a UsersGetWithResponse call
func (UsersGetResponse) ContentType ¶
func (r UsersGetResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (UsersGetResponse) GetApplicationproblemJSON400 ¶ added in v0.9.79
func (r UsersGetResponse) GetApplicationproblemJSON400() *Error
GetApplicationproblemJSON400 returns the response for an HTTP 400 `application/problem+json` response
func (UsersGetResponse) GetApplicationproblemJSON401 ¶ added in v0.9.79
func (r UsersGetResponse) GetApplicationproblemJSON401() *Error
GetApplicationproblemJSON401 returns the response for an HTTP 401 `application/problem+json` response
func (UsersGetResponse) GetApplicationproblemJSON403 ¶ added in v0.9.81
func (r UsersGetResponse) GetApplicationproblemJSON403() *Forbidden
GetApplicationproblemJSON403 returns the response for an HTTP 403 `application/problem+json` response
func (UsersGetResponse) GetApplicationproblemJSON404 ¶ added in v0.9.79
func (r UsersGetResponse) GetApplicationproblemJSON404() *Error
GetApplicationproblemJSON404 returns the response for an HTTP 404 `application/problem+json` response
func (UsersGetResponse) GetApplicationproblemJSONDefault ¶ added in v0.9.79
func (r UsersGetResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response
func (UsersGetResponse) GetBody ¶
func (r UsersGetResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (UsersGetResponse) GetJSON200 ¶
func (r UsersGetResponse) GetJSON200() *User
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (UsersGetResponse) Status ¶
func (r UsersGetResponse) Status() string
Status returns HTTPResponse.Status
func (UsersGetResponse) StatusCode ¶
func (r UsersGetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UsersListParams ¶
type UsersListParams struct {
// Limit Number of users to return. Omit or use 0 for the default of 10. Empty values are invalid.
Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
// Offset Number of users to skip. Omit for the default of 0. Empty values are invalid.
Offset *int `form:"offset,omitempty" json:"offset,omitempty"`
}
UsersListParams defines parameters for UsersList.
type UsersListResponse ¶
type UsersListResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *[]User
// ApplicationproblemJSON400 the response for an HTTP 400 `application/problem+json` response
ApplicationproblemJSON400 *Error
// ApplicationproblemJSON401 the response for an HTTP 401 `application/problem+json` response
ApplicationproblemJSON401 *Error
// ApplicationproblemJSON403 the response for an HTTP 403 `application/problem+json` response
ApplicationproblemJSON403 *Forbidden
// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
ApplicationproblemJSONDefault *UnexpectedResponse
}
func ParseUsersListResponse ¶
func ParseUsersListResponse(rsp *http.Response) (*UsersListResponse, error)
ParseUsersListResponse parses an HTTP response from a UsersListWithResponse call
func (UsersListResponse) ContentType ¶
func (r UsersListResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (UsersListResponse) GetApplicationproblemJSON400 ¶ added in v0.9.79
func (r UsersListResponse) GetApplicationproblemJSON400() *Error
GetApplicationproblemJSON400 returns the response for an HTTP 400 `application/problem+json` response
func (UsersListResponse) GetApplicationproblemJSON401 ¶ added in v0.9.79
func (r UsersListResponse) GetApplicationproblemJSON401() *Error
GetApplicationproblemJSON401 returns the response for an HTTP 401 `application/problem+json` response
func (UsersListResponse) GetApplicationproblemJSON403 ¶ added in v0.9.81
func (r UsersListResponse) GetApplicationproblemJSON403() *Forbidden
GetApplicationproblemJSON403 returns the response for an HTTP 403 `application/problem+json` response
func (UsersListResponse) GetApplicationproblemJSONDefault ¶ added in v0.9.79
func (r UsersListResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response
func (UsersListResponse) GetBody ¶
func (r UsersListResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (UsersListResponse) GetJSON200 ¶
func (r UsersListResponse) GetJSON200() *[]User
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (UsersListResponse) Status ¶
func (r UsersListResponse) Status() string
Status returns HTTPResponse.Status
func (UsersListResponse) StatusCode ¶
func (r UsersListResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UsersMeReadResponse ¶
type UsersMeReadResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *User
// ApplicationproblemJSON401 the response for an HTTP 401 `application/problem+json` response
ApplicationproblemJSON401 *Error
// ApplicationproblemJSON403 the response for an HTTP 403 `application/problem+json` response
ApplicationproblemJSON403 *Forbidden
// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
ApplicationproblemJSONDefault *UnexpectedResponse
}
func ParseUsersMeReadResponse ¶
func ParseUsersMeReadResponse(rsp *http.Response) (*UsersMeReadResponse, error)
ParseUsersMeReadResponse parses an HTTP response from a UsersMeReadWithResponse call
func (UsersMeReadResponse) ContentType ¶
func (r UsersMeReadResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (UsersMeReadResponse) GetApplicationproblemJSON401 ¶ added in v0.9.79
func (r UsersMeReadResponse) GetApplicationproblemJSON401() *Error
GetApplicationproblemJSON401 returns the response for an HTTP 401 `application/problem+json` response
func (UsersMeReadResponse) GetApplicationproblemJSON403 ¶ added in v0.9.81
func (r UsersMeReadResponse) GetApplicationproblemJSON403() *Forbidden
GetApplicationproblemJSON403 returns the response for an HTTP 403 `application/problem+json` response
func (UsersMeReadResponse) GetApplicationproblemJSONDefault ¶ added in v0.9.79
func (r UsersMeReadResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response
func (UsersMeReadResponse) GetBody ¶
func (r UsersMeReadResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (UsersMeReadResponse) GetJSON200 ¶
func (r UsersMeReadResponse) GetJSON200() *User
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (UsersMeReadResponse) Status ¶
func (r UsersMeReadResponse) Status() string
Status returns HTTPResponse.Status
func (UsersMeReadResponse) StatusCode ¶
func (r UsersMeReadResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UsersMeUpdateJSONRequestBody ¶
type UsersMeUpdateJSONRequestBody = UpdateSelfRequest
UsersMeUpdateJSONRequestBody defines body for UsersMeUpdate for application/json ContentType.
type UsersMeUpdateResponse ¶
type UsersMeUpdateResponse struct {
Body []byte
HTTPResponse *http.Response
// ApplicationproblemJSON400 the response for an HTTP 400 `application/problem+json` response
ApplicationproblemJSON400 *Error
// ApplicationproblemJSON401 the response for an HTTP 401 `application/problem+json` response
ApplicationproblemJSON401 *Error
// ApplicationproblemJSON403 the response for an HTTP 403 `application/problem+json` response
ApplicationproblemJSON403 *Forbidden
// ApplicationproblemJSON409 the response for an HTTP 409 `application/problem+json` response
ApplicationproblemJSON409 *UserConflict
// ApplicationproblemJSON429 the response for an HTTP 429 `application/problem+json` response
ApplicationproblemJSON429 *RateLimited
// ApplicationproblemJSON503 the response for an HTTP 503 `application/problem+json` response
ApplicationproblemJSON503 *AuthenticationUnavailable
// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
ApplicationproblemJSONDefault *UnexpectedResponse
}
func ParseUsersMeUpdateResponse ¶
func ParseUsersMeUpdateResponse(rsp *http.Response) (*UsersMeUpdateResponse, error)
ParseUsersMeUpdateResponse parses an HTTP response from a UsersMeUpdateWithResponse call
func (UsersMeUpdateResponse) ContentType ¶
func (r UsersMeUpdateResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (UsersMeUpdateResponse) GetApplicationproblemJSON400 ¶ added in v0.9.79
func (r UsersMeUpdateResponse) GetApplicationproblemJSON400() *Error
GetApplicationproblemJSON400 returns the response for an HTTP 400 `application/problem+json` response
func (UsersMeUpdateResponse) GetApplicationproblemJSON401 ¶ added in v0.9.79
func (r UsersMeUpdateResponse) GetApplicationproblemJSON401() *Error
GetApplicationproblemJSON401 returns the response for an HTTP 401 `application/problem+json` response
func (UsersMeUpdateResponse) GetApplicationproblemJSON403 ¶ added in v0.9.81
func (r UsersMeUpdateResponse) GetApplicationproblemJSON403() *Forbidden
GetApplicationproblemJSON403 returns the response for an HTTP 403 `application/problem+json` response
func (UsersMeUpdateResponse) GetApplicationproblemJSON409 ¶ added in v0.9.81
func (r UsersMeUpdateResponse) GetApplicationproblemJSON409() *UserConflict
GetApplicationproblemJSON409 returns the response for an HTTP 409 `application/problem+json` response
func (UsersMeUpdateResponse) GetApplicationproblemJSON429 ¶ added in v0.9.79
func (r UsersMeUpdateResponse) GetApplicationproblemJSON429() *RateLimited
GetApplicationproblemJSON429 returns the response for an HTTP 429 `application/problem+json` response
func (UsersMeUpdateResponse) GetApplicationproblemJSON503 ¶ added in v0.9.79
func (r UsersMeUpdateResponse) GetApplicationproblemJSON503() *AuthenticationUnavailable
GetApplicationproblemJSON503 returns the response for an HTTP 503 `application/problem+json` response
func (UsersMeUpdateResponse) GetApplicationproblemJSONDefault ¶ added in v0.9.79
func (r UsersMeUpdateResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response
func (UsersMeUpdateResponse) GetBody ¶
func (r UsersMeUpdateResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (UsersMeUpdateResponse) Status ¶
func (r UsersMeUpdateResponse) Status() string
Status returns HTTPResponse.Status
func (UsersMeUpdateResponse) StatusCode ¶
func (r UsersMeUpdateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UsersUpdateJSONRequestBody ¶
type UsersUpdateJSONRequestBody = UpdateUserRequest
UsersUpdateJSONRequestBody defines body for UsersUpdate for application/json ContentType.
type UsersUpdateResponse ¶
type UsersUpdateResponse struct {
Body []byte
HTTPResponse *http.Response
// ApplicationproblemJSON400 the response for an HTTP 400 `application/problem+json` response
ApplicationproblemJSON400 *Error
// ApplicationproblemJSON401 the response for an HTTP 401 `application/problem+json` response
ApplicationproblemJSON401 *Error
// ApplicationproblemJSON403 the response for an HTTP 403 `application/problem+json` response
ApplicationproblemJSON403 *Forbidden
// ApplicationproblemJSON404 the response for an HTTP 404 `application/problem+json` response
ApplicationproblemJSON404 *Error
// ApplicationproblemJSON409 the response for an HTTP 409 `application/problem+json` response
ApplicationproblemJSON409 *UserConflict
// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
ApplicationproblemJSONDefault *UnexpectedResponse
}
func ParseUsersUpdateResponse ¶
func ParseUsersUpdateResponse(rsp *http.Response) (*UsersUpdateResponse, error)
ParseUsersUpdateResponse parses an HTTP response from a UsersUpdateWithResponse call
func (UsersUpdateResponse) ContentType ¶
func (r UsersUpdateResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (UsersUpdateResponse) GetApplicationproblemJSON400 ¶ added in v0.9.79
func (r UsersUpdateResponse) GetApplicationproblemJSON400() *Error
GetApplicationproblemJSON400 returns the response for an HTTP 400 `application/problem+json` response
func (UsersUpdateResponse) GetApplicationproblemJSON401 ¶ added in v0.9.79
func (r UsersUpdateResponse) GetApplicationproblemJSON401() *Error
GetApplicationproblemJSON401 returns the response for an HTTP 401 `application/problem+json` response
func (UsersUpdateResponse) GetApplicationproblemJSON403 ¶ added in v0.9.81
func (r UsersUpdateResponse) GetApplicationproblemJSON403() *Forbidden
GetApplicationproblemJSON403 returns the response for an HTTP 403 `application/problem+json` response
func (UsersUpdateResponse) GetApplicationproblemJSON404 ¶ added in v0.9.79
func (r UsersUpdateResponse) GetApplicationproblemJSON404() *Error
GetApplicationproblemJSON404 returns the response for an HTTP 404 `application/problem+json` response
func (UsersUpdateResponse) GetApplicationproblemJSON409 ¶ added in v0.9.81
func (r UsersUpdateResponse) GetApplicationproblemJSON409() *UserConflict
GetApplicationproblemJSON409 returns the response for an HTTP 409 `application/problem+json` response
func (UsersUpdateResponse) GetApplicationproblemJSONDefault ¶ added in v0.9.79
func (r UsersUpdateResponse) GetApplicationproblemJSONDefault() *UnexpectedResponse
GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response
func (UsersUpdateResponse) GetBody ¶
func (r UsersUpdateResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (UsersUpdateResponse) Status ¶
func (r UsersUpdateResponse) Status() string
Status returns HTTPResponse.Status
func (UsersUpdateResponse) StatusCode ¶
func (r UsersUpdateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode