@chrt-inc/typescript-sdk 1.421.0 → 1.421.1
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/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.d.ts +39 -52
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.js +94 -147
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/{DevicesRegisterToOrgReq1.d.ts → DeviceClientCreate1.d.ts} +4 -2
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DeviceClientUpdate1.d.ts +19 -0
- package/dist/{esm/api/resources/tracking/resources/sessions/client/requests/SessionsStartV1Request.d.mts → cjs/api/resources/tracking/resources/devices/client/requests/DevicesArchiveV1Request.d.ts} +3 -3
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesGetV1Request.d.ts +1 -3
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesListV1Request.d.ts +12 -12
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesSearchV1Request.d.ts +6 -2
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesTypeaheadV1Request.d.ts +20 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesUpdateSharedOrgsReq1.d.ts +14 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/index.d.ts +5 -6
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.d.ts +65 -52
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.js +160 -106
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionAddFlightReq1.d.ts +16 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionClientCreate1.d.ts +22 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionClientUpdate1.d.ts +19 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionRemoveFlightReq1.d.ts +16 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsListV1Request.d.ts +31 -19
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsSearchV1Request.d.ts +6 -2
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/{SessionsPauseRecordingV1Request.d.ts → SessionsSyncFlightStatusV1Request.d.ts} +1 -1
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsTypeaheadV1Request.d.ts +20 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/{SessionsStartV1Request.d.ts → SessionsUpdateSharedOrgsReq1.d.ts} +3 -1
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/index.d.ts +7 -7
- package/dist/cjs/api/types/DeviceExpandedRes.d.ts +11 -0
- package/dist/cjs/api/types/{Device1.d.ts → DeviceLimitedForList1.d.ts} +16 -6
- package/dist/cjs/api/types/DeviceListRes.d.ts +1 -1
- package/dist/cjs/api/types/DeviceSearchRes.d.ts +1 -1
- package/dist/cjs/api/types/FlightStatusEnum.d.ts +14 -0
- package/dist/cjs/api/types/FlightStatusEnum.js +16 -0
- package/dist/cjs/api/types/Session1.d.ts +15 -8
- package/dist/cjs/api/types/SessionSortByEnum.d.ts +4 -3
- package/dist/cjs/api/types/SessionSortByEnum.js +3 -2
- package/dist/cjs/api/types/TrackingOrgScopeEnum.d.ts +9 -0
- package/dist/cjs/api/types/TrackingOrgScopeEnum.js +11 -0
- package/dist/cjs/api/types/TrackingTypeaheadFieldEnum.d.ts +8 -0
- package/dist/cjs/api/types/TrackingTypeaheadFieldEnum.js +10 -0
- package/dist/cjs/api/types/TrackingTypeaheadResult.d.ts +8 -0
- package/dist/cjs/api/types/index.d.ts +6 -2
- package/dist/cjs/api/types/index.js +6 -2
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.d.mts +39 -52
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.mjs +94 -147
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/{DevicesRegisterToOrgReq1.d.mts → DeviceClientCreate1.d.mts} +4 -2
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DeviceClientUpdate1.d.mts +19 -0
- package/dist/esm/api/resources/tracking/resources/{sessions/client/requests/SessionsDeleteV1Request.d.mts → devices/client/requests/DevicesArchiveV1Request.d.mts} +3 -3
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesGetV1Request.d.mts +1 -3
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesListV1Request.d.mts +12 -12
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesSearchV1Request.d.mts +6 -2
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesTypeaheadV1Request.d.mts +20 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesUpdateSharedOrgsReq1.d.mts +14 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/index.d.mts +5 -6
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.d.mts +65 -52
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.mjs +160 -106
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionAddFlightReq1.d.mts +16 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionClientCreate1.d.mts +22 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionClientUpdate1.d.mts +19 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionRemoveFlightReq1.d.mts +16 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsListV1Request.d.mts +31 -19
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsSearchV1Request.d.mts +6 -2
- package/dist/{cjs/api/resources/tracking/resources/sessions/client/requests/SessionsDeleteV1Request.d.ts → esm/api/resources/tracking/resources/sessions/client/requests/SessionsSyncFlightStatusV1Request.d.mts} +1 -1
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsTypeaheadV1Request.d.mts +20 -0
- package/dist/{cjs/api/resources/tracking/resources/sessions/client/requests/SessionsResumeRecordingV1Request.d.ts → esm/api/resources/tracking/resources/sessions/client/requests/SessionsUpdateSharedOrgsReq1.d.mts} +3 -1
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/index.d.mts +7 -7
- package/dist/esm/api/types/DeviceExpandedRes.d.mts +11 -0
- package/dist/esm/api/types/{Device1.d.mts → DeviceLimitedForList1.d.mts} +16 -6
- package/dist/esm/api/types/DeviceListRes.d.mts +1 -1
- package/dist/esm/api/types/DeviceSearchRes.d.mts +1 -1
- package/dist/esm/api/types/FlightStatusEnum.d.mts +14 -0
- package/dist/esm/api/types/FlightStatusEnum.mjs +13 -0
- package/dist/esm/api/types/Session1.d.mts +15 -8
- package/dist/esm/api/types/SessionSortByEnum.d.mts +4 -3
- package/dist/esm/api/types/SessionSortByEnum.mjs +3 -2
- package/dist/esm/api/types/TrackingOrgScopeEnum.d.mts +9 -0
- package/dist/esm/api/types/TrackingOrgScopeEnum.mjs +8 -0
- package/dist/esm/api/types/TrackingTypeaheadFieldEnum.d.mts +8 -0
- package/dist/esm/api/types/TrackingTypeaheadFieldEnum.mjs +7 -0
- package/dist/esm/api/types/TrackingTypeaheadResult.d.mts +8 -0
- package/dist/esm/api/types/index.d.mts +6 -2
- package/dist/esm/api/types/index.mjs +6 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +82 -132
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesDeleteV1Request.d.ts +0 -14
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesLinkToCargoV1Request.d.ts +0 -14
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesTypeaheadOffChrtOrderIdV1Request.d.ts +0 -16
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesUnlinkFromCargoV1Request.d.ts +0 -12
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesUpdateRequest1.d.ts +0 -18
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionCreateSessionRequest1.d.ts +0 -16
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionUpdateRequest1.d.ts +0 -20
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsTypeaheadOffChrtOrderIdV1Request.d.ts +0 -16
- package/dist/cjs/api/types/SessionDeleteResponse1.d.ts +0 -7
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesDeleteV1Request.d.mts +0 -14
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesLinkToCargoV1Request.d.mts +0 -14
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesTypeaheadOffChrtOrderIdV1Request.d.mts +0 -16
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesUnlinkFromCargoV1Request.d.mts +0 -12
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesUpdateRequest1.d.mts +0 -18
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionCreateSessionRequest1.d.mts +0 -16
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionUpdateRequest1.d.mts +0 -20
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsPauseRecordingV1Request.d.mts +0 -12
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsResumeRecordingV1Request.d.mts +0 -12
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsTypeaheadOffChrtOrderIdV1Request.d.mts +0 -16
- package/dist/esm/api/types/SessionDeleteResponse1.d.mts +0 -7
- /package/dist/cjs/api/resources/tracking/resources/devices/client/requests/{DevicesDeleteV1Request.js → DeviceClientCreate1.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/devices/client/requests/{DevicesLinkToCargoV1Request.js → DeviceClientUpdate1.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/devices/client/requests/{DevicesRegisterToOrgReq1.js → DevicesArchiveV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/devices/client/requests/{DevicesTypeaheadOffChrtOrderIdV1Request.js → DevicesTypeaheadV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/devices/client/requests/{DevicesUnlinkFromCargoV1Request.js → DevicesUpdateSharedOrgsReq1.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/{devices/client/requests/DevicesUpdateRequest1.js → sessions/client/requests/SessionAddFlightReq1.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/{SessionCreateSessionRequest1.js → SessionClientCreate1.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/{SessionUpdateRequest1.js → SessionClientUpdate1.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/{SessionsDeleteV1Request.js → SessionRemoveFlightReq1.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/{SessionsPauseRecordingV1Request.js → SessionsSyncFlightStatusV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/{SessionsResumeRecordingV1Request.js → SessionsTypeaheadV1Request.js} +0 -0
- /package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/{SessionsStartV1Request.js → SessionsUpdateSharedOrgsReq1.js} +0 -0
- /package/dist/cjs/api/{resources/tracking/resources/sessions/client/requests/SessionsTypeaheadOffChrtOrderIdV1Request.js → types/DeviceExpandedRes.js} +0 -0
- /package/dist/cjs/api/types/{Device1.js → DeviceLimitedForList1.js} +0 -0
- /package/dist/cjs/api/types/{SessionDeleteResponse1.js → TrackingTypeaheadResult.js} +0 -0
- /package/dist/esm/api/resources/tracking/resources/devices/client/requests/{DevicesDeleteV1Request.mjs → DeviceClientCreate1.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/devices/client/requests/{DevicesLinkToCargoV1Request.mjs → DeviceClientUpdate1.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/devices/client/requests/{DevicesRegisterToOrgReq1.mjs → DevicesArchiveV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/devices/client/requests/{DevicesTypeaheadOffChrtOrderIdV1Request.mjs → DevicesTypeaheadV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/devices/client/requests/{DevicesUnlinkFromCargoV1Request.mjs → DevicesUpdateSharedOrgsReq1.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/{devices/client/requests/DevicesUpdateRequest1.mjs → sessions/client/requests/SessionAddFlightReq1.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/sessions/client/requests/{SessionCreateSessionRequest1.mjs → SessionClientCreate1.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/sessions/client/requests/{SessionUpdateRequest1.mjs → SessionClientUpdate1.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/sessions/client/requests/{SessionsDeleteV1Request.mjs → SessionRemoveFlightReq1.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/sessions/client/requests/{SessionsPauseRecordingV1Request.mjs → SessionsSyncFlightStatusV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/sessions/client/requests/{SessionsResumeRecordingV1Request.mjs → SessionsTypeaheadV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/tracking/resources/sessions/client/requests/{SessionsStartV1Request.mjs → SessionsUpdateSharedOrgsReq1.mjs} +0 -0
- /package/dist/esm/api/{resources/tracking/resources/sessions/client/requests/SessionsTypeaheadOffChrtOrderIdV1Request.mjs → types/DeviceExpandedRes.mjs} +0 -0
- /package/dist/esm/api/types/{Device1.mjs → DeviceLimitedForList1.mjs} +0 -0
- /package/dist/esm/api/types/{SessionDeleteResponse1.mjs → TrackingTypeaheadResult.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -13053,7 +13053,7 @@ await client.taskGroups.expanded.listForCourierDriverV1({
|
|
|
13053
13053
|
<dl>
|
|
13054
13054
|
<dd>
|
|
13055
13055
|
|
|
13056
|
-
Registers a tracking device to the caller's organization. If device is already registered to a different organization,
|
|
13056
|
+
Registers a tracking device to the caller's organization. If the device is already registered to a different organization, returns 409 Conflict. | (DeviceClientCreate1) -> (PydanticObjectId)
|
|
13057
13057
|
|
|
13058
13058
|
</dd>
|
|
13059
13059
|
</dl>
|
|
@@ -13070,6 +13070,7 @@ Registers a tracking device to the caller's organization. If device is already r
|
|
|
13070
13070
|
|
|
13071
13071
|
```typescript
|
|
13072
13072
|
await client.tracking.devices.registerToOrgV1({
|
|
13073
|
+
schema_version: 1,
|
|
13073
13074
|
device_mac_address: "device_mac_address",
|
|
13074
13075
|
});
|
|
13075
13076
|
```
|
|
@@ -13087,7 +13088,7 @@ await client.tracking.devices.registerToOrgV1({
|
|
|
13087
13088
|
<dl>
|
|
13088
13089
|
<dd>
|
|
13089
13090
|
|
|
13090
|
-
**request:** `Chrt.tracking.
|
|
13091
|
+
**request:** `Chrt.tracking.DeviceClientCreate1`
|
|
13091
13092
|
|
|
13092
13093
|
</dd>
|
|
13093
13094
|
</dl>
|
|
@@ -13118,70 +13119,7 @@ await client.tracking.devices.registerToOrgV1({
|
|
|
13118
13119
|
<dl>
|
|
13119
13120
|
<dd>
|
|
13120
13121
|
|
|
13121
|
-
Updates a device's type, comments, and/or
|
|
13122
|
-
|
|
13123
|
-
</dd>
|
|
13124
|
-
</dl>
|
|
13125
|
-
</dd>
|
|
13126
|
-
</dl>
|
|
13127
|
-
|
|
13128
|
-
#### 🔌 Usage
|
|
13129
|
-
|
|
13130
|
-
<dl>
|
|
13131
|
-
<dd>
|
|
13132
|
-
|
|
13133
|
-
<dl>
|
|
13134
|
-
<dd>
|
|
13135
|
-
|
|
13136
|
-
```typescript
|
|
13137
|
-
await client.tracking.devices.updateV1();
|
|
13138
|
-
```
|
|
13139
|
-
|
|
13140
|
-
</dd>
|
|
13141
|
-
</dl>
|
|
13142
|
-
</dd>
|
|
13143
|
-
</dl>
|
|
13144
|
-
|
|
13145
|
-
#### ⚙️ Parameters
|
|
13146
|
-
|
|
13147
|
-
<dl>
|
|
13148
|
-
<dd>
|
|
13149
|
-
|
|
13150
|
-
<dl>
|
|
13151
|
-
<dd>
|
|
13152
|
-
|
|
13153
|
-
**request:** `Chrt.tracking.DevicesUpdateRequest1`
|
|
13154
|
-
|
|
13155
|
-
</dd>
|
|
13156
|
-
</dl>
|
|
13157
|
-
|
|
13158
|
-
<dl>
|
|
13159
|
-
<dd>
|
|
13160
|
-
|
|
13161
|
-
**requestOptions:** `Devices.RequestOptions`
|
|
13162
|
-
|
|
13163
|
-
</dd>
|
|
13164
|
-
</dl>
|
|
13165
|
-
</dd>
|
|
13166
|
-
</dl>
|
|
13167
|
-
|
|
13168
|
-
</dd>
|
|
13169
|
-
</dl>
|
|
13170
|
-
</details>
|
|
13171
|
-
|
|
13172
|
-
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">deleteV1</a>({ ...params }) -> boolean</code></summary>
|
|
13173
|
-
<dl>
|
|
13174
|
-
<dd>
|
|
13175
|
-
|
|
13176
|
-
#### 📝 Description
|
|
13177
|
-
|
|
13178
|
-
<dl>
|
|
13179
|
-
<dd>
|
|
13180
|
-
|
|
13181
|
-
<dl>
|
|
13182
|
-
<dd>
|
|
13183
|
-
|
|
13184
|
-
Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion. Deregisters from Shiprec (transfers to deactivate account) before removing from database. | () -> (bool)
|
|
13122
|
+
Updates a device's type, comments, and/or off_chrt_reference_id. Use \_\_set_to_None flags to explicitly clear Optional fields. | (DeviceClientUpdate1) -> (bool)
|
|
13185
13123
|
|
|
13186
13124
|
</dd>
|
|
13187
13125
|
</dl>
|
|
@@ -13197,9 +13135,8 @@ Deletes a device by ID or MAC address. Device must be unlinked from any session
|
|
|
13197
13135
|
<dd>
|
|
13198
13136
|
|
|
13199
13137
|
```typescript
|
|
13200
|
-
await client.tracking.devices.
|
|
13138
|
+
await client.tracking.devices.updateV1({
|
|
13201
13139
|
device_id: "device_id",
|
|
13202
|
-
device_mac_address: "device_mac_address",
|
|
13203
13140
|
});
|
|
13204
13141
|
```
|
|
13205
13142
|
|
|
@@ -13216,7 +13153,7 @@ await client.tracking.devices.deleteV1({
|
|
|
13216
13153
|
<dl>
|
|
13217
13154
|
<dd>
|
|
13218
13155
|
|
|
13219
|
-
**request:** `Chrt.tracking.
|
|
13156
|
+
**request:** `Chrt.tracking.DeviceClientUpdate1`
|
|
13220
13157
|
|
|
13221
13158
|
</dd>
|
|
13222
13159
|
</dl>
|
|
@@ -13235,7 +13172,7 @@ await client.tracking.devices.deleteV1({
|
|
|
13235
13172
|
</dl>
|
|
13236
13173
|
</details>
|
|
13237
13174
|
|
|
13238
|
-
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">
|
|
13175
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">archiveV1</a>({ ...params }) -> boolean</code></summary>
|
|
13239
13176
|
<dl>
|
|
13240
13177
|
<dd>
|
|
13241
13178
|
|
|
@@ -13247,7 +13184,7 @@ await client.tracking.devices.deleteV1({
|
|
|
13247
13184
|
<dl>
|
|
13248
13185
|
<dd>
|
|
13249
13186
|
|
|
13250
|
-
|
|
13187
|
+
Archives a device by setting archived=True. Device must not have an active session — terminate it first. | () -> (bool)
|
|
13251
13188
|
|
|
13252
13189
|
</dd>
|
|
13253
13190
|
</dl>
|
|
@@ -13263,9 +13200,8 @@ Links a device to cargo with bidirectional references. Device must not already b
|
|
|
13263
13200
|
<dd>
|
|
13264
13201
|
|
|
13265
13202
|
```typescript
|
|
13266
|
-
await client.tracking.devices.
|
|
13267
|
-
|
|
13268
|
-
cargo_id: "cargo_id",
|
|
13203
|
+
await client.tracking.devices.archiveV1({
|
|
13204
|
+
device_id: "device_id",
|
|
13269
13205
|
});
|
|
13270
13206
|
```
|
|
13271
13207
|
|
|
@@ -13282,7 +13218,7 @@ await client.tracking.devices.linkToCargoV1({
|
|
|
13282
13218
|
<dl>
|
|
13283
13219
|
<dd>
|
|
13284
13220
|
|
|
13285
|
-
**request:** `Chrt.tracking.
|
|
13221
|
+
**request:** `Chrt.tracking.DevicesArchiveV1Request`
|
|
13286
13222
|
|
|
13287
13223
|
</dd>
|
|
13288
13224
|
</dl>
|
|
@@ -13301,7 +13237,7 @@ await client.tracking.devices.linkToCargoV1({
|
|
|
13301
13237
|
</dl>
|
|
13302
13238
|
</details>
|
|
13303
13239
|
|
|
13304
|
-
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">
|
|
13240
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">updateSharedOrgsV1</a>({ ...params }) -> boolean</code></summary>
|
|
13305
13241
|
<dl>
|
|
13306
13242
|
<dd>
|
|
13307
13243
|
|
|
@@ -13313,7 +13249,7 @@ await client.tracking.devices.linkToCargoV1({
|
|
|
13313
13249
|
<dl>
|
|
13314
13250
|
<dd>
|
|
13315
13251
|
|
|
13316
|
-
|
|
13252
|
+
Adds and/or removes org_ids from a device's shared_with_org_ids list. Removal overrides addition. | (DevicesUpdateSharedOrgsReq1) -> (bool)
|
|
13317
13253
|
|
|
13318
13254
|
</dd>
|
|
13319
13255
|
</dl>
|
|
@@ -13329,8 +13265,8 @@ Unlinks a device from its linked cargo, removing the bidirectional reference. Re
|
|
|
13329
13265
|
<dd>
|
|
13330
13266
|
|
|
13331
13267
|
```typescript
|
|
13332
|
-
await client.tracking.devices.
|
|
13333
|
-
|
|
13268
|
+
await client.tracking.devices.updateSharedOrgsV1({
|
|
13269
|
+
device_id: "device_id",
|
|
13334
13270
|
});
|
|
13335
13271
|
```
|
|
13336
13272
|
|
|
@@ -13347,7 +13283,7 @@ await client.tracking.devices.unlinkFromCargoV1({
|
|
|
13347
13283
|
<dl>
|
|
13348
13284
|
<dd>
|
|
13349
13285
|
|
|
13350
|
-
**request:** `Chrt.tracking.
|
|
13286
|
+
**request:** `Chrt.tracking.DevicesUpdateSharedOrgsReq1`
|
|
13351
13287
|
|
|
13352
13288
|
</dd>
|
|
13353
13289
|
</dl>
|
|
@@ -13366,7 +13302,7 @@ await client.tracking.devices.unlinkFromCargoV1({
|
|
|
13366
13302
|
</dl>
|
|
13367
13303
|
</details>
|
|
13368
13304
|
|
|
13369
|
-
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">getV1</a>({ ...params }) -> Chrt.
|
|
13305
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">getV1</a>({ ...params }) -> Chrt.DeviceExpandedRes</code></summary>
|
|
13370
13306
|
<dl>
|
|
13371
13307
|
<dd>
|
|
13372
13308
|
|
|
@@ -13378,7 +13314,7 @@ await client.tracking.devices.unlinkFromCargoV1({
|
|
|
13378
13314
|
<dl>
|
|
13379
13315
|
<dd>
|
|
13380
13316
|
|
|
13381
|
-
Retrieves a single device by its
|
|
13317
|
+
Retrieves a single device by its ID with expanded sessions and cargos. Access restricted to the caller's organization or shared organizations. | authz: min_org_role=operator | () -> (DeviceExpandedRes)
|
|
13382
13318
|
|
|
13383
13319
|
</dd>
|
|
13384
13320
|
</dl>
|
|
@@ -13395,7 +13331,6 @@ Retrieves a single device by its MAC address or ID. Access restricted to the cal
|
|
|
13395
13331
|
|
|
13396
13332
|
```typescript
|
|
13397
13333
|
await client.tracking.devices.getV1({
|
|
13398
|
-
device_mac_address: "device_mac_address",
|
|
13399
13334
|
device_id: "device_id",
|
|
13400
13335
|
});
|
|
13401
13336
|
```
|
|
@@ -13444,7 +13379,7 @@ await client.tracking.devices.getV1({
|
|
|
13444
13379
|
<dl>
|
|
13445
13380
|
<dd>
|
|
13446
13381
|
|
|
13447
|
-
Lists devices with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (DeviceListRes)
|
|
13382
|
+
Lists devices with filtering, sorting, and pagination. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (DeviceListRes)
|
|
13448
13383
|
|
|
13449
13384
|
</dd>
|
|
13450
13385
|
</dl>
|
|
@@ -13465,11 +13400,11 @@ await client.tracking.devices.listV1({
|
|
|
13465
13400
|
sort_order: "asc",
|
|
13466
13401
|
page: 1,
|
|
13467
13402
|
page_size: 1,
|
|
13468
|
-
|
|
13469
|
-
|
|
13403
|
+
org_scope: "owned",
|
|
13404
|
+
filter_off_chrt_reference_id: "filter_off_chrt_reference_id",
|
|
13470
13405
|
filter_type: "D15N-tag",
|
|
13471
|
-
|
|
13472
|
-
|
|
13406
|
+
filter_active_cargo_id: "filter_active_cargo_id",
|
|
13407
|
+
filter_active_session_id: "filter_active_session_id",
|
|
13473
13408
|
filter_registered_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
13474
13409
|
filter_registered_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
13475
13410
|
filter_last_seen_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -13509,7 +13444,7 @@ await client.tracking.devices.listV1({
|
|
|
13509
13444
|
</dl>
|
|
13510
13445
|
</details>
|
|
13511
13446
|
|
|
13512
|
-
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">
|
|
13447
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.TrackingTypeaheadResult[]</code></summary>
|
|
13513
13448
|
<dl>
|
|
13514
13449
|
<dd>
|
|
13515
13450
|
|
|
@@ -13521,7 +13456,7 @@ await client.tracking.devices.listV1({
|
|
|
13521
13456
|
<dl>
|
|
13522
13457
|
<dd>
|
|
13523
13458
|
|
|
13524
|
-
Returns distinct
|
|
13459
|
+
Returns distinct device_mac_address and off_chrt_reference_id values matching the query via case-insensitive regex, searching devices. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (list[TrackingTypeaheadResult])
|
|
13525
13460
|
|
|
13526
13461
|
</dd>
|
|
13527
13462
|
</dl>
|
|
@@ -13537,9 +13472,10 @@ Returns distinct off_chrt_order_id values matching the query via case-insensitiv
|
|
|
13537
13472
|
<dd>
|
|
13538
13473
|
|
|
13539
13474
|
```typescript
|
|
13540
|
-
await client.tracking.devices.
|
|
13475
|
+
await client.tracking.devices.typeaheadV1({
|
|
13541
13476
|
query: "query",
|
|
13542
13477
|
limit: 1,
|
|
13478
|
+
org_scope: "owned",
|
|
13543
13479
|
});
|
|
13544
13480
|
```
|
|
13545
13481
|
|
|
@@ -13556,7 +13492,7 @@ await client.tracking.devices.typeaheadOffChrtOrderIdV1({
|
|
|
13556
13492
|
<dl>
|
|
13557
13493
|
<dd>
|
|
13558
13494
|
|
|
13559
|
-
**request:** `Chrt.tracking.
|
|
13495
|
+
**request:** `Chrt.tracking.DevicesTypeaheadV1Request`
|
|
13560
13496
|
|
|
13561
13497
|
</dd>
|
|
13562
13498
|
</dl>
|
|
@@ -13587,7 +13523,7 @@ await client.tracking.devices.typeaheadOffChrtOrderIdV1({
|
|
|
13587
13523
|
<dl>
|
|
13588
13524
|
<dd>
|
|
13589
13525
|
|
|
13590
|
-
|
|
13526
|
+
Search across device device_mac_address, comments, and off_chrt_reference_id. Handles both partial (typing) and full query submission. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (DeviceSearchRes)
|
|
13591
13527
|
|
|
13592
13528
|
</dd>
|
|
13593
13529
|
</dl>
|
|
@@ -13607,6 +13543,7 @@ await client.tracking.devices.searchV1({
|
|
|
13607
13543
|
query: "query",
|
|
13608
13544
|
page: 1,
|
|
13609
13545
|
page_size: 1,
|
|
13546
|
+
org_scope: "owned",
|
|
13610
13547
|
});
|
|
13611
13548
|
```
|
|
13612
13549
|
|
|
@@ -13732,7 +13669,7 @@ await client.tracking.driver.updateV1({
|
|
|
13732
13669
|
<dl>
|
|
13733
13670
|
<dd>
|
|
13734
13671
|
|
|
13735
|
-
Lists sessions with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (SessionListRes)
|
|
13672
|
+
Lists sessions with filtering, sorting, and pagination. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (SessionListRes)
|
|
13736
13673
|
|
|
13737
13674
|
</dd>
|
|
13738
13675
|
</dl>
|
|
@@ -13749,20 +13686,24 @@ Lists sessions with filtering, sorting, and pagination. | authz: min_org_role=op
|
|
|
13749
13686
|
|
|
13750
13687
|
```typescript
|
|
13751
13688
|
await client.tracking.sessions.listV1({
|
|
13752
|
-
sort_by: "
|
|
13689
|
+
sort_by: "created_at_timestamp",
|
|
13753
13690
|
sort_order: "asc",
|
|
13754
13691
|
page: 1,
|
|
13755
13692
|
page_size: 1,
|
|
13756
|
-
|
|
13693
|
+
org_scope: "owned",
|
|
13757
13694
|
filter_terminated: true,
|
|
13758
13695
|
filter_public: true,
|
|
13759
13696
|
filter_device_id: "filter_device_id",
|
|
13760
|
-
|
|
13697
|
+
filter_off_chrt_reference_id: "filter_off_chrt_reference_id",
|
|
13761
13698
|
filter_flight_number: "filter_flight_number",
|
|
13762
|
-
|
|
13763
|
-
|
|
13764
|
-
|
|
13765
|
-
|
|
13699
|
+
filter_fa_flight_id: "filter_fa_flight_id",
|
|
13700
|
+
filter_flight_loaded_status: "filter_flight_loaded_status",
|
|
13701
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
13702
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
13703
|
+
filter_termination_scheduled_for_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
13704
|
+
filter_termination_scheduled_for_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
13705
|
+
filter_terminated_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
13706
|
+
filter_terminated_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
13766
13707
|
});
|
|
13767
13708
|
```
|
|
13768
13709
|
|
|
@@ -13810,7 +13751,7 @@ await client.tracking.sessions.listV1({
|
|
|
13810
13751
|
<dl>
|
|
13811
13752
|
<dd>
|
|
13812
13753
|
|
|
13813
|
-
Retrieves a single session by its ID. Access restricted to the caller's organization. | authz: min_org_role=operator | () -> (Session1)
|
|
13754
|
+
Retrieves a single session by its ID. Access restricted to the caller's organization or shared organizations. | authz: min_org_role=operator | () -> (Session1)
|
|
13814
13755
|
|
|
13815
13756
|
</dd>
|
|
13816
13757
|
</dl>
|
|
@@ -13863,7 +13804,7 @@ await client.tracking.sessions.getV1({
|
|
|
13863
13804
|
</dl>
|
|
13864
13805
|
</details>
|
|
13865
13806
|
|
|
13866
|
-
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">
|
|
13807
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.TrackingTypeaheadResult[]</code></summary>
|
|
13867
13808
|
<dl>
|
|
13868
13809
|
<dd>
|
|
13869
13810
|
|
|
@@ -13875,7 +13816,7 @@ await client.tracking.sessions.getV1({
|
|
|
13875
13816
|
<dl>
|
|
13876
13817
|
<dd>
|
|
13877
13818
|
|
|
13878
|
-
Returns distinct
|
|
13819
|
+
Returns distinct device_mac_address and off_chrt_reference_id values matching the query via case-insensitive regex, searching sessions. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (list[TrackingTypeaheadResult])
|
|
13879
13820
|
|
|
13880
13821
|
</dd>
|
|
13881
13822
|
</dl>
|
|
@@ -13891,9 +13832,10 @@ Returns distinct off_chrt_order_id values matching the query via case-insensitiv
|
|
|
13891
13832
|
<dd>
|
|
13892
13833
|
|
|
13893
13834
|
```typescript
|
|
13894
|
-
await client.tracking.sessions.
|
|
13835
|
+
await client.tracking.sessions.typeaheadV1({
|
|
13895
13836
|
query: "query",
|
|
13896
13837
|
limit: 1,
|
|
13838
|
+
org_scope: "owned",
|
|
13897
13839
|
});
|
|
13898
13840
|
```
|
|
13899
13841
|
|
|
@@ -13910,7 +13852,7 @@ await client.tracking.sessions.typeaheadOffChrtOrderIdV1({
|
|
|
13910
13852
|
<dl>
|
|
13911
13853
|
<dd>
|
|
13912
13854
|
|
|
13913
|
-
**request:** `Chrt.tracking.
|
|
13855
|
+
**request:** `Chrt.tracking.SessionsTypeaheadV1Request`
|
|
13914
13856
|
|
|
13915
13857
|
</dd>
|
|
13916
13858
|
</dl>
|
|
@@ -13941,7 +13883,7 @@ await client.tracking.sessions.typeaheadOffChrtOrderIdV1({
|
|
|
13941
13883
|
<dl>
|
|
13942
13884
|
<dd>
|
|
13943
13885
|
|
|
13944
|
-
|
|
13886
|
+
Search across session comments, device_mac_address, flight_numbers, and off_chrt_reference_id. Handles both partial and full matches. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (SessionSearchRes)
|
|
13945
13887
|
|
|
13946
13888
|
</dd>
|
|
13947
13889
|
</dl>
|
|
@@ -13961,6 +13903,7 @@ await client.tracking.sessions.searchV1({
|
|
|
13961
13903
|
query: "query",
|
|
13962
13904
|
page: 1,
|
|
13963
13905
|
page_size: 1,
|
|
13906
|
+
org_scope: "owned",
|
|
13964
13907
|
});
|
|
13965
13908
|
```
|
|
13966
13909
|
|
|
@@ -14008,7 +13951,7 @@ await client.tracking.sessions.searchV1({
|
|
|
14008
13951
|
<dl>
|
|
14009
13952
|
<dd>
|
|
14010
13953
|
|
|
14011
|
-
Creates a new tracking session for a device
|
|
13954
|
+
Creates a new tracking session for a device. The device must already be registered to the caller's org and must not have an active session. Recording starts immediately and auto-termination is scheduled for ~3 days out at 8 PM PT. | (SessionClientCreate1) -> (PydanticObjectId)
|
|
14012
13955
|
|
|
14013
13956
|
</dd>
|
|
14014
13957
|
</dl>
|
|
@@ -14025,7 +13968,9 @@ Creates a new tracking session for a device and links the device to it. The devi
|
|
|
14025
13968
|
|
|
14026
13969
|
```typescript
|
|
14027
13970
|
await client.tracking.sessions.createSessionV1({
|
|
14028
|
-
|
|
13971
|
+
device_id: "device_id",
|
|
13972
|
+
termination_scheduled_for_timestamp: "2024-01-15T09:30:00Z",
|
|
13973
|
+
schema_version: 1,
|
|
14029
13974
|
});
|
|
14030
13975
|
```
|
|
14031
13976
|
|
|
@@ -14042,7 +13987,7 @@ await client.tracking.sessions.createSessionV1({
|
|
|
14042
13987
|
<dl>
|
|
14043
13988
|
<dd>
|
|
14044
13989
|
|
|
14045
|
-
**request:** `Chrt.tracking.
|
|
13990
|
+
**request:** `Chrt.tracking.SessionClientCreate1`
|
|
14046
13991
|
|
|
14047
13992
|
</dd>
|
|
14048
13993
|
</dl>
|
|
@@ -14073,7 +14018,7 @@ await client.tracking.sessions.createSessionV1({
|
|
|
14073
14018
|
<dl>
|
|
14074
14019
|
<dd>
|
|
14075
14020
|
|
|
14076
|
-
Updates a session's
|
|
14021
|
+
Updates a session's metadata and/or termination_scheduled_for_timestamp. | (SessionClientUpdate1) -> (bool)
|
|
14077
14022
|
|
|
14078
14023
|
</dd>
|
|
14079
14024
|
</dl>
|
|
@@ -14091,6 +14036,7 @@ Updates a session's mutable fields (comments, public, off_chrt_order_id, flight_
|
|
|
14091
14036
|
```typescript
|
|
14092
14037
|
await client.tracking.sessions.updateV1({
|
|
14093
14038
|
session_id: "session_id",
|
|
14039
|
+
termination_scheduled_for_timestamp: "2024-01-15T09:30:00Z",
|
|
14094
14040
|
});
|
|
14095
14041
|
```
|
|
14096
14042
|
|
|
@@ -14107,7 +14053,7 @@ await client.tracking.sessions.updateV1({
|
|
|
14107
14053
|
<dl>
|
|
14108
14054
|
<dd>
|
|
14109
14055
|
|
|
14110
|
-
**request:** `Chrt.tracking.
|
|
14056
|
+
**request:** `Chrt.tracking.SessionClientUpdate1`
|
|
14111
14057
|
|
|
14112
14058
|
</dd>
|
|
14113
14059
|
</dl>
|
|
@@ -14126,7 +14072,7 @@ await client.tracking.sessions.updateV1({
|
|
|
14126
14072
|
</dl>
|
|
14127
14073
|
</details>
|
|
14128
14074
|
|
|
14129
|
-
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">
|
|
14075
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">updateSharedOrgsV1</a>({ ...params }) -> boolean</code></summary>
|
|
14130
14076
|
<dl>
|
|
14131
14077
|
<dd>
|
|
14132
14078
|
|
|
@@ -14138,7 +14084,7 @@ await client.tracking.sessions.updateV1({
|
|
|
14138
14084
|
<dl>
|
|
14139
14085
|
<dd>
|
|
14140
14086
|
|
|
14141
|
-
|
|
14087
|
+
Adds and/or removes org_ids from a session's shared_with_org_ids list. Only the owning org may modify sharing. Removal overrides addition. | (SessionsUpdateSharedOrgsReq1) -> (bool)
|
|
14142
14088
|
|
|
14143
14089
|
</dd>
|
|
14144
14090
|
</dl>
|
|
@@ -14154,7 +14100,7 @@ Starts location recording for a session by setting recording status to true. Set
|
|
|
14154
14100
|
<dd>
|
|
14155
14101
|
|
|
14156
14102
|
```typescript
|
|
14157
|
-
await client.tracking.sessions.
|
|
14103
|
+
await client.tracking.sessions.updateSharedOrgsV1({
|
|
14158
14104
|
session_id: "session_id",
|
|
14159
14105
|
});
|
|
14160
14106
|
```
|
|
@@ -14172,7 +14118,7 @@ await client.tracking.sessions.startV1({
|
|
|
14172
14118
|
<dl>
|
|
14173
14119
|
<dd>
|
|
14174
14120
|
|
|
14175
|
-
**request:** `Chrt.tracking.
|
|
14121
|
+
**request:** `Chrt.tracking.SessionsUpdateSharedOrgsReq1`
|
|
14176
14122
|
|
|
14177
14123
|
</dd>
|
|
14178
14124
|
</dl>
|
|
@@ -14191,7 +14137,7 @@ await client.tracking.sessions.startV1({
|
|
|
14191
14137
|
</dl>
|
|
14192
14138
|
</details>
|
|
14193
14139
|
|
|
14194
|
-
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">
|
|
14140
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">terminateV1</a>({ ...params }) -> boolean</code></summary>
|
|
14195
14141
|
<dl>
|
|
14196
14142
|
<dd>
|
|
14197
14143
|
|
|
@@ -14203,7 +14149,7 @@ await client.tracking.sessions.startV1({
|
|
|
14203
14149
|
<dl>
|
|
14204
14150
|
<dd>
|
|
14205
14151
|
|
|
14206
|
-
|
|
14152
|
+
Terminates a session. Moves device.active_session_id to device.past_session_ids. | () -> (bool)
|
|
14207
14153
|
|
|
14208
14154
|
</dd>
|
|
14209
14155
|
</dl>
|
|
@@ -14219,7 +14165,7 @@ Pauses location recording for a session by setting recording status to false. De
|
|
|
14219
14165
|
<dd>
|
|
14220
14166
|
|
|
14221
14167
|
```typescript
|
|
14222
|
-
await client.tracking.sessions.
|
|
14168
|
+
await client.tracking.sessions.terminateV1({
|
|
14223
14169
|
session_id: "session_id",
|
|
14224
14170
|
});
|
|
14225
14171
|
```
|
|
@@ -14237,7 +14183,7 @@ await client.tracking.sessions.pauseRecordingV1({
|
|
|
14237
14183
|
<dl>
|
|
14238
14184
|
<dd>
|
|
14239
14185
|
|
|
14240
|
-
**request:** `Chrt.tracking.
|
|
14186
|
+
**request:** `Chrt.tracking.SessionsTerminateV1Request`
|
|
14241
14187
|
|
|
14242
14188
|
</dd>
|
|
14243
14189
|
</dl>
|
|
@@ -14256,7 +14202,7 @@ await client.tracking.sessions.pauseRecordingV1({
|
|
|
14256
14202
|
</dl>
|
|
14257
14203
|
</details>
|
|
14258
14204
|
|
|
14259
|
-
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">
|
|
14205
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">addFlightV1</a>({ ...params }) -> boolean</code></summary>
|
|
14260
14206
|
<dl>
|
|
14261
14207
|
<dd>
|
|
14262
14208
|
|
|
@@ -14268,7 +14214,7 @@ await client.tracking.sessions.pauseRecordingV1({
|
|
|
14268
14214
|
<dl>
|
|
14269
14215
|
<dd>
|
|
14270
14216
|
|
|
14271
|
-
|
|
14217
|
+
Adds a flight number and FA flight IDs to an existing session. Creates or reuses a FlightAware alert. | authz: min_org_role=operator | (SessionAddFlightReq1) -> (bool)
|
|
14272
14218
|
|
|
14273
14219
|
</dd>
|
|
14274
14220
|
</dl>
|
|
@@ -14284,8 +14230,10 @@ Resumes location recording for a session by setting recording status to true. |
|
|
|
14284
14230
|
<dd>
|
|
14285
14231
|
|
|
14286
14232
|
```typescript
|
|
14287
|
-
await client.tracking.sessions.
|
|
14233
|
+
await client.tracking.sessions.addFlightV1({
|
|
14288
14234
|
session_id: "session_id",
|
|
14235
|
+
flight_number: "flight_number",
|
|
14236
|
+
fa_flight_ids: ["fa_flight_ids"],
|
|
14289
14237
|
});
|
|
14290
14238
|
```
|
|
14291
14239
|
|
|
@@ -14302,7 +14250,7 @@ await client.tracking.sessions.resumeRecordingV1({
|
|
|
14302
14250
|
<dl>
|
|
14303
14251
|
<dd>
|
|
14304
14252
|
|
|
14305
|
-
**request:** `Chrt.tracking.
|
|
14253
|
+
**request:** `Chrt.tracking.SessionAddFlightReq1`
|
|
14306
14254
|
|
|
14307
14255
|
</dd>
|
|
14308
14256
|
</dl>
|
|
@@ -14321,7 +14269,7 @@ await client.tracking.sessions.resumeRecordingV1({
|
|
|
14321
14269
|
</dl>
|
|
14322
14270
|
</details>
|
|
14323
14271
|
|
|
14324
|
-
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">
|
|
14272
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">removeFlightV1</a>({ ...params }) -> boolean</code></summary>
|
|
14325
14273
|
<dl>
|
|
14326
14274
|
<dd>
|
|
14327
14275
|
|
|
@@ -14333,7 +14281,7 @@ await client.tracking.sessions.resumeRecordingV1({
|
|
|
14333
14281
|
<dl>
|
|
14334
14282
|
<dd>
|
|
14335
14283
|
|
|
14336
|
-
|
|
14284
|
+
Removes a flight number and FA flight IDs from a session. Runs the shared-aware FlightAware unsubscribe cycle before removing. | authz: min_org_role=operator | (SessionRemoveFlightReq1) -> (bool)
|
|
14337
14285
|
|
|
14338
14286
|
</dd>
|
|
14339
14287
|
</dl>
|
|
@@ -14349,8 +14297,10 @@ Terminates a session by setting recording to false and marking it as terminated.
|
|
|
14349
14297
|
<dd>
|
|
14350
14298
|
|
|
14351
14299
|
```typescript
|
|
14352
|
-
await client.tracking.sessions.
|
|
14300
|
+
await client.tracking.sessions.removeFlightV1({
|
|
14353
14301
|
session_id: "session_id",
|
|
14302
|
+
flight_number: "flight_number",
|
|
14303
|
+
fa_flight_ids: ["fa_flight_ids"],
|
|
14354
14304
|
});
|
|
14355
14305
|
```
|
|
14356
14306
|
|
|
@@ -14367,7 +14317,7 @@ await client.tracking.sessions.terminateV1({
|
|
|
14367
14317
|
<dl>
|
|
14368
14318
|
<dd>
|
|
14369
14319
|
|
|
14370
|
-
**request:** `Chrt.tracking.
|
|
14320
|
+
**request:** `Chrt.tracking.SessionRemoveFlightReq1`
|
|
14371
14321
|
|
|
14372
14322
|
</dd>
|
|
14373
14323
|
</dl>
|
|
@@ -14386,7 +14336,7 @@ await client.tracking.sessions.terminateV1({
|
|
|
14386
14336
|
</dl>
|
|
14387
14337
|
</details>
|
|
14388
14338
|
|
|
14389
|
-
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">
|
|
14339
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">syncFlightStatusV1</a>({ ...params }) -> boolean</code></summary>
|
|
14390
14340
|
<dl>
|
|
14391
14341
|
<dd>
|
|
14392
14342
|
|
|
@@ -14398,7 +14348,7 @@ await client.tracking.sessions.terminateV1({
|
|
|
14398
14348
|
<dl>
|
|
14399
14349
|
<dd>
|
|
14400
14350
|
|
|
14401
|
-
|
|
14351
|
+
Fetches current OOOI timestamps from FlightAware for each fa_flight_id on the session and updates flight_status_by_fa_flight_id. Use when the webhook may have left state out of sync. | authz: min_org_role=operator | () -> (bool)
|
|
14402
14352
|
|
|
14403
14353
|
</dd>
|
|
14404
14354
|
</dl>
|
|
@@ -14414,7 +14364,7 @@ Deletes a terminated session and all its associated timeseries data points. Only
|
|
|
14414
14364
|
<dd>
|
|
14415
14365
|
|
|
14416
14366
|
```typescript
|
|
14417
|
-
await client.tracking.sessions.
|
|
14367
|
+
await client.tracking.sessions.syncFlightStatusV1({
|
|
14418
14368
|
session_id: "session_id",
|
|
14419
14369
|
});
|
|
14420
14370
|
```
|
|
@@ -14432,7 +14382,7 @@ await client.tracking.sessions.deleteV1({
|
|
|
14432
14382
|
<dl>
|
|
14433
14383
|
<dd>
|
|
14434
14384
|
|
|
14435
|
-
**request:** `Chrt.tracking.
|
|
14385
|
+
**request:** `Chrt.tracking.SessionsSyncFlightStatusV1Request`
|
|
14436
14386
|
|
|
14437
14387
|
</dd>
|
|
14438
14388
|
</dl>
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
/**
|
|
5
|
-
* @example
|
|
6
|
-
* {
|
|
7
|
-
* device_id: "device_id",
|
|
8
|
-
* device_mac_address: "device_mac_address"
|
|
9
|
-
* }
|
|
10
|
-
*/
|
|
11
|
-
export interface DevicesDeleteV1Request {
|
|
12
|
-
device_id?: string | null;
|
|
13
|
-
device_mac_address?: string | null;
|
|
14
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
/**
|
|
5
|
-
* @example
|
|
6
|
-
* {
|
|
7
|
-
* device_mac_address: "device_mac_address",
|
|
8
|
-
* cargo_id: "cargo_id"
|
|
9
|
-
* }
|
|
10
|
-
*/
|
|
11
|
-
export interface DevicesLinkToCargoV1Request {
|
|
12
|
-
device_mac_address: string;
|
|
13
|
-
cargo_id: string;
|
|
14
|
-
}
|