@chrt-inc/typescript-sdk 1.754.0 → 1.760.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/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.d.ts +0 -13
- package/dist/cjs/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.js +0 -59
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.d.ts +102 -1
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.js +439 -1
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriverSelfReportedHoursAndMileageClientCreate1.d.ts +18 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriverSelfReportedHoursAndMileageClientUpdate1.d.ts +13 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriversListSelfReportedHoursAndMileageV1Request.d.ts +21 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriversListSelfReportedHoursAndMileageV1Request.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriversOrgListSelfReportedHoursAndMileageV1Request.d.ts +25 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriversOrgListSelfReportedHoursAndMileageV1Request.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/index.d.ts +4 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/index.js +1 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/types/DriversOrgListSelfReportedHoursAndMileageV1RequestSortBy.d.ts +8 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/types/DriversOrgListSelfReportedHoursAndMileageV1RequestSortBy.js +10 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/types/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/flights/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/flights/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/index.d.ts +2 -1
- package/dist/cjs/api/resources/shipping/resources/index.js +3 -2
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/Client.js +2 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/client/Client.js +2 -1
- package/dist/cjs/api/resources/tracking/resources/driver/client/Client.d.ts +26 -0
- package/dist/cjs/api/resources/tracking/resources/driver/client/Client.js +75 -0
- package/dist/cjs/api/resources/tracking/resources/driver/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/tracking/resources/driver/client/index.js +15 -0
- package/dist/cjs/api/resources/tracking/resources/driver/client/requests/DriverByDriverDataPointClientCreate1.d.ts +26 -0
- package/dist/cjs/api/resources/tracking/resources/driver/client/requests/DriverByDriverDataPointClientCreate1.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/driver/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/tracking/resources/driver/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/tracking/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/tracking/resources/index.js +1 -0
- package/dist/cjs/api/types/CargoAiTrackAndTraceUpdate1.d.ts +0 -4
- package/dist/cjs/api/types/CargoAiTrackAndTraceUpdateSourceEnum.d.ts +1 -5
- package/dist/cjs/api/types/CargoAiTrackAndTraceUpdateSourceEnum.js +0 -5
- package/dist/cjs/api/types/DriverSelfReportedHoursAndMileage1.d.ts +17 -0
- package/dist/cjs/api/types/DriverSelfReportedHoursAndMileage1.js +5 -0
- package/dist/cjs/api/types/DriverSelfReportedHoursAndMileageListRes.d.ts +8 -0
- package/dist/cjs/api/types/DriverSelfReportedHoursAndMileageListRes.js +5 -0
- package/dist/cjs/api/types/DriverStatsRes.d.ts +8 -3
- package/dist/cjs/api/types/DriverUpdateRes.d.ts +1 -0
- package/dist/cjs/api/types/FlightLeg1.d.ts +1 -1
- package/dist/cjs/api/types/FlightLegClientCreate1.d.ts +1 -1
- package/dist/cjs/api/types/{FlightTrackPosition.d.ts → FlightTrackPosition1.d.ts} +1 -4
- package/dist/cjs/api/types/FlightTrackPosition1.js +5 -0
- package/dist/cjs/api/types/FlightTrackRes.d.ts +2 -2
- package/dist/{esm/api/types/FlightTrackWaypoint.d.mts → cjs/api/types/FlightTrackWaypoint1.d.ts} +1 -4
- package/dist/cjs/api/types/FlightTrackWaypoint1.js +5 -0
- package/dist/cjs/api/types/index.d.ts +4 -2
- package/dist/cjs/api/types/index.js +4 -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/integrations/resources/cargoaiTrackAndTrace/client/Client.d.mts +0 -13
- package/dist/esm/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.mjs +0 -59
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.d.mts +102 -1
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.mjs +439 -1
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriverSelfReportedHoursAndMileageClientCreate1.d.mts +18 -0
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriverSelfReportedHoursAndMileageClientUpdate1.d.mts +13 -0
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriversListSelfReportedHoursAndMileageV1Request.d.mts +21 -0
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriversListSelfReportedHoursAndMileageV1Request.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriversOrgListSelfReportedHoursAndMileageV1Request.d.mts +25 -0
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriversOrgListSelfReportedHoursAndMileageV1Request.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/index.d.mts +4 -0
- package/dist/esm/api/resources/shipping/resources/drivers/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/types/DriversOrgListSelfReportedHoursAndMileageV1RequestSortBy.d.mts +8 -0
- package/dist/esm/api/resources/shipping/resources/drivers/types/DriversOrgListSelfReportedHoursAndMileageV1RequestSortBy.mjs +7 -0
- package/dist/esm/api/resources/shipping/resources/drivers/types/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/types/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/flights/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/flights/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/index.d.mts +2 -1
- package/dist/esm/api/resources/shipping/resources/index.mjs +2 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/Client.mjs +2 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/client/Client.mjs +2 -1
- package/dist/esm/api/resources/tracking/resources/driver/client/Client.d.mts +26 -0
- package/dist/esm/api/resources/tracking/resources/driver/client/Client.mjs +75 -0
- package/dist/esm/api/resources/tracking/resources/driver/client/index.d.mts +1 -0
- package/dist/esm/api/resources/tracking/resources/driver/client/index.mjs +1 -1
- package/dist/esm/api/resources/tracking/resources/driver/client/requests/DriverByDriverDataPointClientCreate1.d.mts +26 -0
- package/dist/esm/api/resources/tracking/resources/driver/client/requests/DriverByDriverDataPointClientCreate1.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/driver/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/tracking/resources/driver/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/tracking/resources/index.mjs +1 -0
- package/dist/esm/api/types/CargoAiTrackAndTraceUpdate1.d.mts +0 -4
- package/dist/esm/api/types/CargoAiTrackAndTraceUpdateSourceEnum.d.mts +1 -5
- package/dist/esm/api/types/CargoAiTrackAndTraceUpdateSourceEnum.mjs +1 -4
- package/dist/esm/api/types/DriverSelfReportedHoursAndMileage1.d.mts +17 -0
- package/dist/esm/api/types/DriverSelfReportedHoursAndMileage1.mjs +4 -0
- package/dist/esm/api/types/DriverSelfReportedHoursAndMileageListRes.d.mts +8 -0
- package/dist/esm/api/types/DriverSelfReportedHoursAndMileageListRes.mjs +4 -0
- package/dist/esm/api/types/DriverStatsRes.d.mts +8 -3
- package/dist/esm/api/types/DriverUpdateRes.d.mts +1 -0
- package/dist/esm/api/types/FlightLeg1.d.mts +1 -1
- package/dist/esm/api/types/FlightLegClientCreate1.d.mts +1 -1
- package/dist/esm/api/types/{FlightTrackPosition.d.mts → FlightTrackPosition1.d.mts} +1 -4
- package/dist/esm/api/types/FlightTrackPosition1.mjs +4 -0
- package/dist/esm/api/types/FlightTrackRes.d.mts +2 -2
- package/dist/{cjs/api/types/FlightTrackWaypoint.d.ts → esm/api/types/FlightTrackWaypoint1.d.mts} +1 -4
- package/dist/esm/api/types/FlightTrackWaypoint1.mjs +4 -0
- package/dist/esm/api/types/index.d.mts +4 -2
- package/dist/esm/api/types/index.mjs +4 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +604 -151
- /package/dist/cjs/api/{types/FlightTrackPosition.js → resources/shipping/resources/drivers/client/requests/DriverSelfReportedHoursAndMileageClientCreate1.js} +0 -0
- /package/dist/cjs/api/{types/FlightTrackWaypoint.js → resources/shipping/resources/drivers/client/requests/DriverSelfReportedHoursAndMileageClientUpdate1.js} +0 -0
- /package/dist/esm/api/{types/FlightTrackPosition.mjs → resources/shipping/resources/drivers/client/requests/DriverSelfReportedHoursAndMileageClientCreate1.mjs} +0 -0
- /package/dist/esm/api/{types/FlightTrackWaypoint.mjs → resources/shipping/resources/drivers/client/requests/DriverSelfReportedHoursAndMileageClientUpdate1.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -6804,69 +6804,6 @@ await client.integrations.cargoaiTrackAndTrace.subscribeV1({
|
|
|
6804
6804
|
</dl>
|
|
6805
6805
|
</details>
|
|
6806
6806
|
|
|
6807
|
-
<details><summary><code>client.integrations.cargoaiTrackAndTrace.<a href="/src/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.ts">refreshV1</a>(awb) -> Chrt.CargoAiTrackAndTraceUpdate1</code></summary>
|
|
6808
|
-
<dl>
|
|
6809
|
-
<dd>
|
|
6810
|
-
|
|
6811
|
-
#### 📝 Description
|
|
6812
|
-
|
|
6813
|
-
<dl>
|
|
6814
|
-
<dd>
|
|
6815
|
-
|
|
6816
|
-
<dl>
|
|
6817
|
-
<dd>
|
|
6818
|
-
|
|
6819
|
-
Polls CargoAi for the current tracking snapshot of an AWB and stores it as a new update (source=poll). No subscription required — any order participant can poll on demand. | authz: order participant | () -> (CargoAiTrackAndTraceUpdate1)
|
|
6820
|
-
|
|
6821
|
-
</dd>
|
|
6822
|
-
</dl>
|
|
6823
|
-
</dd>
|
|
6824
|
-
</dl>
|
|
6825
|
-
|
|
6826
|
-
#### 🔌 Usage
|
|
6827
|
-
|
|
6828
|
-
<dl>
|
|
6829
|
-
<dd>
|
|
6830
|
-
|
|
6831
|
-
<dl>
|
|
6832
|
-
<dd>
|
|
6833
|
-
|
|
6834
|
-
```typescript
|
|
6835
|
-
await client.integrations.cargoaiTrackAndTrace.refreshV1("awb");
|
|
6836
|
-
```
|
|
6837
|
-
|
|
6838
|
-
</dd>
|
|
6839
|
-
</dl>
|
|
6840
|
-
</dd>
|
|
6841
|
-
</dl>
|
|
6842
|
-
|
|
6843
|
-
#### ⚙️ Parameters
|
|
6844
|
-
|
|
6845
|
-
<dl>
|
|
6846
|
-
<dd>
|
|
6847
|
-
|
|
6848
|
-
<dl>
|
|
6849
|
-
<dd>
|
|
6850
|
-
|
|
6851
|
-
**awb:** `string`
|
|
6852
|
-
|
|
6853
|
-
</dd>
|
|
6854
|
-
</dl>
|
|
6855
|
-
|
|
6856
|
-
<dl>
|
|
6857
|
-
<dd>
|
|
6858
|
-
|
|
6859
|
-
**requestOptions:** `CargoaiTrackAndTrace.RequestOptions`
|
|
6860
|
-
|
|
6861
|
-
</dd>
|
|
6862
|
-
</dl>
|
|
6863
|
-
</dd>
|
|
6864
|
-
</dl>
|
|
6865
|
-
|
|
6866
|
-
</dd>
|
|
6867
|
-
</dl>
|
|
6868
|
-
</details>
|
|
6869
|
-
|
|
6870
6807
|
## Integrations WebcargoBookings
|
|
6871
6808
|
|
|
6872
6809
|
<details><summary><code>client.integrations.webcargoBookings.<a href="/src/api/resources/integrations/resources/webcargoBookings/client/Client.ts">syncV1</a>(taskGroupId) -> Chrt.WebcargoBookingRecord1</code></summary>
|
|
@@ -16008,7 +15945,394 @@ await client.orgs.complianceDocuments.s3Object.getS3ObjectMetadataV1("org_compli
|
|
|
16008
15945
|
</dl>
|
|
16009
15946
|
</details>
|
|
16010
15947
|
|
|
16011
|
-
<details><summary><code>client.orgs.complianceDocuments.s3Object.<a href="/src/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.ts">getV1</a>(orgComplianceDocumentS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
|
|
15948
|
+
<details><summary><code>client.orgs.complianceDocuments.s3Object.<a href="/src/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.ts">getV1</a>(orgComplianceDocumentS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
|
|
15949
|
+
<dl>
|
|
15950
|
+
<dd>
|
|
15951
|
+
|
|
15952
|
+
#### 📝 Description
|
|
15953
|
+
|
|
15954
|
+
<dl>
|
|
15955
|
+
<dd>
|
|
15956
|
+
|
|
15957
|
+
<dl>
|
|
15958
|
+
<dd>
|
|
15959
|
+
|
|
15960
|
+
Streams an organization compliance document S3 object file from storage. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (binary)
|
|
15961
|
+
|
|
15962
|
+
</dd>
|
|
15963
|
+
</dl>
|
|
15964
|
+
</dd>
|
|
15965
|
+
</dl>
|
|
15966
|
+
|
|
15967
|
+
#### 🔌 Usage
|
|
15968
|
+
|
|
15969
|
+
<dl>
|
|
15970
|
+
<dd>
|
|
15971
|
+
|
|
15972
|
+
<dl>
|
|
15973
|
+
<dd>
|
|
15974
|
+
|
|
15975
|
+
```typescript
|
|
15976
|
+
await client.orgs.complianceDocuments.s3Object.getV1("org_compliance_document_s3_object_metadata_id");
|
|
15977
|
+
```
|
|
15978
|
+
|
|
15979
|
+
</dd>
|
|
15980
|
+
</dl>
|
|
15981
|
+
</dd>
|
|
15982
|
+
</dl>
|
|
15983
|
+
|
|
15984
|
+
#### ⚙️ Parameters
|
|
15985
|
+
|
|
15986
|
+
<dl>
|
|
15987
|
+
<dd>
|
|
15988
|
+
|
|
15989
|
+
<dl>
|
|
15990
|
+
<dd>
|
|
15991
|
+
|
|
15992
|
+
**orgComplianceDocumentS3ObjectMetadataId:** `string`
|
|
15993
|
+
|
|
15994
|
+
</dd>
|
|
15995
|
+
</dl>
|
|
15996
|
+
|
|
15997
|
+
<dl>
|
|
15998
|
+
<dd>
|
|
15999
|
+
|
|
16000
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
16001
|
+
|
|
16002
|
+
</dd>
|
|
16003
|
+
</dl>
|
|
16004
|
+
</dd>
|
|
16005
|
+
</dl>
|
|
16006
|
+
|
|
16007
|
+
</dd>
|
|
16008
|
+
</dl>
|
|
16009
|
+
</details>
|
|
16010
|
+
|
|
16011
|
+
<details><summary><code>client.orgs.complianceDocuments.s3Object.<a href="/src/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.ts">addV1</a>(orgComplianceDocumentId, { ...params }) -> boolean</code></summary>
|
|
16012
|
+
<dl>
|
|
16013
|
+
<dd>
|
|
16014
|
+
|
|
16015
|
+
#### 📝 Description
|
|
16016
|
+
|
|
16017
|
+
<dl>
|
|
16018
|
+
<dd>
|
|
16019
|
+
|
|
16020
|
+
<dl>
|
|
16021
|
+
<dd>
|
|
16022
|
+
|
|
16023
|
+
Uploads a file to an organization compliance document. Automatic blurhash generation for images. | authz: allowed_org_types=[provider], min_org_role=administrator | (UploadFile) -> (bool)
|
|
16024
|
+
|
|
16025
|
+
</dd>
|
|
16026
|
+
</dl>
|
|
16027
|
+
</dd>
|
|
16028
|
+
</dl>
|
|
16029
|
+
|
|
16030
|
+
#### 🔌 Usage
|
|
16031
|
+
|
|
16032
|
+
<dl>
|
|
16033
|
+
<dd>
|
|
16034
|
+
|
|
16035
|
+
<dl>
|
|
16036
|
+
<dd>
|
|
16037
|
+
|
|
16038
|
+
```typescript
|
|
16039
|
+
await client.orgs.complianceDocuments.s3Object.addV1("org_compliance_document_id", {
|
|
16040
|
+
file: fs.createReadStream("/path/to/your/file"),
|
|
16041
|
+
});
|
|
16042
|
+
```
|
|
16043
|
+
|
|
16044
|
+
</dd>
|
|
16045
|
+
</dl>
|
|
16046
|
+
</dd>
|
|
16047
|
+
</dl>
|
|
16048
|
+
|
|
16049
|
+
#### ⚙️ Parameters
|
|
16050
|
+
|
|
16051
|
+
<dl>
|
|
16052
|
+
<dd>
|
|
16053
|
+
|
|
16054
|
+
<dl>
|
|
16055
|
+
<dd>
|
|
16056
|
+
|
|
16057
|
+
**orgComplianceDocumentId:** `string`
|
|
16058
|
+
|
|
16059
|
+
</dd>
|
|
16060
|
+
</dl>
|
|
16061
|
+
|
|
16062
|
+
<dl>
|
|
16063
|
+
<dd>
|
|
16064
|
+
|
|
16065
|
+
**request:** `Chrt.orgs.complianceDocuments.BodyPostOrgComplianceDocumentsS3ObjectAddV1OrgsComplianceDocumentsS3ObjectAddV1OrgComplianceDocumentIdPost`
|
|
16066
|
+
|
|
16067
|
+
</dd>
|
|
16068
|
+
</dl>
|
|
16069
|
+
|
|
16070
|
+
<dl>
|
|
16071
|
+
<dd>
|
|
16072
|
+
|
|
16073
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
16074
|
+
|
|
16075
|
+
</dd>
|
|
16076
|
+
</dl>
|
|
16077
|
+
</dd>
|
|
16078
|
+
</dl>
|
|
16079
|
+
|
|
16080
|
+
</dd>
|
|
16081
|
+
</dl>
|
|
16082
|
+
</details>
|
|
16083
|
+
|
|
16084
|
+
<details><summary><code>client.orgs.complianceDocuments.s3Object.<a href="/src/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.ts">deleteV1</a>(orgComplianceDocumentS3ObjectMetadataId) -> boolean</code></summary>
|
|
16085
|
+
<dl>
|
|
16086
|
+
<dd>
|
|
16087
|
+
|
|
16088
|
+
#### 📝 Description
|
|
16089
|
+
|
|
16090
|
+
<dl>
|
|
16091
|
+
<dd>
|
|
16092
|
+
|
|
16093
|
+
<dl>
|
|
16094
|
+
<dd>
|
|
16095
|
+
|
|
16096
|
+
Deletes an organization compliance document S3 object and metadata. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (bool)
|
|
16097
|
+
|
|
16098
|
+
</dd>
|
|
16099
|
+
</dl>
|
|
16100
|
+
</dd>
|
|
16101
|
+
</dl>
|
|
16102
|
+
|
|
16103
|
+
#### 🔌 Usage
|
|
16104
|
+
|
|
16105
|
+
<dl>
|
|
16106
|
+
<dd>
|
|
16107
|
+
|
|
16108
|
+
<dl>
|
|
16109
|
+
<dd>
|
|
16110
|
+
|
|
16111
|
+
```typescript
|
|
16112
|
+
await client.orgs.complianceDocuments.s3Object.deleteV1("org_compliance_document_s3_object_metadata_id");
|
|
16113
|
+
```
|
|
16114
|
+
|
|
16115
|
+
</dd>
|
|
16116
|
+
</dl>
|
|
16117
|
+
</dd>
|
|
16118
|
+
</dl>
|
|
16119
|
+
|
|
16120
|
+
#### ⚙️ Parameters
|
|
16121
|
+
|
|
16122
|
+
<dl>
|
|
16123
|
+
<dd>
|
|
16124
|
+
|
|
16125
|
+
<dl>
|
|
16126
|
+
<dd>
|
|
16127
|
+
|
|
16128
|
+
**orgComplianceDocumentS3ObjectMetadataId:** `string`
|
|
16129
|
+
|
|
16130
|
+
</dd>
|
|
16131
|
+
</dl>
|
|
16132
|
+
|
|
16133
|
+
<dl>
|
|
16134
|
+
<dd>
|
|
16135
|
+
|
|
16136
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
16137
|
+
|
|
16138
|
+
</dd>
|
|
16139
|
+
</dl>
|
|
16140
|
+
</dd>
|
|
16141
|
+
</dl>
|
|
16142
|
+
|
|
16143
|
+
</dd>
|
|
16144
|
+
</dl>
|
|
16145
|
+
</details>
|
|
16146
|
+
|
|
16147
|
+
## Orgs OrgInfoForConnections Shipper
|
|
16148
|
+
|
|
16149
|
+
<details><summary><code>client.orgs.orgInfoForConnections.shipper.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/shipper/client/Client.ts">getV1</a>() -> Chrt.ShipperOrgInfoForConnections1</code></summary>
|
|
16150
|
+
<dl>
|
|
16151
|
+
<dd>
|
|
16152
|
+
|
|
16153
|
+
#### 📝 Description
|
|
16154
|
+
|
|
16155
|
+
<dl>
|
|
16156
|
+
<dd>
|
|
16157
|
+
|
|
16158
|
+
<dl>
|
|
16159
|
+
<dd>
|
|
16160
|
+
|
|
16161
|
+
Retrieves shipper organization connection information for the caller's organization. | () -> (ShipperOrgInfoForConnections1)
|
|
16162
|
+
|
|
16163
|
+
</dd>
|
|
16164
|
+
</dl>
|
|
16165
|
+
</dd>
|
|
16166
|
+
</dl>
|
|
16167
|
+
|
|
16168
|
+
#### 🔌 Usage
|
|
16169
|
+
|
|
16170
|
+
<dl>
|
|
16171
|
+
<dd>
|
|
16172
|
+
|
|
16173
|
+
<dl>
|
|
16174
|
+
<dd>
|
|
16175
|
+
|
|
16176
|
+
```typescript
|
|
16177
|
+
await client.orgs.orgInfoForConnections.shipper.getV1();
|
|
16178
|
+
```
|
|
16179
|
+
|
|
16180
|
+
</dd>
|
|
16181
|
+
</dl>
|
|
16182
|
+
</dd>
|
|
16183
|
+
</dl>
|
|
16184
|
+
|
|
16185
|
+
#### ⚙️ Parameters
|
|
16186
|
+
|
|
16187
|
+
<dl>
|
|
16188
|
+
<dd>
|
|
16189
|
+
|
|
16190
|
+
<dl>
|
|
16191
|
+
<dd>
|
|
16192
|
+
|
|
16193
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
16194
|
+
|
|
16195
|
+
</dd>
|
|
16196
|
+
</dl>
|
|
16197
|
+
</dd>
|
|
16198
|
+
</dl>
|
|
16199
|
+
|
|
16200
|
+
</dd>
|
|
16201
|
+
</dl>
|
|
16202
|
+
</details>
|
|
16203
|
+
|
|
16204
|
+
<details><summary><code>client.orgs.orgInfoForConnections.shipper.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/shipper/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
16205
|
+
<dl>
|
|
16206
|
+
<dd>
|
|
16207
|
+
|
|
16208
|
+
#### 📝 Description
|
|
16209
|
+
|
|
16210
|
+
<dl>
|
|
16211
|
+
<dd>
|
|
16212
|
+
|
|
16213
|
+
<dl>
|
|
16214
|
+
<dd>
|
|
16215
|
+
|
|
16216
|
+
Creates shipper organization connection information. Fails if already exists. | (ShipperOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
|
|
16217
|
+
|
|
16218
|
+
</dd>
|
|
16219
|
+
</dl>
|
|
16220
|
+
</dd>
|
|
16221
|
+
</dl>
|
|
16222
|
+
|
|
16223
|
+
#### 🔌 Usage
|
|
16224
|
+
|
|
16225
|
+
<dl>
|
|
16226
|
+
<dd>
|
|
16227
|
+
|
|
16228
|
+
<dl>
|
|
16229
|
+
<dd>
|
|
16230
|
+
|
|
16231
|
+
```typescript
|
|
16232
|
+
await client.orgs.orgInfoForConnections.shipper.createV1({
|
|
16233
|
+
schema_version: 1,
|
|
16234
|
+
email_address_primary: "email_address_primary",
|
|
16235
|
+
});
|
|
16236
|
+
```
|
|
16237
|
+
|
|
16238
|
+
</dd>
|
|
16239
|
+
</dl>
|
|
16240
|
+
</dd>
|
|
16241
|
+
</dl>
|
|
16242
|
+
|
|
16243
|
+
#### ⚙️ Parameters
|
|
16244
|
+
|
|
16245
|
+
<dl>
|
|
16246
|
+
<dd>
|
|
16247
|
+
|
|
16248
|
+
<dl>
|
|
16249
|
+
<dd>
|
|
16250
|
+
|
|
16251
|
+
**request:** `Chrt.orgs.orgInfoForConnections.ShipperOrgInfoForConnectionsClientCreate1`
|
|
16252
|
+
|
|
16253
|
+
</dd>
|
|
16254
|
+
</dl>
|
|
16255
|
+
|
|
16256
|
+
<dl>
|
|
16257
|
+
<dd>
|
|
16258
|
+
|
|
16259
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
16260
|
+
|
|
16261
|
+
</dd>
|
|
16262
|
+
</dl>
|
|
16263
|
+
</dd>
|
|
16264
|
+
</dl>
|
|
16265
|
+
|
|
16266
|
+
</dd>
|
|
16267
|
+
</dl>
|
|
16268
|
+
</details>
|
|
16269
|
+
|
|
16270
|
+
<details><summary><code>client.orgs.orgInfoForConnections.shipper.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/shipper/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
16271
|
+
<dl>
|
|
16272
|
+
<dd>
|
|
16273
|
+
|
|
16274
|
+
#### 📝 Description
|
|
16275
|
+
|
|
16276
|
+
<dl>
|
|
16277
|
+
<dd>
|
|
16278
|
+
|
|
16279
|
+
<dl>
|
|
16280
|
+
<dd>
|
|
16281
|
+
|
|
16282
|
+
Updates existing shipper organization connection information. | (ShipperOrgInfoForConnectionsClientUpdate1) -> (bool)
|
|
16283
|
+
|
|
16284
|
+
</dd>
|
|
16285
|
+
</dl>
|
|
16286
|
+
</dd>
|
|
16287
|
+
</dl>
|
|
16288
|
+
|
|
16289
|
+
#### 🔌 Usage
|
|
16290
|
+
|
|
16291
|
+
<dl>
|
|
16292
|
+
<dd>
|
|
16293
|
+
|
|
16294
|
+
<dl>
|
|
16295
|
+
<dd>
|
|
16296
|
+
|
|
16297
|
+
```typescript
|
|
16298
|
+
await client.orgs.orgInfoForConnections.shipper.updateV1();
|
|
16299
|
+
```
|
|
16300
|
+
|
|
16301
|
+
</dd>
|
|
16302
|
+
</dl>
|
|
16303
|
+
</dd>
|
|
16304
|
+
</dl>
|
|
16305
|
+
|
|
16306
|
+
#### ⚙️ Parameters
|
|
16307
|
+
|
|
16308
|
+
<dl>
|
|
16309
|
+
<dd>
|
|
16310
|
+
|
|
16311
|
+
<dl>
|
|
16312
|
+
<dd>
|
|
16313
|
+
|
|
16314
|
+
**request:** `Chrt.orgs.orgInfoForConnections.ShipperOrgInfoForConnectionsClientUpdate1`
|
|
16315
|
+
|
|
16316
|
+
</dd>
|
|
16317
|
+
</dl>
|
|
16318
|
+
|
|
16319
|
+
<dl>
|
|
16320
|
+
<dd>
|
|
16321
|
+
|
|
16322
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
16323
|
+
|
|
16324
|
+
</dd>
|
|
16325
|
+
</dl>
|
|
16326
|
+
</dd>
|
|
16327
|
+
</dl>
|
|
16328
|
+
|
|
16329
|
+
</dd>
|
|
16330
|
+
</dl>
|
|
16331
|
+
</details>
|
|
16332
|
+
|
|
16333
|
+
## Orgs OrgInfoForConnections Provider
|
|
16334
|
+
|
|
16335
|
+
<details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">getV1</a>() -> Chrt.ProviderOrgInfoForConnections1</code></summary>
|
|
16012
16336
|
<dl>
|
|
16013
16337
|
<dd>
|
|
16014
16338
|
|
|
@@ -16020,7 +16344,7 @@ await client.orgs.complianceDocuments.s3Object.getS3ObjectMetadataV1("org_compli
|
|
|
16020
16344
|
<dl>
|
|
16021
16345
|
<dd>
|
|
16022
16346
|
|
|
16023
|
-
|
|
16347
|
+
Retrieves provider organization connection information for the caller's organization. | () -> (ProviderOrgInfoForConnections1)
|
|
16024
16348
|
|
|
16025
16349
|
</dd>
|
|
16026
16350
|
</dl>
|
|
@@ -16036,7 +16360,7 @@ Streams an organization compliance document S3 object file from storage. | authz
|
|
|
16036
16360
|
<dd>
|
|
16037
16361
|
|
|
16038
16362
|
```typescript
|
|
16039
|
-
await client.orgs.
|
|
16363
|
+
await client.orgs.orgInfoForConnections.provider.getV1();
|
|
16040
16364
|
```
|
|
16041
16365
|
|
|
16042
16366
|
</dd>
|
|
@@ -16052,15 +16376,7 @@ await client.orgs.complianceDocuments.s3Object.getV1("org_compliance_document_s3
|
|
|
16052
16376
|
<dl>
|
|
16053
16377
|
<dd>
|
|
16054
16378
|
|
|
16055
|
-
**
|
|
16056
|
-
|
|
16057
|
-
</dd>
|
|
16058
|
-
</dl>
|
|
16059
|
-
|
|
16060
|
-
<dl>
|
|
16061
|
-
<dd>
|
|
16062
|
-
|
|
16063
|
-
**requestOptions:** `S3Object.RequestOptions`
|
|
16379
|
+
**requestOptions:** `Provider.RequestOptions`
|
|
16064
16380
|
|
|
16065
16381
|
</dd>
|
|
16066
16382
|
</dl>
|
|
@@ -16071,7 +16387,7 @@ await client.orgs.complianceDocuments.s3Object.getV1("org_compliance_document_s3
|
|
|
16071
16387
|
</dl>
|
|
16072
16388
|
</details>
|
|
16073
16389
|
|
|
16074
|
-
<details><summary><code>client.orgs.
|
|
16390
|
+
<details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">listV1</a>() -> Chrt.ProviderOrgInfoForConnections1[]</code></summary>
|
|
16075
16391
|
<dl>
|
|
16076
16392
|
<dd>
|
|
16077
16393
|
|
|
@@ -16083,7 +16399,7 @@ await client.orgs.complianceDocuments.s3Object.getV1("org_compliance_document_s3
|
|
|
16083
16399
|
<dl>
|
|
16084
16400
|
<dd>
|
|
16085
16401
|
|
|
16086
|
-
|
|
16402
|
+
Retrieves list of provider org info documents for providers connected to the caller. Shippers see providers via shipper_provider_connections; providers see other providers via provider_provider_connections (in either direction). | () -> (list[ProviderOrgInfoForConnections1])
|
|
16087
16403
|
|
|
16088
16404
|
</dd>
|
|
16089
16405
|
</dl>
|
|
@@ -16099,9 +16415,7 @@ Uploads a file to an organization compliance document. Automatic blurhash genera
|
|
|
16099
16415
|
<dd>
|
|
16100
16416
|
|
|
16101
16417
|
```typescript
|
|
16102
|
-
await client.orgs.
|
|
16103
|
-
file: fs.createReadStream("/path/to/your/file"),
|
|
16104
|
-
});
|
|
16418
|
+
await client.orgs.orgInfoForConnections.provider.listV1();
|
|
16105
16419
|
```
|
|
16106
16420
|
|
|
16107
16421
|
</dd>
|
|
@@ -16117,23 +16431,7 @@ await client.orgs.complianceDocuments.s3Object.addV1("org_compliance_document_id
|
|
|
16117
16431
|
<dl>
|
|
16118
16432
|
<dd>
|
|
16119
16433
|
|
|
16120
|
-
**
|
|
16121
|
-
|
|
16122
|
-
</dd>
|
|
16123
|
-
</dl>
|
|
16124
|
-
|
|
16125
|
-
<dl>
|
|
16126
|
-
<dd>
|
|
16127
|
-
|
|
16128
|
-
**request:** `Chrt.orgs.complianceDocuments.BodyPostOrgComplianceDocumentsS3ObjectAddV1OrgsComplianceDocumentsS3ObjectAddV1OrgComplianceDocumentIdPost`
|
|
16129
|
-
|
|
16130
|
-
</dd>
|
|
16131
|
-
</dl>
|
|
16132
|
-
|
|
16133
|
-
<dl>
|
|
16134
|
-
<dd>
|
|
16135
|
-
|
|
16136
|
-
**requestOptions:** `S3Object.RequestOptions`
|
|
16434
|
+
**requestOptions:** `Provider.RequestOptions`
|
|
16137
16435
|
|
|
16138
16436
|
</dd>
|
|
16139
16437
|
</dl>
|
|
@@ -16144,7 +16442,7 @@ await client.orgs.complianceDocuments.s3Object.addV1("org_compliance_document_id
|
|
|
16144
16442
|
</dl>
|
|
16145
16443
|
</details>
|
|
16146
16444
|
|
|
16147
|
-
<details><summary><code>client.orgs.
|
|
16445
|
+
<details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
16148
16446
|
<dl>
|
|
16149
16447
|
<dd>
|
|
16150
16448
|
|
|
@@ -16156,7 +16454,7 @@ await client.orgs.complianceDocuments.s3Object.addV1("org_compliance_document_id
|
|
|
16156
16454
|
<dl>
|
|
16157
16455
|
<dd>
|
|
16158
16456
|
|
|
16159
|
-
|
|
16457
|
+
Creates provider organization connection information. Fails if already exists. | (ProviderOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
|
|
16160
16458
|
|
|
16161
16459
|
</dd>
|
|
16162
16460
|
</dl>
|
|
@@ -16172,7 +16470,10 @@ Deletes an organization compliance document S3 object and metadata. | authz: all
|
|
|
16172
16470
|
<dd>
|
|
16173
16471
|
|
|
16174
16472
|
```typescript
|
|
16175
|
-
await client.orgs.
|
|
16473
|
+
await client.orgs.orgInfoForConnections.provider.createV1({
|
|
16474
|
+
schema_version: 1,
|
|
16475
|
+
email_address_primary: "email_address_primary",
|
|
16476
|
+
});
|
|
16176
16477
|
```
|
|
16177
16478
|
|
|
16178
16479
|
</dd>
|
|
@@ -16188,7 +16489,7 @@ await client.orgs.complianceDocuments.s3Object.deleteV1("org_compliance_document
|
|
|
16188
16489
|
<dl>
|
|
16189
16490
|
<dd>
|
|
16190
16491
|
|
|
16191
|
-
**
|
|
16492
|
+
**request:** `Chrt.orgs.orgInfoForConnections.ProviderOrgInfoForConnectionsClientCreate1`
|
|
16192
16493
|
|
|
16193
16494
|
</dd>
|
|
16194
16495
|
</dl>
|
|
@@ -16196,7 +16497,7 @@ await client.orgs.complianceDocuments.s3Object.deleteV1("org_compliance_document
|
|
|
16196
16497
|
<dl>
|
|
16197
16498
|
<dd>
|
|
16198
16499
|
|
|
16199
|
-
**requestOptions:** `
|
|
16500
|
+
**requestOptions:** `Provider.RequestOptions`
|
|
16200
16501
|
|
|
16201
16502
|
</dd>
|
|
16202
16503
|
</dl>
|
|
@@ -16207,9 +16508,7 @@ await client.orgs.complianceDocuments.s3Object.deleteV1("org_compliance_document
|
|
|
16207
16508
|
</dl>
|
|
16208
16509
|
</details>
|
|
16209
16510
|
|
|
16210
|
-
|
|
16211
|
-
|
|
16212
|
-
<details><summary><code>client.orgs.orgInfoForConnections.shipper.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/shipper/client/Client.ts">getV1</a>() -> Chrt.ShipperOrgInfoForConnections1</code></summary>
|
|
16511
|
+
<details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
16213
16512
|
<dl>
|
|
16214
16513
|
<dd>
|
|
16215
16514
|
|
|
@@ -16221,7 +16520,7 @@ await client.orgs.complianceDocuments.s3Object.deleteV1("org_compliance_document
|
|
|
16221
16520
|
<dl>
|
|
16222
16521
|
<dd>
|
|
16223
16522
|
|
|
16224
|
-
|
|
16523
|
+
Updates existing provider organization connection information. | (ProviderOrgInfoForConnectionsClientUpdate1) -> (bool)
|
|
16225
16524
|
|
|
16226
16525
|
</dd>
|
|
16227
16526
|
</dl>
|
|
@@ -16237,7 +16536,7 @@ Retrieves shipper organization connection information for the caller's organizat
|
|
|
16237
16536
|
<dd>
|
|
16238
16537
|
|
|
16239
16538
|
```typescript
|
|
16240
|
-
await client.orgs.orgInfoForConnections.
|
|
16539
|
+
await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
16241
16540
|
```
|
|
16242
16541
|
|
|
16243
16542
|
</dd>
|
|
@@ -16253,7 +16552,15 @@ await client.orgs.orgInfoForConnections.shipper.getV1();
|
|
|
16253
16552
|
<dl>
|
|
16254
16553
|
<dd>
|
|
16255
16554
|
|
|
16256
|
-
**
|
|
16555
|
+
**request:** `Chrt.orgs.orgInfoForConnections.ProviderOrgInfoForConnectionsClientUpdate1`
|
|
16556
|
+
|
|
16557
|
+
</dd>
|
|
16558
|
+
</dl>
|
|
16559
|
+
|
|
16560
|
+
<dl>
|
|
16561
|
+
<dd>
|
|
16562
|
+
|
|
16563
|
+
**requestOptions:** `Provider.RequestOptions`
|
|
16257
16564
|
|
|
16258
16565
|
</dd>
|
|
16259
16566
|
</dl>
|
|
@@ -16264,7 +16571,9 @@ await client.orgs.orgInfoForConnections.shipper.getV1();
|
|
|
16264
16571
|
</dl>
|
|
16265
16572
|
</details>
|
|
16266
16573
|
|
|
16267
|
-
|
|
16574
|
+
## Shipping Drivers
|
|
16575
|
+
|
|
16576
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getStatsV1</a>(driverId, { ...params }) -> Chrt.DriverStatsRes</code></summary>
|
|
16268
16577
|
<dl>
|
|
16269
16578
|
<dd>
|
|
16270
16579
|
|
|
@@ -16276,7 +16585,7 @@ await client.orgs.orgInfoForConnections.shipper.getV1();
|
|
|
16276
16585
|
<dl>
|
|
16277
16586
|
<dd>
|
|
16278
16587
|
|
|
16279
|
-
|
|
16588
|
+
Retrieves driver stats for a time window: overlap-corrected hours worked, total GPS mileage, and mileage restricted to worked task-group intervals. | authz: allowed_org_types=[provider], min_org_role=operator | (DriverStatsReq) -> (DriverStatsRes)
|
|
16280
16589
|
|
|
16281
16590
|
</dd>
|
|
16282
16591
|
</dl>
|
|
@@ -16292,9 +16601,9 @@ Creates shipper organization connection information. Fails if already exists. |
|
|
|
16292
16601
|
<dd>
|
|
16293
16602
|
|
|
16294
16603
|
```typescript
|
|
16295
|
-
await client.
|
|
16296
|
-
|
|
16297
|
-
|
|
16604
|
+
await client.shipping.drivers.getStatsV1("driver_id", {
|
|
16605
|
+
start_timestamp: "2024-01-15T09:30:00Z",
|
|
16606
|
+
end_timestamp: "2024-01-15T09:30:00Z",
|
|
16298
16607
|
});
|
|
16299
16608
|
```
|
|
16300
16609
|
|
|
@@ -16311,7 +16620,7 @@ await client.orgs.orgInfoForConnections.shipper.createV1({
|
|
|
16311
16620
|
<dl>
|
|
16312
16621
|
<dd>
|
|
16313
16622
|
|
|
16314
|
-
**
|
|
16623
|
+
**driverId:** `string`
|
|
16315
16624
|
|
|
16316
16625
|
</dd>
|
|
16317
16626
|
</dl>
|
|
@@ -16319,7 +16628,15 @@ await client.orgs.orgInfoForConnections.shipper.createV1({
|
|
|
16319
16628
|
<dl>
|
|
16320
16629
|
<dd>
|
|
16321
16630
|
|
|
16322
|
-
**
|
|
16631
|
+
**request:** `Chrt.shipping.DriverStatsReq`
|
|
16632
|
+
|
|
16633
|
+
</dd>
|
|
16634
|
+
</dl>
|
|
16635
|
+
|
|
16636
|
+
<dl>
|
|
16637
|
+
<dd>
|
|
16638
|
+
|
|
16639
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
16323
16640
|
|
|
16324
16641
|
</dd>
|
|
16325
16642
|
</dl>
|
|
@@ -16330,7 +16647,7 @@ await client.orgs.orgInfoForConnections.shipper.createV1({
|
|
|
16330
16647
|
</dl>
|
|
16331
16648
|
</details>
|
|
16332
16649
|
|
|
16333
|
-
<details><summary><code>client.
|
|
16650
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getSelfReportedHoursAndMileageV1</a>(driverId, reportDate) -> Chrt.DriverSelfReportedHoursAndMileage1</code></summary>
|
|
16334
16651
|
<dl>
|
|
16335
16652
|
<dd>
|
|
16336
16653
|
|
|
@@ -16342,7 +16659,7 @@ await client.orgs.orgInfoForConnections.shipper.createV1({
|
|
|
16342
16659
|
<dl>
|
|
16343
16660
|
<dd>
|
|
16344
16661
|
|
|
16345
|
-
|
|
16662
|
+
Retrieves a driver's self-report for a single calendar day. Caller must be the driver themselves or an operator+ in the driver's org. | authz: allowed_org_types=[provider], min_org_role=driver | () -> (DriverSelfReportedHoursAndMileage1)
|
|
16346
16663
|
|
|
16347
16664
|
</dd>
|
|
16348
16665
|
</dl>
|
|
@@ -16358,7 +16675,7 @@ Updates existing shipper organization connection information. | (ShipperOrgInfoF
|
|
|
16358
16675
|
<dd>
|
|
16359
16676
|
|
|
16360
16677
|
```typescript
|
|
16361
|
-
await client.
|
|
16678
|
+
await client.shipping.drivers.getSelfReportedHoursAndMileageV1("driver_id", "report_date");
|
|
16362
16679
|
```
|
|
16363
16680
|
|
|
16364
16681
|
</dd>
|
|
@@ -16374,7 +16691,7 @@ await client.orgs.orgInfoForConnections.shipper.updateV1();
|
|
|
16374
16691
|
<dl>
|
|
16375
16692
|
<dd>
|
|
16376
16693
|
|
|
16377
|
-
**
|
|
16694
|
+
**driverId:** `string`
|
|
16378
16695
|
|
|
16379
16696
|
</dd>
|
|
16380
16697
|
</dl>
|
|
@@ -16382,7 +16699,15 @@ await client.orgs.orgInfoForConnections.shipper.updateV1();
|
|
|
16382
16699
|
<dl>
|
|
16383
16700
|
<dd>
|
|
16384
16701
|
|
|
16385
|
-
**
|
|
16702
|
+
**reportDate:** `string`
|
|
16703
|
+
|
|
16704
|
+
</dd>
|
|
16705
|
+
</dl>
|
|
16706
|
+
|
|
16707
|
+
<dl>
|
|
16708
|
+
<dd>
|
|
16709
|
+
|
|
16710
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
16386
16711
|
|
|
16387
16712
|
</dd>
|
|
16388
16713
|
</dl>
|
|
@@ -16393,9 +16718,7 @@ await client.orgs.orgInfoForConnections.shipper.updateV1();
|
|
|
16393
16718
|
</dl>
|
|
16394
16719
|
</details>
|
|
16395
16720
|
|
|
16396
|
-
|
|
16397
|
-
|
|
16398
|
-
<details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">getV1</a>() -> Chrt.ProviderOrgInfoForConnections1</code></summary>
|
|
16721
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">listSelfReportedHoursAndMileageV1</a>(driverId, { ...params }) -> Chrt.DriverSelfReportedHoursAndMileageListRes</code></summary>
|
|
16399
16722
|
<dl>
|
|
16400
16723
|
<dd>
|
|
16401
16724
|
|
|
@@ -16407,7 +16730,7 @@ await client.orgs.orgInfoForConnections.shipper.updateV1();
|
|
|
16407
16730
|
<dl>
|
|
16408
16731
|
<dd>
|
|
16409
16732
|
|
|
16410
|
-
|
|
16733
|
+
Lists a driver's self-reports across an optional date range with sorting and pagination. Caller must be the driver themselves or an operator+ in the driver's org. | authz: allowed_org_types=[provider], min_org_role=driver | () -> (DriverSelfReportedHoursAndMileageListRes)
|
|
16411
16734
|
|
|
16412
16735
|
</dd>
|
|
16413
16736
|
</dl>
|
|
@@ -16423,7 +16746,13 @@ Retrieves provider organization connection information for the caller's organiza
|
|
|
16423
16746
|
<dd>
|
|
16424
16747
|
|
|
16425
16748
|
```typescript
|
|
16426
|
-
await client.
|
|
16749
|
+
await client.shipping.drivers.listSelfReportedHoursAndMileageV1("driver_id", {
|
|
16750
|
+
filter_start_date: "filter_start_date",
|
|
16751
|
+
filter_end_date: "filter_end_date",
|
|
16752
|
+
sort_order: "asc",
|
|
16753
|
+
page: 1,
|
|
16754
|
+
page_size: 1,
|
|
16755
|
+
});
|
|
16427
16756
|
```
|
|
16428
16757
|
|
|
16429
16758
|
</dd>
|
|
@@ -16439,7 +16768,23 @@ await client.orgs.orgInfoForConnections.provider.getV1();
|
|
|
16439
16768
|
<dl>
|
|
16440
16769
|
<dd>
|
|
16441
16770
|
|
|
16442
|
-
**
|
|
16771
|
+
**driverId:** `string`
|
|
16772
|
+
|
|
16773
|
+
</dd>
|
|
16774
|
+
</dl>
|
|
16775
|
+
|
|
16776
|
+
<dl>
|
|
16777
|
+
<dd>
|
|
16778
|
+
|
|
16779
|
+
**request:** `Chrt.shipping.DriversListSelfReportedHoursAndMileageV1Request`
|
|
16780
|
+
|
|
16781
|
+
</dd>
|
|
16782
|
+
</dl>
|
|
16783
|
+
|
|
16784
|
+
<dl>
|
|
16785
|
+
<dd>
|
|
16786
|
+
|
|
16787
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
16443
16788
|
|
|
16444
16789
|
</dd>
|
|
16445
16790
|
</dl>
|
|
@@ -16450,7 +16795,7 @@ await client.orgs.orgInfoForConnections.provider.getV1();
|
|
|
16450
16795
|
</dl>
|
|
16451
16796
|
</details>
|
|
16452
16797
|
|
|
16453
|
-
<details><summary><code>client.
|
|
16798
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">orgListSelfReportedHoursAndMileageV1</a>({ ...params }) -> Chrt.DriverSelfReportedHoursAndMileageListRes</code></summary>
|
|
16454
16799
|
<dl>
|
|
16455
16800
|
<dd>
|
|
16456
16801
|
|
|
@@ -16462,7 +16807,7 @@ await client.orgs.orgInfoForConnections.provider.getV1();
|
|
|
16462
16807
|
<dl>
|
|
16463
16808
|
<dd>
|
|
16464
16809
|
|
|
16465
|
-
|
|
16810
|
+
Lists all drivers' self-reports in the caller's org with date-range filtering, sorting, and pagination. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (DriverSelfReportedHoursAndMileageListRes)
|
|
16466
16811
|
|
|
16467
16812
|
</dd>
|
|
16468
16813
|
</dl>
|
|
@@ -16478,7 +16823,15 @@ Retrieves list of provider org info documents for providers connected to the cal
|
|
|
16478
16823
|
<dd>
|
|
16479
16824
|
|
|
16480
16825
|
```typescript
|
|
16481
|
-
await client.
|
|
16826
|
+
await client.shipping.drivers.orgListSelfReportedHoursAndMileageV1({
|
|
16827
|
+
filter_driver_id: "filter_driver_id",
|
|
16828
|
+
filter_start_date: "filter_start_date",
|
|
16829
|
+
filter_end_date: "filter_end_date",
|
|
16830
|
+
sort_by: "date",
|
|
16831
|
+
sort_order: "asc",
|
|
16832
|
+
page: 1,
|
|
16833
|
+
page_size: 1,
|
|
16834
|
+
});
|
|
16482
16835
|
```
|
|
16483
16836
|
|
|
16484
16837
|
</dd>
|
|
@@ -16494,7 +16847,15 @@ await client.orgs.orgInfoForConnections.provider.listV1();
|
|
|
16494
16847
|
<dl>
|
|
16495
16848
|
<dd>
|
|
16496
16849
|
|
|
16497
|
-
**
|
|
16850
|
+
**request:** `Chrt.shipping.DriversOrgListSelfReportedHoursAndMileageV1Request`
|
|
16851
|
+
|
|
16852
|
+
</dd>
|
|
16853
|
+
</dl>
|
|
16854
|
+
|
|
16855
|
+
<dl>
|
|
16856
|
+
<dd>
|
|
16857
|
+
|
|
16858
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
16498
16859
|
|
|
16499
16860
|
</dd>
|
|
16500
16861
|
</dl>
|
|
@@ -16505,7 +16866,7 @@ await client.orgs.orgInfoForConnections.provider.listV1();
|
|
|
16505
16866
|
</dl>
|
|
16506
16867
|
</details>
|
|
16507
16868
|
|
|
16508
|
-
<details><summary><code>client.
|
|
16869
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">createSelfReportedHoursAndMileageV1</a>({ ...params }) -> Chrt.DriverSelfReportedHoursAndMileage1</code></summary>
|
|
16509
16870
|
<dl>
|
|
16510
16871
|
<dd>
|
|
16511
16872
|
|
|
@@ -16517,7 +16878,7 @@ await client.orgs.orgInfoForConnections.provider.listV1();
|
|
|
16517
16878
|
<dl>
|
|
16518
16879
|
<dd>
|
|
16519
16880
|
|
|
16520
|
-
Creates
|
|
16881
|
+
Creates a driver's self-reported hours worked and miles driven for a single calendar day. Caller must be the driver themselves. | authz: allowed_org_types=[provider], min_org_role=driver | (DriverSelfReportedHoursAndMileageClientCreate1) -> (DriverSelfReportedHoursAndMileage1)
|
|
16521
16882
|
|
|
16522
16883
|
</dd>
|
|
16523
16884
|
</dl>
|
|
@@ -16533,9 +16894,10 @@ Creates provider organization connection information. Fails if already exists. |
|
|
|
16533
16894
|
<dd>
|
|
16534
16895
|
|
|
16535
16896
|
```typescript
|
|
16536
|
-
await client.
|
|
16897
|
+
await client.shipping.drivers.createSelfReportedHoursAndMileageV1({
|
|
16537
16898
|
schema_version: 1,
|
|
16538
|
-
|
|
16899
|
+
driver_id: "driver_id",
|
|
16900
|
+
date: "date",
|
|
16539
16901
|
});
|
|
16540
16902
|
```
|
|
16541
16903
|
|
|
@@ -16552,7 +16914,7 @@ await client.orgs.orgInfoForConnections.provider.createV1({
|
|
|
16552
16914
|
<dl>
|
|
16553
16915
|
<dd>
|
|
16554
16916
|
|
|
16555
|
-
**request:** `Chrt.
|
|
16917
|
+
**request:** `Chrt.shipping.DriverSelfReportedHoursAndMileageClientCreate1`
|
|
16556
16918
|
|
|
16557
16919
|
</dd>
|
|
16558
16920
|
</dl>
|
|
@@ -16560,7 +16922,7 @@ await client.orgs.orgInfoForConnections.provider.createV1({
|
|
|
16560
16922
|
<dl>
|
|
16561
16923
|
<dd>
|
|
16562
16924
|
|
|
16563
|
-
**requestOptions:** `
|
|
16925
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
16564
16926
|
|
|
16565
16927
|
</dd>
|
|
16566
16928
|
</dl>
|
|
@@ -16571,7 +16933,7 @@ await client.orgs.orgInfoForConnections.provider.createV1({
|
|
|
16571
16933
|
</dl>
|
|
16572
16934
|
</details>
|
|
16573
16935
|
|
|
16574
|
-
<details><summary><code>client.
|
|
16936
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateSelfReportedHoursAndMileageV1</a>(driverId, reportDate, { ...params }) -> Chrt.DriverSelfReportedHoursAndMileage1</code></summary>
|
|
16575
16937
|
<dl>
|
|
16576
16938
|
<dd>
|
|
16577
16939
|
|
|
@@ -16583,7 +16945,7 @@ await client.orgs.orgInfoForConnections.provider.createV1({
|
|
|
16583
16945
|
<dl>
|
|
16584
16946
|
<dd>
|
|
16585
16947
|
|
|
16586
|
-
|
|
16948
|
+
Partially updates a driver's self-reported hours worked and/or miles driven for a calendar day. Caller must be the driver themselves. | authz: allowed_org_types=[provider], min_org_role=driver | (DriverSelfReportedHoursAndMileageClientUpdate1) -> (DriverSelfReportedHoursAndMileage1)
|
|
16587
16949
|
|
|
16588
16950
|
</dd>
|
|
16589
16951
|
</dl>
|
|
@@ -16599,7 +16961,7 @@ Updates existing provider organization connection information. | (ProviderOrgInf
|
|
|
16599
16961
|
<dd>
|
|
16600
16962
|
|
|
16601
16963
|
```typescript
|
|
16602
|
-
await client.
|
|
16964
|
+
await client.shipping.drivers.updateSelfReportedHoursAndMileageV1("driver_id", "report_date");
|
|
16603
16965
|
```
|
|
16604
16966
|
|
|
16605
16967
|
</dd>
|
|
@@ -16615,7 +16977,7 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
|
16615
16977
|
<dl>
|
|
16616
16978
|
<dd>
|
|
16617
16979
|
|
|
16618
|
-
**
|
|
16980
|
+
**driverId:** `string`
|
|
16619
16981
|
|
|
16620
16982
|
</dd>
|
|
16621
16983
|
</dl>
|
|
@@ -16623,7 +16985,23 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
|
16623
16985
|
<dl>
|
|
16624
16986
|
<dd>
|
|
16625
16987
|
|
|
16626
|
-
**
|
|
16988
|
+
**reportDate:** `string`
|
|
16989
|
+
|
|
16990
|
+
</dd>
|
|
16991
|
+
</dl>
|
|
16992
|
+
|
|
16993
|
+
<dl>
|
|
16994
|
+
<dd>
|
|
16995
|
+
|
|
16996
|
+
**request:** `Chrt.shipping.DriverSelfReportedHoursAndMileageClientUpdate1`
|
|
16997
|
+
|
|
16998
|
+
</dd>
|
|
16999
|
+
</dl>
|
|
17000
|
+
|
|
17001
|
+
<dl>
|
|
17002
|
+
<dd>
|
|
17003
|
+
|
|
17004
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
16627
17005
|
|
|
16628
17006
|
</dd>
|
|
16629
17007
|
</dl>
|
|
@@ -16634,9 +17012,7 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
|
16634
17012
|
</dl>
|
|
16635
17013
|
</details>
|
|
16636
17014
|
|
|
16637
|
-
|
|
16638
|
-
|
|
16639
|
-
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getStatsV1</a>(driverId, { ...params }) -> Chrt.DriverStatsRes</code></summary>
|
|
17015
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">deleteSelfReportedHoursAndMileageV1</a>(driverId, reportDate) -> boolean</code></summary>
|
|
16640
17016
|
<dl>
|
|
16641
17017
|
<dd>
|
|
16642
17018
|
|
|
@@ -16648,7 +17024,7 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
|
16648
17024
|
<dl>
|
|
16649
17025
|
<dd>
|
|
16650
17026
|
|
|
16651
|
-
|
|
17027
|
+
Permanently deletes a driver's self-report for a calendar day. Caller must be the driver themselves. | authz: allowed_org_types=[provider], min_org_role=driver | () -> (bool)
|
|
16652
17028
|
|
|
16653
17029
|
</dd>
|
|
16654
17030
|
</dl>
|
|
@@ -16664,10 +17040,7 @@ Retrieves driver stats (hours worked + observed mileage) with overlap-corrected
|
|
|
16664
17040
|
<dd>
|
|
16665
17041
|
|
|
16666
17042
|
```typescript
|
|
16667
|
-
await client.shipping.drivers.
|
|
16668
|
-
start_timestamp: "2024-01-15T09:30:00Z",
|
|
16669
|
-
end_timestamp: "2024-01-15T09:30:00Z",
|
|
16670
|
-
});
|
|
17043
|
+
await client.shipping.drivers.deleteSelfReportedHoursAndMileageV1("driver_id", "report_date");
|
|
16671
17044
|
```
|
|
16672
17045
|
|
|
16673
17046
|
</dd>
|
|
@@ -16691,7 +17064,7 @@ await client.shipping.drivers.getStatsV1("driver_id", {
|
|
|
16691
17064
|
<dl>
|
|
16692
17065
|
<dd>
|
|
16693
17066
|
|
|
16694
|
-
**
|
|
17067
|
+
**reportDate:** `string`
|
|
16695
17068
|
|
|
16696
17069
|
</dd>
|
|
16697
17070
|
</dl>
|
|
@@ -17648,7 +18021,7 @@ await client.shipping.flights.getFlightStatusForFlightLegV1("flight_leg_id");
|
|
|
17648
18021
|
<dl>
|
|
17649
18022
|
<dd>
|
|
17650
18023
|
|
|
17651
|
-
Returns the Cirium-sourced positional track for a flight leg — the live breadcrumb trail plus the planned path (waypoints + legacy route) in one read-through call. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | () -> (FlightTrackRes)
|
|
18024
|
+
Returns the Cirium-sourced positional track for a flight leg — the live breadcrumb trail plus the planned path (waypoints + legacy route) in one read-through call, cached on read. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | () -> (FlightTrackRes)
|
|
17652
18025
|
|
|
17653
18026
|
</dd>
|
|
17654
18027
|
</dl>
|
|
@@ -20583,6 +20956,7 @@ await client.shipping.taskGroups.setFlightInfoV1("task_group_id", {
|
|
|
20583
20956
|
origin_iata: "origin_iata",
|
|
20584
20957
|
destination_iata: "destination_iata",
|
|
20585
20958
|
scheduled_departure_utc: "2024-01-15T09:30:00Z",
|
|
20959
|
+
carrier_iata: "carrier_iata",
|
|
20586
20960
|
},
|
|
20587
20961
|
],
|
|
20588
20962
|
});
|
|
@@ -23312,6 +23686,7 @@ await client.shipping.orderDrafts.taskGroup.setFlightInfoV1("task_group_id", {
|
|
|
23312
23686
|
origin_iata: "origin_iata",
|
|
23313
23687
|
destination_iata: "destination_iata",
|
|
23314
23688
|
scheduled_departure_utc: "2024-01-15T09:30:00Z",
|
|
23689
|
+
carrier_iata: "carrier_iata",
|
|
23315
23690
|
},
|
|
23316
23691
|
],
|
|
23317
23692
|
});
|
|
@@ -27344,6 +27719,84 @@ await client.tracking.driver.updateV1({
|
|
|
27344
27719
|
</dl>
|
|
27345
27720
|
</details>
|
|
27346
27721
|
|
|
27722
|
+
<details><summary><code>client.tracking.driver.<a href="/src/api/resources/tracking/resources/driver/client/Client.ts">updateV2</a>({ ...params }) -> Chrt.DriverUpdateRes</code></summary>
|
|
27723
|
+
<dl>
|
|
27724
|
+
<dd>
|
|
27725
|
+
|
|
27726
|
+
#### 📝 Description
|
|
27727
|
+
|
|
27728
|
+
<dl>
|
|
27729
|
+
<dd>
|
|
27730
|
+
|
|
27731
|
+
<dl>
|
|
27732
|
+
<dd>
|
|
27733
|
+
|
|
27734
|
+
Records driver location updates with a client-supplied capture timestamp. Writes a driver_by_driver ping on every call, updates the driver's last seen, and records tracking data for all IN_PROGRESS task groups and their associated IN_TRANSIT cargos. | auth: api_key | (DriverByDriverDataPointClientCreate1) -> (DriverUpdateRes)
|
|
27735
|
+
|
|
27736
|
+
</dd>
|
|
27737
|
+
</dl>
|
|
27738
|
+
</dd>
|
|
27739
|
+
</dl>
|
|
27740
|
+
|
|
27741
|
+
#### 🔌 Usage
|
|
27742
|
+
|
|
27743
|
+
<dl>
|
|
27744
|
+
<dd>
|
|
27745
|
+
|
|
27746
|
+
<dl>
|
|
27747
|
+
<dd>
|
|
27748
|
+
|
|
27749
|
+
```typescript
|
|
27750
|
+
await client.tracking.driver.updateV2({
|
|
27751
|
+
schema_version: 1,
|
|
27752
|
+
location: {
|
|
27753
|
+
type: "Feature",
|
|
27754
|
+
geometry: {
|
|
27755
|
+
type: "GeometryCollection",
|
|
27756
|
+
geometries: [
|
|
27757
|
+
{
|
|
27758
|
+
type: "LineString",
|
|
27759
|
+
coordinates: [[]],
|
|
27760
|
+
},
|
|
27761
|
+
],
|
|
27762
|
+
},
|
|
27763
|
+
},
|
|
27764
|
+
timestamp: "2024-01-15T09:30:00Z",
|
|
27765
|
+
});
|
|
27766
|
+
```
|
|
27767
|
+
|
|
27768
|
+
</dd>
|
|
27769
|
+
</dl>
|
|
27770
|
+
</dd>
|
|
27771
|
+
</dl>
|
|
27772
|
+
|
|
27773
|
+
#### ⚙️ Parameters
|
|
27774
|
+
|
|
27775
|
+
<dl>
|
|
27776
|
+
<dd>
|
|
27777
|
+
|
|
27778
|
+
<dl>
|
|
27779
|
+
<dd>
|
|
27780
|
+
|
|
27781
|
+
**request:** `Chrt.tracking.DriverByDriverDataPointClientCreate1`
|
|
27782
|
+
|
|
27783
|
+
</dd>
|
|
27784
|
+
</dl>
|
|
27785
|
+
|
|
27786
|
+
<dl>
|
|
27787
|
+
<dd>
|
|
27788
|
+
|
|
27789
|
+
**requestOptions:** `Driver.RequestOptions`
|
|
27790
|
+
|
|
27791
|
+
</dd>
|
|
27792
|
+
</dl>
|
|
27793
|
+
</dd>
|
|
27794
|
+
</dl>
|
|
27795
|
+
|
|
27796
|
+
</dd>
|
|
27797
|
+
</dl>
|
|
27798
|
+
</details>
|
|
27799
|
+
|
|
27347
27800
|
## Tracking Sessions
|
|
27348
27801
|
|
|
27349
27802
|
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">listV1</a>({ ...params }) -> Chrt.SessionListRes</code></summary>
|