@placeos/ts-client 4.8.3 → 4.8.5

package/dist/zones/interfaces.d.ts

@@ -7,6 +7,8 @@ export interface PlaceZoneQueryOptions extends PlaceResourceQueryOptions {
     tags?: string;
     /** ID of the system to filter the results */
     control_system_id?: string;
+    /** Whether zones should include a count of their children */
+    include_children_count?: boolean;
 }
 /** Mapping of available query parameters for the zones show endpoint */
 export interface PlaceZoneShowOptions {

package/dist/zones/zone.d.ts

@@ -33,6 +33,8 @@ export declare class PlaceZone extends PlaceResource {
     readonly type: string;
     /** Count of resources associated with the zone */
     readonly count: number;
+    /** Count of child zones for this zone */
+    readonly children_count?: number;
     /** Amount of physical capacity associated with the zone */
     readonly capacity: number;
     /** ID or URL of or in a map associated with the zone */

package/package.json

@@ -1,5 +1,5 @@
 {
-    "version": "4.8.3",
+    "version": "4.8.5",
     "license": "MIT",
     "name": "@placeos/ts-client",
     "author": "Alex Sorafumo <alex@place.tech>",

package/src/zones/functions.ts

@@ -10,7 +10,11 @@ import {
 import { PlaceResourceQueryOptions } from '../resources/interface';
 import { PlaceTrigger } from '../triggers/trigger';
 import { HashMap } from '../utilities/types';
-import { PlaceZoneMetadataQueryOptions, PlaceZoneQueryOptions, PlaceZoneShowOptions } from './interfaces';
+import {
+    PlaceZoneMetadataQueryOptions,
+    PlaceZoneQueryOptions,
+    PlaceZoneShowOptions,
+} from './interfaces';
 import { PlaceZone } from './zone';
 
 /**

package/src/zones/interfaces.ts

@@ -8,6 +8,8 @@ export interface PlaceZoneQueryOptions extends PlaceResourceQueryOptions {
     tags?: string;
     /** ID of the system to filter the results */
     control_system_id?: string;
+    /** Whether zones should include a count of their children */
+    include_children_count?: boolean;
 }
 
 /** Mapping of available query parameters for the zones show endpoint */

package/src/zones/zone.ts

@@ -36,6 +36,8 @@ export class PlaceZone extends PlaceResource {
     public readonly type: string;
     /** Count of resources associated with the zone */
     public readonly count: number;
+    /** Count of child zones for this zone */
+    public readonly children_count?: number;
     /** Amount of physical capacity associated with the zone */
     public readonly capacity: number;
     /** ID or URL of or in a map associated with the zone */
@@ -69,6 +71,8 @@ export class PlaceZone extends PlaceResource {
         this.timezone = raw_data.timezone || '';
         this.images = raw_data.images || [];
         this.playlists = raw_data.playlists || [];
+        if (isFinite(Number(raw_data.children_count)))
+            this.children_count = raw_data.children_count;
         if (typeof this.settings !== 'object') {
             (this as any).settings = [null, null, null, null];
         }