@placeos/ts-client 4.3.1 → 4.4.0

package/dist/alerts/alert.d.ts

@@ -0,0 +1,17 @@
+import { PlaceResource } from '../resources/resource';
+import { TriggerConditions } from '../triggers/interfaces';
+import { PlaceAlertDashboard } from './dashboard';
+export type AlertSeverity = 'low' | 'medium' | 'high' | 'critical';
+export type AlertType = 'threshold' | 'status' | 'custom';
+export declare class PlaceAlert extends PlaceResource {
+    readonly alert_dashboard_id: string;
+    readonly alert_dashboard_details: PlaceAlertDashboard | undefined;
+    readonly authority_id: string;
+    readonly description: string;
+    readonly enabled: boolean;
+    readonly conditions: TriggerConditions;
+    readonly severity: AlertSeverity;
+    readonly alert_type: AlertType;
+    readonly debounce_period: number;
+    constructor(data: Partial<PlaceAlert>);
+}

package/dist/alerts/dashboard.d.ts

@@ -0,0 +1,7 @@
+import { PlaceResource } from '../resources/resource';
+export declare class PlaceAlertDashboard extends PlaceResource {
+    readonly authority_id: string;
+    readonly description: string;
+    readonly enabled: boolean;
+    constructor(data: Partial<PlaceAlertDashboard>);
+}

package/dist/alerts/functions.d.ts

@@ -0,0 +1,70 @@
+import { PlaceResourceQueryOptions } from '../resources/interface';
+import { PlaceAlert } from './alert';
+import { PlaceAlertDashboard } from './dashboard';
+/**
+ * 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>;
+/**
+ * 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>;
+/**
+ * Update the alert dashboard in the database
+ * @param id ID of the alert dashboard
+ * @param form_data New values for the alert dashboard
+ * @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 updateAlertDashboard(id: string, form_data: Partial<PlaceAlertDashboard>, method?: 'put' | 'patch'): import('rxjs').Observable<PlaceAlertDashboard>;
+/**
+ * Add a new alert dashboard to the database
+ * @param form_data Application data
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function addAlertDashboard(form_data: Partial<PlaceAlertDashboard>): import('rxjs').Observable<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>>;
+/**
+ * Get list of alerts for dashbaord
+ * @param id Alert dashboard ID
+ */
+export declare function listDashboardAlerts(id: string): import('..').QueryResponse<PlaceAlert>;
+/**
+ * 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>;
+/**
+ * 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>;
+/**
+ * Update the alert in the database
+ * @param id ID of the alert
+ * @param form_data New values for the alert
+ * @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 updateAlert(id: string, form_data: Partial<PlaceAlert>, method?: 'put' | 'patch'): import('rxjs').Observable<PlaceAlert>;
+/**
+ * Add a new alert to the database
+ * @param form_data Application data
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function addAlert(form_data: Partial<PlaceAlert>): import('rxjs').Observable<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 declare function removeAlert(id: string, query_params?: Record<string, any>): import('rxjs').Observable<import('../utilities/types').HashMap<any>>;

package/dist/api.d.ts

@@ -1,6 +1,9 @@
 export { del, get, patch, post, put, responseHeaders } from './http/functions';
 export type { HttpError, HttpJsonOptions, HttpOptions, HttpResponse, HttpResponseType, MockHttpRequest, MockHttpRequestHandler, MockHttpRequestHandlerOptions, } from './http/interfaces';
 export { deregisterMockEndpoint, registerMockEndpoint, setMockNotFoundHandler, } from './http/mock';
+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 { PlaceApplication } from './applications/application';
 export { addApplication, queryApplications, removeApplication, showApplication, updateApplication, } from './applications/functions';
 export type { PlaceApplicationQueryOptions } from './applications/interfaces';
@@ -48,7 +51,8 @@ export type { PlaceModuleFunction, PlaceModuleFunctionMap, PlaceSystemShowOption
 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, TriggerActions, TriggerAtTimeCondition, TriggerComparison, TriggerConditionConstant, TriggerConditionValue, TriggerCronTimeCondition, TriggerFunction, TriggerMailer, TriggerStatusVariable, TriggerTimeCondition, TriggerWebhook, } from './triggers/interfaces';
+export type { TriggerConditions } from './triggers/interfaces';
 export { PlaceTrigger } from './triggers/trigger';
 export { addUser, currentUser, queryUsers, removeUser, showUser, updateUser, } from './users/functions';
 export type { PlaceUserQueryOptions } from './users/interfaces';