@chrt-inc/typescript-sdk 1.595.0 → 1.597.0

package/reference.md

@@ -9792,7 +9792,7 @@ await client.shipping.tasks.addToTaskGroupV1("task_group_id", {
 <dl>
 <dd>
 
-Updates a task. Operational fields require STAGED status (lig_owner_operators). order_placer_comments can be edited on any non-DRAFT task (order_creator_org_operators). | (TaskClientUpdate1) -> (PydanticObjectId)
+Updates a task. Operational fields (location, action, time_windows) require STAGED status (lig_owner_operators). order_placer_comments can be edited on any non-DRAFT task (order_creator_org_operators). directory_entry_ids can be edited on STAGED/IN_PROGRESS orders for tasks still in STAGED status (order_creator_org_operators OR lig_owner_operators). | (TaskClientUpdate1) -> (PydanticObjectId)
 
 </dd>
 </dl>
@@ -15781,6 +15781,483 @@ await client.tracking.timeseries.taskGroupByDriver.dataPointsPublicV1({
 </dl>
 </details>
 
+## TrackingIntegrations Tive Devices
+
+<details><summary><code>client.trackingIntegrations.tive.devices.<a href="/src/api/resources/trackingIntegrations/resources/tive/resources/devices/client/Client.ts">listV1</a>({ ...params }) -> Chrt.TiveDeviceListRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists Tive devices with filtering, sorting, and pagination. Scoped to the caller's organization. | authz: min_org_role=operator | () -> (TiveDeviceListRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.trackingIntegrations.tive.devices.listV1({
+    sort_by: "chrt_created_at_timestamp",
+    sort_order: "asc",
+    page: 1,
+    page_size: 1,
+    filter_tive_account_id: 1,
+    filter_tive_device_id: "filter_tive_device_id",
+    filter_chrt_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_chrt_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.trackingIntegrations.tive.DevicesListV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Devices.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.trackingIntegrations.tive.devices.<a href="/src/api/resources/trackingIntegrations/resources/tive/resources/devices/client/Client.ts">getV1</a>({ ...params }) -> Chrt.TiveDevice1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves a single Tive device by its ID. Scoped to the caller's organization. | authz: min_org_role=operator | () -> (TiveDevice1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.trackingIntegrations.tive.devices.getV1({
+    tive_device_id: "tive_device_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.trackingIntegrations.tive.DevicesGetV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Devices.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## TrackingIntegrations Tive Shipments
+
+<details><summary><code>client.trackingIntegrations.tive.shipments.<a href="/src/api/resources/trackingIntegrations/resources/tive/resources/shipments/client/Client.ts">listV1</a>({ ...params }) -> Chrt.TiveShipmentListRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists Tive shipments with filtering, sorting, and pagination. Scoped to the caller's organization. | authz: min_org_role=operator | () -> (TiveShipmentListRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.trackingIntegrations.tive.shipments.listV1({
+    sort_by: "chrt_created_at_timestamp",
+    sort_order: "asc",
+    page: 1,
+    page_size: 1,
+    filter_tive_device_object_id: "filter_tive_device_object_id",
+    filter_tive_shipment_id: "filter_tive_shipment_id",
+    filter_chrt_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_chrt_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.trackingIntegrations.tive.ShipmentsListV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Shipments.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.trackingIntegrations.tive.shipments.<a href="/src/api/resources/trackingIntegrations/resources/tive/resources/shipments/client/Client.ts">getV1</a>({ ...params }) -> Chrt.TiveShipment1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves a single Tive shipment by its ID. Scoped to the caller's organization. | authz: min_org_role=operator | () -> (TiveShipment1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.trackingIntegrations.tive.shipments.getV1({
+    tive_shipment_id: "tive_shipment_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.trackingIntegrations.tive.ShipmentsGetV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Shipments.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## TrackingIntegrations Tive Timeseries
+
+<details><summary><code>client.trackingIntegrations.tive.timeseries.<a href="/src/api/resources/trackingIntegrations/resources/tive/resources/timeseries/client/Client.ts">lastSeenV1</a>({ ...params }) -> (Chrt.TiveDataPoint1 | null) | undefined</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns the most recent Tive data point for a shipment. Scoped to the caller's organization. | authz: min_org_role=operator | () -> (TiveDataPoint1 | None)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.trackingIntegrations.tive.timeseries.lastSeenV1({
+    tive_shipment_id: "tive_shipment_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.trackingIntegrations.tive.TimeseriesLastSeenV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Timeseries.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.trackingIntegrations.tive.timeseries.<a href="/src/api/resources/trackingIntegrations/resources/tive/resources/timeseries/client/Client.ts">dataPointsV1</a>({ ...params }) -> Chrt.TiveTimeseriesRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns raw Tive data points for a shipment within the given time range. Scoped to the caller's organization. | authz: min_org_role=operator | () -> (TiveTimeseriesRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.trackingIntegrations.tive.timeseries.dataPointsV1({
+    tive_shipment_id: "tive_shipment_id",
+    start_timestamp: "2024-01-15T09:30:00Z",
+    end_timestamp: "2024-01-15T09:30:00Z",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.trackingIntegrations.tive.TimeseriesDataPointsV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Timeseries.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.trackingIntegrations.tive.timeseries.<a href="/src/api/resources/trackingIntegrations/resources/tive/resources/timeseries/client/Client.ts">syncV1</a>({ ...params }) -> Chrt.TiveTimeseriesSyncRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Fetches new Tive tracker data points from the Tive API for a shipment and stores them in our timeseries collection. Uses a high-water-mark strategy with overlap dedup to prevent duplicate inserts. | authz: min_org_role=operator | () -> (TiveTimeseriesSyncRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.trackingIntegrations.tive.timeseries.syncV1({
+    tive_shipment_id: "tive_shipment_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.trackingIntegrations.tive.TimeseriesSyncV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Timeseries.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Users PublicData
 
 <details><summary><code>client.users.publicData.<a href="/src/api/resources/users/resources/publicData/client/Client.ts">getV1</a>() -> Chrt.UserPublicData1</code></summary>