@space-df/sdk 0.0.1-dev.44 → 0.0.1-dev.45

package/api.doc.md

@@ -3012,7 +3012,7 @@ await client.trip.delete('trip-uuid-456');
 
 ## Overview
 
-The `Telemetry` class provides methods for retrieving telemetry entities, alerts, events, automations, and geofences. This class allows you to search and filter telemetry entities by display type and search terms, retrieve alerts, query events by device, manage automations (list, create, retrieve, update, delete), and manage geofences (list, create, retrieve, update, delete, test).
+The `Telemetry` class provides methods for retrieving telemetry entities, alerts, events, automations, actions, and geofences. This class allows you to search and filter telemetry entities by display type and search terms, retrieve alerts, query events by device, list telemetry actions, manage automations (list, create, retrieve, update, delete), and manage geofences (list, create, retrieve, update, delete, test).
 
 ## Methods
 
@@ -3313,6 +3313,57 @@ await client.telemetry.automations.delete('automation-uuid-123');
 
 </details>
 
+<details>
+  <summary><strong>actions.list</strong></summary>
+
+List telemetry actions with optional filtering and pagination.
+
+**Signature:**
+
+```typescript
+list(params: ActionsListParams, options?: Core.RequestOptions): Core.APIPromise<ActionsListResponse>
+```
+
+**Parameters:**
+
+-   `params` _(ActionsListParams)_: Query parameters for filtering and pagination:
+    -   `search` _(string, optional)_: A search term to filter results.
+    -   `ordering` _(string, optional)_: Which field to use when ordering the results.
+    -   `limit` _(integer, optional)_: Number of results to return per page.
+    -   `offset` _(integer, optional)_: The initial index from which to return the results.
+-   `options` _(Core.RequestOptions)_: Additional request options.
+
+**Returns:** `Promise<ActionsListResponse>`
+
+**Response shape:**
+
+-   `count` _(integer)_: Total number of actions matching the query.
+-   `next` _(string | null)_: URL to the next page of results, or `null`.
+-   `previous` _(string | null)_: URL to the previous page of results, or `null`.
+-   `results` _(Action[])_: Array of action objects.
+
+**Action shape:**
+
+-   `id` _(string)_: Action UUID.
+-   `name` _(string)_: Action name.
+-   `created_at` _(string, optional)_: Creation timestamp.
+-   `data` _(object)_: Action payload:
+    -   `channel` _(string)_: Channel identifier.
+    -   `message` _(string)_: Message content.
+
+**Example:**
+
+```typescript
+const actions = await client.telemetry.actions.list({
+    search: 'battery',
+    limit: 10,
+    offset: 0,
+});
+console.log(actions.results);
+```
+
+</details>
+
 <details>
   <summary><strong>events.list</strong></summary>
 

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@space-df/sdk",
-  "version": "0.0.1-dev.44",
+  "version": "0.0.1-dev.45",
   "description": "The official TypeScript library for the Spacedf SDK API",
   "author": "Spacedf SDK <support@digitalfortress.dev>",
   "types": "./index.d.ts",

package/dist/resources/telemetry/actions.d.ts

@@ -0,0 +1,23 @@
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
+import { ListParamsResponse, ListResponse } from "../../types/api.js";
+export interface Action {
+    created_at?: string;
+    data: {
+        channel: string;
+        message: string;
+    };
+    id: string;
+    name: string;
+    key: string;
+}
+export type ActionsListResponse = ListResponse<Action>;
+export interface ActionsListParams extends ListParamsResponse {
+    limit?: number;
+    offset?: number;
+    search?: string;
+}
+export declare class Actions extends APIResource {
+    list(params: ActionsListParams, options?: Core.RequestOptions): Core.APIPromise<ActionsListResponse>;
+}
+//# sourceMappingURL=actions.d.ts.map

package/dist/resources/telemetry/actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../src/resources/telemetry/actions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEnE,MAAM,WAAW,MAAM;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE;QACF,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,mBAAmB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;AAEvD,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB;IACzD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,qBAAa,OAAQ,SAAQ,WAAW;IACpC,IAAI,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAQvG"}

package/dist/resources/telemetry/actions.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Actions = void 0;
+const resource_1 = require("../../resource.js");
+class Actions extends resource_1.APIResource {
+    list(params, options) {
+        const { ...query } = params;
+        return this._client.get(`/telemetry/v1/actions`, {
+            query,
+            ...options,
+            headers: { ...options?.headers },
+        });
+    }
+}
+exports.Actions = Actions;
+//# sourceMappingURL=actions.js.map

package/dist/resources/telemetry/actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.js","sourceRoot":"","sources":["../../src/resources/telemetry/actions.ts"],"names":[],"mappings":";;;AAAA,gDAA6C;AAuB7C,MAAa,OAAQ,SAAQ,sBAAW;IACpC,IAAI,CAAC,MAAyB,EAAE,OAA6B;QACzD,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE;YAC7C,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SACnC,CAAC,CAAC;IACP,CAAC;CACJ;AATD,0BASC"}

package/dist/resources/telemetry/actions.mjs

@@ -0,0 +1,12 @@
+import { APIResource } from "../../resource.mjs";
+export class Actions extends APIResource {
+    list(params, options) {
+        const { ...query } = params;
+        return this._client.get(`/telemetry/v1/actions`, {
+            query,
+            ...options,
+            headers: { ...options?.headers },
+        });
+    }
+}
+//# sourceMappingURL=actions.mjs.map

package/dist/resources/telemetry/actions.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.mjs","sourceRoot":"","sources":["../../src/resources/telemetry/actions.ts"],"names":[],"mappings":"OAAO,EAAE,WAAW,EAAE;AAuBtB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACpC,IAAI,CAAC,MAAyB,EAAE,OAA6B;QACzD,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE;YAC7C,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SACnC,CAAC,CAAC;IACP,CAAC;CACJ"}

package/dist/resources/telemetry/index.d.ts

@@ -4,11 +4,13 @@ import { Alerts } from "./alerts.js";
 import { Geofences } from "./geofences.js";
 import { Automations } from "./automations.js";
 import { Events } from "./events.js";
+import { Actions } from "./actions.js";
 export declare class Telemetry extends APIResource {
     entities: Entities;
     alerts: Alerts;
     geofences: Geofences;
     automations: Automations;
     events: Events;
+    actions: Actions;
 }
 //# sourceMappingURL=index.d.ts.map

package/dist/resources/telemetry/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/telemetry/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,qBAAa,SAAU,SAAQ,WAAW;IACtC,QAAQ,EAAE,QAAQ,CAA8B;IAChD,MAAM,EAAE,MAAM,CAA4B;IAC1C,SAAS,EAAE,SAAS,CAA+B;IACnD,WAAW,EAAE,WAAW,CAAiC;IACzD,MAAM,EAAE,MAAM,CAA4B;CAC7C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/telemetry/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,qBAAa,SAAU,SAAQ,WAAW;IACtC,QAAQ,EAAE,QAAQ,CAA8B;IAChD,MAAM,EAAE,MAAM,CAA4B;IAC1C,SAAS,EAAE,SAAS,CAA+B;IACnD,WAAW,EAAE,WAAW,CAAiC;IACzD,MAAM,EAAE,MAAM,CAA4B;IAC1C,OAAO,EAAE,OAAO,CAA6B;CAChD"}

package/dist/resources/telemetry/index.js

@@ -7,6 +7,7 @@ const alerts_1 = require("./alerts.js");
 const geofences_1 = require("./geofences.js");
 const automations_1 = require("./automations.js");
 const events_1 = require("./events.js");
+const actions_1 = require("./actions.js");
 class Telemetry extends resource_1.APIResource {
     constructor() {
         super(...arguments);
@@ -15,6 +16,7 @@ class Telemetry extends resource_1.APIResource {
         this.geofences = new geofences_1.Geofences(this._client);
         this.automations = new automations_1.Automations(this._client);
         this.events = new events_1.Events(this._client);
+        this.actions = new actions_1.Actions(this._client);
     }
 }
 exports.Telemetry = Telemetry;

package/dist/resources/telemetry/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/telemetry/index.ts"],"names":[],"mappings":";;;AAAA,qDAAqD;AACrD,4CAAsC;AACtC,wCAAkC;AAClC,8CAAwC;AACxC,kDAA4C;AAC5C,wCAAkC;AAElC,MAAa,SAAU,SAAQ,sBAAW;IAA1C;;QACI,aAAQ,GAAa,IAAI,mBAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChD,WAAM,GAAW,IAAI,eAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,cAAS,GAAc,IAAI,qBAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnD,gBAAW,GAAgB,IAAI,yBAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,WAAM,GAAW,IAAI,eAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC;CAAA;AAND,8BAMC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/telemetry/index.ts"],"names":[],"mappings":";;;AAAA,qDAAqD;AACrD,4CAAsC;AACtC,wCAAkC;AAClC,8CAAwC;AACxC,kDAA4C;AAC5C,wCAAkC;AAClC,0CAAoC;AAEpC,MAAa,SAAU,SAAQ,sBAAW;IAA1C;;QACI,aAAQ,GAAa,IAAI,mBAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChD,WAAM,GAAW,IAAI,eAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,cAAS,GAAc,IAAI,qBAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnD,gBAAW,GAAgB,IAAI,yBAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,WAAM,GAAW,IAAI,eAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,YAAO,GAAY,IAAI,iBAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACjD,CAAC;CAAA;AAPD,8BAOC"}

package/dist/resources/telemetry/index.mjs

@@ -4,6 +4,7 @@ import { Alerts } from "./alerts.mjs";
 import { Geofences } from "./geofences.mjs";
 import { Automations } from "./automations.mjs";
 import { Events } from "./events.mjs";
+import { Actions } from "./actions.mjs";
 export class Telemetry extends APIResource {
     constructor() {
         super(...arguments);
@@ -12,6 +13,7 @@ export class Telemetry extends APIResource {
         this.geofences = new Geofences(this._client);
         this.automations = new Automations(this._client);
         this.events = new Events(this._client);
+        this.actions = new Actions(this._client);
     }
 }
 //# sourceMappingURL=index.mjs.map

package/dist/resources/telemetry/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/telemetry/index.ts"],"names":[],"mappings":"OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB;OAC7C,EAAE,QAAQ,EAAE;OACZ,EAAE,MAAM,EAAE;OACV,EAAE,SAAS,EAAE;OACb,EAAE,WAAW,EAAE;OACf,EAAE,MAAM,EAAE;AAEjB,MAAM,OAAO,SAAU,SAAQ,WAAW;IAA1C;;QACI,aAAQ,GAAa,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChD,WAAM,GAAW,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,cAAS,GAAc,IAAI,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnD,gBAAW,GAAgB,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,WAAM,GAAW,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC;CAAA"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/telemetry/index.ts"],"names":[],"mappings":"OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB;OAC7C,EAAE,QAAQ,EAAE;OACZ,EAAE,MAAM,EAAE;OACV,EAAE,SAAS,EAAE;OACb,EAAE,WAAW,EAAE;OACf,EAAE,MAAM,EAAE;OACV,EAAE,OAAO,EAAE;AAElB,MAAM,OAAO,SAAU,SAAQ,WAAW;IAA1C;;QACI,aAAQ,GAAa,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChD,WAAM,GAAW,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,cAAS,GAAc,IAAI,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnD,gBAAW,GAAgB,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,WAAM,GAAW,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,YAAO,GAAY,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACjD,CAAC;CAAA"}

package/dist/src/resources/telemetry/actions.ts

@@ -0,0 +1,33 @@
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import { ListParamsResponse, ListResponse } from '../../types/api';
+
+export interface Action {
+    created_at?: string;
+    data: {
+        channel: string;
+        message: string;
+    };
+    id: string;
+    name: string;
+    key: string;
+}
+
+export type ActionsListResponse = ListResponse<Action>;
+
+export interface ActionsListParams extends ListParamsResponse {
+    limit?: number;
+    offset?: number;
+    search?: string;
+}
+
+export class Actions extends APIResource {
+    list(params: ActionsListParams, options?: Core.RequestOptions): Core.APIPromise<ActionsListResponse> {
+        const { ...query } = params;
+        return this._client.get(`/telemetry/v1/actions`, {
+            query,
+            ...options,
+            headers: { ...options?.headers },
+        });
+    }
+}

package/dist/src/resources/telemetry/index.ts

@@ -4,6 +4,7 @@ import { Alerts } from './alerts';
 import { Geofences } from './geofences';
 import { Automations } from './automations';
 import { Events } from './events';
+import { Actions } from './actions';
 
 export class Telemetry extends APIResource {
     entities: Entities = new Entities(this._client);
@@ -11,4 +12,5 @@ export class Telemetry extends APIResource {
     geofences: Geofences = new Geofences(this._client);
     automations: Automations = new Automations(this._client);
     events: Events = new Events(this._client);
+    actions: Actions = new Actions(this._client);
 }

package/dist/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.0.1-dev.44';
+export const VERSION = '0.0.1-dev.45';

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.0.1-dev.44";
+export declare const VERSION = "0.0.1-dev.45";
 //# sourceMappingURL=version.d.ts.map

package/dist/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.0.1-dev.44';
+exports.VERSION = '0.0.1-dev.45';
 //# sourceMappingURL=version.js.map

package/dist/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.0.1-dev.44';
+export const VERSION = '0.0.1-dev.45';
 //# sourceMappingURL=version.mjs.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@space-df/sdk",
-  "version": "0.0.1-dev.44",
+  "version": "0.0.1-dev.45",
   "description": "The official TypeScript library for the Spacedf SDK API",
   "author": "Spacedf SDK <support@digitalfortress.dev>",
   "types": "dist/index.d.ts",

package/src/resources/telemetry/actions.ts

@@ -0,0 +1,33 @@
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import { ListParamsResponse, ListResponse } from '../../types/api';
+
+export interface Action {
+    created_at?: string;
+    data: {
+        channel: string;
+        message: string;
+    };
+    id: string;
+    name: string;
+    key: string;
+}
+
+export type ActionsListResponse = ListResponse<Action>;
+
+export interface ActionsListParams extends ListParamsResponse {
+    limit?: number;
+    offset?: number;
+    search?: string;
+}
+
+export class Actions extends APIResource {
+    list(params: ActionsListParams, options?: Core.RequestOptions): Core.APIPromise<ActionsListResponse> {
+        const { ...query } = params;
+        return this._client.get(`/telemetry/v1/actions`, {
+            query,
+            ...options,
+            headers: { ...options?.headers },
+        });
+    }
+}

package/src/resources/telemetry/index.ts

@@ -4,6 +4,7 @@ import { Alerts } from './alerts';
 import { Geofences } from './geofences';
 import { Automations } from './automations';
 import { Events } from './events';
+import { Actions } from './actions';
 
 export class Telemetry extends APIResource {
     entities: Entities = new Entities(this._client);
@@ -11,4 +12,5 @@ export class Telemetry extends APIResource {
     geofences: Geofences = new Geofences(this._client);
     automations: Automations = new Automations(this._client);
     events: Events = new Events(this._client);
+    actions: Actions = new Actions(this._client);
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.0.1-dev.44';
+export const VERSION = '0.0.1-dev.45';