@placeos/ts-client 4.5.0 → 4.7.0

package/dist/storages/storage.class.d.ts

@@ -0,0 +1,18 @@
+/** Storage type enumeration */
+export type StorageType = 's3' | 'azure' | 'google';
+export declare class PlaceStorage {
+    readonly id: string;
+    readonly storage_type: StorageType | null;
+    readonly bucket_name: string;
+    readonly region: string;
+    readonly access_key: string;
+    readonly access_secret: string;
+    readonly authority_id: string;
+    readonly endpoint: string;
+    readonly is_default: boolean;
+    readonly ext_filter: string[];
+    readonly mime_filter: string[];
+    readonly created_at: number;
+    readonly updated_at: number;
+    constructor(data: Partial<PlaceStorage>);
+}

package/dist/systems/functions.d.ts

@@ -3,7 +3,7 @@ import { PlaceSettings } from '../settings/settings';
 import { PlaceTrigger } from '../triggers/trigger';
 import { HashMap } from '../utilities/types';
 import { PlaceZone } from '../zones/zone';
-import { PlaceModuleFunctionMap, PlaceSystemsQueryOptions } from './interfaces';
+import { PlaceModuleFunctionMap, PlaceSystemControlOptions, PlaceSystemMetadataOptions, PlaceSystemShowOptions, PlaceSystemsQueryOptions, PlaceSystemsWithEmailsOptions, PlaceSystemStartStopOptions, PlaceSystemTriggerShowOptions, PlaceSystemTriggersQueryOptions } from './interfaces';
 import { PlaceSystem } from './system';
 /**
  * Query the available systems
@@ -11,16 +11,16 @@ import { PlaceSystem } from './system';
  */
 export declare function querySystems(query_params?: PlaceSystemsQueryOptions): import('..').QueryResponse<PlaceSystem>;
 /**
- * Query the available systems
+ * Query the available systems by email addresses
  * @param query_params Query parameters to add the to request URL
  */
-export declare function querySystemsWithEmails(query_params?: PlaceSystemsQueryOptions): import('..').QueryResponse<PlaceSystem>;
+export declare function querySystemsWithEmails(query_params: PlaceSystemsWithEmailsOptions): import('..').QueryResponse<PlaceSystem>;
 /**
  * Get the data for a system
  * @param id ID of the system to retrieve
  * @param query_params Query parameters to add the to request URL
  */
-export declare function showSystem(id: string, query_params?: PlaceSystemsQueryOptions): Observable<PlaceSystem>;
+export declare function showSystem(id: string, query_params?: PlaceSystemShowOptions): Observable<PlaceSystem>;
 /**
  * Update the system in the database
  * @param id ID of the system
@@ -36,11 +36,10 @@ export declare function updateSystem(id: string, form_data: Partial<PlaceSystem>
  */
 export declare function addSystem(form_data: Partial<PlaceSystem>): Observable<PlaceSystem>;
 /**
- * Remove an system from the database
+ * Remove a system from the database
  * @param id ID of the system
- * @param query_params Query parameters to add the to request URL
  */
-export declare function removeSystem(id: string, query_params?: HashMap): Observable<HashMap<any>>;
+export declare function removeSystem(id: string): Observable<HashMap<any>>;
 /**
  * Add module to the given system
  * @param id System ID
@@ -56,13 +55,15 @@ export declare function removeSystemModule(id: string, module_id: string): Obser
 /**
  * Start the given system and clears any existing caches
  * @param id System ID
+ * @param query_params Query parameters to add the to request URL
  */
-export declare function startSystem(id: string): Observable<void>;
+export declare function startSystem(id: string, query_params?: PlaceSystemStartStopOptions): Observable<void>;
 /**
  * Stops all modules in the given system
  * @param id System ID
+ * @param query_params Query parameters to add the to request URL
  */
-export declare function stopSystem(id: string): Observable<void>;
+export declare function stopSystem(id: string, query_params?: PlaceSystemStartStopOptions): Observable<void>;
 /**
  * Execute a function of the given system module
  * @param id System ID
@@ -116,8 +117,9 @@ export declare function listSystemZones(id: string): import('..').QueryResponse<
 /**
  * Get list of triggers for system
  * @param id System ID
+ * @param query_params Query parameters to add the to request URL
  */
-export declare function listSystemTriggers(id: string): import('..').QueryResponse<PlaceTrigger>;
+export declare function listSystemTriggers(id: string, query_params?: PlaceSystemTriggersQueryOptions): import('..').QueryResponse<PlaceTrigger>;
 /**
  * Get list of triggers for system
  * @param id System ID
@@ -135,3 +137,29 @@ export declare function removeSystemTrigger(id: string, trigger_id: string): Obs
  * @param id System ID
  */
 export declare function systemSettings(id: string): Observable<PlaceSettings[]>;
+/**
+ * Get the websocket API endpoint URL for system control.
+ * @param query_params Query parameters to add to the URL
+ */
+export declare function systemControlUrl(query_params?: PlaceSystemControlOptions): string;
+/**
+ * Get metadata for the system
+ * @param id System ID
+ * @param query_params Query parameters to add to the request
+ */
+export declare function systemMetadata(id: string, query_params?: PlaceSystemMetadataOptions): Observable<HashMap>;
+/**
+ * Get a particular trigger instance
+ * @param sys_id System ID
+ * @param trig_id Trigger ID
+ * @param query_params Query parameters to add to the request
+ */
+export declare function showSystemTrigger(sys_id: string, trig_id: string, query_params?: PlaceSystemTriggerShowOptions): Observable<PlaceTrigger>;
+/**
+ * Update the details of a trigger instance
+ * @param sys_id System ID
+ * @param trig_id Trigger ID
+ * @param data Values for trigger properties
+ * @param method HTTP verb to use on request. Defaults to `patch`
+ */
+export declare function updateSystemTrigger(sys_id: string, trig_id: string, data: Partial<PlaceTrigger>, method?: 'put' | 'patch'): Observable<PlaceTrigger>;

package/dist/systems/interfaces.d.ts

@@ -12,17 +12,70 @@ export interface PlaceModuleFunction {
 }
 /** Allowable query parameters for systems index endpoint */
 export interface PlaceSystemsQueryOptions extends PlaceResourceQueryOptions {
-    /** Comma seperated list of email addresses to filter on */
-    in?: string;
+    /** Return only bookable or non-bookable rooms (returns both when not specified) */
+    bookable?: boolean;
+    /** Return only rooms with capacity equal or greater than provided */
+    capacity?: number;
+    /** Return only systems whose resource address matches one of the emails provided */
+    email?: string;
+    /** Comma separated list of features. Return only rooms with all requested features */
+    features?: string;
+    /** Return only systems which have this module ID */
+    module_id?: string;
+    /** Return systems using this trigger ID */
+    trigger_id?: string;
     /** Zone ID to filter the returned values on */
     zone_id?: string;
-    /** Driver ID to filter the returned values on */
-    module_id?: string;
+    /** Return systems which are public */
+    public?: boolean;
     /** Only return systems that have signage capabilities */
     signage?: boolean;
 }
+/** Allowable query parameters for systems with_emails endpoint */
+export interface PlaceSystemsWithEmailsOptions {
+    /** Comma separated list of email addresses (required) */
+    in: string;
+}
 /** Allowable query parameters for systems show endpoint */
 export interface PlaceSystemShowOptions {
-    /** Whether to return zone and module data for the system */
+    /** Return the system with zone, module, and driver information collected */
+    complete?: boolean;
+}
+/** Allowable query parameters for systems update endpoint */
+export interface PlaceSystemUpdateOptions {
+    /** Version number to prevent overwriting newer config (required for PUT/PATCH) */
+    version: number;
+}
+/** Allowable query parameters for system start/stop endpoints */
+export interface PlaceSystemStartStopOptions {
+    /** Start/stop modules that only occur in the selected system */
+    single_occurrence?: boolean;
+}
+/** Allowable query parameters for system triggers index endpoint */
+export interface PlaceSystemTriggersQueryOptions extends PlaceResourceQueryOptions {
+    /** Provide the control system details */
+    complete?: boolean;
+    /** Only return triggers marked as important */
+    important?: boolean;
+    /** Only return triggers that have recently been triggered */
+    triggered?: boolean;
+    /** Filter by a particular trigger type */
+    trigger_id?: string;
+    /** Return triggers updated before the time specified (unix epoch) */
+    as_of?: number;
+}
+/** Allowable query parameters for systems control endpoint */
+export interface PlaceSystemControlOptions {
+    /** Fixed device identifier */
+    fixed_device?: boolean;
+}
+/** Allowable query parameters for system metadata endpoint */
+export interface PlaceSystemMetadataOptions {
+    /** Name of the metadata key */
+    name?: string;
+}
+/** Allowable query parameters for system trigger show endpoint */
+export interface PlaceSystemTriggerShowOptions {
+    /** Return the full trigger details */
     complete?: boolean;
 }

package/dist/triggers/functions.d.ts

@@ -1,18 +1,17 @@
 import { Observable } from 'rxjs';
-import { PlaceResourceQueryOptions } from '../resources/interface';
-import { HashMap } from '../utilities/types';
+import { PlaceTriggerQueryOptions, PlaceTriggerShowOptions } from './interfaces';
 import { PlaceTrigger } from './trigger';
 /**
  * Query the available triggers
  * @param query_params Query parameters to add the to request URL
  */
-export declare function queryTriggers(query_params?: PlaceResourceQueryOptions): import('..').QueryResponse<PlaceTrigger>;
+export declare function queryTriggers(query_params?: PlaceTriggerQueryOptions): import('..').QueryResponse<PlaceTrigger>;
 /**
  * Get the data for a trigger
  * @param id ID of the trigger to retrieve
  * @param query_params Query parameters to add the to request URL
  */
-export declare function showTrigger(id: string, query_params?: PlaceResourceQueryOptions): Observable<PlaceTrigger>;
+export declare function showTrigger(id: string, query_params?: PlaceTriggerShowOptions): Observable<PlaceTrigger>;
 /**
  * Update the trigger in the database
  * @param id ID of the trigger
@@ -28,11 +27,10 @@ export declare function updateTrigger(id: string, form_data: Partial<PlaceTrigge
  */
 export declare function addTrigger(form_data: Partial<PlaceTrigger>): Observable<PlaceTrigger>;
 /**
- * Remove an trigger from the database
+ * Remove a trigger from the database
  * @param id ID of the trigger
- * @param query_params Query parameters to add the to request URL
  */
-export declare function removeTrigger(id: string, query_params?: HashMap): Observable<HashMap<any>>;
+export declare function removeTrigger(id: string): Observable<import('../utilities/types').HashMap<any>>;
 /**
  * List systems that contain instances of a trigger
  * @param id ID of the trigger to grab system instances for

package/dist/triggers/interfaces.d.ts

@@ -1,4 +1,13 @@
+import { PlaceResourceQueryOptions } from '../resources/interface';
 import { HashMap } from '../utilities/types';
+/** Mapping of available query parameters for the triggers index endpoint */
+export interface PlaceTriggerQueryOptions extends PlaceResourceQueryOptions {
+}
+/** Mapping of available query parameters for the triggers show endpoint */
+export interface PlaceTriggerShowOptions {
+    /** Return the instances associated with this trigger */
+    instances?: boolean;
+}
 export interface TriggerActions {
     /** List of functions to execute when the trigger is activated */
     functions: TriggerFunction[];

package/dist/users/functions.d.ts

@@ -1,5 +1,6 @@
+import { Observable } from 'rxjs';
 import { HashMap } from '../utilities/types';
-import { PlaceUserQueryOptions } from './interfaces';
+import { PlaceUserDeleteOptions, PlaceUserGroupsOptions, PlaceUserMetadataOptions, PlaceUserMetadataSearchOptions, PlaceUserQueryOptions, PlaceUserShowOptions } from './interfaces';
 import { PlaceUser } from './user';
 /**
  * Query the available triggers
@@ -7,16 +8,16 @@ import { PlaceUser } from './user';
  */
 export declare function queryUsers(query_params?: PlaceUserQueryOptions): import('..').QueryResponse<PlaceUser>;
 /**
- * Get the data for a trigger
- * @param id ID of the trigger to retrieve
+ * Get the data for a user
+ * @param id ID of the user to retrieve
  * @param query_params Query parameters to add the to request URL
  */
-export declare function showUser(id: string, query_params?: PlaceUserQueryOptions): import('rxjs').Observable<PlaceUser>;
+export declare function showUser(id: string, query_params?: PlaceUserShowOptions): Observable<PlaceUser>;
 /**
  * Get the data for the currently logged in user
  * @param query_params Query parameters to add the to request URL
  */
-export declare function currentUser(query_params?: PlaceUserQueryOptions): import('rxjs').Observable<PlaceUser>;
+export declare function currentUser(query_params?: PlaceUserShowOptions): Observable<PlaceUser>;
 /**
  * Update the trigger in the database
  * @param id ID of the trigger
@@ -24,16 +25,55 @@ export declare function currentUser(query_params?: PlaceUserQueryOptions): impor
  * @param query_params Query parameters to add the to request URL
  * @param method HTTP verb to use on request. Defaults to `patch`
  */
-export declare function updateUser(id: string, form_data: Partial<PlaceUser>, method?: 'put' | 'patch'): import('rxjs').Observable<PlaceUser>;
+export declare function updateUser(id: string, form_data: Partial<PlaceUser>, method?: 'put' | 'patch'): Observable<PlaceUser>;
 /**
  * Add a new trigger to the database
  * @param form_data Trigger data
  * @param query_params Query parameters to add the to request URL
  */
-export declare function addUser(form_data: Partial<PlaceUser>): import('rxjs').Observable<PlaceUser>;
+export declare function addUser(form_data: Partial<PlaceUser>): Observable<PlaceUser>;
 /**
- * Remove an trigger from the database
- * @param id ID of the trigger
+ * Remove a user from the database
+ * @param id ID of the user
  * @param query_params Query parameters to add the to request URL
  */
-export declare function removeUser(id: string, query_params?: HashMap): import('rxjs').Observable<HashMap<any>>;
+export declare function removeUser(id: string, query_params?: PlaceUserDeleteOptions): Observable<HashMap<any>>;
+/**
+ * Get the groups that users are in
+ * @param query_params Query parameters including email addresses
+ */
+export declare function queryUserGroups(query_params: PlaceUserGroupsOptions): Observable<HashMap<string[]>>;
+/**
+ * Search user metadata with provided JSON Path query
+ * @param query_params Query parameters including filter
+ */
+export declare function searchUserMetadata(query_params: PlaceUserMetadataSearchOptions): Observable<HashMap[]>;
+/**
+ * Obtain a token to the current user's SSO resources
+ */
+export declare function currentUserResourceToken(): Observable<{
+    token: string;
+}>;
+/**
+ * Get a user's metadata
+ * @param id User ID
+ * @param query_params Query parameters to add to the request
+ */
+export declare function userMetadata(id: string, query_params?: PlaceUserMetadataOptions): Observable<HashMap>;
+/**
+ * Remove the saved resource token of a user
+ * @param id User ID
+ */
+export declare function removeUserResourceToken(id: string): Observable<void>;
+/**
+ * Obtain a token to the specified user's SSO resources
+ * @param id User ID
+ */
+export declare function userResourceToken(id: string): Observable<{
+    token: string;
+}>;
+/**
+ * Undelete a user
+ * @param id User ID
+ */
+export declare function reviveUser(id: string): Observable<PlaceUser>;

package/dist/users/interfaces.d.ts

@@ -1,6 +1,39 @@
 import { PlaceResourceQueryOptions } from '../resources/interface';
-/** Mapping of available query paramters for the users index */
+/** Mapping of available query parameters for the users index endpoint */
 export interface PlaceUserQueryOptions extends PlaceResourceQueryOptions {
-    /** Return only users on the given domain */
+    /** Include soft deleted users in the results */
+    include_deleted?: boolean;
+    /** Include user metadata in the response */
+    include_metadata?: boolean;
+    /** Admin users can view other domains (ignored for other users) */
     authority_id?: string;
 }
+/** Mapping of available query parameters for the users show endpoint */
+export interface PlaceUserShowOptions {
+    /** Include user metadata in the response */
+    include_metadata?: boolean;
+}
+/** Mapping of available query parameters for the users delete endpoint */
+export interface PlaceUserDeleteOptions {
+    /** Force permanent removal of user */
+    force_removal?: boolean;
+}
+/** Mapping of available query parameters for the users groups endpoint */
+export interface PlaceUserGroupsOptions {
+    /** Comma-separated list of email addresses */
+    emails: string;
+}
+/** Mapping of available query parameters for the users metadata search endpoint */
+export interface PlaceUserMetadataSearchOptions {
+    /** JSON Path query filter */
+    filter: string;
+    /** Maximum number of results to return */
+    limit?: number;
+    /** Offset for pagination */
+    offset?: number;
+}
+/** Mapping of available query parameters for the user metadata endpoint */
+export interface PlaceUserMetadataOptions {
+    /** Name of the metadata key */
+    name?: string;
+}

package/dist/webrtc/functions.d.ts

@@ -0,0 +1,52 @@
+import { Observable } from 'rxjs';
+import { PlaceGuestParticipant, PlaceKickReason, PlaceWebrtcMember, PlaceWebrtcRoomDetails, PlaceWebrtcRoomsQueryOptions } from './interfaces';
+/**
+ * Query the list of public chat rooms for the current domain
+ * @param query_params Query parameters to add to the request URL
+ */
+export declare function queryWebrtcRooms(query_params?: PlaceWebrtcRoomsQueryOptions): Observable<PlaceWebrtcRoomDetails[]>;
+/**
+ * Get the details of a public chat room
+ * @param system_id Either a system ID or a unique permalink
+ */
+export declare function showWebrtcRoom(system_id: string): Observable<PlaceWebrtcRoomDetails>;
+/**
+ * Get a list of connected users in a chat session
+ * @param session_id ID of the chat session
+ */
+export declare function webrtcSessionMembers(session_id: string): Observable<PlaceWebrtcMember[]>;
+/**
+ * Request guest access to an anonymous chat room.
+ * The guest participant details will be forwarded to any listening systems.
+ * Additional fields provided as part of the guest post will also be forwarded.
+ * @param system_id Either a system ID or a unique permalink
+ * @param participant Guest participant details
+ */
+export declare function webrtcGuestEntry(system_id: string, participant: PlaceGuestParticipant): Observable<void>;
+/**
+ * End a guest call gracefully.
+ * This will remove the authentication token and close any open websockets.
+ */
+export declare function webrtcGuestExit(): Observable<void>;
+/**
+ * Kick a user from a chat session.
+ * Similar to guest exit without the token expiration.
+ * Other members of the call will stop communicating with them.
+ * @param user_id ID of the user to kick
+ * @param session_id ID of the chat session
+ * @param reason Reason for kicking the user
+ */
+export declare function webrtcKickUser(user_id: string, session_id: string, reason: PlaceKickReason): Observable<void>;
+/**
+ * Transfer a user from one chat to another.
+ * For authorized users to move people from one chat to another.
+ * @param user_id ID of the user to transfer
+ * @param session_id ID of the current chat session
+ * @param connection_details Optional custom connection details for the transfer
+ */
+export declare function webrtcTransferUser(user_id: string, session_id: string, connection_details?: Record<string, unknown>): Observable<void>;
+/**
+ * Get the WebRTC signaller websocket URL.
+ * This is the endpoint for managing call participants.
+ */
+export declare function webrtcSignallerUrl(): string;

package/dist/webrtc/interfaces.d.ts

@@ -0,0 +1,73 @@
+import { PlaceResourceQueryOptions } from '../resources/interface';
+/** Mapping of available query parameters for the webrtc rooms index endpoint */
+export interface PlaceWebrtcRoomsQueryOptions extends PlaceResourceQueryOptions {
+}
+/** Guest participant details for joining an anonymous chat room */
+export interface PlaceGuestParticipant {
+    /** Captcha token for verification (required) */
+    captcha: string;
+    /** Display name for the guest (required) */
+    name: string;
+    /** User ID for the guest (required) */
+    user_id: string;
+    /** Session ID for the chat (required) */
+    session_id: string;
+    /** Email address of the guest */
+    email?: string;
+    /** Phone number of the guest */
+    phone?: string;
+    /** Type of participant */
+    type?: string;
+    /** User ID of the person to chat with directly */
+    chat_to_user_id?: string;
+}
+/** Reason for kicking a user from a chat */
+export interface PlaceKickReason {
+    /** Reason for ending the call (required) */
+    reason: string;
+}
+/** Details of a WebRTC public chat room */
+export interface PlaceWebrtcRoomDetails {
+    /** System information for the room */
+    system?: {
+        created_at?: number;
+        updated_at?: number;
+        name?: string;
+        description?: string;
+        features?: string[];
+        email?: string;
+        bookable?: boolean;
+        public?: boolean;
+        display_name?: string;
+        code?: string;
+        type?: string;
+        capacity?: number;
+        map_id?: string;
+        approval?: boolean;
+        images?: string[];
+        timezone?: Record<string, unknown>;
+        support_url?: string;
+        timetable_url?: string;
+        camera_snapshot_url?: string;
+        camera_url?: string;
+        room_booking_url?: string;
+        version?: number;
+        installed_ui_devices?: number;
+        zones?: string[];
+        modules?: string[];
+        orientation?: 'unspecified' | 'landscape' | 'portrait' | 'square';
+        playlists?: string[];
+        signage?: boolean;
+    };
+}
+/** Member details in a WebRTC chat session */
+export interface PlaceWebrtcMember {
+    /** User ID of the member */
+    user_id?: string;
+    /** Display name of the member */
+    name?: string;
+    /** Email of the member */
+    email?: string;
+    /** Whether the member is a guest */
+    is_guest?: boolean;
+}

package/dist/zones/functions.d.ts

@@ -1,7 +1,8 @@
 import { Observable } from 'rxjs';
+import { PlaceResourceQueryOptions } from '../resources/interface';
 import { PlaceTrigger } from '../triggers/trigger';
 import { HashMap } from '../utilities/types';
-import { PlaceZoneQueryOptions, PlaceZoneShowOptions } from './interfaces';
+import { PlaceZoneMetadataQueryOptions, PlaceZoneQueryOptions, PlaceZoneShowOptions } from './interfaces';
 import { PlaceZone } from './zone';
 /**
  * Query the available applications
@@ -34,17 +35,16 @@ export declare function updateZone(id: string, form_data: Partial<PlaceZone>, me
  */
 export declare function addZone(form_data: Partial<PlaceZone>): Observable<PlaceZone>;
 /**
- * Remove an application from the database
- * @param id ID of the application
- * @param query_params Query parameters to add the to request URL
+ * Remove a zone from the database
+ * @param id ID of the zone
  */
-export declare function removeZone(id: string, query_params?: HashMap): Observable<HashMap<any>>;
+export declare function removeZone(id: string): Observable<HashMap<any>>;
 /**
  * Query the triggers for a zone
  * @param id ID of the zone
  * @param query_params Query parameters to add the to request URL
  */
-export declare function listZoneTriggers(id: string, query_params?: HashMap): import('..').QueryResponse<PlaceTrigger>;
+export declare function listZoneTriggers(id: string, query_params?: PlaceResourceQueryOptions): import('..').QueryResponse<PlaceTrigger>;
 /**
  * Execute a function of the system's module under a given zone
  * @param id Zone ID
@@ -54,3 +54,9 @@ export declare function listZoneTriggers(id: string, query_params?: HashMap): im
  * @param args Array of arguments to pass to the executed method
  */
 export declare function executeOnZone(id: string, method: string, module: string, index?: number, args?: any[]): Observable<HashMap>;
+/**
+ * Get metadata associated with the selected zone
+ * @param id Zone ID
+ * @param query_params Query parameters to add to the request
+ */
+export declare function zoneMetadata(id: string, query_params?: PlaceZoneMetadataQueryOptions): Observable<HashMap>;

package/dist/zones/interfaces.d.ts

@@ -1,12 +1,12 @@
 import { PlaceResourceQueryOptions } from '../resources/interface';
-/** Mapping of available query paramters for the zones index endpoint */
+/** Mapping of available query parameters for the zones index endpoint */
 export interface PlaceZoneQueryOptions extends PlaceResourceQueryOptions {
-    /** List of space seperated tags to filter the results */
+    /** ID of the parent zone to filter the results (supports comma-separated list) */
+    parent_id?: string;
+    /** List of space separated tags to filter the results */
     tags?: string;
     /** ID of the system to filter the results */
     control_system_id?: string;
-    /** ID of the parent zone to filter the results */
-    parent_id?: string;
 }
 /** Mapping of available query parameters for the zones show endpoint */
 export interface PlaceZoneShowOptions {
@@ -18,3 +18,8 @@ export interface PlaceZoneShowOptions {
      */
     data?: string;
 }
+/** Mapping of available query parameters for the zone metadata endpoint */
+export interface PlaceZoneMetadataQueryOptions {
+    /** The name of the metadata key to retrieve */
+    name?: string;
+}

package/package.json

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