@placeos/ts-client 4.6.0 → 4.7.1

package/dist/alerts/alert.d.ts

@@ -13,5 +13,6 @@ export declare class PlaceAlert extends PlaceResource {
     readonly severity: AlertSeverity;
     readonly alert_type: AlertType;
     readonly debounce_period: number;
+    readonly any_match: boolean;
     constructor(data: Partial<PlaceAlert>);
 }

package/dist/alerts/functions.d.ts

@@ -1,17 +1,16 @@
-import { PlaceResourceQueryOptions } from '../resources/interface';
 import { PlaceAlert } from './alert';
 import { PlaceAlertDashboard } from './dashboard';
+import { PlaceAlertDashboardQueryOptions, PlaceAlertQueryOptions, PlaceAlertShowOptions } from './interfaces';
 /**
  * Query the available alert dashboards
  * @param query_params Query parameters to add the to request URL
  */
-export declare function queryAlertDashboards(query_params?: PlaceResourceQueryOptions): import('..').QueryResponse<PlaceAlertDashboard>;
+export declare function queryAlertDashboards(query_params?: PlaceAlertDashboardQueryOptions): import('..').QueryResponse<PlaceAlertDashboard>;
 /**
  * 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 declare function showAlertDashboard(id: string, query_params?: Record<string, any>): import('rxjs').Observable<PlaceAlertDashboard>;
+export declare function showAlertDashboard(id: string): import('rxjs').Observable<PlaceAlertDashboard>;
 /**
  * Update the alert dashboard in the database
  * @param id ID of the alert dashboard
@@ -29,9 +28,8 @@ export declare 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 declare function removeAlertDashboard(id: string, query_params?: Record<string, any>): import('rxjs').Observable<import('../utilities/types').HashMap<any>>;
+export declare function removeAlertDashboard(id: string): import('rxjs').Observable<import('../utilities/types').HashMap<any>>;
 /**
  * Get list of alerts for dashbaord
  * @param id Alert dashboard ID
@@ -41,13 +39,13 @@ export declare function listDashboardAlerts(id: string): import('..').QueryRespo
  * Query the available alerts
  * @param query_params Query parameters to add the to request URL
  */
-export declare function queryAlerts(query_params?: PlaceResourceQueryOptions): import('..').QueryResponse<PlaceAlert>;
+export declare function queryAlerts(query_params?: PlaceAlertQueryOptions): import('..').QueryResponse<PlaceAlert>;
 /**
  * Get the data for an alert
  * @param id ID of the alert to retrieve
  * @param query_params Query parameters to add the to request URL
  */
-export declare function showAlert(id: string, query_params?: Record<string, any>): import('rxjs').Observable<PlaceAlert>;
+export declare function showAlert(id: string, query_params?: PlaceAlertShowOptions): import('rxjs').Observable<PlaceAlert>;
 /**
  * Update the alert in the database
  * @param id ID of the alert
@@ -65,6 +63,5 @@ export declare function addAlert(form_data: Partial<PlaceAlert>): import('rxjs')
 /**
  * Remove an alert from the database
  * @param id ID of the alert
- * @param query_params Query parameters to add the to request URL
  */
-export declare function removeAlert(id: string, query_params?: Record<string, any>): import('rxjs').Observable<import('../utilities/types').HashMap<any>>;
+export declare function removeAlert(id: string): import('rxjs').Observable<import('../utilities/types').HashMap<any>>;

package/dist/alerts/interfaces.d.ts

@@ -0,0 +1,22 @@
+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/dist/api.d.ts

@@ -4,6 +4,7 @@ export { deregisterMockEndpoint, registerMockEndpoint, setMockNotFoundHandler, }
 export { PlaceAlert } from './alerts/alert';
 export { PlaceAlertDashboard } from './alerts/dashboard';
 export { addAlert, addAlertDashboard, listDashboardAlerts, queryAlertDashboards, queryAlerts, removeAlert, removeAlertDashboard, showAlert, showAlertDashboard, updateAlert, updateAlertDashboard, } from './alerts/functions';
+export type { PlaceAlertDashboardQueryOptions, PlaceAlertQueryOptions, PlaceAlertShowOptions, } from './alerts/interfaces';
 export { PlaceApplication } from './applications/application';
 export { addApplication, queryApplications, removeApplication, showApplication, updateApplication, } from './applications/functions';
 export type { PlaceApplicationQueryOptions } from './applications/interfaces';
@@ -11,57 +12,58 @@ export type { PlaceAuthSourceQueryOptions } from './auth-sources/interfaces';
 export { AuthType, PlaceMQTTBroker } from './broker/broker';
 export { addBroker, queryBrokers, removeBroker, showBroker, updateBroker, } from './broker/functions';
 export { PlaceCluster } from './clusters/cluster';
-export { queryClusters, queryProcesses, showCluster, terminateProcess, } from './clusters/functions';
-export type { PlaceClusterQueryOptions } from './clusters/interfaces';
+export { clusterRebalance, clusterVersions, queryClusters, queryProcesses, showCluster, terminateProcess, } from './clusters/functions';
+export type { PlaceClusterQueryOptions, PlaceClusterShowOptions, PlaceClusterTerminateOptions, PlaceClusterVersions, } from './clusters/interfaces';
 export { PlaceProcess } from './clusters/process';
 export { PlaceDomain } from './domains/domain';
-export { addDomain, queryDomains, removeDomain, showDomain, updateDomain, } from './domains/functions';
+export { addDomain, lookupDomainByEmail, queryDomains, removeDomain, showDomain, updateDomain, } from './domains/functions';
 export { PlaceDriver } from './drivers/driver';
 export { PlaceDriverRole } from './drivers/enums';
 export { addDriver, driverReadme, isDriverCompiled, queryDrivers, recompileDriver, reloadDriver, removeDriver, showDriver, updateDriver, } from './drivers/functions';
-export type { PlaceDriverDetails, PlaceDriverQueryOptions, } from './drivers/interfaces';
+export type { PlaceDriverDetails, PlaceDriverQueryOptions, PlaceDriverShowOptions, } from './drivers/interfaces';
 export { PlaceEdge } from './edge/edge';
-export { addEdge, queryEdges, removeEdge, retrieveEdgeToken, showEdge, updateEdge, } from './edge/functions';
+export { addEdge, edgeControlUrl, queryEdges, removeEdge, retrieveEdgeToken, showEdge, updateEdge, } from './edge/functions';
 export { addLDAPSource, queryLDAPSources, removeLDAPSource, showLDAPSource, updateLDAPSource, } from './ldap-sources/functions';
 export { PlaceLDAPSource } from './ldap-sources/ldap-source';
 export { addMetadata, listChildMetadata, listMetadata, listMetadataHistory, removeMetadata, showMetadata, updateMetadata, } from './metadata/functions';
-export type { PlaceMetadataOptions, PlaceZoneMetadataOptions, } from './metadata/interfaces';
+export type { PlaceMetadataDeleteOptions, PlaceMetadataHistoryOptions, PlaceMetadataOptions, PlaceZoneMetadataOptions, } from './metadata/interfaces';
 export { PlaceMetadata } from './metadata/metadata';
 export { PlaceZoneMetadata } from './metadata/zone-metadata';
-export { addModule, loadModule, lookupModuleState, moduleRuntimeError, moduleSettings, moduleState, queryModules, removeModule, showModule, startModule, stopModule, updateModule, } from './modules/functions';
-export type { PlaceModulePingOptions, PlaceModuleQueryOptions, } from './modules/interfaces';
+export { addModule, executeOnModule, loadModule, lookupModuleState, moduleRuntimeError, moduleSettings, moduleState, queryModules, removeModule, showModule, startModule, stopModule, updateModule, } from './modules/functions';
+export type { PlaceModulePingOptions, PlaceModuleQueryOptions, PlaceModuleShowOptions, } from './modules/interfaces';
 export { PlaceModule } from './modules/module';
 export { addOAuthSource, queryOAuthSources, removeOAuthSource, showOAuthSource, updateOAuthSource, } from './oauth-sources/functions';
 export { PlaceOAuthSource } from './oauth-sources/oauth-source';
-export { addRepository, listInterfaceRepositories, listRemoteRepositoryBranches, listRemoteRepositoryCommits, listRemoteRepositoryDefaultBranch, listRepositoryBranches, listRepositoryCommits, listRepositoryDefaultBranch, listRepositoryDriverDetails, listRepositoryDrivers, pullRepositoryChanges, queryRepositories, removeRepository, showRepository, updateRepository, } from './repositories/functions';
+export { addRepository, listInterfaceRepositories, listRemoteRepositoryBranches, listRemoteRepositoryCommits, listRemoteRepositoryDefaultBranch, listRepositoryBranches, listRepositoryCommits, listRepositoryDefaultBranch, listRepositoryDriverDetails, listRepositoryDrivers, listRepositoryFolders, pullRepositoryChanges, queryRepositories, removeRepository, showRepository, updateRepository, } from './repositories/functions';
 export { PlaceRepositoryType } from './repositories/interfaces';
-export type { GitCommitDetails, PlaceRepositoryCommit, PlaceRepositoryCommitQuery, PlaceRepositoryDetailsQuery, PlaceRepositoryPullQuery, } from './repositories/interfaces';
+export type { GitCommitDetails, PlaceRemoteRepositoryCommitsQuery, PlaceRemoteRepositoryQuery, PlaceRepositoryCommit, PlaceRepositoryCommitQuery, PlaceRepositoryDetailsQuery, PlaceRepositoryFoldersQuery, PlaceRepositoryPullQuery, PlaceRepositoryQueryOptions, } from './repositories/interfaces';
 export { PlaceRepository } from './repositories/repository';
 export { create, lastRequestTotal, query, remove, requestTotal, show, update, type QueryResponse, } from './resources/functions';
+export type { PlaceResourceQueryOptions } from './resources/interface';
 export { PlaceResource } from './resources/resource';
 export { addSAMLSource, querySAMLSources, removeSAMLSource, showSAMLSource, updateSAMLSource, } from './saml-sources/functions';
 export { PlaceSAMLSource } from './saml-sources/saml-source';
 export type { PlaceSamlRequestAttribute } from './saml-sources/saml-source';
 export { addSettings, querySettings, removeSettings, settingsHistory, showSettings, 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 { addSystem, addSystemModule, addSystemTrigger, executeOnSystem, functionList, listSystemTriggers, listSystemZones, lookupSystemModuleState, querySystems, querySystemsWithEmails, removeSystem, removeSystemModule, removeSystemTrigger, showSystem, startSystem, stopSystem, systemModuleState, systemSettings, updateSystem, } from './systems/functions';
-export type { PlaceModuleFunction, PlaceModuleFunctionMap, PlaceSystemShowOptions, PlaceSystemsQueryOptions, } from './systems/interfaces';
+export { addSystem, addSystemModule, addSystemTrigger, executeOnSystem, functionList, listSystemTriggers, listSystemZones, lookupSystemModuleState, querySystems, querySystemsWithEmails, removeSystem, 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';
 export { addTrigger, listTriggerInstances, queryTriggers, removeTrigger, showTrigger, updateTrigger, } from './triggers/functions';
 export { TriggerConditionOperator, TriggerTimeConditionType, TriggerWebhookType, } from './triggers/interfaces';
-export type { ExecuteArgs, TriggerActions, TriggerAtTimeCondition, TriggerComparison, TriggerConditionConstant, TriggerConditionValue, TriggerConditions, TriggerCronTimeCondition, TriggerFunction, TriggerMailer, TriggerStatusVariable, TriggerTimeCondition, TriggerWebhook, } from './triggers/interfaces';
+export type { ExecuteArgs, PlaceTriggerQueryOptions, PlaceTriggerShowOptions, TriggerActions, TriggerAtTimeCondition, TriggerComparison, TriggerConditionConstant, TriggerConditionValue, TriggerConditions, TriggerCronTimeCondition, TriggerFunction, TriggerMailer, TriggerStatusVariable, TriggerTimeCondition, TriggerWebhook, } from './triggers/interfaces';
 export { PlaceTrigger } from './triggers/trigger';
-export { addUser, currentUser, queryUsers, removeUser, showUser, updateUser, } from './users/functions';
-export type { PlaceUserQueryOptions } from './users/interfaces';
+export { addUser, currentUser, currentUserResourceToken, queryUserGroups, queryUsers, removeUser, removeUserResourceToken, reviveUser, searchUserMetadata, showUser, updateUser, userMetadata, userResourceToken, } from './users/functions';
+export type { PlaceUserDeleteOptions, PlaceUserGroupsOptions, PlaceUserMetadataOptions, PlaceUserMetadataSearchOptions, PlaceUserQueryOptions, PlaceUserShowOptions, } from './users/interfaces';
 export { PlaceUser } from './users/user';
 export type { WorktimePreference } from './users/user';
-export { addZone, executeOnZone, listZoneTags, listZoneTriggers, queryZones, removeZone, showZone, updateZone, } from './zones/functions';
-export type { PlaceZoneQueryOptions, PlaceZoneShowOptions, } from './zones/interfaces';
+export { addZone, executeOnZone, listZoneTags, listZoneTriggers, queryZones, removeZone, showZone, updateZone, zoneMetadata, } from './zones/functions';
+export type { PlaceZoneMetadataQueryOptions, PlaceZoneQueryOptions, PlaceZoneShowOptions, } from './zones/interfaces';
 export { PlaceZone } from './zones/zone';
 export { addSignageMedia, addSignagePlaylist, approveSignagePlaylist, listSignagePlaylistMedia, listSignagePlaylistMediaRevisions, querySignageMedia, querySignagePlaylists, removeSignageMedia, removeSignagePlaylist, showSignage, showSignageMedia, showSignageMetrics, showSignagePlaylist, updateSignageMedia, updateSignagePlaylist, updateSignagePlaylistMedia, } from './signage/functions';
-export type { SignageMediaQueryOptions, SignageMetrics, } from './signage/interfaces';
+export type { SignageMediaQueryOptions, SignageMetrics, SignagePlaylistQueryOptions, SignagePlaylistRevisionsOptions, } from './signage/interfaces';
 export { MediaAnimation, SignageMedia, type MediaOrientation, } from './signage/media.class';
 export { SignagePlaylist, SignagePlaylistMedia, } from './signage/playlist.class';
 export { addAnswer, queryAnswers } from './staff/answers/functions';
@@ -78,3 +80,12 @@ export type { SurveyQueryOptions, SurveyShowOptions, } from './staff/surveys/int
 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/dist/applications/functions.d.ts

@@ -1,4 +1,3 @@
-import { HashMap } from '../utilities/types';
 import { PlaceApplication } from './application';
 import { PlaceApplicationQueryOptions } from './interfaces';
 /**
@@ -9,9 +8,8 @@ export declare function queryApplications(query_params?: PlaceApplicationQueryOp
 /**
  * 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 declare function showApplication(id: string, query_params?: HashMap): import('rxjs').Observable<PlaceApplication>;
+export declare function showApplication(id: string): import('rxjs').Observable<PlaceApplication>;
 /**
  * Update the application in the database
  * @param id ID of the application
@@ -29,6 +27,5 @@ export declare function addApplication(form_data: Partial<PlaceApplication>): im
 /**
  * Remove an application from the database
  * @param id ID of the application
- * @param query_params Query parameters to add the to request URL
  */
-export declare function removeApplication(id: string, query_params?: HashMap): import('rxjs').Observable<HashMap<any>>;
+export declare function removeApplication(id: string): import('rxjs').Observable<import('../utilities/types').HashMap<any>>;

package/dist/applications/interfaces.d.ts

@@ -1,12 +1,6 @@
-/** 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/dist/assets/functions.d.ts

@@ -1,10 +1,10 @@
-import { PlaceResourceQueryOptions } from '../resources/interface';
 import { PlaceAsset, PlaceAssetCategory, PlaceAssetPurchaseOrder, PlaceAssetType } from './assets.class';
+import { PlaceAssetCategoryQueryOptions, PlaceAssetPurchaseOrderQueryOptions, PlaceAssetQueryOptions, PlaceAssetTypeQueryOptions } from './interfaces';
 /**
  * Query the available assets
  * @param query_params Query parameters to add the to request URL
  */
-export declare function queryAssets(query_params?: PlaceResourceQueryOptions): import('..').QueryResponse<PlaceAsset>;
+export declare function queryAssets(query_params?: PlaceAssetQueryOptions): import('..').QueryResponse<PlaceAsset>;
 /**
  * Get the data for an asset
  * @param id ID of the asset to retrieve
@@ -55,7 +55,7 @@ export declare function removeAssets(id_list: string[], query_params?: Record<st
  * Query the available asset types
  * @param query_params Query parameters to add the to request URL
  */
-export declare function queryAssetTypes(query_params?: PlaceResourceQueryOptions): import('..').QueryResponse<PlaceAssetType>;
+export declare function queryAssetTypes(query_params?: PlaceAssetTypeQueryOptions): import('..').QueryResponse<PlaceAssetType>;
 /**
  * Get the data for an asset type
  * @param id ID of the asset type to retrieve
@@ -86,7 +86,7 @@ export declare function removeAssetType(id: string, query_params?: Record<string
  * Query the available asset categories
  * @param query_params Query parameters to add the to request URL
  */
-export declare function queryAssetCategories(query_params?: PlaceResourceQueryOptions): import('..').QueryResponse<PlaceAssetCategory>;
+export declare function queryAssetCategories(query_params?: PlaceAssetCategoryQueryOptions): import('..').QueryResponse<PlaceAssetCategory>;
 /**
  * Get the data for an asset category
  * @param id ID of the asset category to retrieve
@@ -117,7 +117,7 @@ export declare function removeAssetCategory(id: string, query_params?: Record<st
  * Query the available asset purchase orders
  * @param query_params Query parameters to add the to request URL
  */
-export declare function queryAssetPurchaseOrders(query_params?: PlaceResourceQueryOptions): import('..').QueryResponse<PlaceAssetPurchaseOrder>;
+export declare function queryAssetPurchaseOrders(query_params?: PlaceAssetPurchaseOrderQueryOptions): import('..').QueryResponse<PlaceAssetPurchaseOrder>;
 /**
  * Get the data for an asset purchase order
  * @param id ID of the asset purchase order to retrieve

package/dist/assets/interfaces.d.ts

@@ -0,0 +1,38 @@
+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/dist/clusters/functions.d.ts

@@ -1,6 +1,7 @@
+import { Observable } from 'rxjs';
 import { HashMap } from '../utilities/types';
 import { PlaceCluster } from './cluster';
-import { PlaceClusterQueryOptions } from './interfaces';
+import { PlaceClusterQueryOptions, PlaceClusterShowOptions, PlaceClusterTerminateOptions, PlaceClusterVersions } from './interfaces';
 /**
  * Query the available clusters
  * @param query_params Query parameters to add the to request URL
@@ -11,16 +12,24 @@ export declare function queryClusters(query_params?: PlaceClusterQueryOptions):
  * @param id ID of the cluster to query
  * @param query_params Query parameters to add the to request URL
  */
-export declare function showCluster(id: string, query_params?: PlaceClusterQueryOptions): import('rxjs').Observable<PlaceCluster>;
+export declare function showCluster(id: string, query_params?: PlaceClusterShowOptions): Observable<PlaceCluster>;
 /**
- * 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 declare function queryProcesses(id: string, query_params?: HashMap): import('rxjs').Observable<any>;
+export declare function queryProcesses(id: string, query_params?: PlaceClusterShowOptions): Observable<any>;
 /**
- * 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 declare function terminateProcess(id: string, driver: string): import('rxjs').Observable<HashMap<any>>;
+export declare function terminateProcess(id: string, query_params: PlaceClusterTerminateOptions): Observable<HashMap<any>>;
+/**
+ * Force the core nodes to perform a cluster rebalance
+ */
+export declare function clusterRebalance(): Observable<void>;
+/**
+ * Get the core node versions
+ */
+export declare function clusterVersions(): Observable<PlaceClusterVersions>;

package/dist/clusters/interfaces.d.ts

@@ -1,9 +1,24 @@
-/** 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/dist/domains/functions.d.ts

@@ -1,3 +1,4 @@
+import { Observable } from 'rxjs';
 import { PlaceResourceQueryOptions } from '../resources/interface';
 import { HashMap } from '../utilities/types';
 import { PlaceDomain } from './domain';
@@ -9,9 +10,8 @@ export declare 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 declare function showDomain(id: string, query_params?: HashMap): import('rxjs').Observable<PlaceDomain>;
+export declare function showDomain(id: string): Observable<PlaceDomain>;
 /**
  * Update the domain in the database
  * @param id ID of the domain
@@ -19,16 +19,20 @@ export declare function showDomain(id: string, query_params?: HashMap): import('
  * @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 updateDomain(id: string, form_data: Partial<PlaceDomain>, method?: 'put' | 'patch'): import('rxjs').Observable<PlaceDomain>;
+export declare function updateDomain(id: string, form_data: Partial<PlaceDomain>, method?: 'put' | 'patch'): Observable<PlaceDomain>;
 /**
  * Add a new domain to the database
  * @param form_data Domain data
  * @param query_params Query parameters to add the to request URL
  */
-export declare function addDomain(form_data: Partial<PlaceDomain>): import('rxjs').Observable<PlaceDomain>;
+export declare function addDomain(form_data: Partial<PlaceDomain>): Observable<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 declare function removeDomain(id: string, query_params?: HashMap): import('rxjs').Observable<HashMap<any>>;
+export declare function removeDomain(id: string): Observable<HashMap<any>>;
+/**
+ * Find the domain name by looking into domain registered email domains
+ * @param email Email address to lookup
+ */
+export declare function lookupDomainByEmail(email: string): Observable<PlaceDomain>;

package/dist/drivers/functions.d.ts

@@ -1,6 +1,5 @@
-import { HashMap } from '../utilities/types';
 import { PlaceDriver } from './driver';
-import { PlaceDriverQueryOptions } from './interfaces';
+import { PlaceDriverQueryOptions, PlaceDriverShowOptions } from './interfaces';
 /**
  * Query the available drivers
  * @param query_params Query parameters to add the to request URL
@@ -11,7 +10,7 @@ export declare function queryDrivers(query_params?: PlaceDriverQueryOptions): im
  * @param id ID of the driver to retrieve
  * @param query_params Query parameters to add the to request URL
  */
-export declare function showDriver(id: string, query_params?: HashMap): import('rxjs').Observable<PlaceDriver>;
+export declare function showDriver(id: string, query_params?: PlaceDriverShowOptions): import('rxjs').Observable<PlaceDriver>;
 /**
  * Update the driver in the database
  * @param id ID of the driver
@@ -29,9 +28,8 @@ export declare function addDriver(form_data: Partial<PlaceDriver>): import('rxjs
 /**
  * Remove a driver from the database
  * @param id ID of the driver
- * @param query_params Query parameters to add the to request URL
  */
-export declare function removeDriver(id: string, query_params?: HashMap): import('rxjs').Observable<HashMap<any>>;
+export declare function removeDriver(id: string): import('rxjs').Observable<import('../utilities/types').HashMap<any>>;
 /**
  * Request a recompilation of the driver's code
  * @param id ID of the driver

package/dist/drivers/interfaces.d.ts

@@ -1,14 +1,16 @@
-/** Mapping of available query paramters for the dependencies index */
-export interface PlaceDriverQueryOptions {
-    /** Set maximum number of results to return. Defaults to `20` */
-    limit?: number;
-    /** Set number of results to skip. Defaults to `0` */
-    offset?: number;
-    /** Filter result by type of driver. One of either `ssh`, `device`, `service` or `logic` */
+import { PlaceResourceQueryOptions } from '../resources/interface';
+/** Mapping of available query parameters for the drivers index endpoint */
+export interface PlaceDriverQueryOptions extends PlaceResourceQueryOptions {
+    /** Filter result by type of driver */
     role?: 'ssh' | 'device' | 'service' | 'logic' | 'websocket';
     /** Only return drivers that have an update available */
     update_available?: boolean;
 }
+/** Mapping of available query parameters for the drivers show endpoint */
+export interface PlaceDriverShowOptions {
+    /** Check if the driver is compiled */
+    compilation_status?: boolean;
+}
 /** List of details that can be assigned to a new Driver */
 export interface PlaceDriverDetails {
     /** Default name for the driver */

package/dist/edge/functions.d.ts

@@ -1,5 +1,4 @@
 import { PlaceAuthSourceQueryOptions } from '../auth-sources/interfaces';
-import { HashMap } from '../utilities/types';
 import { PlaceEdge } from './edge';
 /**
  * Query the available Edges
@@ -9,9 +8,8 @@ export declare function queryEdges(query_params?: PlaceAuthSourceQueryOptions):
 /**
  * Get the data for an Edge
  * @param id ID of the Edge to retrieve
- * @param query_params Query parameters to add the to request URL
  */
-export declare function showEdge(id: string, query_params?: HashMap): import('rxjs').Observable<PlaceEdge>;
+export declare function showEdge(id: string): import('rxjs').Observable<PlaceEdge>;
 /**
  * Update the Edge in the database
  * @param id ID of the Edge
@@ -29,14 +27,17 @@ export declare function addEdge(form_data: Partial<PlaceEdge>): import('rxjs').O
 /**
  * Remove an Edge node from the database
  * @param id ID of the Edge
- * @param query_params Query parameters to add the to request URL
  */
-export declare function removeEdge(id: string, query_params?: HashMap): import('rxjs').Observable<HashMap<any>>;
+export declare function removeEdge(id: string): import('rxjs').Observable<import('../utilities/types').HashMap<any>>;
 /**
  * Generate token for Edge connection
  * @param id ID of the Edge
- * @param query_params Query parameters to add the to request URL
  */
-export declare function retrieveEdgeToken(id: string, query_params?: HashMap): import('rxjs').Observable<{
+export declare function retrieveEdgeToken(id: string): import('rxjs').Observable<{
     token: string;
 }>;
+/**
+ * Get the edge control websocket URL.
+ * This is the endpoint that edge devices use to connect to the cluster.
+ */
+export declare function edgeControlUrl(): string;