Class UsersApi

Hierarchy

BaseAPI
- UsersApi

Index

Constructors

Properties

Methods

createNewUser createNewUserRaw deleteUser deleteUserRaw listUsers listUsersRaw readUserById readUserByIdRaw request updateLogo updateLogoRaw updateUser updateUserRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new UsersApi(configuration?: Configuration): UsersApi
Parameters
- configuration: Configuration = DefaultConfig
Returns UsersApi
Inherited from BaseAPI.constructor
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/runtime.ts:96

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

createNewUser

createNewUser(requestParameters?: CreateNewUserOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Create New User
Parameters
- requestParameters: CreateNewUserOperationRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/UsersApi.ts:94

createNewUserRaw

createNewUserRaw(requestParameters: CreateNewUserOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Create New User
Parameters
- requestParameters: CreateNewUserOperationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/UsersApi.ts:69

deleteUser

deleteUser(requestParameters: DeleteUserRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Delete User
Parameters
- requestParameters: DeleteUserRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/UsersApi.ts:128

deleteUserRaw

deleteUserRaw(requestParameters: DeleteUserRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Delete User
Parameters
- requestParameters: DeleteUserRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/UsersApi.ts:102

listUsers

listUsers(requestParameters?: ListUsersRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
List Users
Parameters
- requestParameters: ListUsersRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/UsersApi.ts:158

listUsersRaw

listUsersRaw(requestParameters: ListUsersRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
List Users
Parameters
- requestParameters: ListUsersRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/UsersApi.ts:136

readUserById

readUserById(requestParameters: ReadUserByIdRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Read User By Id
Parameters
- requestParameters: ReadUserByIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/UsersApi.ts:192

readUserByIdRaw

readUserByIdRaw(requestParameters: ReadUserByIdRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Read User By Id
Parameters
- requestParameters: ReadUserByIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/UsersApi.ts:166

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/runtime.ts:116

updateLogo

updateLogo(requestParameters?: UpdateLogoOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Update Logo
Parameters
- requestParameters: UpdateLogoOperationRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/UsersApi.ts:225

updateLogoRaw

updateLogoRaw(requestParameters: UpdateLogoOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Update Logo
Parameters
- requestParameters: UpdateLogoOperationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/UsersApi.ts:200

updateUser

updateUser(requestParameters: UpdateUserOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
update user
Parameters
- requestParameters: UpdateUserOperationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/UsersApi.ts:262

updateUserRaw

updateUserRaw(requestParameters: UpdateUserOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
update user
Parameters
- requestParameters: UpdateUserOperationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/UsersApi.ts:233

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/runtime.ts:100

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: (undefined | ((context: ResponseContext) => Promise<void | Response>))[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: (undefined | ((context: ResponseContext) => Promise<void | Response>))[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/runtime.ts:111

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: (undefined | ((context: RequestContext) => Promise<void | FetchParams>))[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: (undefined | ((context: RequestContext) => Promise<void | FetchParams>))[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/runtime.ts:106

Generated using TypeDoc