@chrt-inc/typescript-sdk 1.262.0 → 1.266.0

package/reference.md

@@ -8492,7 +8492,133 @@ await client.tracking.devices.registerToOrg({
 <dl>
 <dd>
 
-**request:** `Chrt.tracking.DevicesRegisterToOrgRequest`
+**request:** `Chrt.tracking.DevicesRegisterToOrgReq1`
+
+</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">update</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Update the type and/or comments for a device.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tracking.devices.update();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.tracking.DevicesUpdateRequest1`
+
+</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">delete</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Delete a device by device_id or device_mac_address. Cannot delete if linked to a session or cargo.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tracking.devices.delete();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.tracking.DevicesDeleteRequest`
 
 </dd>
 </dl>
@@ -9148,7 +9274,7 @@ await client.tracking.sessionByDevice.updateComments({
 </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>
+<details><summary><code>client.tracking.sessionByDevice.<a href="/src/api/resources/tracking/resources/sessionByDevice/client/Client.ts">start</a>({ ...params }) -> boolean</code></summary>
 <dl>
 <dd>
 
@@ -9176,7 +9302,7 @@ Start a session (set recording=true).
 <dd>
 
 ```typescript
-await client.tracking.sessionByDevice.startSession({
+await client.tracking.sessionByDevice.start({
     session_id: "session_id",
 });
 ```
@@ -9194,7 +9320,7 @@ await client.tracking.sessionByDevice.startSession({
 <dl>
 <dd>
 
-**request:** `Chrt.tracking.SessionByDeviceStartSessionRequest`
+**request:** `Chrt.tracking.SessionByDeviceStartRequest`
 
 </dd>
 </dl>
@@ -9213,7 +9339,7 @@ await client.tracking.sessionByDevice.startSession({
 </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>
+<details><summary><code>client.tracking.sessionByDevice.<a href="/src/api/resources/tracking/resources/sessionByDevice/client/Client.ts">pauseRecording</a>({ ...params }) -> boolean</code></summary>
 <dl>
 <dd>
 
@@ -9241,7 +9367,7 @@ Pause a session (set recording=false).
 <dd>
 
 ```typescript
-await client.tracking.sessionByDevice.pauseSession({
+await client.tracking.sessionByDevice.pauseRecording({
     session_id: "session_id",
 });
 ```
@@ -9259,7 +9385,7 @@ await client.tracking.sessionByDevice.pauseSession({
 <dl>
 <dd>
 
-**request:** `Chrt.tracking.SessionByDevicePauseSessionRequest`
+**request:** `Chrt.tracking.SessionByDevicePauseRecordingRequest`
 
 </dd>
 </dl>
@@ -9278,7 +9404,7 @@ await client.tracking.sessionByDevice.pauseSession({
 </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>
+<details><summary><code>client.tracking.sessionByDevice.<a href="/src/api/resources/tracking/resources/sessionByDevice/client/Client.ts">resumeRecording</a>({ ...params }) -> boolean</code></summary>
 <dl>
 <dd>
 
@@ -9306,7 +9432,7 @@ Resume a session (set recording=true).
 <dd>
 
 ```typescript
-await client.tracking.sessionByDevice.resumeSession({
+await client.tracking.sessionByDevice.resumeRecording({
     session_id: "session_id",
 });
 ```
@@ -9324,7 +9450,7 @@ await client.tracking.sessionByDevice.resumeSession({
 <dl>
 <dd>
 
-**request:** `Chrt.tracking.SessionByDeviceResumeSessionRequest`
+**request:** `Chrt.tracking.SessionByDeviceResumeRecordingRequest`
 
 </dd>
 </dl>
@@ -9343,7 +9469,7 @@ await client.tracking.sessionByDevice.resumeSession({
 </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>
+<details><summary><code>client.tracking.sessionByDevice.<a href="/src/api/resources/tracking/resources/sessionByDevice/client/Client.ts">terminate</a>({ ...params }) -> boolean</code></summary>
 <dl>
 <dd>
 
@@ -9371,7 +9497,72 @@ End a session (set recording=false).
 <dd>
 
 ```typescript
-await client.tracking.sessionByDevice.endSession({
+await client.tracking.sessionByDevice.terminate({
+    session_id: "session_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.tracking.SessionByDeviceTerminateRequest`
+
+</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">delete</a>({ ...params }) -> Chrt.SessionByDeviceDeleteResponse1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Delete a terminated session and all associated timeseries data.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tracking.sessionByDevice.delete({
     session_id: "session_id",
 });
 ```
@@ -9389,7 +9580,7 @@ await client.tracking.sessionByDevice.endSession({
 <dl>
 <dd>
 
-**request:** `Chrt.tracking.SessionByDeviceEndSessionRequest`
+**request:** `Chrt.tracking.SessionByDeviceDeleteRequest`
 
 </dd>
 </dl>

package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDevicePauseSessionRequest.d.mts

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * @example
- *     {
- *         session_id: "session_id"
- *     }
- */
-export interface SessionByDevicePauseSessionRequest {
-    session_id: string;
-}

package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceResumeSessionRequest.d.mts

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * @example
- *     {
- *         session_id: "session_id"
- *     }
- */
-export interface SessionByDeviceResumeSessionRequest {
-    session_id: string;
-}

package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/requests/SessionByDeviceStartSessionRequest.d.mts

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * @example
- *     {
- *         session_id: "session_id"
- *     }
- */
-export interface SessionByDeviceStartSessionRequest {
-    session_id: string;
-}