@placeos/ts-client 4.6.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,
@@ -409,3 +468,57 @@ export {
     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/functions.ts

@@ -11,7 +11,6 @@ import {
     update,
 } from '../api';
 import { apiEndpoint } from '../auth';
-import { PlaceResourceQueryOptions } from '../resources/interface';
 import { toQueryString } from '../utilities/api';
 import {
     PlaceAsset,
@@ -19,6 +18,12 @@ import {
     PlaceAssetPurchaseOrder,
     PlaceAssetType,
 } from './assets.class';
+import {
+    PlaceAssetCategoryQueryOptions,
+    PlaceAssetPurchaseOrderQueryOptions,
+    PlaceAssetQueryOptions,
+    PlaceAssetTypeQueryOptions,
+} from './interfaces';
 
 ///////////////////////////////////////////////////////////////
 //////////////////////////   Assets   /////////////////////////
@@ -38,7 +43,7 @@ function processAsset(item: Partial<PlaceAsset>) {
  * Query the available assets
  * @param query_params Query parameters to add the to request URL
  */
-export function queryAssets(query_params: PlaceResourceQueryOptions = {}) {
+export function queryAssets(query_params: PlaceAssetQueryOptions = {}) {
     return query({
         query_params,
         fn: processAsset,
@@ -173,7 +178,7 @@ function processAssetType(item: Partial<PlaceAssetType>) {
  * Query the available asset types
  * @param query_params Query parameters to add the to request URL
  */
-export function queryAssetTypes(query_params: PlaceResourceQueryOptions = {}) {
+export function queryAssetTypes(query_params: PlaceAssetTypeQueryOptions = {}) {
     return query({
         query_params,
         fn: processAssetType,
@@ -265,7 +270,7 @@ function processAssetCategory(item: Partial<PlaceAssetCategory>) {
  * @param query_params Query parameters to add the to request URL
  */
 export function queryAssetCategories(
-    query_params: PlaceResourceQueryOptions = {},
+    query_params: PlaceAssetCategoryQueryOptions = {},
 ) {
     return query({
         query_params,
@@ -358,7 +363,7 @@ function processAssetPurchaseOrder(item: Partial<PlaceAssetPurchaseOrder>) {
  * @param query_params Query parameters to add the to request URL
  */
 export function queryAssetPurchaseOrders(
-    query_params: PlaceResourceQueryOptions = {},
+    query_params: PlaceAssetPurchaseOrderQueryOptions = {},
 ) {
     return query({
         query_params,

package/src/assets/interfaces.ts

@@ -0,0 +1,41 @@
+import { PlaceResourceQueryOptions } from '../resources/interface';
+
+/** Mapping of available query parameters for the assets index endpoint */
+export interface PlaceAssetQueryOptions extends PlaceResourceQueryOptions {
+    /** Return assets which are in the zone provided */
+    zone_id?: string;
+    /** Return assets that match the asset type ID provided */
+    type_id?: string;
+    /** Return assets that match the purchase order ID provided */
+    order_id?: string;
+    /** Return assets that have a matching barcode */
+    barcode?: string;
+    /** Return assets that have a matching serial number */
+    serial_number?: string;
+}
+
+/** Mapping of available query parameters for the asset types index endpoint */
+export interface PlaceAssetTypeQueryOptions extends PlaceResourceQueryOptions {
+    /** Return assets with the provided brand name */
+    brand?: string;
+    /** Return assets with the provided model number */
+    model_number?: string;
+    /** Return asset types in the category provided */
+    category_id?: string;
+    /** Filters the asset count to the zone provided */
+    zone_id?: string;
+}
+
+/** Mapping of available query parameters for the asset categories index endpoint */
+export interface PlaceAssetCategoryQueryOptions extends PlaceResourceQueryOptions {
+    /**
+     * Filter categories by hidden status.
+     * `true` returns only hidden categories,
+     * `false` returns only non-hidden categories,
+     * `undefined` returns all categories.
+     */
+    hidden?: boolean;
+}
+
+/** Mapping of available query parameters for the asset purchase orders index endpoint */
+export interface PlaceAssetPurchaseOrderQueryOptions extends PlaceResourceQueryOptions {}

package/src/clusters/functions.ts

@@ -1,7 +1,16 @@
+import { Observable } from 'rxjs';
+import { map } from 'rxjs/operators';
+import { apiEndpoint } from '../auth/functions';
+import { get, post } from '../http/functions';
 import { query, remove, show } from '../resources/functions';
 import { HashMap } from '../utilities/types';
 import { PlaceCluster } from './cluster';
-import { PlaceClusterQueryOptions } from './interfaces';
+import {
+    PlaceClusterQueryOptions,
+    PlaceClusterShowOptions,
+    PlaceClusterTerminateOptions,
+    PlaceClusterVersions,
+} from './interfaces';
 import { PlaceProcess } from './process';
 
 /**
@@ -29,17 +38,20 @@ export function queryClusters(query_params: PlaceClusterQueryOptions = {}) {
  */
 export function showCluster(
     id: string,
-    query_params: PlaceClusterQueryOptions = {},
+    query_params: PlaceClusterShowOptions = {},
 ) {
     return show({ id, query_params, fn: process, path: PATH });
 }
 
 /**
- * Query the available process for a cluster
+ * Query the available processes for a cluster
  * @param id ID of the cluster to query
  * @param query_params Query parameters to add the to request URL
  */
-export function queryProcesses(id: string, query_params: HashMap = {}) {
+export function queryProcesses(
+    id: string,
+    query_params: PlaceClusterShowOptions = {},
+) {
     return show({
         id,
         query_params,
@@ -52,10 +64,29 @@ export function queryProcesses(id: string, query_params: HashMap = {}) {
 }
 
 /**
- * Terminal a process in a cluster
+ * Terminate a process in a cluster
  * @param id ID of the cluster associated with the process
- * @param driver Name of the process to kill
+ * @param query_params Query parameters including driver name (required)
+ */
+export function terminateProcess(
+    id: string,
+    query_params: PlaceClusterTerminateOptions,
+) {
+    return remove({ id, query_params, path: PATH });
+}
+
+/**
+ * Force the core nodes to perform a cluster rebalance
+ */
+export function clusterRebalance(): Observable<void> {
+    const url = `${apiEndpoint()}${PATH}/rebalance`;
+    return post(url, {}).pipe(map(() => undefined));
+}
+
+/**
+ * Get the core node versions
  */
-export function terminateProcess(id: string, driver: string) {
-    return remove({ id, query_params: { driver }, path: PATH });
+export function clusterVersions(): Observable<PlaceClusterVersions> {
+    const url = `${apiEndpoint()}${PATH}/versions`;
+    return get(url).pipe(map((resp: HashMap) => resp as PlaceClusterVersions));
 }

package/src/clusters/interfaces.ts

@@ -1,9 +1,27 @@
-/** Mapping of available query paramters for the application index endpoint */
+/** Mapping of available query parameters for the cluster index endpoint */
 export interface PlaceClusterQueryOptions {
-    /** Whether the cluster status details should be included */
-    include_status?: string;
+    /** Return the detailed status of the node including memory and CPU usage */
+    include_status?: boolean;
     /** Number of results to return. Defaults to `20`. Max `500` */
     limit?: number;
     /** Offset the page of results. Max `10000` */
     offset?: number;
 }
+
+/** Mapping of available query parameters for the cluster show endpoint */
+export interface PlaceClusterShowOptions {
+    /** Return the detailed status of the drivers running on the node */
+    include_status?: boolean;
+}
+
+/** Mapping of available query parameters for the cluster delete endpoint (terminate process) */
+export interface PlaceClusterTerminateOptions {
+    /** The name of the driver to terminate (required) */
+    driver: string;
+}
+
+/** Response from the cluster versions endpoint */
+export interface PlaceClusterVersions {
+    /** Map of node ID to version string */
+    [nodeId: string]: string;
+}

package/src/domains/functions.ts

@@ -1,3 +1,7 @@
+import { Observable } from 'rxjs';
+import { map } from 'rxjs/operators';
+import { apiEndpoint } from '../auth/functions';
+import { get } from '../http/functions';
 import { create, query, remove, show, update } from '../resources/functions';
 import { PlaceResourceQueryOptions } from '../resources/interface';
 import { HashMap } from '../utilities/types';
@@ -24,10 +28,9 @@ export function queryDomains(query_params: PlaceResourceQueryOptions = {}) {
 /**
  * Get the data for a domain
  * @param id ID of the domain to retrieve
- * @param query_params Query parameters to add the to request URL
  */
-export function showDomain(id: string, query_params: HashMap = {}) {
-    return show({ id, query_params, fn: process, path: PATH });
+export function showDomain(id: string) {
+    return show({ id, query_params: {}, fn: process, path: PATH });
 }
 
 /**
@@ -64,8 +67,16 @@ export function addDomain(form_data: Partial<PlaceDomain>) {
 /**
  * Remove a domain from the database
  * @param id ID of the domain
- * @param query_params Query parameters to add the to request URL
  */
-export function removeDomain(id: string, query_params: HashMap = {}) {
-    return remove({ id, query_params, path: PATH });
+export function removeDomain(id: string) {
+    return remove({ id, query_params: {}, path: PATH });
+}
+
+/**
+ * Find the domain name by looking into domain registered email domains
+ * @param email Email address to lookup
+ */
+export function lookupDomainByEmail(email: string): Observable<PlaceDomain> {
+    const url = `${apiEndpoint()}${PATH}/lookup/${encodeURIComponent(email)}`;
+    return get(url).pipe(map((resp: HashMap) => process(resp as Partial<PlaceDomain>)));
 }