Class UsersApi

UsersApi - object-oriented interface

Export

UsersApi

Hierarchy

BaseAPI
- UsersApi

Index

Constructors

Properties

axios basePath configuration

Methods

usersDestroy usersList usersPartialUpdate usersRetrieve usersRetrieveSelf

Constructors

constructor

new UsersApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): UsersApi
Parameters
- Optionalconfiguration: 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: UsersApiUsersDestroyRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: UsersApiUsersDestroyRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
UsersApi
- Defined in api-client/users-api.ts:637

usersList

usersList(
requestParameters?: UsersApiUsersListRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PaginatedMetaUserList, any>>
Parameters
- requestParameters: UsersApiUsersListRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaginatedMetaUserList, any>>
Throws
Memberof
UsersApi
- Defined in api-client/users-api.ts:649

usersPartialUpdate

usersPartialUpdate(
requestParameters: UsersApiUsersPartialUpdateRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<MetaUser, any>>
Parameters
- requestParameters: UsersApiUsersPartialUpdateRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<MetaUser, any>>
Throws
Memberof
UsersApi
- Defined in api-client/users-api.ts:661

usersRetrieve

usersRetrieve(
requestParameters: UsersApiUsersRetrieveRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<MetaUser, any>>
Parameters
- requestParameters: UsersApiUsersRetrieveRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<MetaUser, any>>
Throws
Memberof
UsersApi
- Defined in api-client/users-api.ts:673

usersRetrieveSelf

usersRetrieveSelf(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<MetaUser, any>>
Method returns an instance of a user who is currently authenticated
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<MetaUser, any>>
Throws
Memberof
UsersApi
- Defined in api-client/users-api.ts:684