@chrt-inc/typescript-sdk 1.1019.0 → 1.1023.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/tracking/resources/devices/client/Client.d.ts +47 -1
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.js +195 -1
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesForCargoV1Request.d.ts +12 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesForCargoV1Request.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesLinkToCargoV1Request.d.ts +14 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesLinkToCargoV1Request.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesUnlinkFromCargoV1Request.d.ts +12 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesUnlinkFromCargoV1Request.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlDimension1.d.ts +2 -10
- package/dist/cjs/api/types/CargoAiFwbAndFhlDimension1.js +0 -10
- package/dist/cjs/api/types/CargoAiFwbAndFhlDimensionUomEnum1.d.ts +8 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlDimensionUomEnum1.js +10 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlWeightOrVolume1.d.ts +2 -10
- package/dist/cjs/api/types/CargoAiFwbAndFhlWeightOrVolume1.js +0 -10
- package/dist/cjs/api/types/CargoAiFwbAndFhlWeightOrVolumeUomEnum1.d.ts +10 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlWeightOrVolumeUomEnum1.js +12 -0
- package/dist/cjs/api/types/DeviceForCargoRes.d.ts +17 -0
- package/dist/cjs/api/types/DeviceForCargoRes.js +5 -0
- package/dist/cjs/api/types/ShippingTaskAddedWebhookPayload.d.ts +2 -0
- package/dist/cjs/api/types/ShippingTaskAttemptedWebhookPayload.d.ts +2 -0
- package/dist/cjs/api/types/ShippingTaskCompletedWebhookPayload.d.ts +2 -0
- package/dist/cjs/api/types/ShippingTaskDeletedWebhookPayload.d.ts +2 -0
- package/dist/cjs/api/types/ShippingTaskExecutorOrgNoteAddedWebhookPayload.d.ts +2 -0
- package/dist/cjs/api/types/ShippingTaskSkippedWebhookPayload.d.ts +2 -0
- package/dist/cjs/api/types/ShippingTaskTaskArtifactCompletedWebhookPayload.d.ts +2 -0
- package/dist/cjs/api/types/Task1.d.ts +1 -0
- package/dist/cjs/api/types/index.d.ts +3 -0
- package/dist/cjs/api/types/index.js +3 -0
- 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 +47 -1
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.mjs +195 -1
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesForCargoV1Request.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesForCargoV1Request.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesLinkToCargoV1Request.d.mts +14 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesLinkToCargoV1Request.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesUnlinkFromCargoV1Request.d.mts +12 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesUnlinkFromCargoV1Request.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/index.d.mts +3 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlDimension1.d.mts +2 -10
- package/dist/esm/api/types/CargoAiFwbAndFhlDimension1.mjs +1 -9
- package/dist/esm/api/types/CargoAiFwbAndFhlDimensionUomEnum1.d.mts +8 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlDimensionUomEnum1.mjs +7 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlWeightOrVolume1.d.mts +2 -10
- package/dist/esm/api/types/CargoAiFwbAndFhlWeightOrVolume1.mjs +1 -9
- package/dist/esm/api/types/CargoAiFwbAndFhlWeightOrVolumeUomEnum1.d.mts +10 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlWeightOrVolumeUomEnum1.mjs +9 -0
- package/dist/esm/api/types/DeviceForCargoRes.d.mts +17 -0
- package/dist/esm/api/types/DeviceForCargoRes.mjs +4 -0
- package/dist/esm/api/types/ShippingTaskAddedWebhookPayload.d.mts +2 -0
- package/dist/esm/api/types/ShippingTaskAttemptedWebhookPayload.d.mts +2 -0
- package/dist/esm/api/types/ShippingTaskCompletedWebhookPayload.d.mts +2 -0
- package/dist/esm/api/types/ShippingTaskDeletedWebhookPayload.d.mts +2 -0
- package/dist/esm/api/types/ShippingTaskExecutorOrgNoteAddedWebhookPayload.d.mts +2 -0
- package/dist/esm/api/types/ShippingTaskSkippedWebhookPayload.d.mts +2 -0
- package/dist/esm/api/types/ShippingTaskTaskArtifactCompletedWebhookPayload.d.mts +2 -0
- package/dist/esm/api/types/Task1.d.mts +1 -0
- package/dist/esm/api/types/index.d.mts +3 -0
- package/dist/esm/api/types/index.mjs +3 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +197 -1
|
@@ -68,6 +68,7 @@ export * from "./CargoAiFwbAndFhlCity1.mjs";
|
|
|
68
68
|
export * from "./CargoAiFwbAndFhlCode1.mjs";
|
|
69
69
|
export * from "./CargoAiFwbAndFhlCountry1.mjs";
|
|
70
70
|
export * from "./CargoAiFwbAndFhlDimension1.mjs";
|
|
71
|
+
export * from "./CargoAiFwbAndFhlDimensionUomEnum1.mjs";
|
|
71
72
|
export * from "./CargoAiFwbAndFhlExecution1.mjs";
|
|
72
73
|
export * from "./CargoAiFwbAndFhlHandling1.mjs";
|
|
73
74
|
export * from "./CargoAiFwbAndFhlHouse1.mjs";
|
|
@@ -81,6 +82,7 @@ export * from "./CargoAiFwbAndFhlRequest1.mjs";
|
|
|
81
82
|
export * from "./CargoAiFwbAndFhlRouting1.mjs";
|
|
82
83
|
export * from "./CargoAiFwbAndFhlUld1.mjs";
|
|
83
84
|
export * from "./CargoAiFwbAndFhlWeightOrVolume1.mjs";
|
|
85
|
+
export * from "./CargoAiFwbAndFhlWeightOrVolumeUomEnum1.mjs";
|
|
84
86
|
export * from "./CargoAiTrackAndTraceAdditionalInformation.mjs";
|
|
85
87
|
export * from "./CargoAiTrackAndTraceAlert.mjs";
|
|
86
88
|
export * from "./CargoAiTrackAndTraceAlertLevelEnum.mjs";
|
|
@@ -296,6 +298,7 @@ export * from "./DepartmentTypeaheadFieldEnum.mjs";
|
|
|
296
298
|
export * from "./DepartmentTypeaheadResult.mjs";
|
|
297
299
|
export * from "./DepartmentTypeaheadValue.mjs";
|
|
298
300
|
export * from "./DeviceExpandedRes.mjs";
|
|
301
|
+
export * from "./DeviceForCargoRes.mjs";
|
|
299
302
|
export * from "./DeviceLimitedForList1.mjs";
|
|
300
303
|
export * from "./DeviceListRes.mjs";
|
|
301
304
|
export * from "./DevicePausedTimeWindow1.mjs";
|
|
@@ -68,6 +68,7 @@ export * from "./CargoAiFwbAndFhlCity1.mjs";
|
|
|
68
68
|
export * from "./CargoAiFwbAndFhlCode1.mjs";
|
|
69
69
|
export * from "./CargoAiFwbAndFhlCountry1.mjs";
|
|
70
70
|
export * from "./CargoAiFwbAndFhlDimension1.mjs";
|
|
71
|
+
export * from "./CargoAiFwbAndFhlDimensionUomEnum1.mjs";
|
|
71
72
|
export * from "./CargoAiFwbAndFhlExecution1.mjs";
|
|
72
73
|
export * from "./CargoAiFwbAndFhlHandling1.mjs";
|
|
73
74
|
export * from "./CargoAiFwbAndFhlHouse1.mjs";
|
|
@@ -81,6 +82,7 @@ export * from "./CargoAiFwbAndFhlRequest1.mjs";
|
|
|
81
82
|
export * from "./CargoAiFwbAndFhlRouting1.mjs";
|
|
82
83
|
export * from "./CargoAiFwbAndFhlUld1.mjs";
|
|
83
84
|
export * from "./CargoAiFwbAndFhlWeightOrVolume1.mjs";
|
|
85
|
+
export * from "./CargoAiFwbAndFhlWeightOrVolumeUomEnum1.mjs";
|
|
84
86
|
export * from "./CargoAiTrackAndTraceAdditionalInformation.mjs";
|
|
85
87
|
export * from "./CargoAiTrackAndTraceAlert.mjs";
|
|
86
88
|
export * from "./CargoAiTrackAndTraceAlertLevelEnum.mjs";
|
|
@@ -296,6 +298,7 @@ export * from "./DepartmentTypeaheadFieldEnum.mjs";
|
|
|
296
298
|
export * from "./DepartmentTypeaheadResult.mjs";
|
|
297
299
|
export * from "./DepartmentTypeaheadValue.mjs";
|
|
298
300
|
export * from "./DeviceExpandedRes.mjs";
|
|
301
|
+
export * from "./DeviceForCargoRes.mjs";
|
|
299
302
|
export * from "./DeviceLimitedForList1.mjs";
|
|
300
303
|
export * from "./DeviceListRes.mjs";
|
|
301
304
|
export * from "./DevicePausedTimeWindow1.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.1023.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "1.
|
|
1
|
+
export const SDK_VERSION = "1.1023.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -33592,7 +33592,7 @@ await client.shippingIntegrations.xcelerator.orders.typeaheadV1({
|
|
|
33592
33592
|
<dl>
|
|
33593
33593
|
<dd>
|
|
33594
33594
|
|
|
33595
|
-
Archives a device
|
|
33595
|
+
Archives a device without an active session or cargo. Terminate or unlink tracking first. | auth: api_key | () -> (bool)
|
|
33596
33596
|
|
|
33597
33597
|
</dd>
|
|
33598
33598
|
</dl>
|
|
@@ -33645,6 +33645,71 @@ await client.tracking.devices.archiveV1({
|
|
|
33645
33645
|
</dl>
|
|
33646
33646
|
</details>
|
|
33647
33647
|
|
|
33648
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">forCargoV1</a>({ ...params }) -> Chrt.DeviceForCargoRes[]</code></summary>
|
|
33649
|
+
<dl>
|
|
33650
|
+
<dd>
|
|
33651
|
+
|
|
33652
|
+
#### 📝 Description
|
|
33653
|
+
|
|
33654
|
+
<dl>
|
|
33655
|
+
<dd>
|
|
33656
|
+
|
|
33657
|
+
<dl>
|
|
33658
|
+
<dd>
|
|
33659
|
+
|
|
33660
|
+
Lists devices currently or previously linked to a cargo, ordered by MAC address. Access follows the cargo's order. | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | () -> (list[DeviceForCargoRes])
|
|
33661
|
+
|
|
33662
|
+
</dd>
|
|
33663
|
+
</dl>
|
|
33664
|
+
</dd>
|
|
33665
|
+
</dl>
|
|
33666
|
+
|
|
33667
|
+
#### 🔌 Usage
|
|
33668
|
+
|
|
33669
|
+
<dl>
|
|
33670
|
+
<dd>
|
|
33671
|
+
|
|
33672
|
+
<dl>
|
|
33673
|
+
<dd>
|
|
33674
|
+
|
|
33675
|
+
```typescript
|
|
33676
|
+
await client.tracking.devices.forCargoV1({
|
|
33677
|
+
cargo_id: "cargo_id",
|
|
33678
|
+
});
|
|
33679
|
+
```
|
|
33680
|
+
|
|
33681
|
+
</dd>
|
|
33682
|
+
</dl>
|
|
33683
|
+
</dd>
|
|
33684
|
+
</dl>
|
|
33685
|
+
|
|
33686
|
+
#### ⚙️ Parameters
|
|
33687
|
+
|
|
33688
|
+
<dl>
|
|
33689
|
+
<dd>
|
|
33690
|
+
|
|
33691
|
+
<dl>
|
|
33692
|
+
<dd>
|
|
33693
|
+
|
|
33694
|
+
**request:** `Chrt.tracking.DevicesForCargoV1Request`
|
|
33695
|
+
|
|
33696
|
+
</dd>
|
|
33697
|
+
</dl>
|
|
33698
|
+
|
|
33699
|
+
<dl>
|
|
33700
|
+
<dd>
|
|
33701
|
+
|
|
33702
|
+
**requestOptions:** `Devices.RequestOptions`
|
|
33703
|
+
|
|
33704
|
+
</dd>
|
|
33705
|
+
</dl>
|
|
33706
|
+
</dd>
|
|
33707
|
+
</dl>
|
|
33708
|
+
|
|
33709
|
+
</dd>
|
|
33710
|
+
</dl>
|
|
33711
|
+
</details>
|
|
33712
|
+
|
|
33648
33713
|
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">getV1</a>({ ...params }) -> Chrt.DeviceExpandedRes</code></summary>
|
|
33649
33714
|
<dl>
|
|
33650
33715
|
<dd>
|
|
@@ -33710,6 +33775,72 @@ await client.tracking.devices.getV1({
|
|
|
33710
33775
|
</dl>
|
|
33711
33776
|
</details>
|
|
33712
33777
|
|
|
33778
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">linkToCargoV1</a>({ ...params }) -> boolean</code></summary>
|
|
33779
|
+
<dl>
|
|
33780
|
+
<dd>
|
|
33781
|
+
|
|
33782
|
+
#### 📝 Description
|
|
33783
|
+
|
|
33784
|
+
<dl>
|
|
33785
|
+
<dd>
|
|
33786
|
+
|
|
33787
|
+
<dl>
|
|
33788
|
+
<dd>
|
|
33789
|
+
|
|
33790
|
+
Links an owned device to cargo and activates its tracker. Relinking the same cargo reactivates a stopped tracker. | authz: min_org_role=operator | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators] | () -> (bool)
|
|
33791
|
+
|
|
33792
|
+
</dd>
|
|
33793
|
+
</dl>
|
|
33794
|
+
</dd>
|
|
33795
|
+
</dl>
|
|
33796
|
+
|
|
33797
|
+
#### 🔌 Usage
|
|
33798
|
+
|
|
33799
|
+
<dl>
|
|
33800
|
+
<dd>
|
|
33801
|
+
|
|
33802
|
+
<dl>
|
|
33803
|
+
<dd>
|
|
33804
|
+
|
|
33805
|
+
```typescript
|
|
33806
|
+
await client.tracking.devices.linkToCargoV1({
|
|
33807
|
+
device_id: "device_id",
|
|
33808
|
+
cargo_id: "cargo_id",
|
|
33809
|
+
});
|
|
33810
|
+
```
|
|
33811
|
+
|
|
33812
|
+
</dd>
|
|
33813
|
+
</dl>
|
|
33814
|
+
</dd>
|
|
33815
|
+
</dl>
|
|
33816
|
+
|
|
33817
|
+
#### ⚙️ Parameters
|
|
33818
|
+
|
|
33819
|
+
<dl>
|
|
33820
|
+
<dd>
|
|
33821
|
+
|
|
33822
|
+
<dl>
|
|
33823
|
+
<dd>
|
|
33824
|
+
|
|
33825
|
+
**request:** `Chrt.tracking.DevicesLinkToCargoV1Request`
|
|
33826
|
+
|
|
33827
|
+
</dd>
|
|
33828
|
+
</dl>
|
|
33829
|
+
|
|
33830
|
+
<dl>
|
|
33831
|
+
<dd>
|
|
33832
|
+
|
|
33833
|
+
**requestOptions:** `Devices.RequestOptions`
|
|
33834
|
+
|
|
33835
|
+
</dd>
|
|
33836
|
+
</dl>
|
|
33837
|
+
</dd>
|
|
33838
|
+
</dl>
|
|
33839
|
+
|
|
33840
|
+
</dd>
|
|
33841
|
+
</dl>
|
|
33842
|
+
</details>
|
|
33843
|
+
|
|
33713
33844
|
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">listV1</a>({ ...params }) -> Chrt.DeviceListRes</code></summary>
|
|
33714
33845
|
<dl>
|
|
33715
33846
|
<dd>
|
|
@@ -33993,6 +34124,71 @@ await client.tracking.devices.typeaheadV1({
|
|
|
33993
34124
|
</dl>
|
|
33994
34125
|
</details>
|
|
33995
34126
|
|
|
34127
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">unlinkFromCargoV1</a>({ ...params }) -> boolean</code></summary>
|
|
34128
|
+
<dl>
|
|
34129
|
+
<dd>
|
|
34130
|
+
|
|
34131
|
+
#### 📝 Description
|
|
34132
|
+
|
|
34133
|
+
<dl>
|
|
34134
|
+
<dd>
|
|
34135
|
+
|
|
34136
|
+
<dl>
|
|
34137
|
+
<dd>
|
|
34138
|
+
|
|
34139
|
+
Unlinks an owned device from its cargo and deactivates its tracker. Returns false when the device is not linked to cargo. | authz: min_org_role=operator | () -> (bool)
|
|
34140
|
+
|
|
34141
|
+
</dd>
|
|
34142
|
+
</dl>
|
|
34143
|
+
</dd>
|
|
34144
|
+
</dl>
|
|
34145
|
+
|
|
34146
|
+
#### 🔌 Usage
|
|
34147
|
+
|
|
34148
|
+
<dl>
|
|
34149
|
+
<dd>
|
|
34150
|
+
|
|
34151
|
+
<dl>
|
|
34152
|
+
<dd>
|
|
34153
|
+
|
|
34154
|
+
```typescript
|
|
34155
|
+
await client.tracking.devices.unlinkFromCargoV1({
|
|
34156
|
+
device_id: "device_id",
|
|
34157
|
+
});
|
|
34158
|
+
```
|
|
34159
|
+
|
|
34160
|
+
</dd>
|
|
34161
|
+
</dl>
|
|
34162
|
+
</dd>
|
|
34163
|
+
</dl>
|
|
34164
|
+
|
|
34165
|
+
#### ⚙️ Parameters
|
|
34166
|
+
|
|
34167
|
+
<dl>
|
|
34168
|
+
<dd>
|
|
34169
|
+
|
|
34170
|
+
<dl>
|
|
34171
|
+
<dd>
|
|
34172
|
+
|
|
34173
|
+
**request:** `Chrt.tracking.DevicesUnlinkFromCargoV1Request`
|
|
34174
|
+
|
|
34175
|
+
</dd>
|
|
34176
|
+
</dl>
|
|
34177
|
+
|
|
34178
|
+
<dl>
|
|
34179
|
+
<dd>
|
|
34180
|
+
|
|
34181
|
+
**requestOptions:** `Devices.RequestOptions`
|
|
34182
|
+
|
|
34183
|
+
</dd>
|
|
34184
|
+
</dl>
|
|
34185
|
+
</dd>
|
|
34186
|
+
</dl>
|
|
34187
|
+
|
|
34188
|
+
</dd>
|
|
34189
|
+
</dl>
|
|
34190
|
+
</details>
|
|
34191
|
+
|
|
33996
34192
|
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">unpauseV1</a>({ ...params }) -> boolean</code></summary>
|
|
33997
34193
|
<dl>
|
|
33998
34194
|
<dd>
|