Class RolesApi

Hierarchy

BaseAPI
- RolesApi

Index

Constructors

Properties

Methods

createRole createRoleRaw deleteRole deleteRoleRaw listRoles listRolesRaw readRole readRoleRaw request updateRole updateRoleRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

createRole

createRole(requestParameters?: CreateRoleOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Create Role
Parameters
- requestParameters: CreateRoleOperationRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/RolesApi.ts:86

createRoleRaw

createRoleRaw(requestParameters: CreateRoleOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Create Role
Parameters
- requestParameters: CreateRoleOperationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/RolesApi.ts:61

deleteRole

deleteRole(requestParameters: DeleteRoleRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Delete Role
Parameters
- requestParameters: DeleteRoleRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/RolesApi.ts:120

deleteRoleRaw

deleteRoleRaw(requestParameters: DeleteRoleRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Delete Role
Parameters
- requestParameters: DeleteRoleRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/RolesApi.ts:94

listRoles

listRoles(requestParameters?: ListRolesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
List Roles
Parameters
- requestParameters: ListRolesRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/RolesApi.ts:150

listRolesRaw

listRolesRaw(requestParameters: ListRolesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
List Roles
Parameters
- requestParameters: ListRolesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/RolesApi.ts:128

readRole

readRole(requestParameters: ReadRoleRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Read Role
Parameters
- requestParameters: ReadRoleRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/RolesApi.ts:184

readRoleRaw

readRoleRaw(requestParameters: ReadRoleRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Read Role
Parameters
- requestParameters: ReadRoleRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/RolesApi.ts:158

`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

updateRole

updateRole(requestParameters: UpdateRoleOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Update Role
Parameters
- requestParameters: UpdateRoleOperationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/RolesApi.ts:221

updateRoleRaw

updateRoleRaw(requestParameters: UpdateRoleOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Update Role
Parameters
- requestParameters: UpdateRoleOperationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/RolesApi.ts:192

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