feat: Added device includeHealth and includeStatus options

Author: bflorian

package.json

@@ -28,7 +28,6 @@
 	},
 	"devDependencies": {
 		"@semantic-release/git": "^9.0.0",
-		"@types/es6-promise": "^3.3.0",
 		"@types/jest": "^26.0.10",
 		"@types/node": "^12.11.7",
 		"@types/qs": "^6.9.1",

src/endpoint-client.ts

@@ -163,31 +163,31 @@ export class EndpointClient {
 		}
 	}
 
-	public async get<T = any, R = AxiosResponse<T>>(path?: string, params?: HttpClientParams): Promise<T> {
-		return this.request('get', path, undefined, params)
+	public async get<T = any, R = AxiosResponse<T>>(path?: string, params?: HttpClientParams, options?: EndpointClientRequestOptions<T>): Promise<T> {
+		return this.request('get', path, undefined, params, options)
 	}
 
-	public post<T = any, R = AxiosResponse<T>>(path?: string, data?: any, params?: HttpClientParams): Promise<T> {
-		return this.request('post', path, data, params)
+	public post<T = any, R = AxiosResponse<T>>(path?: string, data?: any, params?: HttpClientParams, options?: EndpointClientRequestOptions<T>): Promise<T> {
+		return this.request('post', path, data, params, options)
 	}
 
-	public put<T = any, R = AxiosResponse<T>>(path?: string, data?: any, params?: HttpClientParams): Promise<T> {
-		return this.request('put', path, data, params)
+	public put<T = any, R = AxiosResponse<T>>(path?: string, data?: any, params?: HttpClientParams, options?: EndpointClientRequestOptions<T>): Promise<T> {
+		return this.request('put', path, data, params, options)
 	}
 
-	public patch<T = any, R = AxiosResponse<T>>(path?: string, data?: any, params?: HttpClientParams): Promise<T> {
-		return this.request('patch', path, data, params)
+	public patch<T = any, R = AxiosResponse<T>>(path?: string, data?: any, params?: HttpClientParams, options?: EndpointClientRequestOptions<T>): Promise<T> {
+		return this.request('patch', path, data, params, options)
 	}
 
-	public delete<T = any, R = AxiosResponse<T>>(path?: string, params?: HttpClientParams): Promise<T> {
-		return this.request('delete', path, undefined, params)
+	public delete<T = any, R = AxiosResponse<T>>(path?: string, params?: HttpClientParams, options?: EndpointClientRequestOptions<T>): Promise<T> {
+		return this.request('delete', path, undefined, params, options)
 	}
 
-	public async getPagedItems<T = any, R = AxiosResponse<T>>(path?: string, params?: HttpClientParams): Promise<T[]> {
-		let list = await this.get<ItemsList>(path, params)
+	public async getPagedItems<T = any, R = AxiosResponse<T>>(path?: string, params?: HttpClientParams, options?: EndpointClientRequestOptions<ItemsList>): Promise<T[]> {
+		let list = await this.get<ItemsList>(path, params, options)
 		const result = list.items
 		while (list._links && list._links.next) {
-			list = await this.get<ItemsList>(list._links.next.href)
+			list = await this.get<ItemsList>(list._links.next.href, undefined, options)
 			result.push(...list.items)
 		}
 		return result

src/endpoint/devices.ts

@@ -5,9 +5,12 @@ import { Links, Status, SuccessStatusValue } from '../types'
 import {PresentationDevicePresentation} from './presentation'
 
 
+const HEADER_OVERRIDES = {Accept: 'application/vnd.smartthings+json;v=20170916'}
+
 export interface CapabilityReference {
 	id: string
 	version?: number
+	status?: CapabilityStatus
 }
 
 export interface Component {
@@ -84,6 +87,11 @@ export interface ProfileIdentifier {
 	id: string
 }
 
+export interface HealthState {
+	state: DeviceHealthState
+	lastUpdatedDate?: string
+}
+
 export interface Device {
 	deviceId?: string
 	name?: string
@@ -104,6 +112,7 @@ export interface Device {
 	viper?: ViperDeviceDetails
 	type?: DeviceIntegrationType
 	restrictionTier?: number
+	healthState?: HealthState
 }
 
 export interface DeviceUpdate {
@@ -222,6 +231,16 @@ export interface DeviceListOptions {
 	 */
 	installedAppId?: string
 
+	/**
+	 * Include the device health, i.e. online/offline status in the response
+	 */
+	includeHealth?: boolean
+
+	/**
+	 * Include the device status data, i.e. the values of all attributes, in the response
+	 */
+	includeStatus?: boolean
+
 	/**
 	 * Limit the number of results to this value. By default all devices are returned
 	 */
@@ -238,6 +257,18 @@ export interface DeviceListOptions {
 	type?: DeviceIntegrationType | DeviceIntegrationType[]
 }
 
+export interface DeviceGetOptions {
+	/**
+	 * Include the device health, i.e. online/offline status in the response
+	 */
+	includeHealth?: boolean
+
+	/**
+	 * Include the device status data, i.e. the values of all attributes, in the response
+	 */
+	includeStatus?: boolean
+}
+
 export interface HueSaturation {
 	hue: number
 	saturation: number
@@ -250,10 +281,12 @@ export class DevicesEndpoint extends Endpoint {
 
 	/**
 	 * Returns a list of devices matching the query options or all devices accessible by the principal (i.e. user)
-	 * if no options are specified.
+	 * if no options are specified. If the includeHealth option is set to true then the response will also contain
+	 * the health status of each device (i.e. if it is online or offline). If the includeStatus option is set to true
+	 * then the response will also include the status of all attributes (i.e. value and timestamp)
 	 *
-	 * @param options query options, capability, capabilitiesMode ('and' or 'or'), locationId, deviceId. These can
-	 * be single values or arrays.
+	 * @param options query options, capability, capabilitiesMode ('and' or 'or'), locationId, deviceId. which can
+	 * be single values or arrays, and includeHealth & includeStatus booleans
 	 */
 	public async list(options: DeviceListOptions = {}): Promise<Device[]> {
 		const params: HttpClientParams = {}
@@ -271,6 +304,12 @@ export class DevicesEndpoint extends Endpoint {
 		if ('deviceId' in options && options.deviceId) {
 			params.deviceId = options.deviceId
 		}
+		if ('includeHealth' in options && options.includeHealth !== undefined) {
+			params.includeHealth = options.includeHealth.toString()
+		}
+		if ('includeStatus' in options && options.includeStatus !== undefined) {
+			params.includeStatus = options.includeStatus.toString()
+		}
 		if ('installedAppId' in options && options.installedAppId) {
 			params.installedAppId = options.installedAppId
 		}
@@ -283,7 +322,8 @@ export class DevicesEndpoint extends Endpoint {
 		if ('type' in options && options.type) {
 			params.type = options.type
 		}
-		return this.client.getPagedItems<Device>(undefined, params)
+		return this.client.getPagedItems<Device>(undefined, params,
+			{headerOverrides: HEADER_OVERRIDES})
 	}
 
 	/**
@@ -320,9 +360,20 @@ export class DevicesEndpoint extends Endpoint {
 	/**
 	 * Returns a description of the specified device
 	 * @param id UUID of the device
+	 * @param options optional includeHealth and includeStatus parameters.
+	 * If the includeHealth option is set to true then the response will also contain
+	 * the health status of each device (i.e. if it is online or offline). If the includeStatus option is set to true
+	 * then the response will also include the status of all attributes (i.e. value and timestamp)
 	 */
-	public get(id: string): Promise<Device> {
-		return this.client.get<Device>(id)
+	public get(id: string, options: DeviceGetOptions = {}): Promise<Device> {
+		const params: HttpClientParams = {}
+		if ('includeHealth' in options && options.includeHealth !== undefined) {
+			params.includeHealth = options.includeHealth.toString()
+		}
+		if ('includeStatus' in options && options.includeStatus !== undefined) {
+			params.includeStatus = options.includeStatus.toString()
+		}
+		return this.client.get<Device>(id, params,{headerOverrides: HEADER_OVERRIDES})
 	}
 
 	/**
@@ -382,8 +433,8 @@ export class DevicesEndpoint extends Endpoint {
 	 * @param data the new device profile
 	 */
 	public updateProfile(id: string, data: DeviceProfileUpdate): Promise<Device> {
-		return this.client.request<Device>('put',`${id}/profile`, data, undefined,
-			{headerOverrides: {Accept: 'application/vnd.smartthings+json;v=20170916'}})
+		return this.client.put<Device>(`${id}/profile`, data, undefined,
+			{headerOverrides: HEADER_OVERRIDES})
 	}
 
 	/**

test/unit/data/devices/get_devices.ts

@@ -3,7 +3,7 @@ const request = {
 	'method': 'get',
 	'headers': {
 		'Content-Type': 'application/json;charset=utf-8',
-		'Accept': 'application/json',
+		'Accept': 'application/vnd.smartthings+json;v=20170916',
 		'Authorization': 'Bearer 52991afa-66e8-4af0-8d85-5c568ed5ba7d',
 	},
 	'params': {},

test/unit/data/devices/get_devices_385931b6-0121-4848-bcc8-54cb76436de1.ts

@@ -3,9 +3,10 @@ const request = {
 	'method': 'get',
 	'headers': {
 		'Content-Type': 'application/json;charset=utf-8',
-		'Accept': 'application/json',
+		'Accept': 'application/vnd.smartthings+json;v=20170916',
 		'Authorization': 'Bearer 52991afa-66e8-4af0-8d85-5c568ed5ba7d',
 	},
+	'params': {},
 }
 const response = {
 	'deviceId': '385931b6-0121-4848-bcc8-54cb76436de1',