@placeos/ts-client 4.5.0 → 4.7.0

package/src/alerts/functions.ts

@@ -1,7 +1,11 @@
 import { create, query, remove, show, update } from '../api';
-import { PlaceResourceQueryOptions } from '../resources/interface';
 import { PlaceAlert } from './alert';
 import { PlaceAlertDashboard } from './dashboard';
+import {
+    PlaceAlertDashboardQueryOptions,
+    PlaceAlertQueryOptions,
+    PlaceAlertShowOptions,
+} from './interfaces';
 
 ///////////////////////////////////////////////////////////////
 /////////////////////   Alert Dashboards   ////////////////////
@@ -22,7 +26,7 @@ function processDashboard(item: Partial<PlaceAlertDashboard>) {
  * @param query_params Query parameters to add the to request URL
  */
 export function queryAlertDashboards(
-    query_params: PlaceResourceQueryOptions = {},
+    query_params: PlaceAlertDashboardQueryOptions = {},
 ) {
     return query({
         query_params,
@@ -34,15 +38,11 @@ export function queryAlertDashboards(
 /**
  * Get the data for an alert dashboard
  * @param id ID of the alert dashboard to retrieve
- * @param query_params Query parameters to add the to request URL
  */
-export function showAlertDashboard(
-    id: string,
-    query_params: Record<string, any> = {},
-) {
+export function showAlertDashboard(id: string) {
     return show({
         id,
-        query_params,
+        query_params: {},
         fn: processDashboard,
         path: DASHBOARD_PATH,
     });
@@ -87,13 +87,9 @@ export function addAlertDashboard(form_data: Partial<PlaceAlertDashboard>) {
 /**
  * Remove an alert dashboard from the database
  * @param id ID of the alert dashboard
- * @param query_params Query parameters to add the to request URL
  */
-export function removeAlertDashboard(
-    id: string,
-    query_params: Record<string, any> = {},
-) {
-    return remove({ id, query_params, path: DASHBOARD_PATH });
+export function removeAlertDashboard(id: string) {
+    return remove({ id, query_params: {}, path: DASHBOARD_PATH });
 }
 
 /**
@@ -126,7 +122,7 @@ function processAlert(item: Partial<PlaceAlert>) {
  * Query the available alerts
  * @param query_params Query parameters to add the to request URL
  */
-export function queryAlerts(query_params: PlaceResourceQueryOptions = {}) {
+export function queryAlerts(query_params: PlaceAlertQueryOptions = {}) {
     return query({
         query_params,
         fn: processAlert,
@@ -139,7 +135,7 @@ export function queryAlerts(query_params: PlaceResourceQueryOptions = {}) {
  * @param id ID of the alert to retrieve
  * @param query_params Query parameters to add the to request URL
  */
-export function showAlert(id: string, query_params: Record<string, any> = {}) {
+export function showAlert(id: string, query_params: PlaceAlertShowOptions = {}) {
     return show({
         id,
         query_params,
@@ -187,11 +183,7 @@ export function addAlert(form_data: Partial<PlaceAlert>) {
 /**
  * Remove an alert from the database
  * @param id ID of the alert
- * @param query_params Query parameters to add the to request URL
  */
-export function removeAlert(
-    id: string,
-    query_params: Record<string, any> = {},
-) {
-    return remove({ id, query_params, path: ALERT_PATH });
+export function removeAlert(id: string) {
+    return remove({ id, query_params: {}, path: ALERT_PATH });
 }

package/src/alerts/interfaces.ts

@@ -0,0 +1,25 @@
+import { PlaceResourceQueryOptions } from '../resources/interface';
+
+/** Mapping of available query parameters for the alert dashboards index endpoint */
+export interface PlaceAlertDashboardQueryOptions extends PlaceResourceQueryOptions {
+    /** Return dashboards for a specific authority */
+    authority_id?: string;
+}
+
+/** Mapping of available query parameters for the alerts index endpoint */
+export interface PlaceAlertQueryOptions extends PlaceResourceQueryOptions {
+    /** Return alerts for a specific dashboard */
+    alert_dashboard_id?: string;
+    /** Filter by alert severity */
+    severity?: string;
+    /** Filter by alert type */
+    alert_type?: string;
+    /** Filter by enabled status */
+    enabled?: boolean;
+}
+
+/** Mapping of available query parameters for the alerts show endpoint */
+export interface PlaceAlertShowOptions {
+    /** Return the dashboard associated with this alert */
+    dashboard?: boolean;
+}

package/src/api.ts

@@ -32,6 +32,11 @@ export {
     updateAlert,
     updateAlertDashboard,
 } from './alerts/functions';
+export type {
+    PlaceAlertDashboardQueryOptions,
+    PlaceAlertQueryOptions,
+    PlaceAlertShowOptions,
+} from './alerts/interfaces';
 
 export { PlaceApplication } from './applications/application';
 export {
@@ -56,17 +61,25 @@ export {
 
 export { PlaceCluster } from './clusters/cluster';
 export {
+    clusterRebalance,
+    clusterVersions,
     queryClusters,
     queryProcesses,
     showCluster,
     terminateProcess,
 } from './clusters/functions';
-export type { PlaceClusterQueryOptions } from './clusters/interfaces';
+export type {
+    PlaceClusterQueryOptions,
+    PlaceClusterShowOptions,
+    PlaceClusterTerminateOptions,
+    PlaceClusterVersions,
+} from './clusters/interfaces';
 export { PlaceProcess } from './clusters/process';
 
 export { PlaceDomain } from './domains/domain';
 export {
     addDomain,
+    lookupDomainByEmail,
     queryDomains,
     removeDomain,
     showDomain,
@@ -89,11 +102,13 @@ export {
 export type {
     PlaceDriverDetails,
     PlaceDriverQueryOptions,
+    PlaceDriverShowOptions,
 } from './drivers/interfaces';
 
 export { PlaceEdge } from './edge/edge';
 export {
     addEdge,
+    edgeControlUrl,
     queryEdges,
     removeEdge,
     retrieveEdgeToken,
@@ -120,6 +135,8 @@ export {
     updateMetadata,
 } from './metadata/functions';
 export type {
+    PlaceMetadataDeleteOptions,
+    PlaceMetadataHistoryOptions,
     PlaceMetadataOptions,
     PlaceZoneMetadataOptions,
 } from './metadata/interfaces';
@@ -128,6 +145,7 @@ export { PlaceZoneMetadata } from './metadata/zone-metadata';
 
 export {
     addModule,
+    executeOnModule,
     loadModule,
     lookupModuleState,
     moduleRuntimeError,
@@ -143,6 +161,7 @@ export {
 export type {
     PlaceModulePingOptions,
     PlaceModuleQueryOptions,
+    PlaceModuleShowOptions,
 } from './modules/interfaces';
 export { PlaceModule } from './modules/module';
 
@@ -166,6 +185,7 @@ export {
     listRepositoryDefaultBranch,
     listRepositoryDriverDetails,
     listRepositoryDrivers,
+    listRepositoryFolders,
     pullRepositoryChanges,
     queryRepositories,
     removeRepository,
@@ -175,10 +195,14 @@ export {
 export { PlaceRepositoryType } from './repositories/interfaces';
 export type {
     GitCommitDetails,
+    PlaceRemoteRepositoryCommitsQuery,
+    PlaceRemoteRepositoryQuery,
     PlaceRepositoryCommit,
     PlaceRepositoryCommitQuery,
     PlaceRepositoryDetailsQuery,
+    PlaceRepositoryFoldersQuery,
     PlaceRepositoryPullQuery,
+    PlaceRepositoryQueryOptions,
 } from './repositories/interfaces';
 export { PlaceRepository } from './repositories/repository';
 
@@ -192,6 +216,7 @@ export {
     update,
     type QueryResponse,
 } from './resources/functions';
+export type { PlaceResourceQueryOptions } from './resources/interface';
 export { PlaceResource } from './resources/resource';
 
 export {
@@ -213,7 +238,10 @@ export {
     updateSettings,
 } from './settings/functions';
 export { EncryptionLevel } from './settings/interfaces';
-export type { PlaceSettingsQueryOptions } from './settings/interfaces';
+export type {
+    PlaceSettingsHistoryOptions,
+    PlaceSettingsQueryOptions,
+} from './settings/interfaces';
 export { PlaceSettings } from './settings/settings';
 
 export {
@@ -231,17 +259,28 @@ export {
     removeSystemModule,
     removeSystemTrigger,
     showSystem,
+    showSystemTrigger,
     startSystem,
     stopSystem,
+    systemControlUrl,
+    systemMetadata,
     systemModuleState,
     systemSettings,
     updateSystem,
+    updateSystemTrigger,
 } from './systems/functions';
 export type {
     PlaceModuleFunction,
     PlaceModuleFunctionMap,
+    PlaceSystemControlOptions,
+    PlaceSystemMetadataOptions,
     PlaceSystemShowOptions,
+    PlaceSystemStartStopOptions,
+    PlaceSystemTriggerShowOptions,
+    PlaceSystemTriggersQueryOptions,
+    PlaceSystemUpdateOptions,
     PlaceSystemsQueryOptions,
+    PlaceSystemsWithEmailsOptions,
 } from './systems/interfaces';
 export { PlaceSystem } from './systems/system';
 
@@ -260,6 +299,8 @@ export {
 } from './triggers/interfaces';
 export type {
     ExecuteArgs,
+    PlaceTriggerQueryOptions,
+    PlaceTriggerShowOptions,
     TriggerActions,
     TriggerAtTimeCondition,
     TriggerComparison,
@@ -278,12 +319,26 @@ export { PlaceTrigger } from './triggers/trigger';
 export {
     addUser,
     currentUser,
+    currentUserResourceToken,
+    queryUserGroups,
     queryUsers,
     removeUser,
+    removeUserResourceToken,
+    reviveUser,
+    searchUserMetadata,
     showUser,
     updateUser,
+    userMetadata,
+    userResourceToken,
 } from './users/functions';
-export type { PlaceUserQueryOptions } from './users/interfaces';
+export type {
+    PlaceUserDeleteOptions,
+    PlaceUserGroupsOptions,
+    PlaceUserMetadataOptions,
+    PlaceUserMetadataSearchOptions,
+    PlaceUserQueryOptions,
+    PlaceUserShowOptions,
+} from './users/interfaces';
 export { PlaceUser } from './users/user';
 export type { WorktimePreference } from './users/user';
 
@@ -296,8 +351,10 @@ export {
     removeZone,
     showZone,
     updateZone,
+    zoneMetadata,
 } from './zones/functions';
 export type {
+    PlaceZoneMetadataQueryOptions,
     PlaceZoneQueryOptions,
     PlaceZoneShowOptions,
 } from './zones/interfaces';
@@ -324,6 +381,8 @@ export {
 export type {
     SignageMediaQueryOptions,
     SignageMetrics,
+    SignagePlaylistQueryOptions,
+    SignagePlaylistRevisionsOptions,
 } from './signage/interfaces';
 export {
     MediaAnimation,
@@ -377,3 +436,89 @@ export type {
     SurveyShowOptions,
 } from './staff/surveys/interfaces';
 export { Survey, type SurveyPage } from './staff/surveys/model';
+
+export {
+    PlaceAsset,
+    PlaceAssetCategory,
+    PlaceAssetPurchaseOrder,
+    PlaceAssetType,
+} from './assets/assets.class';
+export {
+    addAsset,
+    addAssetCategory,
+    addAssetPurchaseOrder,
+    addAssetType,
+    addAssets,
+    queryAssetCategories,
+    queryAssetPurchaseOrders,
+    queryAssetTypes,
+    queryAssets,
+    removeAsset,
+    removeAssetCategory,
+    removeAssetPurchaseOrder,
+    removeAssetType,
+    removeAssets,
+    showAsset,
+    showAssetCategory,
+    showAssetPurchaseOrder,
+    showAssetType,
+    updateAsset,
+    updateAssetCategory,
+    updateAssetPurchaseOrder,
+    updateAssetType,
+    updateAssets,
+} from './assets/functions';
+export type {
+    PlaceAssetCategoryQueryOptions,
+    PlaceAssetPurchaseOrderQueryOptions,
+    PlaceAssetQueryOptions,
+    PlaceAssetTypeQueryOptions,
+} from './assets/interfaces';
+
+export { PlaceShortUrl } from './short-url/short-url.class';
+export {
+    addShortUrl,
+    generateQrCode,
+    getShortUrlQrCodeSvg,
+    qrCodeUrl,
+    queryShortUrls,
+    removeShortUrl,
+    shortUrlQrCodePngUrl,
+    shortUrlRedirectUrl,
+    showShortUrl,
+    updateShortUrl,
+} from './short-url/functions';
+export type {
+    PlaceQrCodeOptions,
+    PlaceShortUrlPngQrOptions,
+    PlaceShortUrlQueryOptions,
+    QrCodeFormat,
+} from './short-url/interfaces';
+
+export { PlaceStorage, type StorageType } from './storages/storage.class';
+export {
+    addStorage,
+    queryStorages,
+    removeStorage,
+    showStorage,
+    updateStorage,
+} from './storages/functions';
+export type { PlaceStorageQueryOptions } from './storages/interfaces';
+
+export {
+    queryWebrtcRooms,
+    showWebrtcRoom,
+    webrtcGuestEntry,
+    webrtcGuestExit,
+    webrtcKickUser,
+    webrtcSessionMembers,
+    webrtcSignallerUrl,
+    webrtcTransferUser,
+} from './webrtc/functions';
+export type {
+    PlaceGuestParticipant,
+    PlaceKickReason,
+    PlaceWebrtcMember,
+    PlaceWebrtcRoomDetails,
+    PlaceWebrtcRoomsQueryOptions,
+} from './webrtc/interfaces';

package/src/applications/functions.ts

@@ -1,5 +1,4 @@
 import { create, query, remove, show, update } from '../resources/functions';
-import { HashMap } from '../utilities/types';
 import { PlaceApplication } from './application';
 import { PlaceApplicationQueryOptions } from './interfaces';
 
@@ -26,10 +25,9 @@ export function queryApplications(
 /**
  * Get the data for an application
  * @param id ID of the application to retrieve
- * @param query_params Query parameters to add the to request URL
  */
-export function showApplication(id: string, query_params: HashMap = {}) {
-    return show({ id, query_params, fn: process, path: PATH });
+export function showApplication(id: string) {
+    return show({ id, query_params: {}, fn: process, path: PATH });
 }
 
 /**
@@ -66,8 +64,7 @@ export function addApplication(form_data: Partial<PlaceApplication>) {
 /**
  * Remove an application from the database
  * @param id ID of the application
- * @param query_params Query parameters to add the to request URL
  */
-export function removeApplication(id: string, query_params: HashMap = {}) {
-    return remove({ id, query_params, path: PATH });
+export function removeApplication(id: string) {
+    return remove({ id, query_params: {}, path: PATH });
 }

package/src/applications/interfaces.ts

@@ -1,13 +1,7 @@
-/* tslint:disable */
-/** Mapping of available query paramters for the application index endpoint */
-export interface PlaceApplicationQueryOptions {
-    /**
-     * Search filter supporting the following syntax
-     * https://www.elastic.co/guide/en/elasticsearch/reference/5.5/query-dsl-simple-query-string-query.html
-     */
-    q?: string;
-    /** Number of results to return. Defaults to `20`. Max `500` */
-    limit?: number;
-    /** Offset the page of results. Max `10000` */
-    offset?: number;
+import { PlaceResourceQueryOptions } from '../resources/interface';
+
+/** Mapping of available query parameters for the OAuth apps index endpoint */
+export interface PlaceApplicationQueryOptions extends PlaceResourceQueryOptions {
+    /** The ID of the domain to list applications for */
+    authority_id?: string;
 }

package/src/assets/assets.class.ts

@@ -0,0 +1,123 @@
+export class PlaceAssetCategory {
+    readonly id: string;
+    readonly parent_category_id: string;
+    readonly name: string;
+    readonly description: string;
+    readonly hidden: boolean;
+    readonly created_at: number;
+    readonly updated_at: number;
+
+    constructor(data: Partial<PlaceAssetCategory>) {
+        this.id = data.id || '';
+        this.parent_category_id = data.parent_category_id || '';
+        this.name = data.name || '';
+        this.description = data.description || '';
+        this.hidden = data.hidden || false;
+        this.created_at = data.created_at || 0;
+        this.updated_at = data.updated_at || 0;
+    }
+}
+
+export class PlaceAssetPurchaseOrder {
+    readonly id: string;
+    readonly purchase_order_number: string;
+    readonly invoice_number: string;
+    readonly supplier_details: Record<string, string>;
+    readonly purchase_date: number;
+    readonly unit_price: number;
+    readonly expected_service_start_date: number;
+    readonly expected_service_end_date: number;
+    readonly created_at: number;
+    readonly updated_at: number;
+
+    constructor(data: Partial<PlaceAssetPurchaseOrder>) {
+        this.id = data.id || '';
+        this.purchase_order_number = data.purchase_order_number || '';
+        this.invoice_number = data.invoice_number || '';
+        this.supplier_details = data.supplier_details || {};
+        this.purchase_date = data.purchase_date || 0;
+        this.unit_price = data.unit_price || 0;
+        this.expected_service_start_date = data.expected_service_start_date || 0;
+        this.expected_service_end_date = data.expected_service_end_date || 0;
+        this.created_at = data.created_at || 0;
+        this.updated_at = data.updated_at || 0;
+    }
+}
+
+export class PlaceAssetType {
+    readonly id: string;
+    readonly category_id: string;
+    readonly name: string;
+    readonly brand: string;
+    readonly description: string;
+    readonly model_number: string;
+    readonly images: string[];
+    readonly created_at: number;
+    readonly updated_at: number;
+
+    constructor(data: Partial<PlaceAssetType>) {
+        this.id = data.id || '';
+        this.category_id = data.category_id || '';
+        this.name = data.name || '';
+        this.brand = data.brand || '';
+        this.description = data.description || '';
+        this.model_number = data.model_number || '';
+        this.images = data.images || [];
+        this.created_at = data.created_at || 0;
+        this.updated_at = data.updated_at || 0;
+    }
+}
+
+export class PlaceAsset {
+    readonly id: string;
+    readonly parent_id: string;
+    readonly asset_type_id: string;
+    readonly purchase_order_id: string;
+    readonly zone_id: string;
+    readonly identifier: string;
+    readonly serial_number: string;
+    readonly other_data: Record<string, string>;
+    readonly barcode: string;
+    readonly name: string;
+    readonly client_ids: Record<string, string>;
+    readonly map_id: string;
+    readonly bookable: boolean;
+    readonly accessible: boolean;
+    readonly zones: string[];
+    readonly place_groups: string[];
+    readonly assigned_to: string;
+    readonly assigned_name: string;
+    readonly features: string[];
+    readonly images: string[];
+    readonly notes: string;
+    readonly security_system_groups: string[];
+    readonly created_at: number;
+    readonly updated_at: number;
+
+    constructor(data: Partial<PlaceAsset>) {
+        this.id = data.id || '';
+        this.parent_id = data.parent_id || '';
+        this.asset_type_id = data.asset_type_id || '';
+        this.purchase_order_id = data.purchase_order_id || '';
+        this.zone_id = data.zone_id || '';
+        this.identifier = data.identifier || '';
+        this.serial_number = data.serial_number || '';
+        this.other_data = data.other_data || {};
+        this.barcode = data.barcode || '';
+        this.name = data.name || '';
+        this.client_ids = data.client_ids || {};
+        this.map_id = data.map_id || '';
+        this.bookable = data.bookable || false;
+        this.accessible = data.accessible || false;
+        this.zones = data.zones || [];
+        this.place_groups = data.place_groups || [];
+        this.assigned_to = data.assigned_to || '';
+        this.assigned_name = data.assigned_name || '';
+        this.features = data.features || [];
+        this.images = data.images || [];
+        this.notes = data.notes || '';
+        this.security_system_groups = data.security_system_groups || [];
+        this.created_at = data.created_at || 0;
+        this.updated_at = data.updated_at || 0;
+    }
+}