@chrt-inc/typescript-sdk 0.231.0 → 0.252.0

package/reference.md

@@ -8382,9 +8382,9 @@ await client.tracking.cargoByDriver.update({
 </dl>
 </details>
 
-## Tracking TaskGroupByDriver
+## Tracking Devices
 
-<details><summary><code>client.tracking.taskGroupByDriver.<a href="/src/api/resources/tracking/resources/taskGroupByDriver/client/Client.ts">lastSeen</a>({ ...params }) -> (Chrt.TrackingTaskGroupByDriverDataPoint1 | null) | undefined</code></summary>
+<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">registerToOrg</a>({ ...params }) -> string</code></summary>
 <dl>
 <dd>
 
@@ -8396,7 +8396,7 @@ await client.tracking.cargoByDriver.update({
 <dl>
 <dd>
 
-Returns the most recent data point in tracking.task_group_by_driver for the given task_group_id.
+Register a device to the caller's org.
 
 </dd>
 </dl>
@@ -8412,8 +8412,8 @@ Returns the most recent data point in tracking.task_group_by_driver for the give
 <dd>
 
 ```typescript
-await client.tracking.taskGroupByDriver.lastSeen({
-    task_group_id: "task_group_id",
+await client.tracking.devices.registerToOrg({
+    device_mac_address: "device_mac_address",
 });
 ```
 
@@ -8430,7 +8430,7 @@ await client.tracking.taskGroupByDriver.lastSeen({
 <dl>
 <dd>
 
-**request:** `Chrt.tracking.TaskGroupByDriverLastSeenRequest`
+**request:** `Chrt.tracking.DevicesRegisterToOrgRequest`
 
 </dd>
 </dl>
@@ -8438,7 +8438,7 @@ await client.tracking.taskGroupByDriver.lastSeen({
 <dl>
 <dd>
 
-**requestOptions:** `TaskGroupByDriver.RequestOptions`
+**requestOptions:** `Devices.RequestOptions`
 
 </dd>
 </dl>
@@ -8449,7 +8449,7 @@ await client.tracking.taskGroupByDriver.lastSeen({
 </dl>
 </details>
 
-<details><summary><code>client.tracking.taskGroupByDriver.<a href="/src/api/resources/tracking/resources/taskGroupByDriver/client/Client.ts">update</a>({ ...params }) -> boolean</code></summary>
+<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">get</a>({ ...params }) -> Chrt.Device1</code></summary>
 <dl>
 <dd>
 
@@ -8461,7 +8461,7 @@ await client.tracking.taskGroupByDriver.lastSeen({
 <dl>
 <dd>
 
-Writes a data point to tracking.task_group_by_driver when the task group is in progress.
+Get a device by device_mac_address.
 
 </dd>
 </dl>
@@ -8477,12 +8477,261 @@ Writes a data point to tracking.task_group_by_driver when the task group is in p
 <dd>
 
 ```typescript
-await client.tracking.taskGroupByDriver.update({
+await client.tracking.devices.get({
+    device_mac_address: "device_mac_address",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.tracking.DevicesGetRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Devices.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">list</a>() -> Chrt.Device1[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+List all devices registered to the caller's org.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tracking.devices.list();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Devices.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">linkToCargo</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Link a device to a cargo (bidirectional references).
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tracking.devices.linkToCargo({
+    device_mac_address: "device_mac_address",
+    cargo_id: "cargo_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.tracking.DevicesLinkToCargoRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Devices.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">unlinkFromCargo</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Unlink a device from its cargo if linked.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tracking.devices.unlinkFromCargo({
+    device_mac_address: "device_mac_address",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.tracking.DevicesUnlinkFromCargoRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Devices.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## Tracking TaskGroupByDriver
+
+<details><summary><code>client.tracking.taskGroupByDriver.<a href="/src/api/resources/tracking/resources/taskGroupByDriver/client/Client.ts">lastSeen</a>({ ...params }) -> (Chrt.TrackingTaskGroupByDriverDataPoint1 | null) | undefined</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns the most recent data point in tracking.task_group_by_driver for the given task_group_id.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tracking.taskGroupByDriver.lastSeen({
     task_group_id: "task_group_id",
-    timestamp: "2024-01-15T09:30:00Z",
-    location: {
-        type: "Feature",
-    },
 });
 ```
 
@@ -8499,7 +8748,7 @@ await client.tracking.taskGroupByDriver.update({
 <dl>
 <dd>
 
-**request:** `Chrt.tracking.TaskGroupByDriverUpdateReq`
+**request:** `Chrt.tracking.TaskGroupByDriverLastSeenRequest`
 
 </dd>
 </dl>
@@ -8517,3 +8766,529 @@ await client.tracking.taskGroupByDriver.update({
 </dd>
 </dl>
 </details>
+
+<details><summary><code>client.tracking.taskGroupByDriver.<a href="/src/api/resources/tracking/resources/taskGroupByDriver/client/Client.ts">update</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Writes a data point to tracking.task_group_by_driver when the task group is in progress.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tracking.taskGroupByDriver.update({
+    task_group_id: "task_group_id",
+    timestamp: "2024-01-15T09:30:00Z",
+    location: {
+        type: "Feature",
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.tracking.TaskGroupByDriverUpdateReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `TaskGroupByDriver.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## Tracking SessionByDevice
+
+<details><summary><code>client.tracking.sessionByDevice.<a href="/src/api/resources/tracking/resources/sessionByDevice/client/Client.ts">lastSeen</a>({ ...params }) -> (Chrt.TrackingSessionByDeviceDataPoint1 | null) | undefined</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Return the most recent datapoint for a session.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tracking.sessionByDevice.lastSeen({
+    session_id: "session_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.tracking.SessionByDeviceLastSeenRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SessionByDevice.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.tracking.sessionByDevice.<a href="/src/api/resources/tracking/resources/sessionByDevice/client/Client.ts">createSession</a>({ ...params }) -> string</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a session for a device and link the device to it.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tracking.sessionByDevice.createSession({
+    device_mac_address: "device_mac_address",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.tracking.SessionByDeviceCreateSessionRequest1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SessionByDevice.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.tracking.sessionByDevice.<a href="/src/api/resources/tracking/resources/sessionByDevice/client/Client.ts">updateComments</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Overwrite or delete the comments for a session.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tracking.sessionByDevice.updateComments({
+    session_id: "session_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.tracking.SessionByDeviceUpdateCommentsRequest1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SessionByDevice.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.tracking.sessionByDevice.<a href="/src/api/resources/tracking/resources/sessionByDevice/client/Client.ts">startSession</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Start a session (set recording=true).
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tracking.sessionByDevice.startSession({
+    session_id: "session_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.tracking.SessionByDeviceStartSessionRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SessionByDevice.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.tracking.sessionByDevice.<a href="/src/api/resources/tracking/resources/sessionByDevice/client/Client.ts">pauseSession</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Pause a session (set recording=false).
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tracking.sessionByDevice.pauseSession({
+    session_id: "session_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.tracking.SessionByDevicePauseSessionRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SessionByDevice.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.tracking.sessionByDevice.<a href="/src/api/resources/tracking/resources/sessionByDevice/client/Client.ts">resumeSession</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Resume a session (set recording=true).
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tracking.sessionByDevice.resumeSession({
+    session_id: "session_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.tracking.SessionByDeviceResumeSessionRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SessionByDevice.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.tracking.sessionByDevice.<a href="/src/api/resources/tracking/resources/sessionByDevice/client/Client.ts">endSession</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+End a session (set recording=false).
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tracking.sessionByDevice.endSession({
+    session_id: "session_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.tracking.SessionByDeviceEndSessionRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SessionByDevice.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>