Class UsersApi

UsersApi - object-oriented interface

Export

Hierarchy

BaseAPI
- UsersApi

Index

Constructors

Properties

axios basePath configuration

Methods

usersDestroy usersList usersPartialUpdate usersRetrieve usersRetrieveSelf

Constructors

constructor

new UsersApi(configuration?, basePath?, axios?): UsersApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns UsersApi
Inherited from BaseAPI.constructor
- Defined in base.ts:53

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

usersDestroy

usersDestroy(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: UsersApiUsersDestroyRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Method deletes a specific user from the server

Throws

Memberof
UsersApi
- Defined in api-client/users-api.ts:628

usersList

usersList(requestParameters?, options?): Promise<AxiosResponse<PaginatedMetaUserList, any>>
Parameters
- requestParameters: UsersApiUsersListRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedMetaUserList, any>>

Summary
Method returns a paginated list of users

Throws

Memberof
UsersApi
- Defined in api-client/users-api.ts:640

usersPartialUpdate

usersPartialUpdate(requestParameters, options?): Promise<AxiosResponse<MetaUser, any>>
Parameters
- requestParameters: UsersApiUsersPartialUpdateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<MetaUser, any>>

Summary
Method updates chosen fields of a user

Throws

Memberof
UsersApi
- Defined in api-client/users-api.ts:652

usersRetrieve

usersRetrieve(requestParameters, options?): Promise<AxiosResponse<MetaUser, any>>
Parameters
- requestParameters: UsersApiUsersRetrieveRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<MetaUser, any>>

Summary
Method provides information of a specific user

Throws

Memberof
UsersApi
- Defined in api-client/users-api.ts:664

usersRetrieveSelf

usersRetrieveSelf(options?): Promise<AxiosResponse<MetaUser, any>>
Method returns an instance of a user who is currently authorized
Parameters
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<MetaUser, any>>

Summary
Method returns an instance of a user who is currently authorized

Throws

Memberof
UsersApi
- Defined in api-client/users-api.ts:675

Generated using TypeDoc