@chrt-inc/typescript-sdk 1.1020.0 → 1.1024.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -9
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/chrtGpt/client/Client.d.ts +6 -13
- package/dist/cjs/api/resources/chrtGpt/client/Client.js +24 -17
- package/dist/cjs/api/resources/chrtGpt/client/requests/{ChrtGptMessageReq.d.ts → ChrtGptReq.d.ts} +1 -1
- package/dist/cjs/api/resources/chrtGpt/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/chrtGpt/index.d.ts +1 -0
- package/dist/cjs/api/resources/chrtGpt/index.js +1 -0
- package/dist/cjs/api/resources/chrtGpt/resources/conversations/client/Client.d.ts +65 -0
- package/dist/cjs/api/resources/chrtGpt/resources/conversations/client/Client.js +205 -0
- package/dist/cjs/api/resources/chrtGpt/resources/conversations/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/chrtGpt/resources/conversations/client/index.js +17 -0
- package/dist/cjs/api/resources/chrtGpt/resources/conversations/client/requests/ConversationsListV1Request.d.ts +21 -0
- package/dist/cjs/api/resources/chrtGpt/resources/conversations/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/chrtGpt/resources/conversations/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/chrtGpt/resources/conversations/index.d.ts +1 -0
- package/dist/cjs/api/resources/chrtGpt/resources/conversations/index.js +17 -0
- package/dist/cjs/api/resources/chrtGpt/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/chrtGpt/resources/index.js +41 -0
- package/dist/cjs/api/resources/orgs/resources/connections/client/Client.d.ts +18 -1
- package/dist/cjs/api/resources/orgs/resources/connections/client/Client.js +75 -6
- package/dist/cjs/api/resources/orgs/resources/connections/client/requests/ConnectionsListShippersForCoordinatorV1Request.d.ts +4 -1
- package/dist/cjs/api/resources/orgs/resources/connections/client/requests/ShipperCoordinatorUpdateKnownShipperReq.d.ts +12 -0
- package/dist/cjs/api/resources/orgs/resources/connections/client/requests/ShipperCoordinatorUpdateKnownShipperReq.js +5 -0
- package/dist/cjs/api/resources/orgs/resources/connections/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/resources/publicData/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/orgs/resources/publicData/client/Client.js +5 -0
- package/dist/cjs/api/resources/orgs/resources/publicData/index.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/resources/publicData/index.js +1 -0
- package/dist/cjs/api/resources/orgs/resources/publicData/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/orgs/resources/publicData/resources/index.js +41 -0
- package/dist/cjs/api/resources/orgs/resources/publicData/resources/s3Object/client/Client.d.ts +86 -0
- package/dist/cjs/api/resources/orgs/resources/publicData/resources/s3Object/client/Client.js +319 -0
- package/dist/cjs/api/resources/orgs/resources/publicData/resources/s3Object/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/orgs/resources/publicData/resources/s3Object/client/index.js +17 -0
- package/dist/cjs/api/resources/orgs/resources/publicData/resources/s3Object/client/requests/BodyPostOrgPublicDataS3ObjectAddV1.d.ts +13 -0
- package/dist/cjs/api/resources/orgs/resources/publicData/resources/s3Object/client/requests/BodyPostOrgPublicDataS3ObjectAddV1.js +5 -0
- package/dist/cjs/api/resources/orgs/resources/publicData/resources/s3Object/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/resources/publicData/resources/s3Object/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/orgs/resources/publicData/resources/s3Object/index.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/resources/publicData/resources/s3Object/index.js +17 -0
- 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/ChrtGptAssistantMessageItem.d.ts +8 -0
- package/dist/cjs/api/types/ChrtGptAssistantMessageItem.js +5 -0
- package/dist/cjs/api/types/ChrtGptCompletedEvent.d.ts +11 -0
- package/dist/cjs/api/types/ChrtGptCompletedEvent.js +5 -0
- package/dist/cjs/api/types/ChrtGptConversation1.d.ts +14 -0
- package/dist/cjs/api/types/ChrtGptConversation1.js +5 -0
- package/dist/cjs/api/types/ChrtGptConversationListRes.d.ts +8 -0
- package/dist/cjs/api/types/ChrtGptConversationListRes.js +5 -0
- package/dist/cjs/api/types/ChrtGptConversationRes.d.ts +9 -0
- package/dist/cjs/api/types/ChrtGptConversationRes.js +5 -0
- package/dist/cjs/api/types/ChrtGptConversationSortByEnum.d.ts +8 -0
- package/dist/cjs/api/types/ChrtGptConversationSortByEnum.js +10 -0
- package/dist/cjs/api/types/ChrtGptErrorEvent.d.ts +9 -0
- package/dist/cjs/api/types/ChrtGptErrorEvent.js +5 -0
- package/dist/cjs/api/types/ChrtGptEvent.d.ts +31 -0
- package/dist/cjs/api/types/ChrtGptEvent.js +5 -0
- package/dist/cjs/api/types/ChrtGptHistoryItem.d.ts +22 -0
- package/dist/cjs/api/types/ChrtGptHistoryItem.js +5 -0
- package/dist/{esm/api/types/ChrtGptMessageRes.d.mts → cjs/api/types/ChrtGptStartedEvent.d.ts} +4 -2
- package/dist/cjs/api/types/ChrtGptStartedEvent.js +5 -0
- package/dist/cjs/api/types/ChrtGptTextDeltaEvent.d.ts +8 -0
- package/dist/cjs/api/types/ChrtGptTextDeltaEvent.js +5 -0
- package/dist/cjs/api/types/ChrtGptTitleEvent.d.ts +11 -0
- package/dist/cjs/api/types/ChrtGptTitleEvent.js +5 -0
- package/dist/cjs/api/types/ChrtGptToolCalledEvent.d.ts +12 -0
- package/dist/cjs/api/types/ChrtGptToolCalledEvent.js +5 -0
- package/dist/cjs/api/types/ChrtGptToolOutputEvent.d.ts +9 -0
- package/dist/cjs/api/types/ChrtGptToolOutputEvent.js +5 -0
- package/dist/cjs/api/types/ChrtGptUserMessageItem.d.ts +6 -0
- package/dist/cjs/api/types/ChrtGptUserMessageItem.js +5 -0
- package/dist/cjs/api/types/ChrtGptWebSearchEvent.d.ts +18 -0
- package/dist/cjs/api/types/ChrtGptWebSearchEvent.js +5 -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/OrgPublicData1.d.ts +1 -0
- package/dist/cjs/api/types/OrgPublicDataS3ObjectMetadata1.d.ts +21 -0
- package/dist/cjs/api/types/OrgPublicDataS3ObjectMetadata1.js +5 -0
- package/dist/cjs/api/types/ShipperCoordinatorConnection1.d.ts +4 -0
- package/dist/cjs/api/types/SpecialHandlingCodeEnum1.d.ts +63 -1
- package/dist/cjs/api/types/SpecialHandlingCodeEnum1.js +62 -0
- package/dist/cjs/api/types/index.d.ts +18 -1
- package/dist/cjs/api/types/index.js +18 -1
- package/dist/cjs/core/index.d.ts +1 -0
- package/dist/cjs/core/index.js +1 -0
- package/dist/cjs/core/stream/Stream.d.ts +46 -0
- package/dist/cjs/core/stream/Stream.js +169 -0
- package/dist/cjs/core/stream/index.d.ts +1 -0
- package/dist/cjs/core/stream/index.js +5 -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/chrtGpt/client/Client.d.mts +6 -13
- package/dist/esm/api/resources/chrtGpt/client/Client.mjs +24 -17
- package/dist/esm/api/resources/chrtGpt/client/requests/{ChrtGptMessageReq.d.mts → ChrtGptReq.d.mts} +1 -1
- package/dist/esm/api/resources/chrtGpt/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/chrtGpt/index.d.mts +1 -0
- package/dist/esm/api/resources/chrtGpt/index.mjs +1 -0
- package/dist/esm/api/resources/chrtGpt/resources/conversations/client/Client.d.mts +65 -0
- package/dist/esm/api/resources/chrtGpt/resources/conversations/client/Client.mjs +168 -0
- package/dist/esm/api/resources/chrtGpt/resources/conversations/client/index.d.mts +2 -0
- package/dist/esm/api/resources/chrtGpt/resources/conversations/client/index.mjs +1 -0
- package/dist/esm/api/resources/chrtGpt/resources/conversations/client/requests/ConversationsListV1Request.d.mts +21 -0
- package/dist/esm/api/resources/chrtGpt/resources/conversations/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/chrtGpt/resources/conversations/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/chrtGpt/resources/conversations/index.d.mts +1 -0
- package/dist/esm/api/resources/chrtGpt/resources/conversations/index.mjs +1 -0
- package/dist/esm/api/resources/chrtGpt/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/chrtGpt/resources/index.mjs +2 -0
- package/dist/esm/api/resources/orgs/resources/connections/client/Client.d.mts +18 -1
- package/dist/esm/api/resources/orgs/resources/connections/client/Client.mjs +75 -6
- package/dist/esm/api/resources/orgs/resources/connections/client/requests/ConnectionsListShippersForCoordinatorV1Request.d.mts +4 -1
- package/dist/esm/api/resources/orgs/resources/connections/client/requests/ShipperCoordinatorUpdateKnownShipperReq.d.mts +12 -0
- package/dist/esm/api/resources/orgs/resources/connections/client/requests/ShipperCoordinatorUpdateKnownShipperReq.mjs +4 -0
- package/dist/esm/api/resources/orgs/resources/connections/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/orgs/resources/publicData/client/Client.d.mts +3 -0
- package/dist/esm/api/resources/orgs/resources/publicData/client/Client.mjs +5 -0
- package/dist/esm/api/resources/orgs/resources/publicData/index.d.mts +1 -0
- package/dist/esm/api/resources/orgs/resources/publicData/index.mjs +1 -0
- package/dist/esm/api/resources/orgs/resources/publicData/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/orgs/resources/publicData/resources/index.mjs +2 -0
- package/dist/esm/api/resources/orgs/resources/publicData/resources/s3Object/client/Client.d.mts +86 -0
- package/dist/esm/api/resources/orgs/resources/publicData/resources/s3Object/client/Client.mjs +282 -0
- package/dist/esm/api/resources/orgs/resources/publicData/resources/s3Object/client/index.d.mts +2 -0
- package/dist/esm/api/resources/orgs/resources/publicData/resources/s3Object/client/index.mjs +1 -0
- package/dist/esm/api/resources/orgs/resources/publicData/resources/s3Object/client/requests/BodyPostOrgPublicDataS3ObjectAddV1.d.mts +13 -0
- package/dist/esm/api/resources/orgs/resources/publicData/resources/s3Object/client/requests/BodyPostOrgPublicDataS3ObjectAddV1.mjs +4 -0
- package/dist/esm/api/resources/orgs/resources/publicData/resources/s3Object/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/orgs/resources/publicData/resources/s3Object/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/orgs/resources/publicData/resources/s3Object/index.d.mts +1 -0
- package/dist/esm/api/resources/orgs/resources/publicData/resources/s3Object/index.mjs +1 -0
- 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/ChrtGptAssistantMessageItem.d.mts +8 -0
- package/dist/esm/api/types/ChrtGptAssistantMessageItem.mjs +4 -0
- package/dist/esm/api/types/ChrtGptCompletedEvent.d.mts +11 -0
- package/dist/esm/api/types/ChrtGptCompletedEvent.mjs +4 -0
- package/dist/esm/api/types/ChrtGptConversation1.d.mts +14 -0
- package/dist/esm/api/types/ChrtGptConversation1.mjs +4 -0
- package/dist/esm/api/types/ChrtGptConversationListRes.d.mts +8 -0
- package/dist/esm/api/types/ChrtGptConversationListRes.mjs +4 -0
- package/dist/esm/api/types/ChrtGptConversationRes.d.mts +9 -0
- package/dist/esm/api/types/ChrtGptConversationRes.mjs +4 -0
- package/dist/esm/api/types/ChrtGptConversationSortByEnum.d.mts +8 -0
- package/dist/esm/api/types/ChrtGptConversationSortByEnum.mjs +7 -0
- package/dist/esm/api/types/ChrtGptErrorEvent.d.mts +9 -0
- package/dist/esm/api/types/ChrtGptErrorEvent.mjs +4 -0
- package/dist/esm/api/types/ChrtGptEvent.d.mts +31 -0
- package/dist/esm/api/types/ChrtGptEvent.mjs +4 -0
- package/dist/esm/api/types/ChrtGptHistoryItem.d.mts +22 -0
- package/dist/esm/api/types/ChrtGptHistoryItem.mjs +4 -0
- package/dist/{cjs/api/types/ChrtGptMessageRes.d.ts → esm/api/types/ChrtGptStartedEvent.d.mts} +4 -2
- package/dist/esm/api/types/ChrtGptStartedEvent.mjs +4 -0
- package/dist/esm/api/types/ChrtGptTextDeltaEvent.d.mts +8 -0
- package/dist/esm/api/types/ChrtGptTextDeltaEvent.mjs +4 -0
- package/dist/esm/api/types/ChrtGptTitleEvent.d.mts +11 -0
- package/dist/esm/api/types/ChrtGptTitleEvent.mjs +4 -0
- package/dist/esm/api/types/ChrtGptToolCalledEvent.d.mts +12 -0
- package/dist/esm/api/types/ChrtGptToolCalledEvent.mjs +4 -0
- package/dist/esm/api/types/ChrtGptToolOutputEvent.d.mts +9 -0
- package/dist/esm/api/types/ChrtGptToolOutputEvent.mjs +4 -0
- package/dist/esm/api/types/ChrtGptUserMessageItem.d.mts +6 -0
- package/dist/esm/api/types/ChrtGptUserMessageItem.mjs +4 -0
- package/dist/esm/api/types/ChrtGptWebSearchEvent.d.mts +18 -0
- package/dist/esm/api/types/ChrtGptWebSearchEvent.mjs +4 -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/OrgPublicData1.d.mts +1 -0
- package/dist/esm/api/types/OrgPublicDataS3ObjectMetadata1.d.mts +21 -0
- package/dist/esm/api/types/OrgPublicDataS3ObjectMetadata1.mjs +4 -0
- package/dist/esm/api/types/ShipperCoordinatorConnection1.d.mts +4 -0
- package/dist/esm/api/types/SpecialHandlingCodeEnum1.d.mts +63 -1
- package/dist/esm/api/types/SpecialHandlingCodeEnum1.mjs +62 -0
- package/dist/esm/api/types/index.d.mts +18 -1
- package/dist/esm/api/types/index.mjs +18 -1
- package/dist/esm/core/index.d.mts +1 -0
- package/dist/esm/core/index.mjs +1 -0
- package/dist/esm/core/stream/Stream.d.mts +46 -0
- package/dist/esm/core/stream/Stream.mjs +164 -0
- package/dist/esm/core/stream/index.d.mts +1 -0
- package/dist/esm/core/stream/index.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +843 -181
- /package/dist/cjs/api/resources/chrtGpt/client/requests/{ChrtGptMessageReq.js → ChrtGptReq.js} +0 -0
- /package/dist/cjs/api/{types/ChrtGptMessageRes.js → resources/chrtGpt/resources/conversations/client/requests/ConversationsListV1Request.js} +0 -0
- /package/dist/esm/api/resources/chrtGpt/client/requests/{ChrtGptMessageReq.mjs → ChrtGptReq.mjs} +0 -0
- /package/dist/esm/api/{types/ChrtGptMessageRes.mjs → resources/chrtGpt/resources/conversations/client/requests/ConversationsListV1Request.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## ChrtGpt
|
|
4
4
|
|
|
5
|
-
<details><summary><code>client.chrtGpt.<a href="/src/api/resources/chrtGpt/client/Client.ts">
|
|
5
|
+
<details><summary><code>client.chrtGpt.<a href="/src/api/resources/chrtGpt/client/Client.ts">postV1</a>({ ...params }) -> core.Stream<Chrt.ChrtGptEvent></code></summary>
|
|
6
6
|
<dl>
|
|
7
7
|
<dd>
|
|
8
8
|
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
<dl>
|
|
15
15
|
<dd>
|
|
16
16
|
|
|
17
|
-
Sends a message to ChrtGPT and
|
|
17
|
+
Sends a message to ChrtGPT and streams its reply, starting and titling a new conversation when no conversation_id is given. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (ChrtGPTReq) -> (stream[ChrtGPTEvent])
|
|
18
18
|
|
|
19
19
|
</dd>
|
|
20
20
|
</dl>
|
|
@@ -30,9 +30,12 @@ Sends a message to ChrtGPT and returns its reply, starting a new conversation wh
|
|
|
30
30
|
<dd>
|
|
31
31
|
|
|
32
32
|
```typescript
|
|
33
|
-
await client.chrtGpt.
|
|
33
|
+
const response = await client.chrtGpt.postV1({
|
|
34
34
|
message: "message",
|
|
35
35
|
});
|
|
36
|
+
for await (const item of response) {
|
|
37
|
+
console.log(item);
|
|
38
|
+
}
|
|
36
39
|
```
|
|
37
40
|
|
|
38
41
|
</dd>
|
|
@@ -48,7 +51,7 @@ await client.chrtGpt.messageV1({
|
|
|
48
51
|
<dl>
|
|
49
52
|
<dd>
|
|
50
53
|
|
|
51
|
-
**request:** `Chrt.
|
|
54
|
+
**request:** `Chrt.ChrtGptReq`
|
|
52
55
|
|
|
53
56
|
</dd>
|
|
54
57
|
</dl>
|
|
@@ -5198,9 +5201,9 @@ await client.cargoOnFlightIntegrations.cargoai.searchV1("cargo_on_flight_booking
|
|
|
5198
5201
|
</dl>
|
|
5199
5202
|
</details>
|
|
5200
5203
|
|
|
5201
|
-
##
|
|
5204
|
+
## ChrtGpt Conversations
|
|
5202
5205
|
|
|
5203
|
-
<details><summary><code>client.
|
|
5206
|
+
<details><summary><code>client.chrtGpt.conversations.<a href="/src/api/resources/chrtGpt/resources/conversations/client/Client.ts">listV1</a>({ ...params }) -> Chrt.ChrtGptConversationListRes</code></summary>
|
|
5204
5207
|
<dl>
|
|
5205
5208
|
<dd>
|
|
5206
5209
|
|
|
@@ -5212,7 +5215,7 @@ await client.cargoOnFlightIntegrations.cargoai.searchV1("cargo_on_flight_booking
|
|
|
5212
5215
|
<dl>
|
|
5213
5216
|
<dd>
|
|
5214
5217
|
|
|
5215
|
-
|
|
5218
|
+
Lists the caller's ChrtGPT conversations, most recently active first by default. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | () -> (ChrtGPTConversationListRes)
|
|
5216
5219
|
|
|
5217
5220
|
</dd>
|
|
5218
5221
|
</dl>
|
|
@@ -5228,7 +5231,12 @@ Retrieves all CHAMP confirmation receipts linked to the air waybill for a task g
|
|
|
5228
5231
|
<dd>
|
|
5229
5232
|
|
|
5230
5233
|
```typescript
|
|
5231
|
-
await client.
|
|
5234
|
+
await client.chrtGpt.conversations.listV1({
|
|
5235
|
+
sort_by: "updated_at",
|
|
5236
|
+
sort_order: "asc",
|
|
5237
|
+
page: 1,
|
|
5238
|
+
page_size: 1,
|
|
5239
|
+
});
|
|
5232
5240
|
```
|
|
5233
5241
|
|
|
5234
5242
|
</dd>
|
|
@@ -5244,7 +5252,7 @@ await client.integrations.airWaybills.confirmationsV1("task_group_id");
|
|
|
5244
5252
|
<dl>
|
|
5245
5253
|
<dd>
|
|
5246
5254
|
|
|
5247
|
-
**
|
|
5255
|
+
**request:** `Chrt.chrtGpt.ConversationsListV1Request`
|
|
5248
5256
|
|
|
5249
5257
|
</dd>
|
|
5250
5258
|
</dl>
|
|
@@ -5252,7 +5260,7 @@ await client.integrations.airWaybills.confirmationsV1("task_group_id");
|
|
|
5252
5260
|
<dl>
|
|
5253
5261
|
<dd>
|
|
5254
5262
|
|
|
5255
|
-
**requestOptions:** `
|
|
5263
|
+
**requestOptions:** `Conversations.RequestOptions`
|
|
5256
5264
|
|
|
5257
5265
|
</dd>
|
|
5258
5266
|
</dl>
|
|
@@ -5263,7 +5271,7 @@ await client.integrations.airWaybills.confirmationsV1("task_group_id");
|
|
|
5263
5271
|
</dl>
|
|
5264
5272
|
</details>
|
|
5265
5273
|
|
|
5266
|
-
<details><summary><code>client.
|
|
5274
|
+
<details><summary><code>client.chrtGpt.conversations.<a href="/src/api/resources/chrtGpt/resources/conversations/client/Client.ts">getV1</a>(conversationId) -> Chrt.ChrtGptConversationRes</code></summary>
|
|
5267
5275
|
<dl>
|
|
5268
5276
|
<dd>
|
|
5269
5277
|
|
|
@@ -5275,7 +5283,7 @@ await client.integrations.airWaybills.confirmationsV1("task_group_id");
|
|
|
5275
5283
|
<dl>
|
|
5276
5284
|
<dd>
|
|
5277
5285
|
|
|
5278
|
-
|
|
5286
|
+
Gets one of the caller's ChrtGPT conversations with its history of messages, tool calls, and web searches. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | () -> (ChrtGPTConversationRes)
|
|
5279
5287
|
|
|
5280
5288
|
</dd>
|
|
5281
5289
|
</dl>
|
|
@@ -5291,9 +5299,7 @@ Creates a CHAMP air waybill pre-populated from the stored WebCargo booking recor
|
|
|
5291
5299
|
<dd>
|
|
5292
5300
|
|
|
5293
5301
|
```typescript
|
|
5294
|
-
await client.
|
|
5295
|
-
task_group_id: "task_group_id",
|
|
5296
|
-
});
|
|
5302
|
+
await client.chrtGpt.conversations.getV1("conversation_id");
|
|
5297
5303
|
```
|
|
5298
5304
|
|
|
5299
5305
|
</dd>
|
|
@@ -5309,7 +5315,7 @@ await client.integrations.airWaybills.createV1({
|
|
|
5309
5315
|
<dl>
|
|
5310
5316
|
<dd>
|
|
5311
5317
|
|
|
5312
|
-
**
|
|
5318
|
+
**conversationId:** `string`
|
|
5313
5319
|
|
|
5314
5320
|
</dd>
|
|
5315
5321
|
</dl>
|
|
@@ -5317,7 +5323,7 @@ await client.integrations.airWaybills.createV1({
|
|
|
5317
5323
|
<dl>
|
|
5318
5324
|
<dd>
|
|
5319
5325
|
|
|
5320
|
-
**requestOptions:** `
|
|
5326
|
+
**requestOptions:** `Conversations.RequestOptions`
|
|
5321
5327
|
|
|
5322
5328
|
</dd>
|
|
5323
5329
|
</dl>
|
|
@@ -5328,7 +5334,9 @@ await client.integrations.airWaybills.createV1({
|
|
|
5328
5334
|
</dl>
|
|
5329
5335
|
</details>
|
|
5330
5336
|
|
|
5331
|
-
|
|
5337
|
+
## Integrations AirWaybills
|
|
5338
|
+
|
|
5339
|
+
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">confirmationsV1</a>(taskGroupId) -> Chrt.ChampConfirmationReceipt1[]</code></summary>
|
|
5332
5340
|
<dl>
|
|
5333
5341
|
<dd>
|
|
5334
5342
|
|
|
@@ -5340,7 +5348,7 @@ await client.integrations.airWaybills.createV1({
|
|
|
5340
5348
|
<dl>
|
|
5341
5349
|
<dd>
|
|
5342
5350
|
|
|
5343
|
-
Retrieves all CHAMP
|
|
5351
|
+
Retrieves all CHAMP confirmation receipts linked to the air waybill for a task group. | () -> (list[ChampConfirmationReceipt1])
|
|
5344
5352
|
|
|
5345
5353
|
</dd>
|
|
5346
5354
|
</dl>
|
|
@@ -5356,7 +5364,7 @@ Retrieves all CHAMP flight status updates linked to the air waybill for a task g
|
|
|
5356
5364
|
<dd>
|
|
5357
5365
|
|
|
5358
5366
|
```typescript
|
|
5359
|
-
await client.integrations.airWaybills.
|
|
5367
|
+
await client.integrations.airWaybills.confirmationsV1("task_group_id");
|
|
5360
5368
|
```
|
|
5361
5369
|
|
|
5362
5370
|
</dd>
|
|
@@ -5391,7 +5399,7 @@ await client.integrations.airWaybills.flightStatusesV1("task_group_id");
|
|
|
5391
5399
|
</dl>
|
|
5392
5400
|
</details>
|
|
5393
5401
|
|
|
5394
|
-
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">
|
|
5402
|
+
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">createV1</a>({ ...params }) -> Chrt.ChampAirWaybill1</code></summary>
|
|
5395
5403
|
<dl>
|
|
5396
5404
|
<dd>
|
|
5397
5405
|
|
|
@@ -5403,7 +5411,7 @@ await client.integrations.airWaybills.flightStatusesV1("task_group_id");
|
|
|
5403
5411
|
<dl>
|
|
5404
5412
|
<dd>
|
|
5405
5413
|
|
|
5406
|
-
|
|
5414
|
+
Creates a CHAMP air waybill pre-populated from the stored WebCargo booking record. The booking must be synced first via the webcargo_bookings sync route. Returns 409 if an air waybill already exists for this task group. | (AirWaybillCreateReq) -> (ChampAirWaybill1)
|
|
5407
5415
|
|
|
5408
5416
|
</dd>
|
|
5409
5417
|
</dl>
|
|
@@ -5419,7 +5427,9 @@ Converts a CHAMP air waybill to PDF via CHAMP's conversion API. Requires shipper
|
|
|
5419
5427
|
<dd>
|
|
5420
5428
|
|
|
5421
5429
|
```typescript
|
|
5422
|
-
await client.integrations.airWaybills.
|
|
5430
|
+
await client.integrations.airWaybills.createV1({
|
|
5431
|
+
task_group_id: "task_group_id",
|
|
5432
|
+
});
|
|
5423
5433
|
```
|
|
5424
5434
|
|
|
5425
5435
|
</dd>
|
|
@@ -5435,7 +5445,7 @@ await client.integrations.airWaybills.pdfV1("task_group_id");
|
|
|
5435
5445
|
<dl>
|
|
5436
5446
|
<dd>
|
|
5437
5447
|
|
|
5438
|
-
**
|
|
5448
|
+
**request:** `Chrt.integrations.AirWaybillCreateReq`
|
|
5439
5449
|
|
|
5440
5450
|
</dd>
|
|
5441
5451
|
</dl>
|
|
@@ -5454,7 +5464,7 @@ await client.integrations.airWaybills.pdfV1("task_group_id");
|
|
|
5454
5464
|
</dl>
|
|
5455
5465
|
</details>
|
|
5456
5466
|
|
|
5457
|
-
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">
|
|
5467
|
+
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">flightStatusesV1</a>(taskGroupId) -> Chrt.ChampFlightStatus1[]</code></summary>
|
|
5458
5468
|
<dl>
|
|
5459
5469
|
<dd>
|
|
5460
5470
|
|
|
@@ -5466,7 +5476,7 @@ await client.integrations.airWaybills.pdfV1("task_group_id");
|
|
|
5466
5476
|
<dl>
|
|
5467
5477
|
<dd>
|
|
5468
5478
|
|
|
5469
|
-
Retrieves
|
|
5479
|
+
Retrieves all CHAMP flight status updates linked to the air waybill for a task group. | () -> (list[ChampFlightStatus1])
|
|
5470
5480
|
|
|
5471
5481
|
</dd>
|
|
5472
5482
|
</dl>
|
|
@@ -5482,7 +5492,7 @@ Retrieves the stored CHAMP air waybill for a task group. | () -> (ChampAirWaybil
|
|
|
5482
5492
|
<dd>
|
|
5483
5493
|
|
|
5484
5494
|
```typescript
|
|
5485
|
-
await client.integrations.airWaybills.
|
|
5495
|
+
await client.integrations.airWaybills.flightStatusesV1("task_group_id");
|
|
5486
5496
|
```
|
|
5487
5497
|
|
|
5488
5498
|
</dd>
|
|
@@ -5517,7 +5527,7 @@ await client.integrations.airWaybills.retrieveV1("task_group_id");
|
|
|
5517
5527
|
</dl>
|
|
5518
5528
|
</details>
|
|
5519
5529
|
|
|
5520
|
-
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">
|
|
5530
|
+
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">pdfV1</a>(taskGroupId) -> unknown</code></summary>
|
|
5521
5531
|
<dl>
|
|
5522
5532
|
<dd>
|
|
5523
5533
|
|
|
@@ -5529,7 +5539,7 @@ await client.integrations.airWaybills.retrieveV1("task_group_id");
|
|
|
5529
5539
|
<dl>
|
|
5530
5540
|
<dd>
|
|
5531
5541
|
|
|
5532
|
-
|
|
5542
|
+
Converts a CHAMP air waybill to PDF via CHAMP's conversion API. Requires shipper, consignee, and charge_declarations to be filled in. Returns the PDF file as application/pdf. | () -> (PDF binary)
|
|
5533
5543
|
|
|
5534
5544
|
</dd>
|
|
5535
5545
|
</dl>
|
|
@@ -5545,7 +5555,7 @@ Submits a draft CHAMP air waybill to Traxon cargoHUB. Requires shipper, consigne
|
|
|
5545
5555
|
<dd>
|
|
5546
5556
|
|
|
5547
5557
|
```typescript
|
|
5548
|
-
await client.integrations.airWaybills.
|
|
5558
|
+
await client.integrations.airWaybills.pdfV1("task_group_id");
|
|
5549
5559
|
```
|
|
5550
5560
|
|
|
5551
5561
|
</dd>
|
|
@@ -5580,7 +5590,7 @@ await client.integrations.airWaybills.submitV1("task_group_id");
|
|
|
5580
5590
|
</dl>
|
|
5581
5591
|
</details>
|
|
5582
5592
|
|
|
5583
|
-
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">
|
|
5593
|
+
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">retrieveV1</a>(taskGroupId) -> Chrt.ChampAirWaybill1</code></summary>
|
|
5584
5594
|
<dl>
|
|
5585
5595
|
<dd>
|
|
5586
5596
|
|
|
@@ -5592,7 +5602,7 @@ await client.integrations.airWaybills.submitV1("task_group_id");
|
|
|
5592
5602
|
<dl>
|
|
5593
5603
|
<dd>
|
|
5594
5604
|
|
|
5595
|
-
|
|
5605
|
+
Retrieves the stored CHAMP air waybill for a task group. | () -> (ChampAirWaybill1)
|
|
5596
5606
|
|
|
5597
5607
|
</dd>
|
|
5598
5608
|
</dl>
|
|
@@ -5608,7 +5618,7 @@ Updates fields on an existing CHAMP air waybill. Any editable field can be set
|
|
|
5608
5618
|
<dd>
|
|
5609
5619
|
|
|
5610
5620
|
```typescript
|
|
5611
|
-
await client.integrations.airWaybills.
|
|
5621
|
+
await client.integrations.airWaybills.retrieveV1("task_group_id");
|
|
5612
5622
|
```
|
|
5613
5623
|
|
|
5614
5624
|
</dd>
|
|
@@ -5632,14 +5642,6 @@ await client.integrations.airWaybills.updateV1("task_group_id");
|
|
|
5632
5642
|
<dl>
|
|
5633
5643
|
<dd>
|
|
5634
5644
|
|
|
5635
|
-
**request:** `Chrt.integrations.ChampAirWaybillClientUpdate1`
|
|
5636
|
-
|
|
5637
|
-
</dd>
|
|
5638
|
-
</dl>
|
|
5639
|
-
|
|
5640
|
-
<dl>
|
|
5641
|
-
<dd>
|
|
5642
|
-
|
|
5643
5645
|
**requestOptions:** `AirWaybills.RequestOptions`
|
|
5644
5646
|
|
|
5645
5647
|
</dd>
|
|
@@ -5651,9 +5653,7 @@ await client.integrations.airWaybills.updateV1("task_group_id");
|
|
|
5651
5653
|
</dl>
|
|
5652
5654
|
</details>
|
|
5653
5655
|
|
|
5654
|
-
|
|
5655
|
-
|
|
5656
|
-
<details><summary><code>client.integrations.cargoaiTrackAndTrace.<a href="/src/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.ts">subscribeV1</a>({ ...params }) -> Chrt.CargoAiTrackAndTraceSubscription1</code></summary>
|
|
5656
|
+
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">submitV1</a>(taskGroupId) -> Chrt.ChampAirWaybill1</code></summary>
|
|
5657
5657
|
<dl>
|
|
5658
5658
|
<dd>
|
|
5659
5659
|
|
|
@@ -5665,7 +5665,7 @@ await client.integrations.airWaybills.updateV1("task_group_id");
|
|
|
5665
5665
|
<dl>
|
|
5666
5666
|
<dd>
|
|
5667
5667
|
|
|
5668
|
-
|
|
5668
|
+
Submits a draft CHAMP air waybill to Traxon cargoHUB. Requires shipper, consignee, and charge_declarations to be filled in. Returns 422 if the AWB is not in draft status or required fields are missing. | () -> (ChampAirWaybill1)
|
|
5669
5669
|
|
|
5670
5670
|
</dd>
|
|
5671
5671
|
</dl>
|
|
@@ -5681,9 +5681,7 @@ Starts CargoAi Track & Trace URL + e-mail updates for an AWB (which must already
|
|
|
5681
5681
|
<dd>
|
|
5682
5682
|
|
|
5683
5683
|
```typescript
|
|
5684
|
-
await client.integrations.
|
|
5685
|
-
awb: "awb",
|
|
5686
|
-
});
|
|
5684
|
+
await client.integrations.airWaybills.submitV1("task_group_id");
|
|
5687
5685
|
```
|
|
5688
5686
|
|
|
5689
5687
|
</dd>
|
|
@@ -5699,7 +5697,7 @@ await client.integrations.cargoaiTrackAndTrace.subscribeV1({
|
|
|
5699
5697
|
<dl>
|
|
5700
5698
|
<dd>
|
|
5701
5699
|
|
|
5702
|
-
**
|
|
5700
|
+
**taskGroupId:** `string`
|
|
5703
5701
|
|
|
5704
5702
|
</dd>
|
|
5705
5703
|
</dl>
|
|
@@ -5707,7 +5705,7 @@ await client.integrations.cargoaiTrackAndTrace.subscribeV1({
|
|
|
5707
5705
|
<dl>
|
|
5708
5706
|
<dd>
|
|
5709
5707
|
|
|
5710
|
-
**requestOptions:** `
|
|
5708
|
+
**requestOptions:** `AirWaybills.RequestOptions`
|
|
5711
5709
|
|
|
5712
5710
|
</dd>
|
|
5713
5711
|
</dl>
|
|
@@ -5718,7 +5716,7 @@ await client.integrations.cargoaiTrackAndTrace.subscribeV1({
|
|
|
5718
5716
|
</dl>
|
|
5719
5717
|
</details>
|
|
5720
5718
|
|
|
5721
|
-
<details><summary><code>client.integrations.
|
|
5719
|
+
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">updateV1</a>(taskGroupId, { ...params }) -> Chrt.ChampAirWaybill1</code></summary>
|
|
5722
5720
|
<dl>
|
|
5723
5721
|
<dd>
|
|
5724
5722
|
|
|
@@ -5730,7 +5728,7 @@ await client.integrations.cargoaiTrackAndTrace.subscribeV1({
|
|
|
5730
5728
|
<dl>
|
|
5731
5729
|
<dd>
|
|
5732
5730
|
|
|
5733
|
-
|
|
5731
|
+
Updates fields on an existing CHAMP air waybill. Any editable field can be set — only fields included in the request body are changed. | (ChampAirWaybillClientUpdate1) -> (ChampAirWaybill1)
|
|
5734
5732
|
|
|
5735
5733
|
</dd>
|
|
5736
5734
|
</dl>
|
|
@@ -5746,7 +5744,7 @@ Retrieves the stored CargoAi tracking subscription for an AWB. | authz: order pa
|
|
|
5746
5744
|
<dd>
|
|
5747
5745
|
|
|
5748
5746
|
```typescript
|
|
5749
|
-
await client.integrations.
|
|
5747
|
+
await client.integrations.airWaybills.updateV1("task_group_id");
|
|
5750
5748
|
```
|
|
5751
5749
|
|
|
5752
5750
|
</dd>
|
|
@@ -5762,7 +5760,7 @@ await client.integrations.cargoaiTrackAndTrace.subscriptionV1("awb");
|
|
|
5762
5760
|
<dl>
|
|
5763
5761
|
<dd>
|
|
5764
5762
|
|
|
5765
|
-
**
|
|
5763
|
+
**taskGroupId:** `string`
|
|
5766
5764
|
|
|
5767
5765
|
</dd>
|
|
5768
5766
|
</dl>
|
|
@@ -5770,7 +5768,15 @@ await client.integrations.cargoaiTrackAndTrace.subscriptionV1("awb");
|
|
|
5770
5768
|
<dl>
|
|
5771
5769
|
<dd>
|
|
5772
5770
|
|
|
5773
|
-
**
|
|
5771
|
+
**request:** `Chrt.integrations.ChampAirWaybillClientUpdate1`
|
|
5772
|
+
|
|
5773
|
+
</dd>
|
|
5774
|
+
</dl>
|
|
5775
|
+
|
|
5776
|
+
<dl>
|
|
5777
|
+
<dd>
|
|
5778
|
+
|
|
5779
|
+
**requestOptions:** `AirWaybills.RequestOptions`
|
|
5774
5780
|
|
|
5775
5781
|
</dd>
|
|
5776
5782
|
</dl>
|
|
@@ -5781,7 +5787,9 @@ await client.integrations.cargoaiTrackAndTrace.subscriptionV1("awb");
|
|
|
5781
5787
|
</dl>
|
|
5782
5788
|
</details>
|
|
5783
5789
|
|
|
5784
|
-
|
|
5790
|
+
## Integrations CargoaiTrackAndTrace
|
|
5791
|
+
|
|
5792
|
+
<details><summary><code>client.integrations.cargoaiTrackAndTrace.<a href="/src/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.ts">subscribeV1</a>({ ...params }) -> Chrt.CargoAiTrackAndTraceSubscription1</code></summary>
|
|
5785
5793
|
<dl>
|
|
5786
5794
|
<dd>
|
|
5787
5795
|
|
|
@@ -5793,7 +5801,7 @@ await client.integrations.cargoaiTrackAndTrace.subscriptionV1("awb");
|
|
|
5793
5801
|
<dl>
|
|
5794
5802
|
<dd>
|
|
5795
5803
|
|
|
5796
|
-
|
|
5804
|
+
Starts CargoAi Track & Trace URL + e-mail updates for an AWB (which must already be recorded on a flight leg). Idempotent: re-subscribing a still-live AWB returns the existing subscription without calling CargoAi again. | authz: order participant operator | (CargoAiTrackAndTraceSubscribeReq) -> (CargoAiTrackAndTraceSubscription1)
|
|
5797
5805
|
|
|
5798
5806
|
</dd>
|
|
5799
5807
|
</dl>
|
|
@@ -5809,7 +5817,9 @@ Lists CargoAi tracking subscriptions for the AWBs recorded on a task group. | au
|
|
|
5809
5817
|
<dd>
|
|
5810
5818
|
|
|
5811
5819
|
```typescript
|
|
5812
|
-
await client.integrations.cargoaiTrackAndTrace.
|
|
5820
|
+
await client.integrations.cargoaiTrackAndTrace.subscribeV1({
|
|
5821
|
+
awb: "awb",
|
|
5822
|
+
});
|
|
5813
5823
|
```
|
|
5814
5824
|
|
|
5815
5825
|
</dd>
|
|
@@ -5825,7 +5835,7 @@ await client.integrations.cargoaiTrackAndTrace.subscriptionsByTaskGroupV1("task_
|
|
|
5825
5835
|
<dl>
|
|
5826
5836
|
<dd>
|
|
5827
5837
|
|
|
5828
|
-
**
|
|
5838
|
+
**request:** `Chrt.integrations.CargoAiTrackAndTraceSubscribeReq`
|
|
5829
5839
|
|
|
5830
5840
|
</dd>
|
|
5831
5841
|
</dl>
|
|
@@ -5844,7 +5854,7 @@ await client.integrations.cargoaiTrackAndTrace.subscriptionsByTaskGroupV1("task_
|
|
|
5844
5854
|
</dl>
|
|
5845
5855
|
</details>
|
|
5846
5856
|
|
|
5847
|
-
<details><summary><code>client.integrations.cargoaiTrackAndTrace.<a href="/src/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.ts">
|
|
5857
|
+
<details><summary><code>client.integrations.cargoaiTrackAndTrace.<a href="/src/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.ts">subscriptionV1</a>(awb) -> Chrt.CargoAiTrackAndTraceSubscription1</code></summary>
|
|
5848
5858
|
<dl>
|
|
5849
5859
|
<dd>
|
|
5850
5860
|
|
|
@@ -5856,7 +5866,7 @@ await client.integrations.cargoaiTrackAndTrace.subscriptionsByTaskGroupV1("task_
|
|
|
5856
5866
|
<dl>
|
|
5857
5867
|
<dd>
|
|
5858
5868
|
|
|
5859
|
-
Retrieves stored CargoAi tracking
|
|
5869
|
+
Retrieves the stored CargoAi tracking subscription for an AWB. | authz: order participant | () -> (CargoAiTrackAndTraceSubscription1)
|
|
5860
5870
|
|
|
5861
5871
|
</dd>
|
|
5862
5872
|
</dl>
|
|
@@ -5872,7 +5882,7 @@ Retrieves stored CargoAi tracking updates for an AWB, latest first (the first it
|
|
|
5872
5882
|
<dd>
|
|
5873
5883
|
|
|
5874
5884
|
```typescript
|
|
5875
|
-
await client.integrations.cargoaiTrackAndTrace.
|
|
5885
|
+
await client.integrations.cargoaiTrackAndTrace.subscriptionV1("awb");
|
|
5876
5886
|
```
|
|
5877
5887
|
|
|
5878
5888
|
</dd>
|
|
@@ -5907,9 +5917,7 @@ await client.integrations.cargoaiTrackAndTrace.updatesV1("awb");
|
|
|
5907
5917
|
</dl>
|
|
5908
5918
|
</details>
|
|
5909
5919
|
|
|
5910
|
-
|
|
5911
|
-
|
|
5912
|
-
<details><summary><code>client.integrations.webcargoBookings.<a href="/src/api/resources/integrations/resources/webcargoBookings/client/Client.ts">retrieveV1</a>(taskGroupId) -> Chrt.WebcargoBookingRecord1</code></summary>
|
|
5920
|
+
<details><summary><code>client.integrations.cargoaiTrackAndTrace.<a href="/src/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.ts">subscriptionsByTaskGroupV1</a>(taskGroupId) -> Chrt.CargoAiTrackAndTraceSubscription1[]</code></summary>
|
|
5913
5921
|
<dl>
|
|
5914
5922
|
<dd>
|
|
5915
5923
|
|
|
@@ -5921,7 +5929,7 @@ await client.integrations.cargoaiTrackAndTrace.updatesV1("awb");
|
|
|
5921
5929
|
<dl>
|
|
5922
5930
|
<dd>
|
|
5923
5931
|
|
|
5924
|
-
|
|
5932
|
+
Lists CargoAi tracking subscriptions for the AWBs recorded on a task group. | authz: order participant | () -> (list[CargoAiTrackAndTraceSubscription1])
|
|
5925
5933
|
|
|
5926
5934
|
</dd>
|
|
5927
5935
|
</dl>
|
|
@@ -5937,7 +5945,7 @@ Retrieves the stored WebCargo booking record for a task group. Returns 404 if th
|
|
|
5937
5945
|
<dd>
|
|
5938
5946
|
|
|
5939
5947
|
```typescript
|
|
5940
|
-
await client.integrations.
|
|
5948
|
+
await client.integrations.cargoaiTrackAndTrace.subscriptionsByTaskGroupV1("task_group_id");
|
|
5941
5949
|
```
|
|
5942
5950
|
|
|
5943
5951
|
</dd>
|
|
@@ -5961,7 +5969,7 @@ await client.integrations.webcargoBookings.retrieveV1("task_group_id");
|
|
|
5961
5969
|
<dl>
|
|
5962
5970
|
<dd>
|
|
5963
5971
|
|
|
5964
|
-
**requestOptions:** `
|
|
5972
|
+
**requestOptions:** `CargoaiTrackAndTrace.RequestOptions`
|
|
5965
5973
|
|
|
5966
5974
|
</dd>
|
|
5967
5975
|
</dl>
|
|
@@ -5972,7 +5980,7 @@ await client.integrations.webcargoBookings.retrieveV1("task_group_id");
|
|
|
5972
5980
|
</dl>
|
|
5973
5981
|
</details>
|
|
5974
5982
|
|
|
5975
|
-
<details><summary><code>client.integrations.
|
|
5983
|
+
<details><summary><code>client.integrations.cargoaiTrackAndTrace.<a href="/src/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.ts">updatesV1</a>(awb) -> Chrt.CargoAiTrackAndTraceUpdate1[]</code></summary>
|
|
5976
5984
|
<dl>
|
|
5977
5985
|
<dd>
|
|
5978
5986
|
|
|
@@ -5984,7 +5992,7 @@ await client.integrations.webcargoBookings.retrieveV1("task_group_id");
|
|
|
5984
5992
|
<dl>
|
|
5985
5993
|
<dd>
|
|
5986
5994
|
|
|
5987
|
-
|
|
5995
|
+
Retrieves stored CargoAi tracking updates for an AWB, latest first (the first item is the current state). | authz: order participant | () -> (list[CargoAiTrackAndTraceUpdate1])
|
|
5988
5996
|
|
|
5989
5997
|
</dd>
|
|
5990
5998
|
</dl>
|
|
@@ -6000,7 +6008,7 @@ Fetches the latest booking record from WebCargo for a task group and upserts it
|
|
|
6000
6008
|
<dd>
|
|
6001
6009
|
|
|
6002
6010
|
```typescript
|
|
6003
|
-
await client.integrations.
|
|
6011
|
+
await client.integrations.cargoaiTrackAndTrace.updatesV1("awb");
|
|
6004
6012
|
```
|
|
6005
6013
|
|
|
6006
6014
|
</dd>
|
|
@@ -6016,7 +6024,7 @@ await client.integrations.webcargoBookings.syncV1("task_group_id");
|
|
|
6016
6024
|
<dl>
|
|
6017
6025
|
<dd>
|
|
6018
6026
|
|
|
6019
|
-
**
|
|
6027
|
+
**awb:** `string` — IATA Air Waybill number: 3-digit airline prefix + 8-digit serial, e.g. '020-12345678'.
|
|
6020
6028
|
|
|
6021
6029
|
</dd>
|
|
6022
6030
|
</dl>
|
|
@@ -6024,7 +6032,7 @@ await client.integrations.webcargoBookings.syncV1("task_group_id");
|
|
|
6024
6032
|
<dl>
|
|
6025
6033
|
<dd>
|
|
6026
6034
|
|
|
6027
|
-
**requestOptions:** `
|
|
6035
|
+
**requestOptions:** `CargoaiTrackAndTrace.RequestOptions`
|
|
6028
6036
|
|
|
6029
6037
|
</dd>
|
|
6030
6038
|
</dl>
|
|
@@ -6035,9 +6043,9 @@ await client.integrations.webcargoBookings.syncV1("task_group_id");
|
|
|
6035
6043
|
</dl>
|
|
6036
6044
|
</details>
|
|
6037
6045
|
|
|
6038
|
-
## Integrations
|
|
6046
|
+
## Integrations WebcargoBookings
|
|
6039
6047
|
|
|
6040
|
-
<details><summary><code>client.integrations.
|
|
6048
|
+
<details><summary><code>client.integrations.webcargoBookings.<a href="/src/api/resources/integrations/resources/webcargoBookings/client/Client.ts">retrieveV1</a>(taskGroupId) -> Chrt.WebcargoBookingRecord1</code></summary>
|
|
6041
6049
|
<dl>
|
|
6042
6050
|
<dd>
|
|
6043
6051
|
|
|
@@ -6049,7 +6057,7 @@ await client.integrations.webcargoBookings.syncV1("task_group_id");
|
|
|
6049
6057
|
<dl>
|
|
6050
6058
|
<dd>
|
|
6051
6059
|
|
|
6052
|
-
|
|
6060
|
+
Retrieves the stored WebCargo booking record for a task group. Returns 404 if the booking has never been synced. | () -> (WebcargoBookingRecord1)
|
|
6053
6061
|
|
|
6054
6062
|
</dd>
|
|
6055
6063
|
</dl>
|
|
@@ -6065,12 +6073,7 @@ Generates a WebCargo Sky Embed token for a FLIGHT task group. Assembles cargo da
|
|
|
6065
6073
|
<dd>
|
|
6066
6074
|
|
|
6067
6075
|
```typescript
|
|
6068
|
-
await client.integrations.
|
|
6069
|
-
country: "country",
|
|
6070
|
-
departure: "departure",
|
|
6071
|
-
destination: "destination",
|
|
6072
|
-
origin: "origin",
|
|
6073
|
-
});
|
|
6076
|
+
await client.integrations.webcargoBookings.retrieveV1("task_group_id");
|
|
6074
6077
|
```
|
|
6075
6078
|
|
|
6076
6079
|
</dd>
|
|
@@ -6094,15 +6097,7 @@ await client.integrations.webcargoEmbed.getEmbedV1("task_group_id", {
|
|
|
6094
6097
|
<dl>
|
|
6095
6098
|
<dd>
|
|
6096
6099
|
|
|
6097
|
-
**
|
|
6098
|
-
|
|
6099
|
-
</dd>
|
|
6100
|
-
</dl>
|
|
6101
|
-
|
|
6102
|
-
<dl>
|
|
6103
|
-
<dd>
|
|
6104
|
-
|
|
6105
|
-
**requestOptions:** `WebcargoEmbed.RequestOptions`
|
|
6100
|
+
**requestOptions:** `WebcargoBookings.RequestOptions`
|
|
6106
6101
|
|
|
6107
6102
|
</dd>
|
|
6108
6103
|
</dl>
|
|
@@ -6113,9 +6108,7 @@ await client.integrations.webcargoEmbed.getEmbedV1("task_group_id", {
|
|
|
6113
6108
|
</dl>
|
|
6114
6109
|
</details>
|
|
6115
6110
|
|
|
6116
|
-
|
|
6117
|
-
|
|
6118
|
-
<details><summary><code>client.listing.bidThreads.<a href="/src/api/resources/listing/resources/bidThreads/client/Client.ts">acceptV1</a>(bidThreadId, { ...params }) -> boolean</code></summary>
|
|
6111
|
+
<details><summary><code>client.integrations.webcargoBookings.<a href="/src/api/resources/integrations/resources/webcargoBookings/client/Client.ts">syncV1</a>(taskGroupId) -> Chrt.WebcargoBookingRecord1</code></summary>
|
|
6119
6112
|
<dl>
|
|
6120
6113
|
<dd>
|
|
6121
6114
|
|
|
@@ -6127,7 +6120,7 @@ await client.integrations.webcargoEmbed.getEmbedV1("task_group_id", {
|
|
|
6127
6120
|
<dl>
|
|
6128
6121
|
<dd>
|
|
6129
6122
|
|
|
6130
|
-
|
|
6123
|
+
Fetches the latest booking record from WebCargo for a task group and upserts it in the database. Creates the record on first call, updates on subsequent calls. | () -> (WebcargoBookingRecord1)
|
|
6131
6124
|
|
|
6132
6125
|
</dd>
|
|
6133
6126
|
</dl>
|
|
@@ -6143,7 +6136,7 @@ Accepts an offer; lister acceptance awards immediately, while bidder acceptance
|
|
|
6143
6136
|
<dd>
|
|
6144
6137
|
|
|
6145
6138
|
```typescript
|
|
6146
|
-
await client.
|
|
6139
|
+
await client.integrations.webcargoBookings.syncV1("task_group_id");
|
|
6147
6140
|
```
|
|
6148
6141
|
|
|
6149
6142
|
</dd>
|
|
@@ -6159,15 +6152,7 @@ await client.listing.bidThreads.acceptV1("bid_thread_id", {});
|
|
|
6159
6152
|
<dl>
|
|
6160
6153
|
<dd>
|
|
6161
6154
|
|
|
6162
|
-
**
|
|
6163
|
-
|
|
6164
|
-
</dd>
|
|
6165
|
-
</dl>
|
|
6166
|
-
|
|
6167
|
-
<dl>
|
|
6168
|
-
<dd>
|
|
6169
|
-
|
|
6170
|
-
**request:** `Chrt.BidAppendReq`
|
|
6155
|
+
**taskGroupId:** `string`
|
|
6171
6156
|
|
|
6172
6157
|
</dd>
|
|
6173
6158
|
</dl>
|
|
@@ -6175,7 +6160,7 @@ await client.listing.bidThreads.acceptV1("bid_thread_id", {});
|
|
|
6175
6160
|
<dl>
|
|
6176
6161
|
<dd>
|
|
6177
6162
|
|
|
6178
|
-
**requestOptions:** `
|
|
6163
|
+
**requestOptions:** `WebcargoBookings.RequestOptions`
|
|
6179
6164
|
|
|
6180
6165
|
</dd>
|
|
6181
6166
|
</dl>
|
|
@@ -6186,7 +6171,9 @@ await client.listing.bidThreads.acceptV1("bid_thread_id", {});
|
|
|
6186
6171
|
</dl>
|
|
6187
6172
|
</details>
|
|
6188
6173
|
|
|
6189
|
-
|
|
6174
|
+
## Integrations WebcargoEmbed
|
|
6175
|
+
|
|
6176
|
+
<details><summary><code>client.integrations.webcargoEmbed.<a href="/src/api/resources/integrations/resources/webcargoEmbed/client/Client.ts">getEmbedV1</a>(taskGroupId, { ...params }) -> Chrt.WebcargoEmbedResponse</code></summary>
|
|
6190
6177
|
<dl>
|
|
6191
6178
|
<dd>
|
|
6192
6179
|
|
|
@@ -6198,7 +6185,7 @@ await client.listing.bidThreads.acceptV1("bid_thread_id", {});
|
|
|
6198
6185
|
<dl>
|
|
6199
6186
|
<dd>
|
|
6200
6187
|
|
|
6201
|
-
|
|
6188
|
+
Generates a WebCargo Sky Embed token for a FLIGHT task group. Assembles cargo data from the task group's tasks and returns an embed URL for the booking widget. | (GetWebcargoEmbedReq) -> (WebcargoEmbedResponse)
|
|
6202
6189
|
|
|
6203
6190
|
</dd>
|
|
6204
6191
|
</dl>
|
|
@@ -6214,7 +6201,12 @@ Fetches a bid thread by id. Visible to the lister, the bidder org (provider), an
|
|
|
6214
6201
|
<dd>
|
|
6215
6202
|
|
|
6216
6203
|
```typescript
|
|
6217
|
-
await client.
|
|
6204
|
+
await client.integrations.webcargoEmbed.getEmbedV1("task_group_id", {
|
|
6205
|
+
country: "country",
|
|
6206
|
+
departure: "departure",
|
|
6207
|
+
destination: "destination",
|
|
6208
|
+
origin: "origin",
|
|
6209
|
+
});
|
|
6218
6210
|
```
|
|
6219
6211
|
|
|
6220
6212
|
</dd>
|
|
@@ -6230,70 +6222,15 @@ await client.listing.bidThreads.byIdV1("bid_thread_id");
|
|
|
6230
6222
|
<dl>
|
|
6231
6223
|
<dd>
|
|
6232
6224
|
|
|
6233
|
-
**
|
|
6234
|
-
|
|
6235
|
-
</dd>
|
|
6236
|
-
</dl>
|
|
6237
|
-
|
|
6238
|
-
<dl>
|
|
6239
|
-
<dd>
|
|
6240
|
-
|
|
6241
|
-
**requestOptions:** `BidThreads.RequestOptions`
|
|
6242
|
-
|
|
6243
|
-
</dd>
|
|
6244
|
-
</dl>
|
|
6245
|
-
</dd>
|
|
6246
|
-
</dl>
|
|
6247
|
-
|
|
6248
|
-
</dd>
|
|
6249
|
-
</dl>
|
|
6250
|
-
</details>
|
|
6251
|
-
|
|
6252
|
-
<details><summary><code>client.listing.bidThreads.<a href="/src/api/resources/listing/resources/bidThreads/client/Client.ts">confirmAcceptV1</a>(bidThreadId) -> boolean</code></summary>
|
|
6253
|
-
<dl>
|
|
6254
|
-
<dd>
|
|
6255
|
-
|
|
6256
|
-
#### 📝 Description
|
|
6257
|
-
|
|
6258
|
-
<dl>
|
|
6259
|
-
<dd>
|
|
6260
|
-
|
|
6261
|
-
<dl>
|
|
6262
|
-
<dd>
|
|
6263
|
-
|
|
6264
|
-
Confirms a pending bidder acceptance and awards at its recorded price. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (bool)
|
|
6265
|
-
|
|
6266
|
-
</dd>
|
|
6267
|
-
</dl>
|
|
6268
|
-
</dd>
|
|
6269
|
-
</dl>
|
|
6270
|
-
|
|
6271
|
-
#### 🔌 Usage
|
|
6272
|
-
|
|
6273
|
-
<dl>
|
|
6274
|
-
<dd>
|
|
6275
|
-
|
|
6276
|
-
<dl>
|
|
6277
|
-
<dd>
|
|
6278
|
-
|
|
6279
|
-
```typescript
|
|
6280
|
-
await client.listing.bidThreads.confirmAcceptV1("bid_thread_id");
|
|
6281
|
-
```
|
|
6225
|
+
**taskGroupId:** `string`
|
|
6282
6226
|
|
|
6283
|
-
</dd>
|
|
6284
|
-
</dl>
|
|
6285
6227
|
</dd>
|
|
6286
6228
|
</dl>
|
|
6287
6229
|
|
|
6288
|
-
#### ⚙️ Parameters
|
|
6289
|
-
|
|
6290
|
-
<dl>
|
|
6291
|
-
<dd>
|
|
6292
|
-
|
|
6293
6230
|
<dl>
|
|
6294
6231
|
<dd>
|
|
6295
6232
|
|
|
6296
|
-
**
|
|
6233
|
+
**request:** `Chrt.integrations.GetWebcargoEmbedReq`
|
|
6297
6234
|
|
|
6298
6235
|
</dd>
|
|
6299
6236
|
</dl>
|
|
@@ -6301,7 +6238,7 @@ await client.listing.bidThreads.confirmAcceptV1("bid_thread_id");
|
|
|
6301
6238
|
<dl>
|
|
6302
6239
|
<dd>
|
|
6303
6240
|
|
|
6304
|
-
**requestOptions:** `
|
|
6241
|
+
**requestOptions:** `WebcargoEmbed.RequestOptions`
|
|
6305
6242
|
|
|
6306
6243
|
</dd>
|
|
6307
6244
|
</dl>
|
|
@@ -6312,7 +6249,9 @@ await client.listing.bidThreads.confirmAcceptV1("bid_thread_id");
|
|
|
6312
6249
|
</dl>
|
|
6313
6250
|
</details>
|
|
6314
6251
|
|
|
6315
|
-
|
|
6252
|
+
## Listing BidThreads
|
|
6253
|
+
|
|
6254
|
+
<details><summary><code>client.listing.bidThreads.<a href="/src/api/resources/listing/resources/bidThreads/client/Client.ts">acceptV1</a>(bidThreadId, { ...params }) -> boolean</code></summary>
|
|
6316
6255
|
<dl>
|
|
6317
6256
|
<dd>
|
|
6318
6257
|
|
|
@@ -6324,7 +6263,7 @@ await client.listing.bidThreads.confirmAcceptV1("bid_thread_id");
|
|
|
6324
6263
|
<dl>
|
|
6325
6264
|
<dd>
|
|
6326
6265
|
|
|
6327
|
-
|
|
6266
|
+
Accepts an offer; lister acceptance awards immediately, while bidder acceptance follows the listing's auto-award setting. | authz: allowed_org_types=[provider], min_org_role=member; lister min_org_role=operator | (BidAppendReq) -> (bool)
|
|
6328
6267
|
|
|
6329
6268
|
</dd>
|
|
6330
6269
|
</dl>
|
|
@@ -6340,7 +6279,7 @@ Adds a counteroffer to an open negotiation. | authz: allowed_org_types=[provider
|
|
|
6340
6279
|
<dd>
|
|
6341
6280
|
|
|
6342
6281
|
```typescript
|
|
6343
|
-
await client.listing.bidThreads.
|
|
6282
|
+
await client.listing.bidThreads.acceptV1("bid_thread_id", {});
|
|
6344
6283
|
```
|
|
6345
6284
|
|
|
6346
6285
|
</dd>
|
|
@@ -6383,7 +6322,7 @@ await client.listing.bidThreads.counterV1("bid_thread_id", {});
|
|
|
6383
6322
|
</dl>
|
|
6384
6323
|
</details>
|
|
6385
6324
|
|
|
6386
|
-
<details><summary><code>client.listing.bidThreads.<a href="/src/api/resources/listing/resources/bidThreads/client/Client.ts">
|
|
6325
|
+
<details><summary><code>client.listing.bidThreads.<a href="/src/api/resources/listing/resources/bidThreads/client/Client.ts">byIdV1</a>(bidThreadId) -> Chrt.BidThread1</code></summary>
|
|
6387
6326
|
<dl>
|
|
6388
6327
|
<dd>
|
|
6389
6328
|
|
|
@@ -6395,7 +6334,7 @@ await client.listing.bidThreads.counterV1("bid_thread_id", {});
|
|
|
6395
6334
|
<dl>
|
|
6396
6335
|
<dd>
|
|
6397
6336
|
|
|
6398
|
-
|
|
6337
|
+
Fetches a bid thread by id. Visible to the lister, the bidder org (provider), and the bidder driver. | authz: allowed_org_types=[provider], min_org_role=driver | () -> (BidThread1)
|
|
6399
6338
|
|
|
6400
6339
|
</dd>
|
|
6401
6340
|
</dl>
|
|
@@ -6411,10 +6350,7 @@ Opens a bid thread with an offer, acceptance, or denial. | authz: allowed_org_ty
|
|
|
6411
6350
|
<dd>
|
|
6412
6351
|
|
|
6413
6352
|
```typescript
|
|
6414
|
-
await client.listing.bidThreads.
|
|
6415
|
-
action: "submit",
|
|
6416
|
-
listing_id: "listing_id",
|
|
6417
|
-
});
|
|
6353
|
+
await client.listing.bidThreads.byIdV1("bid_thread_id");
|
|
6418
6354
|
```
|
|
6419
6355
|
|
|
6420
6356
|
</dd>
|
|
@@ -6430,7 +6366,7 @@ await client.listing.bidThreads.createV1({
|
|
|
6430
6366
|
<dl>
|
|
6431
6367
|
<dd>
|
|
6432
6368
|
|
|
6433
|
-
**
|
|
6369
|
+
**bidThreadId:** `string`
|
|
6434
6370
|
|
|
6435
6371
|
</dd>
|
|
6436
6372
|
</dl>
|
|
@@ -6449,7 +6385,7 @@ await client.listing.bidThreads.createV1({
|
|
|
6449
6385
|
</dl>
|
|
6450
6386
|
</details>
|
|
6451
6387
|
|
|
6452
|
-
<details><summary><code>client.listing.bidThreads.<a href="/src/api/resources/listing/resources/bidThreads/client/Client.ts">
|
|
6388
|
+
<details><summary><code>client.listing.bidThreads.<a href="/src/api/resources/listing/resources/bidThreads/client/Client.ts">confirmAcceptV1</a>(bidThreadId) -> boolean</code></summary>
|
|
6453
6389
|
<dl>
|
|
6454
6390
|
<dd>
|
|
6455
6391
|
|
|
@@ -6461,7 +6397,7 @@ await client.listing.bidThreads.createV1({
|
|
|
6461
6397
|
<dl>
|
|
6462
6398
|
<dd>
|
|
6463
6399
|
|
|
6464
|
-
|
|
6400
|
+
Confirms a pending bidder acceptance and awards at its recorded price. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (bool)
|
|
6465
6401
|
|
|
6466
6402
|
</dd>
|
|
6467
6403
|
</dl>
|
|
@@ -6477,7 +6413,207 @@ Declines an open negotiation and closes its thread. | authz: allowed_org_types=[
|
|
|
6477
6413
|
<dd>
|
|
6478
6414
|
|
|
6479
6415
|
```typescript
|
|
6480
|
-
await client.listing.bidThreads.
|
|
6416
|
+
await client.listing.bidThreads.confirmAcceptV1("bid_thread_id");
|
|
6417
|
+
```
|
|
6418
|
+
|
|
6419
|
+
</dd>
|
|
6420
|
+
</dl>
|
|
6421
|
+
</dd>
|
|
6422
|
+
</dl>
|
|
6423
|
+
|
|
6424
|
+
#### ⚙️ Parameters
|
|
6425
|
+
|
|
6426
|
+
<dl>
|
|
6427
|
+
<dd>
|
|
6428
|
+
|
|
6429
|
+
<dl>
|
|
6430
|
+
<dd>
|
|
6431
|
+
|
|
6432
|
+
**bidThreadId:** `string`
|
|
6433
|
+
|
|
6434
|
+
</dd>
|
|
6435
|
+
</dl>
|
|
6436
|
+
|
|
6437
|
+
<dl>
|
|
6438
|
+
<dd>
|
|
6439
|
+
|
|
6440
|
+
**requestOptions:** `BidThreads.RequestOptions`
|
|
6441
|
+
|
|
6442
|
+
</dd>
|
|
6443
|
+
</dl>
|
|
6444
|
+
</dd>
|
|
6445
|
+
</dl>
|
|
6446
|
+
|
|
6447
|
+
</dd>
|
|
6448
|
+
</dl>
|
|
6449
|
+
</details>
|
|
6450
|
+
|
|
6451
|
+
<details><summary><code>client.listing.bidThreads.<a href="/src/api/resources/listing/resources/bidThreads/client/Client.ts">counterV1</a>(bidThreadId, { ...params }) -> boolean</code></summary>
|
|
6452
|
+
<dl>
|
|
6453
|
+
<dd>
|
|
6454
|
+
|
|
6455
|
+
#### 📝 Description
|
|
6456
|
+
|
|
6457
|
+
<dl>
|
|
6458
|
+
<dd>
|
|
6459
|
+
|
|
6460
|
+
<dl>
|
|
6461
|
+
<dd>
|
|
6462
|
+
|
|
6463
|
+
Adds a counteroffer to an open negotiation. | authz: allowed_org_types=[provider], min_org_role=member | (BidAppendReq) -> (bool)
|
|
6464
|
+
|
|
6465
|
+
</dd>
|
|
6466
|
+
</dl>
|
|
6467
|
+
</dd>
|
|
6468
|
+
</dl>
|
|
6469
|
+
|
|
6470
|
+
#### 🔌 Usage
|
|
6471
|
+
|
|
6472
|
+
<dl>
|
|
6473
|
+
<dd>
|
|
6474
|
+
|
|
6475
|
+
<dl>
|
|
6476
|
+
<dd>
|
|
6477
|
+
|
|
6478
|
+
```typescript
|
|
6479
|
+
await client.listing.bidThreads.counterV1("bid_thread_id", {});
|
|
6480
|
+
```
|
|
6481
|
+
|
|
6482
|
+
</dd>
|
|
6483
|
+
</dl>
|
|
6484
|
+
</dd>
|
|
6485
|
+
</dl>
|
|
6486
|
+
|
|
6487
|
+
#### ⚙️ Parameters
|
|
6488
|
+
|
|
6489
|
+
<dl>
|
|
6490
|
+
<dd>
|
|
6491
|
+
|
|
6492
|
+
<dl>
|
|
6493
|
+
<dd>
|
|
6494
|
+
|
|
6495
|
+
**bidThreadId:** `string`
|
|
6496
|
+
|
|
6497
|
+
</dd>
|
|
6498
|
+
</dl>
|
|
6499
|
+
|
|
6500
|
+
<dl>
|
|
6501
|
+
<dd>
|
|
6502
|
+
|
|
6503
|
+
**request:** `Chrt.BidAppendReq`
|
|
6504
|
+
|
|
6505
|
+
</dd>
|
|
6506
|
+
</dl>
|
|
6507
|
+
|
|
6508
|
+
<dl>
|
|
6509
|
+
<dd>
|
|
6510
|
+
|
|
6511
|
+
**requestOptions:** `BidThreads.RequestOptions`
|
|
6512
|
+
|
|
6513
|
+
</dd>
|
|
6514
|
+
</dl>
|
|
6515
|
+
</dd>
|
|
6516
|
+
</dl>
|
|
6517
|
+
|
|
6518
|
+
</dd>
|
|
6519
|
+
</dl>
|
|
6520
|
+
</details>
|
|
6521
|
+
|
|
6522
|
+
<details><summary><code>client.listing.bidThreads.<a href="/src/api/resources/listing/resources/bidThreads/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
6523
|
+
<dl>
|
|
6524
|
+
<dd>
|
|
6525
|
+
|
|
6526
|
+
#### 📝 Description
|
|
6527
|
+
|
|
6528
|
+
<dl>
|
|
6529
|
+
<dd>
|
|
6530
|
+
|
|
6531
|
+
<dl>
|
|
6532
|
+
<dd>
|
|
6533
|
+
|
|
6534
|
+
Opens a bid thread with an offer, acceptance, or denial. | authz: allowed_org_types=[provider], min_org_role=member | (BidThreadClientCreate1) -> (PydanticObjectId)
|
|
6535
|
+
|
|
6536
|
+
</dd>
|
|
6537
|
+
</dl>
|
|
6538
|
+
</dd>
|
|
6539
|
+
</dl>
|
|
6540
|
+
|
|
6541
|
+
#### 🔌 Usage
|
|
6542
|
+
|
|
6543
|
+
<dl>
|
|
6544
|
+
<dd>
|
|
6545
|
+
|
|
6546
|
+
<dl>
|
|
6547
|
+
<dd>
|
|
6548
|
+
|
|
6549
|
+
```typescript
|
|
6550
|
+
await client.listing.bidThreads.createV1({
|
|
6551
|
+
action: "submit",
|
|
6552
|
+
listing_id: "listing_id",
|
|
6553
|
+
});
|
|
6554
|
+
```
|
|
6555
|
+
|
|
6556
|
+
</dd>
|
|
6557
|
+
</dl>
|
|
6558
|
+
</dd>
|
|
6559
|
+
</dl>
|
|
6560
|
+
|
|
6561
|
+
#### ⚙️ Parameters
|
|
6562
|
+
|
|
6563
|
+
<dl>
|
|
6564
|
+
<dd>
|
|
6565
|
+
|
|
6566
|
+
<dl>
|
|
6567
|
+
<dd>
|
|
6568
|
+
|
|
6569
|
+
**request:** `Chrt.listing.BidThreadClientCreate1`
|
|
6570
|
+
|
|
6571
|
+
</dd>
|
|
6572
|
+
</dl>
|
|
6573
|
+
|
|
6574
|
+
<dl>
|
|
6575
|
+
<dd>
|
|
6576
|
+
|
|
6577
|
+
**requestOptions:** `BidThreads.RequestOptions`
|
|
6578
|
+
|
|
6579
|
+
</dd>
|
|
6580
|
+
</dl>
|
|
6581
|
+
</dd>
|
|
6582
|
+
</dl>
|
|
6583
|
+
|
|
6584
|
+
</dd>
|
|
6585
|
+
</dl>
|
|
6586
|
+
</details>
|
|
6587
|
+
|
|
6588
|
+
<details><summary><code>client.listing.bidThreads.<a href="/src/api/resources/listing/resources/bidThreads/client/Client.ts">denyV1</a>(bidThreadId, { ...params }) -> boolean</code></summary>
|
|
6589
|
+
<dl>
|
|
6590
|
+
<dd>
|
|
6591
|
+
|
|
6592
|
+
#### 📝 Description
|
|
6593
|
+
|
|
6594
|
+
<dl>
|
|
6595
|
+
<dd>
|
|
6596
|
+
|
|
6597
|
+
<dl>
|
|
6598
|
+
<dd>
|
|
6599
|
+
|
|
6600
|
+
Declines an open negotiation and closes its thread. | authz: allowed_org_types=[provider], min_org_role=member | (BidAppendReq) -> (bool)
|
|
6601
|
+
|
|
6602
|
+
</dd>
|
|
6603
|
+
</dl>
|
|
6604
|
+
</dd>
|
|
6605
|
+
</dl>
|
|
6606
|
+
|
|
6607
|
+
#### 🔌 Usage
|
|
6608
|
+
|
|
6609
|
+
<dl>
|
|
6610
|
+
<dd>
|
|
6611
|
+
|
|
6612
|
+
<dl>
|
|
6613
|
+
<dd>
|
|
6614
|
+
|
|
6615
|
+
```typescript
|
|
6616
|
+
await client.listing.bidThreads.denyV1("bid_thread_id", {});
|
|
6481
6617
|
```
|
|
6482
6618
|
|
|
6483
6619
|
</dd>
|
|
@@ -14337,6 +14473,79 @@ await client.orgs.connections.setShipperCoordinatorDefaultDepartmentV1("connecti
|
|
|
14337
14473
|
</dl>
|
|
14338
14474
|
</details>
|
|
14339
14475
|
|
|
14476
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">setShipperCoordinatorKnownShipperV1</a>(connectionId, { ...params }) -> boolean</code></summary>
|
|
14477
|
+
<dl>
|
|
14478
|
+
<dd>
|
|
14479
|
+
|
|
14480
|
+
#### 📝 Description
|
|
14481
|
+
|
|
14482
|
+
<dl>
|
|
14483
|
+
<dd>
|
|
14484
|
+
|
|
14485
|
+
<dl>
|
|
14486
|
+
<dd>
|
|
14487
|
+
|
|
14488
|
+
Sets the coordinator's known-shipper designation for an on- or off-CHRT shipper and records who changed it and when. | authz: allowed_org_types=[provider], min_org_role=operator | (ShipperCoordinatorUpdateKnownShipperReq) -> (bool)
|
|
14489
|
+
|
|
14490
|
+
</dd>
|
|
14491
|
+
</dl>
|
|
14492
|
+
</dd>
|
|
14493
|
+
</dl>
|
|
14494
|
+
|
|
14495
|
+
#### 🔌 Usage
|
|
14496
|
+
|
|
14497
|
+
<dl>
|
|
14498
|
+
<dd>
|
|
14499
|
+
|
|
14500
|
+
<dl>
|
|
14501
|
+
<dd>
|
|
14502
|
+
|
|
14503
|
+
```typescript
|
|
14504
|
+
await client.orgs.connections.setShipperCoordinatorKnownShipperV1("connection_id", {
|
|
14505
|
+
known_shipper: true,
|
|
14506
|
+
});
|
|
14507
|
+
```
|
|
14508
|
+
|
|
14509
|
+
</dd>
|
|
14510
|
+
</dl>
|
|
14511
|
+
</dd>
|
|
14512
|
+
</dl>
|
|
14513
|
+
|
|
14514
|
+
#### ⚙️ Parameters
|
|
14515
|
+
|
|
14516
|
+
<dl>
|
|
14517
|
+
<dd>
|
|
14518
|
+
|
|
14519
|
+
<dl>
|
|
14520
|
+
<dd>
|
|
14521
|
+
|
|
14522
|
+
**connectionId:** `string`
|
|
14523
|
+
|
|
14524
|
+
</dd>
|
|
14525
|
+
</dl>
|
|
14526
|
+
|
|
14527
|
+
<dl>
|
|
14528
|
+
<dd>
|
|
14529
|
+
|
|
14530
|
+
**request:** `Chrt.orgs.ShipperCoordinatorUpdateKnownShipperReq`
|
|
14531
|
+
|
|
14532
|
+
</dd>
|
|
14533
|
+
</dl>
|
|
14534
|
+
|
|
14535
|
+
<dl>
|
|
14536
|
+
<dd>
|
|
14537
|
+
|
|
14538
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
14539
|
+
|
|
14540
|
+
</dd>
|
|
14541
|
+
</dl>
|
|
14542
|
+
</dd>
|
|
14543
|
+
</dl>
|
|
14544
|
+
|
|
14545
|
+
</dd>
|
|
14546
|
+
</dl>
|
|
14547
|
+
</details>
|
|
14548
|
+
|
|
14340
14549
|
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listShippersForCoordinatorV1</a>({ ...params }) -> Chrt.ShipperCoordinatorConnectionsForCoordinatorListRes</code></summary>
|
|
14341
14550
|
<dl>
|
|
14342
14551
|
<dd>
|
|
@@ -14371,6 +14580,7 @@ await client.orgs.connections.listShippersForCoordinatorV1({
|
|
|
14371
14580
|
page_size: 1,
|
|
14372
14581
|
filter_connection_ids: ["filter_connection_ids"],
|
|
14373
14582
|
filter_connected: true,
|
|
14583
|
+
filter_known_shipper: true,
|
|
14374
14584
|
});
|
|
14375
14585
|
```
|
|
14376
14586
|
|
|
@@ -16462,6 +16672,262 @@ await client.orgs.connections.shippers.typeaheadV1({
|
|
|
16462
16672
|
</dl>
|
|
16463
16673
|
</details>
|
|
16464
16674
|
|
|
16675
|
+
## Orgs PublicData S3Object
|
|
16676
|
+
|
|
16677
|
+
<details><summary><code>client.orgs.publicData.s3Object.<a href="/src/api/resources/orgs/resources/publicData/resources/s3Object/client/Client.ts">addV1</a>({ ...params }) -> Chrt.OrgPublicDataS3ObjectMetadata1</code></summary>
|
|
16678
|
+
<dl>
|
|
16679
|
+
<dd>
|
|
16680
|
+
|
|
16681
|
+
#### 📝 Description
|
|
16682
|
+
|
|
16683
|
+
<dl>
|
|
16684
|
+
<dd>
|
|
16685
|
+
|
|
16686
|
+
<dl>
|
|
16687
|
+
<dd>
|
|
16688
|
+
|
|
16689
|
+
Uploads a file, such as a logo, to the caller's organization public data. Retains uploaded files; previews require a clean malware scan. | authz: min_org_role=operator | (UploadFile) -> (OrgPublicDataS3ObjectMetadata1)
|
|
16690
|
+
|
|
16691
|
+
</dd>
|
|
16692
|
+
</dl>
|
|
16693
|
+
</dd>
|
|
16694
|
+
</dl>
|
|
16695
|
+
|
|
16696
|
+
#### 🔌 Usage
|
|
16697
|
+
|
|
16698
|
+
<dl>
|
|
16699
|
+
<dd>
|
|
16700
|
+
|
|
16701
|
+
<dl>
|
|
16702
|
+
<dd>
|
|
16703
|
+
|
|
16704
|
+
```typescript
|
|
16705
|
+
await client.orgs.publicData.s3Object.addV1({
|
|
16706
|
+
file: fs.createReadStream("/path/to/your/file"),
|
|
16707
|
+
});
|
|
16708
|
+
```
|
|
16709
|
+
|
|
16710
|
+
</dd>
|
|
16711
|
+
</dl>
|
|
16712
|
+
</dd>
|
|
16713
|
+
</dl>
|
|
16714
|
+
|
|
16715
|
+
#### ⚙️ Parameters
|
|
16716
|
+
|
|
16717
|
+
<dl>
|
|
16718
|
+
<dd>
|
|
16719
|
+
|
|
16720
|
+
<dl>
|
|
16721
|
+
<dd>
|
|
16722
|
+
|
|
16723
|
+
**request:** `Chrt.orgs.publicData.BodyPostOrgPublicDataS3ObjectAddV1`
|
|
16724
|
+
|
|
16725
|
+
</dd>
|
|
16726
|
+
</dl>
|
|
16727
|
+
|
|
16728
|
+
<dl>
|
|
16729
|
+
<dd>
|
|
16730
|
+
|
|
16731
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
16732
|
+
|
|
16733
|
+
</dd>
|
|
16734
|
+
</dl>
|
|
16735
|
+
</dd>
|
|
16736
|
+
</dl>
|
|
16737
|
+
|
|
16738
|
+
</dd>
|
|
16739
|
+
</dl>
|
|
16740
|
+
</details>
|
|
16741
|
+
|
|
16742
|
+
<details><summary><code>client.orgs.publicData.s3Object.<a href="/src/api/resources/orgs/resources/publicData/resources/s3Object/client/Client.ts">deleteV1</a>(orgPublicDataS3ObjectMetadataId) -> boolean</code></summary>
|
|
16743
|
+
<dl>
|
|
16744
|
+
<dd>
|
|
16745
|
+
|
|
16746
|
+
#### 📝 Description
|
|
16747
|
+
|
|
16748
|
+
<dl>
|
|
16749
|
+
<dd>
|
|
16750
|
+
|
|
16751
|
+
<dl>
|
|
16752
|
+
<dd>
|
|
16753
|
+
|
|
16754
|
+
Deletes an S3 object and its metadata from the caller's organization public data. | authz: min_org_role=operator | () -> (bool)
|
|
16755
|
+
|
|
16756
|
+
</dd>
|
|
16757
|
+
</dl>
|
|
16758
|
+
</dd>
|
|
16759
|
+
</dl>
|
|
16760
|
+
|
|
16761
|
+
#### 🔌 Usage
|
|
16762
|
+
|
|
16763
|
+
<dl>
|
|
16764
|
+
<dd>
|
|
16765
|
+
|
|
16766
|
+
<dl>
|
|
16767
|
+
<dd>
|
|
16768
|
+
|
|
16769
|
+
```typescript
|
|
16770
|
+
await client.orgs.publicData.s3Object.deleteV1("org_public_data_s3_object_metadata_id");
|
|
16771
|
+
```
|
|
16772
|
+
|
|
16773
|
+
</dd>
|
|
16774
|
+
</dl>
|
|
16775
|
+
</dd>
|
|
16776
|
+
</dl>
|
|
16777
|
+
|
|
16778
|
+
#### ⚙️ Parameters
|
|
16779
|
+
|
|
16780
|
+
<dl>
|
|
16781
|
+
<dd>
|
|
16782
|
+
|
|
16783
|
+
<dl>
|
|
16784
|
+
<dd>
|
|
16785
|
+
|
|
16786
|
+
**orgPublicDataS3ObjectMetadataId:** `string`
|
|
16787
|
+
|
|
16788
|
+
</dd>
|
|
16789
|
+
</dl>
|
|
16790
|
+
|
|
16791
|
+
<dl>
|
|
16792
|
+
<dd>
|
|
16793
|
+
|
|
16794
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
16795
|
+
|
|
16796
|
+
</dd>
|
|
16797
|
+
</dl>
|
|
16798
|
+
</dd>
|
|
16799
|
+
</dl>
|
|
16800
|
+
|
|
16801
|
+
</dd>
|
|
16802
|
+
</dl>
|
|
16803
|
+
</details>
|
|
16804
|
+
|
|
16805
|
+
<details><summary><code>client.orgs.publicData.s3Object.<a href="/src/api/resources/orgs/resources/publicData/resources/s3Object/client/Client.ts">getS3ObjectMetadataV1</a>(orgPublicDataS3ObjectMetadataId) -> Chrt.OrgPublicDataS3ObjectMetadata1</code></summary>
|
|
16806
|
+
<dl>
|
|
16807
|
+
<dd>
|
|
16808
|
+
|
|
16809
|
+
#### 📝 Description
|
|
16810
|
+
|
|
16811
|
+
<dl>
|
|
16812
|
+
<dd>
|
|
16813
|
+
|
|
16814
|
+
<dl>
|
|
16815
|
+
<dd>
|
|
16816
|
+
|
|
16817
|
+
Retrieves metadata for an organization public data S3 object. | () -> (OrgPublicDataS3ObjectMetadata1)
|
|
16818
|
+
|
|
16819
|
+
</dd>
|
|
16820
|
+
</dl>
|
|
16821
|
+
</dd>
|
|
16822
|
+
</dl>
|
|
16823
|
+
|
|
16824
|
+
#### 🔌 Usage
|
|
16825
|
+
|
|
16826
|
+
<dl>
|
|
16827
|
+
<dd>
|
|
16828
|
+
|
|
16829
|
+
<dl>
|
|
16830
|
+
<dd>
|
|
16831
|
+
|
|
16832
|
+
```typescript
|
|
16833
|
+
await client.orgs.publicData.s3Object.getS3ObjectMetadataV1("org_public_data_s3_object_metadata_id");
|
|
16834
|
+
```
|
|
16835
|
+
|
|
16836
|
+
</dd>
|
|
16837
|
+
</dl>
|
|
16838
|
+
</dd>
|
|
16839
|
+
</dl>
|
|
16840
|
+
|
|
16841
|
+
#### ⚙️ Parameters
|
|
16842
|
+
|
|
16843
|
+
<dl>
|
|
16844
|
+
<dd>
|
|
16845
|
+
|
|
16846
|
+
<dl>
|
|
16847
|
+
<dd>
|
|
16848
|
+
|
|
16849
|
+
**orgPublicDataS3ObjectMetadataId:** `string`
|
|
16850
|
+
|
|
16851
|
+
</dd>
|
|
16852
|
+
</dl>
|
|
16853
|
+
|
|
16854
|
+
<dl>
|
|
16855
|
+
<dd>
|
|
16856
|
+
|
|
16857
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
16858
|
+
|
|
16859
|
+
</dd>
|
|
16860
|
+
</dl>
|
|
16861
|
+
</dd>
|
|
16862
|
+
</dl>
|
|
16863
|
+
|
|
16864
|
+
</dd>
|
|
16865
|
+
</dl>
|
|
16866
|
+
</details>
|
|
16867
|
+
|
|
16868
|
+
<details><summary><code>client.orgs.publicData.s3Object.<a href="/src/api/resources/orgs/resources/publicData/resources/s3Object/client/Client.ts">getV1</a>(orgPublicDataS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
|
|
16869
|
+
<dl>
|
|
16870
|
+
<dd>
|
|
16871
|
+
|
|
16872
|
+
#### 📝 Description
|
|
16873
|
+
|
|
16874
|
+
<dl>
|
|
16875
|
+
<dd>
|
|
16876
|
+
|
|
16877
|
+
<dl>
|
|
16878
|
+
<dd>
|
|
16879
|
+
|
|
16880
|
+
Streams an organization public data S3 object file from storage. | () -> (binary)
|
|
16881
|
+
|
|
16882
|
+
</dd>
|
|
16883
|
+
</dl>
|
|
16884
|
+
</dd>
|
|
16885
|
+
</dl>
|
|
16886
|
+
|
|
16887
|
+
#### 🔌 Usage
|
|
16888
|
+
|
|
16889
|
+
<dl>
|
|
16890
|
+
<dd>
|
|
16891
|
+
|
|
16892
|
+
<dl>
|
|
16893
|
+
<dd>
|
|
16894
|
+
|
|
16895
|
+
```typescript
|
|
16896
|
+
await client.orgs.publicData.s3Object.getV1("org_public_data_s3_object_metadata_id");
|
|
16897
|
+
```
|
|
16898
|
+
|
|
16899
|
+
</dd>
|
|
16900
|
+
</dl>
|
|
16901
|
+
</dd>
|
|
16902
|
+
</dl>
|
|
16903
|
+
|
|
16904
|
+
#### ⚙️ Parameters
|
|
16905
|
+
|
|
16906
|
+
<dl>
|
|
16907
|
+
<dd>
|
|
16908
|
+
|
|
16909
|
+
<dl>
|
|
16910
|
+
<dd>
|
|
16911
|
+
|
|
16912
|
+
**orgPublicDataS3ObjectMetadataId:** `string`
|
|
16913
|
+
|
|
16914
|
+
</dd>
|
|
16915
|
+
</dl>
|
|
16916
|
+
|
|
16917
|
+
<dl>
|
|
16918
|
+
<dd>
|
|
16919
|
+
|
|
16920
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
16921
|
+
|
|
16922
|
+
</dd>
|
|
16923
|
+
</dl>
|
|
16924
|
+
</dd>
|
|
16925
|
+
</dl>
|
|
16926
|
+
|
|
16927
|
+
</dd>
|
|
16928
|
+
</dl>
|
|
16929
|
+
</details>
|
|
16930
|
+
|
|
16465
16931
|
## Shipping CargoOnFlightAirWaybills
|
|
16466
16932
|
|
|
16467
16933
|
<details><summary><code>client.shipping.cargoOnFlightAirWaybills.<a href="/src/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/Client.ts">createV1</a>({ ...params }) -> Chrt.CargoOnFlightAirWaybill1</code></summary>
|
|
@@ -33592,7 +34058,7 @@ await client.shippingIntegrations.xcelerator.orders.typeaheadV1({
|
|
|
33592
34058
|
<dl>
|
|
33593
34059
|
<dd>
|
|
33594
34060
|
|
|
33595
|
-
Archives a device
|
|
34061
|
+
Archives a device without an active session or cargo. Terminate or unlink tracking first. | auth: api_key | () -> (bool)
|
|
33596
34062
|
|
|
33597
34063
|
</dd>
|
|
33598
34064
|
</dl>
|
|
@@ -33645,6 +34111,71 @@ await client.tracking.devices.archiveV1({
|
|
|
33645
34111
|
</dl>
|
|
33646
34112
|
</details>
|
|
33647
34113
|
|
|
34114
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">forCargoV1</a>({ ...params }) -> Chrt.DeviceForCargoRes[]</code></summary>
|
|
34115
|
+
<dl>
|
|
34116
|
+
<dd>
|
|
34117
|
+
|
|
34118
|
+
#### 📝 Description
|
|
34119
|
+
|
|
34120
|
+
<dl>
|
|
34121
|
+
<dd>
|
|
34122
|
+
|
|
34123
|
+
<dl>
|
|
34124
|
+
<dd>
|
|
34125
|
+
|
|
34126
|
+
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])
|
|
34127
|
+
|
|
34128
|
+
</dd>
|
|
34129
|
+
</dl>
|
|
34130
|
+
</dd>
|
|
34131
|
+
</dl>
|
|
34132
|
+
|
|
34133
|
+
#### 🔌 Usage
|
|
34134
|
+
|
|
34135
|
+
<dl>
|
|
34136
|
+
<dd>
|
|
34137
|
+
|
|
34138
|
+
<dl>
|
|
34139
|
+
<dd>
|
|
34140
|
+
|
|
34141
|
+
```typescript
|
|
34142
|
+
await client.tracking.devices.forCargoV1({
|
|
34143
|
+
cargo_id: "cargo_id",
|
|
34144
|
+
});
|
|
34145
|
+
```
|
|
34146
|
+
|
|
34147
|
+
</dd>
|
|
34148
|
+
</dl>
|
|
34149
|
+
</dd>
|
|
34150
|
+
</dl>
|
|
34151
|
+
|
|
34152
|
+
#### ⚙️ Parameters
|
|
34153
|
+
|
|
34154
|
+
<dl>
|
|
34155
|
+
<dd>
|
|
34156
|
+
|
|
34157
|
+
<dl>
|
|
34158
|
+
<dd>
|
|
34159
|
+
|
|
34160
|
+
**request:** `Chrt.tracking.DevicesForCargoV1Request`
|
|
34161
|
+
|
|
34162
|
+
</dd>
|
|
34163
|
+
</dl>
|
|
34164
|
+
|
|
34165
|
+
<dl>
|
|
34166
|
+
<dd>
|
|
34167
|
+
|
|
34168
|
+
**requestOptions:** `Devices.RequestOptions`
|
|
34169
|
+
|
|
34170
|
+
</dd>
|
|
34171
|
+
</dl>
|
|
34172
|
+
</dd>
|
|
34173
|
+
</dl>
|
|
34174
|
+
|
|
34175
|
+
</dd>
|
|
34176
|
+
</dl>
|
|
34177
|
+
</details>
|
|
34178
|
+
|
|
33648
34179
|
<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
34180
|
<dl>
|
|
33650
34181
|
<dd>
|
|
@@ -33710,6 +34241,72 @@ await client.tracking.devices.getV1({
|
|
|
33710
34241
|
</dl>
|
|
33711
34242
|
</details>
|
|
33712
34243
|
|
|
34244
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">linkToCargoV1</a>({ ...params }) -> boolean</code></summary>
|
|
34245
|
+
<dl>
|
|
34246
|
+
<dd>
|
|
34247
|
+
|
|
34248
|
+
#### 📝 Description
|
|
34249
|
+
|
|
34250
|
+
<dl>
|
|
34251
|
+
<dd>
|
|
34252
|
+
|
|
34253
|
+
<dl>
|
|
34254
|
+
<dd>
|
|
34255
|
+
|
|
34256
|
+
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)
|
|
34257
|
+
|
|
34258
|
+
</dd>
|
|
34259
|
+
</dl>
|
|
34260
|
+
</dd>
|
|
34261
|
+
</dl>
|
|
34262
|
+
|
|
34263
|
+
#### 🔌 Usage
|
|
34264
|
+
|
|
34265
|
+
<dl>
|
|
34266
|
+
<dd>
|
|
34267
|
+
|
|
34268
|
+
<dl>
|
|
34269
|
+
<dd>
|
|
34270
|
+
|
|
34271
|
+
```typescript
|
|
34272
|
+
await client.tracking.devices.linkToCargoV1({
|
|
34273
|
+
device_id: "device_id",
|
|
34274
|
+
cargo_id: "cargo_id",
|
|
34275
|
+
});
|
|
34276
|
+
```
|
|
34277
|
+
|
|
34278
|
+
</dd>
|
|
34279
|
+
</dl>
|
|
34280
|
+
</dd>
|
|
34281
|
+
</dl>
|
|
34282
|
+
|
|
34283
|
+
#### ⚙️ Parameters
|
|
34284
|
+
|
|
34285
|
+
<dl>
|
|
34286
|
+
<dd>
|
|
34287
|
+
|
|
34288
|
+
<dl>
|
|
34289
|
+
<dd>
|
|
34290
|
+
|
|
34291
|
+
**request:** `Chrt.tracking.DevicesLinkToCargoV1Request`
|
|
34292
|
+
|
|
34293
|
+
</dd>
|
|
34294
|
+
</dl>
|
|
34295
|
+
|
|
34296
|
+
<dl>
|
|
34297
|
+
<dd>
|
|
34298
|
+
|
|
34299
|
+
**requestOptions:** `Devices.RequestOptions`
|
|
34300
|
+
|
|
34301
|
+
</dd>
|
|
34302
|
+
</dl>
|
|
34303
|
+
</dd>
|
|
34304
|
+
</dl>
|
|
34305
|
+
|
|
34306
|
+
</dd>
|
|
34307
|
+
</dl>
|
|
34308
|
+
</details>
|
|
34309
|
+
|
|
33713
34310
|
<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
34311
|
<dl>
|
|
33715
34312
|
<dd>
|
|
@@ -33993,6 +34590,71 @@ await client.tracking.devices.typeaheadV1({
|
|
|
33993
34590
|
</dl>
|
|
33994
34591
|
</details>
|
|
33995
34592
|
|
|
34593
|
+
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">unlinkFromCargoV1</a>({ ...params }) -> boolean</code></summary>
|
|
34594
|
+
<dl>
|
|
34595
|
+
<dd>
|
|
34596
|
+
|
|
34597
|
+
#### 📝 Description
|
|
34598
|
+
|
|
34599
|
+
<dl>
|
|
34600
|
+
<dd>
|
|
34601
|
+
|
|
34602
|
+
<dl>
|
|
34603
|
+
<dd>
|
|
34604
|
+
|
|
34605
|
+
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)
|
|
34606
|
+
|
|
34607
|
+
</dd>
|
|
34608
|
+
</dl>
|
|
34609
|
+
</dd>
|
|
34610
|
+
</dl>
|
|
34611
|
+
|
|
34612
|
+
#### 🔌 Usage
|
|
34613
|
+
|
|
34614
|
+
<dl>
|
|
34615
|
+
<dd>
|
|
34616
|
+
|
|
34617
|
+
<dl>
|
|
34618
|
+
<dd>
|
|
34619
|
+
|
|
34620
|
+
```typescript
|
|
34621
|
+
await client.tracking.devices.unlinkFromCargoV1({
|
|
34622
|
+
device_id: "device_id",
|
|
34623
|
+
});
|
|
34624
|
+
```
|
|
34625
|
+
|
|
34626
|
+
</dd>
|
|
34627
|
+
</dl>
|
|
34628
|
+
</dd>
|
|
34629
|
+
</dl>
|
|
34630
|
+
|
|
34631
|
+
#### ⚙️ Parameters
|
|
34632
|
+
|
|
34633
|
+
<dl>
|
|
34634
|
+
<dd>
|
|
34635
|
+
|
|
34636
|
+
<dl>
|
|
34637
|
+
<dd>
|
|
34638
|
+
|
|
34639
|
+
**request:** `Chrt.tracking.DevicesUnlinkFromCargoV1Request`
|
|
34640
|
+
|
|
34641
|
+
</dd>
|
|
34642
|
+
</dl>
|
|
34643
|
+
|
|
34644
|
+
<dl>
|
|
34645
|
+
<dd>
|
|
34646
|
+
|
|
34647
|
+
**requestOptions:** `Devices.RequestOptions`
|
|
34648
|
+
|
|
34649
|
+
</dd>
|
|
34650
|
+
</dl>
|
|
34651
|
+
</dd>
|
|
34652
|
+
</dl>
|
|
34653
|
+
|
|
34654
|
+
</dd>
|
|
34655
|
+
</dl>
|
|
34656
|
+
</details>
|
|
34657
|
+
|
|
33996
34658
|
<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">unpauseV1</a>({ ...params }) -> boolean</code></summary>
|
|
33997
34659
|
<dl>
|
|
33998
34660
|
<dd>
|