Class UserApi

UserApi - object-oriented interface

export

Hierarchy

BaseAPI
- UserApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new UserApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): UserApi

Inherited from BaseAPI.constructor
- Defined in base.ts:50
Parameters
- Optional configuration: Configuration
- Default value basePath: string = BASE_PATH
- Default value axios: AxiosInstance = globalAxios
Returns UserApi

Properties

Protected axios

axios: AxiosInstance

Protected basePath

basePath: string

Protected configuration

configuration: Configuration | undefined

Methods

createUser

createUser(createUserRequest: CreateUserRequest, options?: any): Promise<AxiosResponse<User>>

- Defined in api.ts:3365
Creates a new ChatKitty user.

summary

Create User

throws

{RequiredError}

memberof

UserApi

Parameters
- createUserRequest: CreateUserRequest
  
  New user parameters
- Optional options: any
Returns Promise<AxiosResponse<User>>

deleteUser

deleteUser(id: number, options?: any): Promise<AxiosResponse<Application>>

- Defined in api.ts:3377
Deletes a user.

summary

Delete User

throws

{RequiredError}

memberof

UserApi

Parameters
- id: number
- Optional options: any
Returns Promise<AxiosResponse<Application>>

deleteUserSecret

deleteUserSecret(id: number, name: string, options?: any): Promise<AxiosResponse<User>>

- Defined in api.ts:3390
Removes a user.

summary

Delete User Secret

throws

{RequiredError}

memberof

UserApi

Parameters
- id: number
- name: string
- Optional options: any
Returns Promise<AxiosResponse<User>>

getUser

getUser(id: number, options?: any): Promise<AxiosResponse<User>>

- Defined in api.ts:3402
Gets a user.

summary

Get User

throws

{RequiredError}

memberof

UserApi

Parameters
- id: number
- Optional options: any
Returns Promise<AxiosResponse<User>>

getUserExists

getUserExists(name: string, options?: any): Promise<AxiosResponse<void>>

- Defined in api.ts:3414
Checks if a user exists.

summary

Get User Exists

throws

{RequiredError}

memberof

UserApi

Parameters
- name: string
  
  The username of the user
- Optional options: any
Returns Promise<AxiosResponse<void>>

getUserSecret

getUserSecret(id: number, name: string, options?: any): Promise<AxiosResponse<Secret>>

- Defined in api.ts:3427
Gets a user sceret.

summary

Get User Secret

throws

{RequiredError}

memberof

UserApi

Parameters
- id: number
- name: string
- Optional options: any
Returns Promise<AxiosResponse<Secret>>

getUsers

getUsers(page?: number, size?: number, name?: string, options?: any): Promise<AxiosResponse<UserPage>>

- Defined in api.ts:3441
Gets a user page.

summary

Get User Page

throws

{RequiredError}

memberof

UserApi

Parameters
- Optional page: number
- Optional size: number
- Optional name: string
- Optional options: any
Returns Promise<AxiosResponse<UserPage>>

updateUser

updateUser(id: number, user: User, options?: any): Promise<AxiosResponse<User>>

- Defined in api.ts:3454
Updates a ChatKitty user.

summary

Update User

throws

{RequiredError}

memberof

UserApi

Parameters
- id: number
- user: User
  
  ChatKitty user with properties to be updated
- Optional options: any
Returns Promise<AxiosResponse<User>>

updateUserSecret

updateUserSecret(id: number, name: string, secret: Secret, options?: any): Promise<AxiosResponse<User>>

- Defined in api.ts:3468
Puts a user secret.

summary

Update User Secret

throws

{RequiredError}

memberof

UserApi

Parameters
- id: number
- name: string
- secret: Secret
  
  Secret value
- Optional options: any
Returns Promise<AxiosResponse<User>>

Generated using TypeDoc, the 9/1/2021 at 5:54:10 AM