Skip to content

Commit 4dd998f

Browse files
committed
feat: implementbulk update entity
1 parent 9284930 commit 4dd998f

2 files changed

Lines changed: 52 additions & 2 deletions

File tree

api.doc.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3714,7 +3714,7 @@ await client.trip.delete('trip-uuid-456');
37143714
37153715
## Overview
37163716
3717-
The `Telemetry` class provides methods for retrieving telemetry entities, alerts, events, automations, actions, notifications, 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 notification subscriptions, manage automations (list, create, retrieve, update, delete), and manage geofences (list, create, retrieve, update, delete, test).
3717+
The `Telemetry` class provides methods for retrieving telemetry entities, alerts, events, automations, actions, notifications, and geofences. This class allows you to search and filter telemetry entities by display type and search terms, bulk-update entity visibility (visible and hidden IDs), retrieve alerts, query events by device, list telemetry actions, manage notification subscriptions, manage automations (list, create, retrieve, update, delete), and manage geofences (list, create, retrieve, update, delete, test).
37183718
37193719
## Methods
37203720
@@ -3772,6 +3772,37 @@ console.log(entities.count);
37723772

37733773
</details>
37743774

3775+
<details>
3776+
<summary><strong>entities.bulkUpdate</strong></summary>
3777+
3778+
Bulk-update telemetry entity visibility by sending arrays of entity IDs to mark as visible or hidden. This issues a `POST` to `/telemetry/v1/entities/bulk-update` with a JSON body.
3779+
3780+
**Signature:**
3781+
3782+
```typescript
3783+
bulkUpdate(params: BulkUpdateEntitiesParams, options?: Core.RequestOptions): Core.APIPromise<void>
3784+
```
3785+
3786+
**Parameters:**
3787+
3788+
- `params` _(BulkUpdateEntitiesParams)_: JSON body parameters:
3789+
- `visible_entity_ids` _(string[])_: Entity IDs to set as visible.
3790+
- `hidden_entity_ids` _(string[])_: Entity IDs to set as hidden.
3791+
- `options` _(Core.RequestOptions)_: Additional request options.
3792+
3793+
**Returns:** `Promise<void>`
3794+
3795+
**Example:**
3796+
3797+
```typescript
3798+
await client.telemetry.entities.bulkUpdate({
3799+
visible_entity_ids: ['entity-id-1', 'entity-id-2'],
3800+
hidden_entity_ids: ['entity-id-3'],
3801+
});
3802+
```
3803+
3804+
</details>
3805+
37753806
<details>
37763807
<summary><strong>alerts.list</strong></summary>
37773808

src/resources/telemetry/entities.ts

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,14 @@ export class Entities extends APIResource {
88
return this._client.get(`/telemetry/v1/entities`, {
99
query,
1010
...options,
11-
headers: { ...options?.headers },
11+
});
12+
}
13+
14+
bulkUpdate(params: BulkUpdateEntitiesParams, options?: Core.RequestOptions): Core.APIPromise<void> {
15+
const { ...body } = params;
16+
return this._client.put(`/telemetry/v1/entities/bulk-update`, {
17+
body,
18+
...options,
1219
});
1320
}
1421
}
@@ -49,3 +56,15 @@ export interface EntitiesListParams extends ListParamsResponse {
4956
*/
5057
search?: string;
5158
}
59+
60+
export interface BulkUpdateEntitiesParams {
61+
/**
62+
* Body param: Array of visible entity IDs to update.
63+
*/
64+
visible_entity_ids: string[];
65+
66+
/**
67+
* Body param: Array of hidden entity IDs to update.
68+
*/
69+
hidden_entity_ids: string[];
70+
}

0 commit comments

Comments
 (0)