@chrt-inc/typescript-sdk 1.331.0 → 1.333.0

package/reference.md

@@ -4232,6 +4232,71 @@ await client.dev.getGitInfoV1();
 </dl>
 </details>
 
+## Flights
+
+<details><summary><code>client.flights.<a href="/src/api/resources/flights/client/Client.ts">getFlightInfoForTaskV1</a>(taskId) -> Chrt.FlightInfoForTaskRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns flight info from an adjacent FLIGHT task group for TENDER_TO_AIRLINE or RECOVER_FROM_AIRLINE tasks. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators, shipper_org_operators] | () -> (FlightInfoForTaskRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.flights.getFlightInfoForTaskV1("task_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Flights.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## TaskArtifactNotifications
 
 <details><summary><code>client.taskArtifactNotifications.<a href="/src/api/resources/taskArtifactNotifications/client/Client.ts">getPreferencesV1</a>() -> Chrt.TaskArtifactNotificationPreferences1</code></summary>
@@ -6266,7 +6331,7 @@ await client.taskGroups.setTaskOrderingV1("task_group_id", {
 </dl>
 </details>
 
-<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">setFlightNumberV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
+<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">setFlightInfoV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
 <dl>
 <dd>
 
@@ -6278,7 +6343,7 @@ await client.taskGroups.setTaskOrderingV1("task_group_id", {
 <dl>
 <dd>
 
-Sets the flight number on a task group, plus any TENDER_TO_AIRLINE tasks in the immediately preceding task group and RECOVER_FROM_AIRLINE tasks in the immediately following task group. | authz_personas=[lig_org_operators] | (SetFlightNumberReq) -> (bool)
+Sets the flight number and/or fa_flight_id on a task group. | authz_personas=[lig_org_operators] | (SetFlightInfoReq) -> (bool)
 
 </dd>
 </dl>
@@ -6294,9 +6359,7 @@ Sets the flight number on a task group, plus any TENDER_TO_AIRLINE tasks in the
 <dd>
 
 ```typescript
-await client.taskGroups.setFlightNumberV1("task_group_id", {
-    flight_number: "flight_number",
-});
+await client.taskGroups.setFlightInfoV1("task_group_id", {});
 ```
 
 </dd>
@@ -6320,7 +6383,7 @@ await client.taskGroups.setFlightNumberV1("task_group_id", {
 <dl>
 <dd>
 
-**request:** `Chrt.SetFlightNumberReq`
+**request:** `Chrt.SetFlightInfoReq`
 
 </dd>
 </dl>
@@ -9199,7 +9262,7 @@ await client.orderDrafts.taskGroup.addV1({
 </dl>
 </details>
 
-<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">setFlightNumberV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
+<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">setFlightInfoV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
 <dl>
 <dd>
 
@@ -9211,7 +9274,7 @@ await client.orderDrafts.taskGroup.addV1({
 <dl>
 <dd>
 
-Sets the flight number on a draft task group. | (SetFlightNumberDraftReq) -> (bool)
+Sets the flight number and/or fa_flight_id on a draft task group. | (SetFlightInfoReq) -> (bool)
 
 </dd>
 </dl>
@@ -9227,9 +9290,7 @@ Sets the flight number on a draft task group. | (SetFlightNumberDraftReq) -> (bo
 <dd>
 
 ```typescript
-await client.orderDrafts.taskGroup.setFlightNumberV1("task_group_id", {
-    flight_number: "flight_number",
-});
+await client.orderDrafts.taskGroup.setFlightInfoV1("task_group_id", {});
 ```
 
 </dd>
@@ -9253,7 +9314,7 @@ await client.orderDrafts.taskGroup.setFlightNumberV1("task_group_id", {
 <dl>
 <dd>
 
-**request:** `Chrt.orderDrafts.SetFlightNumberDraftReq`
+**request:** `Chrt.SetFlightInfoReq`
 
 </dd>
 </dl>
@@ -13096,7 +13157,7 @@ await client.tracking.devices.listV1();
 <dl>
 <dd>
 
-Records driver location updates. Automatically writes to all IN_PROGRESS task groups and their associated cargos. Updates driver's last seen timestamp and location. | (DriverUpdateReq) -> (DriverUpdateRes)
+Records driver location updates. Automatically writes to all IN_PROGRESS task groups and their associated IN_TRANSIT cargos. Updates driver's last seen timestamp and location. | (DriverUpdateReq) -> (DriverUpdateRes)
 
 </dd>
 </dl>
@@ -13113,18 +13174,15 @@ Records driver location updates. Automatically writes to all IN_PROGRESS task gr
 
 ```typescript
 await client.tracking.driver.updateV1({
-    timestamp: "2024-01-15T09:30:00Z",
-    location: {
-        type: "Feature",
-        geometry: {
-            type: "GeometryCollection",
-            geometries: [
-                {
-                    type: "LineString",
-                    coordinates: [[]],
-                },
-            ],
-        },
+    type: "Feature",
+    geometry: {
+        type: "GeometryCollection",
+        geometries: [
+            {
+                type: "LineString",
+                coordinates: [[]],
+            },
+        ],
     },
 });
 ```
@@ -13142,7 +13200,7 @@ await client.tracking.driver.updateV1({
 <dl>
 <dd>
 
-**request:** `Chrt.tracking.DriverUpdateReq`
+**request:** `Chrt.LocationFeature`
 
 </dd>
 </dl>
@@ -13738,9 +13796,9 @@ await client.tracking.sessions.deleteV1({
 </dl>
 </details>
 
-## Tracking Sharing
+## Tracking SharingSettings
 
-<details><summary><code>client.tracking.sharing.<a href="/src/api/resources/tracking/resources/sharing/client/Client.ts">getSettingsV1</a>(orderIdOrShortId) -> Chrt.TrackingSharingSettingsRes[]</code></summary>
+<details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">getSettingsV1</a>(orderIdOrShortId) -> Chrt.TrackingSharingSettingsRes[]</code></summary>
 <dl>
 <dd>
 
@@ -13768,7 +13826,7 @@ Get all tracking datasets and their sharing settings for a given order. | authz_
 <dd>
 
 ```typescript
-await client.tracking.sharing.getSettingsV1("order_id_or_short_id");
+await client.tracking.sharingSettings.getSettingsV1("order_id_or_short_id");
 ```
 
 </dd>
@@ -13792,7 +13850,7 @@ await client.tracking.sharing.getSettingsV1("order_id_or_short_id");
 <dl>
 <dd>
 
-**requestOptions:** `Sharing.RequestOptions`
+**requestOptions:** `SharingSettings.RequestOptions`
 
 </dd>
 </dl>
@@ -13803,7 +13861,7 @@ await client.tracking.sharing.getSettingsV1("order_id_or_short_id");
 </dl>
 </details>
 
-<details><summary><code>client.tracking.sharing.<a href="/src/api/resources/tracking/resources/sharing/client/Client.ts">taskGroupByDriverSharingSettingsV1</a>({ ...params }) -> Chrt.TaskGroupByDriverSharingSettings1</code></summary>
+<details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">taskGroupByDriverSharingSettingsV1</a>({ ...params }) -> Chrt.TaskGroupByDriverSharingSettings1</code></summary>
 <dl>
 <dd>
 
@@ -13831,7 +13889,7 @@ Updates the sharing settings for a task group by driver tracking dataset. | auth
 <dd>
 
 ```typescript
-await client.tracking.sharing.taskGroupByDriverSharingSettingsV1({
+await client.tracking.sharingSettings.taskGroupByDriverSharingSettingsV1({
     task_group_id: "task_group_id",
     driver_id: "driver_id",
     public: true,
@@ -13859,7 +13917,7 @@ await client.tracking.sharing.taskGroupByDriverSharingSettingsV1({
 <dl>
 <dd>
 
-**requestOptions:** `Sharing.RequestOptions`
+**requestOptions:** `SharingSettings.RequestOptions`
 
 </dd>
 </dl>
@@ -13870,7 +13928,7 @@ await client.tracking.sharing.taskGroupByDriverSharingSettingsV1({
 </dl>
 </details>
 
-<details><summary><code>client.tracking.sharing.<a href="/src/api/resources/tracking/resources/sharing/client/Client.ts">cargoByDriverSettingsV1</a>({ ...params }) -> Chrt.CargoByDriverSharingSettings1</code></summary>
+<details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">cargoByDriverSettingsV1</a>({ ...params }) -> Chrt.CargoByDriverSharingSettings1</code></summary>
 <dl>
 <dd>
 
@@ -13898,7 +13956,7 @@ Updates the sharing settings for a cargo by driver tracking dataset. | authz_per
 <dd>
 
 ```typescript
-await client.tracking.sharing.cargoByDriverSettingsV1({
+await client.tracking.sharingSettings.cargoByDriverSettingsV1({
     task_group_id: "task_group_id",
     cargo_id: "cargo_id",
     driver_id: "driver_id",
@@ -13927,7 +13985,7 @@ await client.tracking.sharing.cargoByDriverSettingsV1({
 <dl>
 <dd>
 
-**requestOptions:** `Sharing.RequestOptions`
+**requestOptions:** `SharingSettings.RequestOptions`
 
 </dd>
 </dl>
@@ -13938,7 +13996,7 @@ await client.tracking.sharing.cargoByDriverSettingsV1({
 </dl>
 </details>
 
-<details><summary><code>client.tracking.sharing.<a href="/src/api/resources/tracking/resources/sharing/client/Client.ts">cargoByDeviceSettingsV1</a>({ ...params }) -> Chrt.CargoByDeviceSharingSettings1</code></summary>
+<details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">cargoByDeviceSettingsV1</a>({ ...params }) -> Chrt.CargoByDeviceSharingSettings1</code></summary>
 <dl>
 <dd>
 
@@ -13966,7 +14024,7 @@ Updates the sharing settings for a cargo by device tracking dataset. | authz_per
 <dd>
 
 ```typescript
-await client.tracking.sharing.cargoByDeviceSettingsV1({
+await client.tracking.sharingSettings.cargoByDeviceSettingsV1({
     task_group_id: "task_group_id",
     cargo_id: "cargo_id",
     device_id: "device_id",
@@ -13995,7 +14053,7 @@ await client.tracking.sharing.cargoByDeviceSettingsV1({
 <dl>
 <dd>
 
-**requestOptions:** `Sharing.RequestOptions`
+**requestOptions:** `SharingSettings.RequestOptions`
 
 </dd>
 </dl>

package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/requests/SetFlightNumberDraftReq.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * @example
- *     {
- *         flight_number: "flight_number"
- *     }
- */
-export interface SetFlightNumberDraftReq {
-    /** Flight number to set on the task group */
-    flight_number: string;
-}

package/dist/cjs/api/resources/taskGroups/client/requests/SetFlightNumberReq.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * @example
- *     {
- *         flight_number: "flight_number"
- *     }
- */
-export interface SetFlightNumberReq {
-    /** Flight number to set on the task group */
-    flight_number: string;
-}

package/dist/cjs/api/resources/tracking/resources/driver/client/requests/DriverUpdateReq.d.ts

@@ -1,24 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../../../../../../index.js";
-/**
- * @example
- *     {
- *         timestamp: "2024-01-15T09:30:00Z",
- *         location: {
- *             type: "Feature",
- *             geometry: {
- *                 type: "GeometryCollection",
- *                 geometries: [{
- *                         type: "LineString",
- *                         coordinates: [[]]
- *                     }]
- *             }
- *         }
- *     }
- */
-export interface DriverUpdateReq {
-    timestamp: string;
-    location: Chrt.LocationFeature;
-}

package/dist/cjs/api/resources/tracking/resources/driver/client/requests/DriverUpdateReq.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/tracking/resources/driver/client/requests/index.d.ts

@@ -1 +0,0 @@
-export { type DriverUpdateReq } from "./DriverUpdateReq.js";

package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/requests/SetFlightNumberDraftReq.d.mts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * @example
- *     {
- *         flight_number: "flight_number"
- *     }
- */
-export interface SetFlightNumberDraftReq {
-    /** Flight number to set on the task group */
-    flight_number: string;
-}

package/dist/esm/api/resources/taskGroups/client/requests/SetFlightNumberReq.d.mts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * @example
- *     {
- *         flight_number: "flight_number"
- *     }
- */
-export interface SetFlightNumberReq {
-    /** Flight number to set on the task group */
-    flight_number: string;
-}

package/dist/esm/api/resources/tracking/resources/driver/client/requests/DriverUpdateReq.d.mts

@@ -1,24 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../../../../../../index.mjs";
-/**
- * @example
- *     {
- *         timestamp: "2024-01-15T09:30:00Z",
- *         location: {
- *             type: "Feature",
- *             geometry: {
- *                 type: "GeometryCollection",
- *                 geometries: [{
- *                         type: "LineString",
- *                         coordinates: [[]]
- *                     }]
- *             }
- *         }
- *     }
- */
-export interface DriverUpdateReq {
-    timestamp: string;
-    location: Chrt.LocationFeature;
-}

package/dist/esm/api/resources/tracking/resources/driver/client/requests/DriverUpdateReq.mjs

@@ -1,4 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export {};

package/dist/esm/api/resources/tracking/resources/driver/client/requests/index.d.mts

@@ -1 +0,0 @@
-export { type DriverUpdateReq } from "./DriverUpdateReq.mjs";