@chrt-inc/typescript-sdk 1.788.0 → 1.807.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -10
- package/dist/cjs/Client.d.ts +3 -0
- package/dist/cjs/Client.js +31 -26
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/Client.d.ts +20 -3
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/Client.js +68 -2
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/requests/{LineItemGroupSharedTaskGroupMileageCreateClientReq.d.ts → SharedTaskGroupMileageCreateForProviderPayDriverClientReq.d.ts} +1 -1
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/requests/SharedTaskGroupMileageCreateForProviderPayProviderClientReq.d.ts +24 -0
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/requests/index.d.ts +2 -1
- package/dist/cjs/api/resources/flights/client/Client.d.ts +52 -0
- package/dist/cjs/api/resources/flights/client/Client.js +135 -0
- package/dist/cjs/api/resources/flights/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/flights/client/index.js +17 -0
- package/dist/cjs/api/resources/flights/client/requests/FlightConnectionsSearchReq.d.ts +45 -0
- package/dist/cjs/api/resources/flights/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/flights/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/flights/index.d.ts +1 -0
- package/dist/cjs/api/resources/flights/index.js +17 -0
- package/dist/cjs/api/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/index.js +3 -1
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/Client.js +1 -1
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/Client.d.ts +19 -1
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/Client.js +71 -1
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksBulkUpdateDeadlinesReq1.d.ts +16 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.js +11 -3
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriversListV1Request.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/OrdersNewDraftReq.d.ts +2 -0
- package/dist/cjs/api/resources/tracking/resources/driver/client/Client.d.ts +0 -22
- package/dist/cjs/api/resources/tracking/resources/driver/client/Client.js +0 -71
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.d.ts +29 -24
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.js +54 -51
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionClientCreate1.d.ts +0 -2
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionSetFlightInfoReq1.d.ts +24 -0
- package/dist/{esm/api/resources/tracking/resources/sessions/client/requests/SessionsSyncFlightStatusV1Request.d.mts → cjs/api/resources/tracking/resources/sessions/client/requests/SessionsFlightLegsV1Request.d.ts} +1 -1
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsFlightTrackV1Request.d.ts +14 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsListV1Request.d.ts +0 -3
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/index.d.ts +3 -3
- package/dist/cjs/api/types/AlertCallback.d.ts +7 -0
- package/dist/cjs/api/types/AlertCallback.js +5 -0
- package/dist/cjs/api/types/AlertEvent.d.ts +6 -0
- package/dist/cjs/api/types/AlertEvent.js +5 -0
- package/dist/cjs/api/types/AlertMessage.d.ts +10 -0
- package/dist/cjs/api/types/AlertMessage.js +5 -0
- package/dist/cjs/api/types/AlertNameValue.d.ts +7 -0
- package/dist/cjs/api/types/AlertNameValue.js +5 -0
- package/dist/cjs/api/types/AlertNameValues.d.ts +7 -0
- package/dist/cjs/api/types/AlertNameValues.js +5 -0
- package/dist/cjs/api/types/AlertRuleEnvelope.d.ts +7 -0
- package/dist/cjs/api/types/AlertRuleEnvelope.js +5 -0
- package/dist/cjs/api/types/CiriumAirportResources.d.ts +9 -0
- package/dist/cjs/api/types/CiriumAirportResources.js +5 -0
- package/dist/cjs/api/types/CiriumDate.d.ts +6 -0
- package/dist/cjs/api/types/CiriumDate.js +5 -0
- package/dist/cjs/api/types/{FlightAwareWebhookResponse.d.ts → CiriumFlightAlertsWebhookResponse.d.ts} +1 -1
- package/dist/cjs/api/types/CiriumFlightAlertsWebhookResponse.js +5 -0
- package/dist/cjs/api/types/CiriumFlightStatus.d.ts +15 -0
- package/dist/cjs/api/types/CiriumFlightStatus.js +5 -0
- package/dist/cjs/api/types/CiriumOperationalTimes.d.ts +17 -0
- package/dist/cjs/api/types/CiriumOperationalTimes.js +5 -0
- package/dist/cjs/api/types/ConnectionSearchByEnum.d.ts +8 -0
- package/dist/cjs/api/types/ConnectionSearchByEnum.js +10 -0
- package/dist/cjs/api/types/ConnectionSearchPreferenceEnum.d.ts +8 -0
- package/dist/cjs/api/types/ConnectionSearchPreferenceEnum.js +10 -0
- package/dist/cjs/api/types/Driver1.d.ts +0 -1
- package/dist/cjs/api/types/DriverListRes.d.ts +1 -1
- package/dist/cjs/api/types/DriverWithActiveTaskGroupIds1.d.ts +35 -0
- package/dist/cjs/api/types/DriverWithActiveTaskGroupIds1.js +5 -0
- package/dist/cjs/api/types/FlightConnection.d.ts +10 -0
- package/dist/cjs/api/types/FlightConnection.js +5 -0
- package/dist/cjs/api/types/FlightConnectionLeg.d.ts +22 -0
- package/dist/cjs/api/types/FlightConnectionLeg.js +5 -0
- package/dist/cjs/api/types/FlightConnectionsSearchRes.d.ts +7 -0
- package/dist/cjs/api/types/FlightConnectionsSearchRes.js +5 -0
- package/dist/cjs/api/types/FlightLeg1.d.ts +3 -2
- package/dist/cjs/api/types/OperationsTaskDeadlineUpdate1.d.ts +7 -0
- package/dist/cjs/api/types/OperationsTaskDeadlineUpdate1.js +5 -0
- package/dist/cjs/api/types/OperationsTaskListRemoveFromCaseRes1.d.ts +1 -1
- package/dist/cjs/api/types/OperationsTaskStatusEnum.d.ts +2 -1
- package/dist/cjs/api/types/OperationsTaskStatusEnum.js +1 -0
- package/dist/cjs/api/types/OperationsTasksBulkUpdateDeadlinesRes1.d.ts +7 -0
- package/dist/cjs/api/types/OperationsTasksBulkUpdateDeadlinesRes1.js +5 -0
- package/dist/cjs/api/types/OrderBuilderReq.d.ts +2 -0
- package/dist/cjs/api/types/OrderDraftValidationRequirements.d.ts +1 -0
- package/dist/cjs/api/types/OrderManifestValidationRequirements.d.ts +1 -0
- package/dist/cjs/api/types/OrgMembersAndDrivers.d.ts +1 -1
- package/dist/cjs/api/types/Session1.d.ts +3 -6
- package/dist/cjs/api/types/index.d.ts +19 -4
- package/dist/cjs/api/types/index.js +19 -4
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.d.mts +3 -0
- package/dist/esm/Client.mjs +7 -2
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/Client.d.mts +20 -3
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/Client.mjs +68 -2
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/requests/{LineItemGroupSharedTaskGroupMileageCreateClientReq.d.mts → SharedTaskGroupMileageCreateForProviderPayDriverClientReq.d.mts} +1 -1
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/requests/SharedTaskGroupMileageCreateForProviderPayProviderClientReq.d.mts +24 -0
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/requests/index.d.mts +2 -1
- package/dist/esm/api/resources/flights/client/Client.d.mts +52 -0
- package/dist/esm/api/resources/flights/client/Client.mjs +98 -0
- package/dist/esm/api/resources/flights/client/index.d.mts +2 -0
- package/dist/esm/api/resources/flights/client/index.mjs +1 -0
- package/dist/esm/api/resources/flights/client/requests/FlightConnectionsSearchReq.d.mts +45 -0
- package/dist/esm/api/resources/flights/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/flights/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/flights/index.d.mts +1 -0
- package/dist/esm/api/resources/flights/index.mjs +1 -0
- package/dist/esm/api/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/index.mjs +2 -0
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/Client.mjs +1 -1
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/Client.d.mts +19 -1
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/Client.mjs +71 -1
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksBulkUpdateDeadlinesReq1.d.mts +16 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.mjs +11 -3
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriversListV1Request.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/OrdersNewDraftReq.d.mts +2 -0
- package/dist/esm/api/resources/tracking/resources/driver/client/Client.d.mts +0 -22
- package/dist/esm/api/resources/tracking/resources/driver/client/Client.mjs +0 -71
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.d.mts +29 -24
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.mjs +54 -51
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionClientCreate1.d.mts +0 -2
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionSetFlightInfoReq1.d.mts +24 -0
- package/dist/{cjs/api/resources/tracking/resources/sessions/client/requests/SessionsSyncFlightStatusV1Request.d.ts → esm/api/resources/tracking/resources/sessions/client/requests/SessionsFlightLegsV1Request.d.mts} +1 -1
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsFlightTrackV1Request.d.mts +14 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsListV1Request.d.mts +0 -3
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/index.d.mts +3 -3
- package/dist/esm/api/types/AlertCallback.d.mts +7 -0
- package/dist/esm/api/types/AlertCallback.mjs +4 -0
- package/dist/esm/api/types/AlertEvent.d.mts +6 -0
- package/dist/esm/api/types/AlertEvent.mjs +4 -0
- package/dist/esm/api/types/AlertMessage.d.mts +10 -0
- package/dist/esm/api/types/AlertMessage.mjs +4 -0
- package/dist/esm/api/types/AlertNameValue.d.mts +7 -0
- package/dist/esm/api/types/AlertNameValue.mjs +4 -0
- package/dist/esm/api/types/AlertNameValues.d.mts +7 -0
- package/dist/esm/api/types/AlertNameValues.mjs +4 -0
- package/dist/esm/api/types/AlertRuleEnvelope.d.mts +7 -0
- package/dist/esm/api/types/AlertRuleEnvelope.mjs +4 -0
- package/dist/esm/api/types/CiriumAirportResources.d.mts +9 -0
- package/dist/esm/api/types/CiriumAirportResources.mjs +4 -0
- package/dist/esm/api/types/CiriumDate.d.mts +6 -0
- package/dist/esm/api/types/CiriumDate.mjs +4 -0
- package/dist/esm/api/types/{FlightAwareWebhookResponse.d.mts → CiriumFlightAlertsWebhookResponse.d.mts} +1 -1
- package/dist/esm/api/types/CiriumFlightAlertsWebhookResponse.mjs +4 -0
- package/dist/esm/api/types/CiriumFlightStatus.d.mts +15 -0
- package/dist/esm/api/types/CiriumFlightStatus.mjs +4 -0
- package/dist/esm/api/types/CiriumOperationalTimes.d.mts +17 -0
- package/dist/esm/api/types/CiriumOperationalTimes.mjs +4 -0
- package/dist/esm/api/types/ConnectionSearchByEnum.d.mts +8 -0
- package/dist/esm/api/types/ConnectionSearchByEnum.mjs +7 -0
- package/dist/esm/api/types/ConnectionSearchPreferenceEnum.d.mts +8 -0
- package/dist/esm/api/types/ConnectionSearchPreferenceEnum.mjs +7 -0
- package/dist/esm/api/types/Driver1.d.mts +0 -1
- package/dist/esm/api/types/DriverListRes.d.mts +1 -1
- package/dist/esm/api/types/DriverWithActiveTaskGroupIds1.d.mts +35 -0
- package/dist/esm/api/types/DriverWithActiveTaskGroupIds1.mjs +4 -0
- package/dist/esm/api/types/FlightConnection.d.mts +10 -0
- package/dist/esm/api/types/FlightConnection.mjs +4 -0
- package/dist/esm/api/types/FlightConnectionLeg.d.mts +22 -0
- package/dist/esm/api/types/FlightConnectionLeg.mjs +4 -0
- package/dist/esm/api/types/FlightConnectionsSearchRes.d.mts +7 -0
- package/dist/esm/api/types/FlightConnectionsSearchRes.mjs +4 -0
- package/dist/esm/api/types/FlightLeg1.d.mts +3 -2
- package/dist/esm/api/types/OperationsTaskDeadlineUpdate1.d.mts +7 -0
- package/dist/esm/api/types/OperationsTaskDeadlineUpdate1.mjs +4 -0
- package/dist/esm/api/types/OperationsTaskListRemoveFromCaseRes1.d.mts +1 -1
- package/dist/esm/api/types/OperationsTaskStatusEnum.d.mts +2 -1
- package/dist/esm/api/types/OperationsTaskStatusEnum.mjs +1 -0
- package/dist/esm/api/types/OperationsTasksBulkUpdateDeadlinesRes1.d.mts +7 -0
- package/dist/esm/api/types/OperationsTasksBulkUpdateDeadlinesRes1.mjs +4 -0
- package/dist/esm/api/types/OrderBuilderReq.d.mts +2 -0
- package/dist/esm/api/types/OrderDraftValidationRequirements.d.mts +1 -0
- package/dist/esm/api/types/OrderManifestValidationRequirements.d.mts +1 -0
- package/dist/esm/api/types/OrgMembersAndDrivers.d.mts +1 -1
- package/dist/esm/api/types/Session1.d.mts +3 -6
- package/dist/esm/api/types/index.d.mts +19 -4
- package/dist/esm/api/types/index.mjs +19 -4
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +241 -101
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionAddFlightReq1.d.ts +0 -16
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionRemoveFlightReq1.d.ts +0 -16
- package/dist/cjs/api/types/FlightAwareAlertFlight.d.ts +0 -16
- package/dist/cjs/api/types/FlightAwareAlertPayload.d.ts +0 -17
- package/dist/cjs/api/types/FlightStatusEnum.d.ts +0 -14
- package/dist/cjs/api/types/FlightStatusEnum.js +0 -16
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionAddFlightReq1.d.mts +0 -16
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionRemoveFlightReq1.d.mts +0 -16
- package/dist/esm/api/types/FlightAwareAlertFlight.d.mts +0 -16
- package/dist/esm/api/types/FlightAwareAlertPayload.d.mts +0 -17
- package/dist/esm/api/types/FlightStatusEnum.d.mts +0 -14
- package/dist/esm/api/types/FlightStatusEnum.mjs +0 -13
- /package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/requests/{LineItemGroupSharedTaskGroupMileageCreateClientReq.js → SharedTaskGroupMileageCreateForProviderPayDriverClientReq.js} +0 -0
- /package/dist/cjs/api/resources/{tracking/resources/sessions/client/requests/SessionAddFlightReq1.js → billing/resources/lineItemGroups/client/requests/SharedTaskGroupMileageCreateForProviderPayProviderClientReq.js} +0 -0
- /package/dist/cjs/api/resources/{tracking/resources/sessions/client/requests/SessionRemoveFlightReq1.js → flights/client/requests/FlightConnectionsSearchReq.js} +0 -0
- /package/dist/cjs/api/resources/{tracking/resources/sessions/client/requests/SessionsSyncFlightStatusV1Request.js → operations/resources/operationsTasks/client/requests/OperationsTasksBulkUpdateDeadlinesReq1.js} +0 -0
- /package/dist/cjs/api/{types/FlightAwareAlertFlight.js → resources/tracking/resources/sessions/client/requests/SessionSetFlightInfoReq1.js} +0 -0
- /package/dist/cjs/api/{types/FlightAwareAlertPayload.js → resources/tracking/resources/sessions/client/requests/SessionsFlightLegsV1Request.js} +0 -0
- /package/dist/cjs/api/{types/FlightAwareWebhookResponse.js → resources/tracking/resources/sessions/client/requests/SessionsFlightTrackV1Request.js} +0 -0
- /package/dist/esm/api/resources/billing/resources/lineItemGroups/client/requests/{LineItemGroupSharedTaskGroupMileageCreateClientReq.mjs → SharedTaskGroupMileageCreateForProviderPayDriverClientReq.mjs} +0 -0
- /package/dist/esm/api/resources/{tracking/resources/sessions/client/requests/SessionAddFlightReq1.mjs → billing/resources/lineItemGroups/client/requests/SharedTaskGroupMileageCreateForProviderPayProviderClientReq.mjs} +0 -0
- /package/dist/esm/api/resources/{tracking/resources/sessions/client/requests/SessionRemoveFlightReq1.mjs → flights/client/requests/FlightConnectionsSearchReq.mjs} +0 -0
- /package/dist/esm/api/resources/{tracking/resources/sessions/client/requests/SessionsSyncFlightStatusV1Request.mjs → operations/resources/operationsTasks/client/requests/OperationsTasksBulkUpdateDeadlinesReq1.mjs} +0 -0
- /package/dist/esm/api/{types/FlightAwareAlertFlight.mjs → resources/tracking/resources/sessions/client/requests/SessionSetFlightInfoReq1.mjs} +0 -0
- /package/dist/esm/api/{types/FlightAwareAlertPayload.mjs → resources/tracking/resources/sessions/client/requests/SessionsFlightLegsV1Request.mjs} +0 -0
- /package/dist/esm/api/{types/FlightAwareWebhookResponse.mjs → resources/tracking/resources/sessions/client/requests/SessionsFlightTrackV1Request.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -1,5 +1,75 @@
|
|
|
1
1
|
# Reference
|
|
2
2
|
|
|
3
|
+
## Flights
|
|
4
|
+
|
|
5
|
+
<details><summary><code>client.flights.<a href="/src/api/resources/flights/client/Client.ts">searchConnectionsV1</a>({ ...params }) -> Chrt.FlightConnectionsSearchRes</code></summary>
|
|
6
|
+
<dl>
|
|
7
|
+
<dd>
|
|
8
|
+
|
|
9
|
+
#### 📝 Description
|
|
10
|
+
|
|
11
|
+
<dl>
|
|
12
|
+
<dd>
|
|
13
|
+
|
|
14
|
+
<dl>
|
|
15
|
+
<dd>
|
|
16
|
+
|
|
17
|
+
Searches Cirium for cargo flight connections between two airports, anchored on a departure or arrival time. | (FlightConnectionsSearchReq) -> (FlightConnectionsSearchRes)
|
|
18
|
+
|
|
19
|
+
</dd>
|
|
20
|
+
</dl>
|
|
21
|
+
</dd>
|
|
22
|
+
</dl>
|
|
23
|
+
|
|
24
|
+
#### 🔌 Usage
|
|
25
|
+
|
|
26
|
+
<dl>
|
|
27
|
+
<dd>
|
|
28
|
+
|
|
29
|
+
<dl>
|
|
30
|
+
<dd>
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
await client.flights.searchConnectionsV1({
|
|
34
|
+
origin: "origin",
|
|
35
|
+
destination: "destination",
|
|
36
|
+
search_by: "departure_time",
|
|
37
|
+
local_date_time: "2024-01-15T09:30:00Z",
|
|
38
|
+
});
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
</dd>
|
|
42
|
+
</dl>
|
|
43
|
+
</dd>
|
|
44
|
+
</dl>
|
|
45
|
+
|
|
46
|
+
#### ⚙️ Parameters
|
|
47
|
+
|
|
48
|
+
<dl>
|
|
49
|
+
<dd>
|
|
50
|
+
|
|
51
|
+
<dl>
|
|
52
|
+
<dd>
|
|
53
|
+
|
|
54
|
+
**request:** `Chrt.FlightConnectionsSearchReq`
|
|
55
|
+
|
|
56
|
+
</dd>
|
|
57
|
+
</dl>
|
|
58
|
+
|
|
59
|
+
<dl>
|
|
60
|
+
<dd>
|
|
61
|
+
|
|
62
|
+
**requestOptions:** `Flights.RequestOptions`
|
|
63
|
+
|
|
64
|
+
</dd>
|
|
65
|
+
</dl>
|
|
66
|
+
</dd>
|
|
67
|
+
</dl>
|
|
68
|
+
|
|
69
|
+
</dd>
|
|
70
|
+
</dl>
|
|
71
|
+
</details>
|
|
72
|
+
|
|
3
73
|
## Orgs
|
|
4
74
|
|
|
5
75
|
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getInfoV1</a>() -> Chrt.OrgInfoResponse</code></summary>
|
|
@@ -2102,7 +2172,7 @@ await client.billing.lineItemGroups.fromRateSheetCreateForProviderPayDriverV1({
|
|
|
2102
2172
|
<dl>
|
|
2103
2173
|
<dd>
|
|
2104
2174
|
|
|
2105
|
-
Prices a single driver's combined trip across several task groups once. Recomputes route mileage from the ordered task locations (plus optional start/end legs), applies the CHRT-ground rate sheet, and atomically creates an OrderGroup-anchored LineItemGroup, its mileage LineItems, and the LineItemCalculation that records how the charges were derived. The LIG is detached on create (task_group_id is None) — attach to a Statement afterwards. | authz: allowed_org_types=[provider], min_org_role=operator | (
|
|
2175
|
+
Prices a single driver's combined trip across several task groups once. Recomputes route mileage from the ordered task locations (plus optional start/end legs), applies the CHRT-ground rate sheet, and atomically creates an OrderGroup-anchored LineItemGroup, its mileage LineItems, and the LineItemCalculation that records how the charges were derived. The LIG is detached on create (task_group_id is None) — attach to a Statement afterwards. | authz: allowed_org_types=[provider], min_org_role=operator | (SharedTaskGroupMileageCreateForProviderPayDriverClientReq) -> (LineItemGroup1)
|
|
2106
2176
|
|
|
2107
2177
|
</dd>
|
|
2108
2178
|
</dl>
|
|
@@ -2139,7 +2209,74 @@ await client.billing.lineItemGroups.sharedTaskGroupMileageCreateV1({
|
|
|
2139
2209
|
<dl>
|
|
2140
2210
|
<dd>
|
|
2141
2211
|
|
|
2142
|
-
**request:** `Chrt.billing.
|
|
2212
|
+
**request:** `Chrt.billing.SharedTaskGroupMileageCreateForProviderPayDriverClientReq`
|
|
2213
|
+
|
|
2214
|
+
</dd>
|
|
2215
|
+
</dl>
|
|
2216
|
+
|
|
2217
|
+
<dl>
|
|
2218
|
+
<dd>
|
|
2219
|
+
|
|
2220
|
+
**requestOptions:** `LineItemGroups.RequestOptions`
|
|
2221
|
+
|
|
2222
|
+
</dd>
|
|
2223
|
+
</dl>
|
|
2224
|
+
</dd>
|
|
2225
|
+
</dl>
|
|
2226
|
+
|
|
2227
|
+
</dd>
|
|
2228
|
+
</dl>
|
|
2229
|
+
</details>
|
|
2230
|
+
|
|
2231
|
+
<details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">sharedTaskGroupMileageCreateForProviderPayProviderV1</a>({ ...params }) -> Chrt.LineItemGroup1</code></summary>
|
|
2232
|
+
<dl>
|
|
2233
|
+
<dd>
|
|
2234
|
+
|
|
2235
|
+
#### 📝 Description
|
|
2236
|
+
|
|
2237
|
+
<dl>
|
|
2238
|
+
<dd>
|
|
2239
|
+
|
|
2240
|
+
<dl>
|
|
2241
|
+
<dd>
|
|
2242
|
+
|
|
2243
|
+
Prices a single agent's combined trip across several task groups once, on the provider_pay_provider vector — a coordinator paying the executor (commonly an off-chrt agent) that ran the route. Recomputes route mileage from the ordered task locations (plus optional start/end legs), applies the CHRT-ground rate sheet, and atomically creates an OrderGroup-anchored LineItemGroup, its mileage LineItems, and the LineItemCalculation that records how the charges were derived. The LIG is detached on create (task_group_id is None) — attach to a Statement afterwards. | authz: allowed_org_types=[provider], min_org_role=operator | (SharedTaskGroupMileageCreateForProviderPayProviderClientReq) -> (LineItemGroup1)
|
|
2244
|
+
|
|
2245
|
+
</dd>
|
|
2246
|
+
</dl>
|
|
2247
|
+
</dd>
|
|
2248
|
+
</dl>
|
|
2249
|
+
|
|
2250
|
+
#### 🔌 Usage
|
|
2251
|
+
|
|
2252
|
+
<dl>
|
|
2253
|
+
<dd>
|
|
2254
|
+
|
|
2255
|
+
<dl>
|
|
2256
|
+
<dd>
|
|
2257
|
+
|
|
2258
|
+
```typescript
|
|
2259
|
+
await client.billing.lineItemGroups.sharedTaskGroupMileageCreateForProviderPayProviderV1({
|
|
2260
|
+
order_group_id: "order_group_id",
|
|
2261
|
+
rate_sheet_id: "rate_sheet_id",
|
|
2262
|
+
task_ids: ["task_ids"],
|
|
2263
|
+
});
|
|
2264
|
+
```
|
|
2265
|
+
|
|
2266
|
+
</dd>
|
|
2267
|
+
</dl>
|
|
2268
|
+
</dd>
|
|
2269
|
+
</dl>
|
|
2270
|
+
|
|
2271
|
+
#### ⚙️ Parameters
|
|
2272
|
+
|
|
2273
|
+
<dl>
|
|
2274
|
+
<dd>
|
|
2275
|
+
|
|
2276
|
+
<dl>
|
|
2277
|
+
<dd>
|
|
2278
|
+
|
|
2279
|
+
**request:** `Chrt.billing.SharedTaskGroupMileageCreateForProviderPayProviderClientReq`
|
|
2143
2280
|
|
|
2144
2281
|
</dd>
|
|
2145
2282
|
</dl>
|
|
@@ -13508,7 +13645,7 @@ await client.operations.operationsTaskLists.applyToCaseV1("task_list_id", "case_
|
|
|
13508
13645
|
<dl>
|
|
13509
13646
|
<dd>
|
|
13510
13647
|
|
|
13511
|
-
Removes the OperationsTasks this OperationsTaskList added to the Case (matched by source_task_list_id). Only untouched (not_started) tasks are deleted; started/completed/skipped tasks are kept. Returns deleted and kept counts. | authz: min_org_role=operator | () -> (OperationsTaskListRemoveFromCaseRes1)
|
|
13648
|
+
Removes the OperationsTasks this OperationsTaskList added to the Case (matched by source_task_list_id). Only untouched (not_started) tasks are deleted; started/completed/skipped/cancelled tasks are kept. Returns deleted and kept counts. | authz: min_org_role=operator | () -> (OperationsTaskListRemoveFromCaseRes1)
|
|
13512
13649
|
|
|
13513
13650
|
</dd>
|
|
13514
13651
|
</dl>
|
|
@@ -13907,6 +14044,76 @@ await client.operations.operationsTasks.createV1({
|
|
|
13907
14044
|
</dl>
|
|
13908
14045
|
</details>
|
|
13909
14046
|
|
|
14047
|
+
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">bulkUpdateDeadlinesV1</a>({ ...params }) -> Chrt.OperationsTasksBulkUpdateDeadlinesRes1</code></summary>
|
|
14048
|
+
<dl>
|
|
14049
|
+
<dd>
|
|
14050
|
+
|
|
14051
|
+
#### 📝 Description
|
|
14052
|
+
|
|
14053
|
+
<dl>
|
|
14054
|
+
<dd>
|
|
14055
|
+
|
|
14056
|
+
<dl>
|
|
14057
|
+
<dd>
|
|
14058
|
+
|
|
14059
|
+
Sets deadline_timestamp on multiple OperationsTasks in one call, each scoped to the caller's organization. Task ids that don't exist or belong to another org are silently skipped; the response reports how many were updated. | authz: min_org_role=operator | (OperationsTasksBulkUpdateDeadlinesReq1) -> (OperationsTasksBulkUpdateDeadlinesRes1)
|
|
14060
|
+
|
|
14061
|
+
</dd>
|
|
14062
|
+
</dl>
|
|
14063
|
+
</dd>
|
|
14064
|
+
</dl>
|
|
14065
|
+
|
|
14066
|
+
#### 🔌 Usage
|
|
14067
|
+
|
|
14068
|
+
<dl>
|
|
14069
|
+
<dd>
|
|
14070
|
+
|
|
14071
|
+
<dl>
|
|
14072
|
+
<dd>
|
|
14073
|
+
|
|
14074
|
+
```typescript
|
|
14075
|
+
await client.operations.operationsTasks.bulkUpdateDeadlinesV1({
|
|
14076
|
+
operations_task_deadline_updates: [
|
|
14077
|
+
{
|
|
14078
|
+
task_id: "task_id",
|
|
14079
|
+
deadline_timestamp: "2024-01-15T09:30:00Z",
|
|
14080
|
+
},
|
|
14081
|
+
],
|
|
14082
|
+
});
|
|
14083
|
+
```
|
|
14084
|
+
|
|
14085
|
+
</dd>
|
|
14086
|
+
</dl>
|
|
14087
|
+
</dd>
|
|
14088
|
+
</dl>
|
|
14089
|
+
|
|
14090
|
+
#### ⚙️ Parameters
|
|
14091
|
+
|
|
14092
|
+
<dl>
|
|
14093
|
+
<dd>
|
|
14094
|
+
|
|
14095
|
+
<dl>
|
|
14096
|
+
<dd>
|
|
14097
|
+
|
|
14098
|
+
**request:** `Chrt.operations.OperationsTasksBulkUpdateDeadlinesReq1`
|
|
14099
|
+
|
|
14100
|
+
</dd>
|
|
14101
|
+
</dl>
|
|
14102
|
+
|
|
14103
|
+
<dl>
|
|
14104
|
+
<dd>
|
|
14105
|
+
|
|
14106
|
+
**requestOptions:** `OperationsTasks.RequestOptions`
|
|
14107
|
+
|
|
14108
|
+
</dd>
|
|
14109
|
+
</dl>
|
|
14110
|
+
</dd>
|
|
14111
|
+
</dl>
|
|
14112
|
+
|
|
14113
|
+
</dd>
|
|
14114
|
+
</dl>
|
|
14115
|
+
</details>
|
|
14116
|
+
|
|
13910
14117
|
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">updateStatusV1</a>(taskId, { ...params }) -> boolean</code></summary>
|
|
13911
14118
|
<dl>
|
|
13912
14119
|
<dd>
|
|
@@ -13919,7 +14126,7 @@ await client.operations.operationsTasks.createV1({
|
|
|
13919
14126
|
<dl>
|
|
13920
14127
|
<dd>
|
|
13921
14128
|
|
|
13922
|
-
Sets an OperationsTask's status (not_started / in_progress / completed / skipped). Setting COMPLETED stamps completed_at/by; any other status clears them. | authz: min_org_role=operator | (OperationsTaskStatusReq) -> (bool)
|
|
14129
|
+
Sets an OperationsTask's status (not_started / in_progress / completed / skipped / cancelled). Setting COMPLETED stamps completed_at/by; any other status clears them. | authz: min_org_role=operator | (OperationsTaskStatusReq) -> (bool)
|
|
13923
14130
|
|
|
13924
14131
|
</dd>
|
|
13925
14132
|
</dl>
|
|
@@ -17861,7 +18068,7 @@ await client.shipping.drivers.deleteSelfReportedHoursAndMileageV1("driver_id", "
|
|
|
17861
18068
|
</dl>
|
|
17862
18069
|
</details>
|
|
17863
18070
|
|
|
17864
|
-
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getForCallerV1</a>() -> Chrt.
|
|
18071
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getForCallerV1</a>() -> Chrt.DriverWithActiveTaskGroupIds1</code></summary>
|
|
17865
18072
|
<dl>
|
|
17866
18073
|
<dd>
|
|
17867
18074
|
|
|
@@ -17873,7 +18080,7 @@ await client.shipping.drivers.deleteSelfReportedHoursAndMileageV1("driver_id", "
|
|
|
17873
18080
|
<dl>
|
|
17874
18081
|
<dd>
|
|
17875
18082
|
|
|
17876
|
-
Retrieves driver information for the caller within their organization. | () -> (
|
|
18083
|
+
Retrieves driver information for the caller within their organization. | () -> (DriverWithActiveTaskGroupIds1)
|
|
17877
18084
|
|
|
17878
18085
|
</dd>
|
|
17879
18086
|
</dl>
|
|
@@ -17916,7 +18123,7 @@ await client.shipping.drivers.getForCallerV1();
|
|
|
17916
18123
|
</dl>
|
|
17917
18124
|
</details>
|
|
17918
18125
|
|
|
17919
|
-
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getByDriverIdV1</a>(driverId) -> Chrt.
|
|
18126
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getByDriverIdV1</a>(driverId) -> Chrt.DriverWithActiveTaskGroupIds1</code></summary>
|
|
17920
18127
|
<dl>
|
|
17921
18128
|
<dd>
|
|
17922
18129
|
|
|
@@ -17928,7 +18135,7 @@ await client.shipping.drivers.getForCallerV1();
|
|
|
17928
18135
|
<dl>
|
|
17929
18136
|
<dd>
|
|
17930
18137
|
|
|
17931
|
-
Retrieves detailed driver information by driver ID within the organization. | () -> (
|
|
18138
|
+
Retrieves detailed driver information by driver ID within the organization. | () -> (DriverWithActiveTaskGroupIds1)
|
|
17932
18139
|
|
|
17933
18140
|
</dd>
|
|
17934
18141
|
</dl>
|
|
@@ -29043,80 +29250,6 @@ await client.tracking.devices.typeaheadV1({
|
|
|
29043
29250
|
|
|
29044
29251
|
## Tracking Driver
|
|
29045
29252
|
|
|
29046
|
-
<details><summary><code>client.tracking.driver.<a href="/src/api/resources/tracking/resources/driver/client/Client.ts">updateV1</a>({ ...params }) -> Chrt.DriverUpdateRes</code></summary>
|
|
29047
|
-
<dl>
|
|
29048
|
-
<dd>
|
|
29049
|
-
|
|
29050
|
-
#### 📝 Description
|
|
29051
|
-
|
|
29052
|
-
<dl>
|
|
29053
|
-
<dd>
|
|
29054
|
-
|
|
29055
|
-
<dl>
|
|
29056
|
-
<dd>
|
|
29057
|
-
|
|
29058
|
-
Records driver location updates. Updates driver's last seen timestamp and location. Automatically records tracking data for all IN_PROGRESS task groups and their associated IN_TRANSIT cargos (cargo_by_driver). | auth: api_key | (LocationFeature) -> (DriverUpdateRes)
|
|
29059
|
-
|
|
29060
|
-
</dd>
|
|
29061
|
-
</dl>
|
|
29062
|
-
</dd>
|
|
29063
|
-
</dl>
|
|
29064
|
-
|
|
29065
|
-
#### 🔌 Usage
|
|
29066
|
-
|
|
29067
|
-
<dl>
|
|
29068
|
-
<dd>
|
|
29069
|
-
|
|
29070
|
-
<dl>
|
|
29071
|
-
<dd>
|
|
29072
|
-
|
|
29073
|
-
```typescript
|
|
29074
|
-
await client.tracking.driver.updateV1({
|
|
29075
|
-
type: "Feature",
|
|
29076
|
-
geometry: {
|
|
29077
|
-
type: "GeometryCollection",
|
|
29078
|
-
geometries: [
|
|
29079
|
-
{
|
|
29080
|
-
type: "LineString",
|
|
29081
|
-
coordinates: [[]],
|
|
29082
|
-
},
|
|
29083
|
-
],
|
|
29084
|
-
},
|
|
29085
|
-
});
|
|
29086
|
-
```
|
|
29087
|
-
|
|
29088
|
-
</dd>
|
|
29089
|
-
</dl>
|
|
29090
|
-
</dd>
|
|
29091
|
-
</dl>
|
|
29092
|
-
|
|
29093
|
-
#### ⚙️ Parameters
|
|
29094
|
-
|
|
29095
|
-
<dl>
|
|
29096
|
-
<dd>
|
|
29097
|
-
|
|
29098
|
-
<dl>
|
|
29099
|
-
<dd>
|
|
29100
|
-
|
|
29101
|
-
**request:** `Chrt.LocationFeature`
|
|
29102
|
-
|
|
29103
|
-
</dd>
|
|
29104
|
-
</dl>
|
|
29105
|
-
|
|
29106
|
-
<dl>
|
|
29107
|
-
<dd>
|
|
29108
|
-
|
|
29109
|
-
**requestOptions:** `Driver.RequestOptions`
|
|
29110
|
-
|
|
29111
|
-
</dd>
|
|
29112
|
-
</dl>
|
|
29113
|
-
</dd>
|
|
29114
|
-
</dl>
|
|
29115
|
-
|
|
29116
|
-
</dd>
|
|
29117
|
-
</dl>
|
|
29118
|
-
</details>
|
|
29119
|
-
|
|
29120
29253
|
<details><summary><code>client.tracking.driver.<a href="/src/api/resources/tracking/resources/driver/client/Client.ts">updateV2</a>({ ...params }) -> Chrt.DriverUpdateRes</code></summary>
|
|
29121
29254
|
<dl>
|
|
29122
29255
|
<dd>
|
|
@@ -29237,7 +29370,6 @@ await client.tracking.sessions.listV1({
|
|
|
29237
29370
|
filter_device_id: "filter_device_id",
|
|
29238
29371
|
filter_off_chrt_reference_id: "filter_off_chrt_reference_id",
|
|
29239
29372
|
filter_flight_number: "filter_flight_number",
|
|
29240
|
-
filter_fa_flight_id: "filter_fa_flight_id",
|
|
29241
29373
|
filter_flight_loaded_status: "filter_flight_loaded_status",
|
|
29242
29374
|
filter_has_last_seen: true,
|
|
29243
29375
|
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -29427,7 +29559,7 @@ await client.tracking.sessions.typeaheadV1({
|
|
|
29427
29559
|
<dl>
|
|
29428
29560
|
<dd>
|
|
29429
29561
|
|
|
29430
|
-
Creates a new tracking session for a device and automatically starts recording data points. The caller must be the device owner or belong to an org the device is shared with. The device owner remains the session owner (org_id). The device's shared_with_org_ids are copied to the session. The device must not have an active session. Optionally seed a destination geofence (location + radius) to fire a destination geofence entered notification. Auto-termination is scheduled for ~1 week out at 8 PM PT. Prevent auto termination with `no_auto_termination=True` | auth: api_key | (SessionClientCreate1) -> (PydanticObjectId)
|
|
29562
|
+
Creates a new tracking session for a device and automatically starts recording data points. The caller must be the device owner or belong to an org the device is shared with. The device owner remains the session owner (org_id). The device's shared_with_org_ids are copied to the session. The device must not have an active session. Optionally seed a destination geofence (location + radius) to fire a destination geofence entered notification; attach flights afterwards via set_flight_info. Auto-termination is scheduled for ~1 week out at 8 PM PT. Prevent auto termination with `no_auto_termination=True` | auth: api_key | (SessionClientCreate1) -> (PydanticObjectId)
|
|
29431
29563
|
|
|
29432
29564
|
</dd>
|
|
29433
29565
|
</dl>
|
|
@@ -29624,7 +29756,7 @@ await client.tracking.sessions.updateSharedOrgsV1({
|
|
|
29624
29756
|
<dl>
|
|
29625
29757
|
<dd>
|
|
29626
29758
|
|
|
29627
|
-
Terminates a session. Moves device.active_session_id to device.past_session_ids. | auth: api_key | () -> (bool)
|
|
29759
|
+
Terminates a session. Moves device.active_session_id to device.past_session_ids and deactivates the device. | auth: api_key | () -> (bool)
|
|
29628
29760
|
|
|
29629
29761
|
</dd>
|
|
29630
29762
|
</dl>
|
|
@@ -29677,7 +29809,7 @@ await client.tracking.sessions.terminateV1({
|
|
|
29677
29809
|
</dl>
|
|
29678
29810
|
</details>
|
|
29679
29811
|
|
|
29680
|
-
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">
|
|
29812
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">flightLegsV1</a>({ ...params }) -> Chrt.FlightLeg1[]</code></summary>
|
|
29681
29813
|
<dl>
|
|
29682
29814
|
<dd>
|
|
29683
29815
|
|
|
@@ -29689,7 +29821,7 @@ await client.tracking.sessions.terminateV1({
|
|
|
29689
29821
|
<dl>
|
|
29690
29822
|
<dd>
|
|
29691
29823
|
|
|
29692
|
-
|
|
29824
|
+
Returns the session's flight legs in order, with Cirium-sourced status lazily resolved and refreshed on read. Access restricted to the caller's organization or shared organizations. | auth: api_key | authz: min_org_role=operator | () -> (list[FlightLeg1])
|
|
29693
29825
|
|
|
29694
29826
|
</dd>
|
|
29695
29827
|
</dl>
|
|
@@ -29705,10 +29837,8 @@ Adds a flight number and FA flight IDs to an existing session. Creates or reuses
|
|
|
29705
29837
|
<dd>
|
|
29706
29838
|
|
|
29707
29839
|
```typescript
|
|
29708
|
-
await client.tracking.sessions.
|
|
29840
|
+
await client.tracking.sessions.flightLegsV1({
|
|
29709
29841
|
session_id: "session_id",
|
|
29710
|
-
flight_number: "flight_number",
|
|
29711
|
-
fa_flight_ids: ["fa_flight_ids"],
|
|
29712
29842
|
});
|
|
29713
29843
|
```
|
|
29714
29844
|
|
|
@@ -29725,7 +29855,7 @@ await client.tracking.sessions.addFlightV1({
|
|
|
29725
29855
|
<dl>
|
|
29726
29856
|
<dd>
|
|
29727
29857
|
|
|
29728
|
-
**request:** `Chrt.tracking.
|
|
29858
|
+
**request:** `Chrt.tracking.SessionsFlightLegsV1Request`
|
|
29729
29859
|
|
|
29730
29860
|
</dd>
|
|
29731
29861
|
</dl>
|
|
@@ -29744,7 +29874,7 @@ await client.tracking.sessions.addFlightV1({
|
|
|
29744
29874
|
</dl>
|
|
29745
29875
|
</details>
|
|
29746
29876
|
|
|
29747
|
-
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">
|
|
29877
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">flightTrackV1</a>({ ...params }) -> Chrt.FlightTrackRes</code></summary>
|
|
29748
29878
|
<dl>
|
|
29749
29879
|
<dd>
|
|
29750
29880
|
|
|
@@ -29756,7 +29886,7 @@ await client.tracking.sessions.addFlightV1({
|
|
|
29756
29886
|
<dl>
|
|
29757
29887
|
<dd>
|
|
29758
29888
|
|
|
29759
|
-
|
|
29889
|
+
Returns the Cirium-sourced positional track for one of the session's flight legs — the live breadcrumb trail plus the planned path (waypoints + legacy route) — cached on read. Access restricted to the caller's organization or shared organizations. | auth: api_key | authz: min_org_role=operator | () -> (FlightTrackRes)
|
|
29760
29890
|
|
|
29761
29891
|
</dd>
|
|
29762
29892
|
</dl>
|
|
@@ -29772,10 +29902,9 @@ Removes a flight number and FA flight IDs from a session. Runs the shared-aware
|
|
|
29772
29902
|
<dd>
|
|
29773
29903
|
|
|
29774
29904
|
```typescript
|
|
29775
|
-
await client.tracking.sessions.
|
|
29905
|
+
await client.tracking.sessions.flightTrackV1({
|
|
29776
29906
|
session_id: "session_id",
|
|
29777
|
-
|
|
29778
|
-
fa_flight_ids: ["fa_flight_ids"],
|
|
29907
|
+
flight_leg_id: "flight_leg_id",
|
|
29779
29908
|
});
|
|
29780
29909
|
```
|
|
29781
29910
|
|
|
@@ -29792,7 +29921,7 @@ await client.tracking.sessions.removeFlightV1({
|
|
|
29792
29921
|
<dl>
|
|
29793
29922
|
<dd>
|
|
29794
29923
|
|
|
29795
|
-
**request:** `Chrt.tracking.
|
|
29924
|
+
**request:** `Chrt.tracking.SessionsFlightTrackV1Request`
|
|
29796
29925
|
|
|
29797
29926
|
</dd>
|
|
29798
29927
|
</dl>
|
|
@@ -29811,7 +29940,7 @@ await client.tracking.sessions.removeFlightV1({
|
|
|
29811
29940
|
</dl>
|
|
29812
29941
|
</details>
|
|
29813
29942
|
|
|
29814
|
-
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">
|
|
29943
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">setFlightInfoV1</a>({ ...params }) -> boolean</code></summary>
|
|
29815
29944
|
<dl>
|
|
29816
29945
|
<dd>
|
|
29817
29946
|
|
|
@@ -29823,7 +29952,7 @@ await client.tracking.sessions.removeFlightV1({
|
|
|
29823
29952
|
<dl>
|
|
29824
29953
|
<dd>
|
|
29825
29954
|
|
|
29826
|
-
|
|
29955
|
+
Replaces the session's followed flights: deletes the existing session-owned FlightLeg documents and creates new ones from the supplied flight details. Each leg's Cirium flightId and status resolve lazily on read. Pass an empty list to clear all flights. | auth: api_key | authz: min_org_role=operator | (SessionSetFlightInfoReq1) -> (bool)
|
|
29827
29956
|
|
|
29828
29957
|
</dd>
|
|
29829
29958
|
</dl>
|
|
@@ -29839,8 +29968,19 @@ Fetches current OOOI timestamps from FlightAware for each fa_flight_id on the se
|
|
|
29839
29968
|
<dd>
|
|
29840
29969
|
|
|
29841
29970
|
```typescript
|
|
29842
|
-
await client.tracking.sessions.
|
|
29971
|
+
await client.tracking.sessions.setFlightInfoV1({
|
|
29843
29972
|
session_id: "session_id",
|
|
29973
|
+
flight_legs: [
|
|
29974
|
+
{
|
|
29975
|
+
schema_version: 1,
|
|
29976
|
+
flight_number: "flight_number",
|
|
29977
|
+
provenance: "manual",
|
|
29978
|
+
origin_iata: "origin_iata",
|
|
29979
|
+
destination_iata: "destination_iata",
|
|
29980
|
+
scheduled_departure_utc: "2024-01-15T09:30:00Z",
|
|
29981
|
+
carrier_iata: "carrier_iata",
|
|
29982
|
+
},
|
|
29983
|
+
],
|
|
29844
29984
|
});
|
|
29845
29985
|
```
|
|
29846
29986
|
|
|
@@ -29857,7 +29997,7 @@ await client.tracking.sessions.syncFlightStatusV1({
|
|
|
29857
29997
|
<dl>
|
|
29858
29998
|
<dd>
|
|
29859
29999
|
|
|
29860
|
-
**request:** `Chrt.tracking.
|
|
30000
|
+
**request:** `Chrt.tracking.SessionSetFlightInfoReq1`
|
|
29861
30001
|
|
|
29862
30002
|
</dd>
|
|
29863
30003
|
</dl>
|
package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionAddFlightReq1.d.ts
DELETED
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
/**
|
|
5
|
-
* @example
|
|
6
|
-
* {
|
|
7
|
-
* session_id: "session_id",
|
|
8
|
-
* flight_number: "flight_number",
|
|
9
|
-
* fa_flight_ids: ["fa_flight_ids"]
|
|
10
|
-
* }
|
|
11
|
-
*/
|
|
12
|
-
export interface SessionAddFlightReq1 {
|
|
13
|
-
session_id: string;
|
|
14
|
-
flight_number: string;
|
|
15
|
-
fa_flight_ids: string[];
|
|
16
|
-
}
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
/**
|
|
5
|
-
* @example
|
|
6
|
-
* {
|
|
7
|
-
* session_id: "session_id",
|
|
8
|
-
* flight_number: "flight_number",
|
|
9
|
-
* fa_flight_ids: ["fa_flight_ids"]
|
|
10
|
-
* }
|
|
11
|
-
*/
|
|
12
|
-
export interface SessionRemoveFlightReq1 {
|
|
13
|
-
session_id: string;
|
|
14
|
-
flight_number: string;
|
|
15
|
-
fa_flight_ids: string[];
|
|
16
|
-
}
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
/**
|
|
5
|
-
* The 'flight' object nested inside a FlightAware alert POST payload.
|
|
6
|
-
*/
|
|
7
|
-
export interface FlightAwareAlertFlight {
|
|
8
|
-
fa_flight_id: string;
|
|
9
|
-
ident: string;
|
|
10
|
-
registration?: string | null;
|
|
11
|
-
aircraft_type?: string | null;
|
|
12
|
-
origin?: string | null;
|
|
13
|
-
destination?: string | null;
|
|
14
|
-
/** Accepts any additional properties */
|
|
15
|
-
[key: string]: any;
|
|
16
|
-
}
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
import * as Chrt from "../index.js";
|
|
5
|
-
/**
|
|
6
|
-
* Top-level FlightAware alert POST payload.
|
|
7
|
-
*/
|
|
8
|
-
export interface FlightAwareAlertPayload {
|
|
9
|
-
long_description?: string | null;
|
|
10
|
-
short_description?: string | null;
|
|
11
|
-
summary?: string | null;
|
|
12
|
-
event_code?: string | null;
|
|
13
|
-
alert_id?: number | null;
|
|
14
|
-
flight?: Chrt.FlightAwareAlertFlight | null;
|
|
15
|
-
/** Accepts any additional properties */
|
|
16
|
-
[key: string]: any;
|
|
17
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
export type FlightStatusEnum = "unknown" | "scheduled" | "departed_from_gate" | "in_flight" | "landed" | "arrived_at_gate" | "diverted" | "cancelled";
|
|
5
|
-
export declare const FlightStatusEnum: {
|
|
6
|
-
readonly Unknown: "unknown";
|
|
7
|
-
readonly Scheduled: "scheduled";
|
|
8
|
-
readonly DepartedFromGate: "departed_from_gate";
|
|
9
|
-
readonly InFlight: "in_flight";
|
|
10
|
-
readonly Landed: "landed";
|
|
11
|
-
readonly ArrivedAtGate: "arrived_at_gate";
|
|
12
|
-
readonly Diverted: "diverted";
|
|
13
|
-
readonly Cancelled: "cancelled";
|
|
14
|
-
};
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/**
|
|
3
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
-
*/
|
|
5
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
exports.FlightStatusEnum = void 0;
|
|
7
|
-
exports.FlightStatusEnum = {
|
|
8
|
-
Unknown: "unknown",
|
|
9
|
-
Scheduled: "scheduled",
|
|
10
|
-
DepartedFromGate: "departed_from_gate",
|
|
11
|
-
InFlight: "in_flight",
|
|
12
|
-
Landed: "landed",
|
|
13
|
-
ArrivedAtGate: "arrived_at_gate",
|
|
14
|
-
Diverted: "diverted",
|
|
15
|
-
Cancelled: "cancelled",
|
|
16
|
-
};
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
/**
|
|
5
|
-
* @example
|
|
6
|
-
* {
|
|
7
|
-
* session_id: "session_id",
|
|
8
|
-
* flight_number: "flight_number",
|
|
9
|
-
* fa_flight_ids: ["fa_flight_ids"]
|
|
10
|
-
* }
|
|
11
|
-
*/
|
|
12
|
-
export interface SessionAddFlightReq1 {
|
|
13
|
-
session_id: string;
|
|
14
|
-
flight_number: string;
|
|
15
|
-
fa_flight_ids: string[];
|
|
16
|
-
}
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
/**
|
|
5
|
-
* @example
|
|
6
|
-
* {
|
|
7
|
-
* session_id: "session_id",
|
|
8
|
-
* flight_number: "flight_number",
|
|
9
|
-
* fa_flight_ids: ["fa_flight_ids"]
|
|
10
|
-
* }
|
|
11
|
-
*/
|
|
12
|
-
export interface SessionRemoveFlightReq1 {
|
|
13
|
-
session_id: string;
|
|
14
|
-
flight_number: string;
|
|
15
|
-
fa_flight_ids: string[];
|
|
16
|
-
}
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
/**
|
|
5
|
-
* The 'flight' object nested inside a FlightAware alert POST payload.
|
|
6
|
-
*/
|
|
7
|
-
export interface FlightAwareAlertFlight {
|
|
8
|
-
fa_flight_id: string;
|
|
9
|
-
ident: string;
|
|
10
|
-
registration?: string | null;
|
|
11
|
-
aircraft_type?: string | null;
|
|
12
|
-
origin?: string | null;
|
|
13
|
-
destination?: string | null;
|
|
14
|
-
/** Accepts any additional properties */
|
|
15
|
-
[key: string]: any;
|
|
16
|
-
}
|