Class DeviceApi

Hierarchy

BaseAPI
- DeviceApi

Index

Constructors

Properties

Methods

listDevices listDevicesRaw readDevices readDevicesRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

listDevices

listDevices(requestParameters?: ListDevicesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
List Devices
Parameters
- requestParameters: ListDevicesRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/DeviceApi.ts:67

listDevicesRaw

listDevicesRaw(requestParameters: ListDevicesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
List Devices
Parameters
- requestParameters: ListDevicesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/DeviceApi.ts:37

readDevices

readDevices(requestParameters: ReadDevicesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Read Devices
Parameters
- requestParameters: ReadDevicesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/DeviceApi.ts:101

readDevicesRaw

readDevicesRaw(requestParameters: ReadDevicesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Read Devices
Parameters
- requestParameters: ReadDevicesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/apis/DeviceApi.ts:75

`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

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