@placeos/ts-client 4.5.0 → 4.7.0

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;