@chrt-inc/typescript-sdk 1.510.0 → 1.512.0

package/reference.md

@@ -3061,6 +3061,665 @@ await client.billing.lineItemGroups.s3Objects.deleteV1("line_item_group_s3_objec
 </dl>
 </details>
 
+## Integrations AirWaybills
+
+<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">createV1</a>({ ...params }) -> Chrt.ChampAirWaybill1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.integrations.airWaybills.createV1({
+    task_group_id: "task_group_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.integrations.AirWaybillCreateReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AirWaybills.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">retrieveV1</a>(taskGroupId) -> Chrt.ChampAirWaybill1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves the stored CHAMP air waybill for a task group. | () -> (ChampAirWaybill1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.integrations.airWaybills.retrieveV1("task_group_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskGroupId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AirWaybills.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<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>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.integrations.airWaybills.updateV1("task_group_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskGroupId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.integrations.ChampAirWaybillClientUpdate1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AirWaybills.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">submitV1</a>(taskGroupId) -> Chrt.ChampAirWaybill1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.integrations.airWaybills.submitV1("task_group_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskGroupId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AirWaybills.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">pdfV1</a>(taskGroupId) -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.integrations.airWaybills.pdfV1("task_group_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskGroupId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AirWaybills.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">confirmationsV1</a>(taskGroupId) -> Chrt.ChampConfirmationReceipt1[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves all CHAMP confirmation receipts linked to the air waybill for a task group. | () -> (list[ChampConfirmationReceipt1])
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.integrations.airWaybills.confirmationsV1("task_group_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskGroupId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AirWaybills.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">flightStatusesV1</a>(taskGroupId) -> Chrt.ChampFlightStatus1[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves all CHAMP flight status updates linked to the air waybill for a task group. | () -> (list[ChampFlightStatus1])
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.integrations.airWaybills.flightStatusesV1("task_group_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskGroupId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AirWaybills.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## Integrations WebcargoBookings
+
+<details><summary><code>client.integrations.webcargoBookings.<a href="/src/api/resources/integrations/resources/webcargoBookings/client/Client.ts">syncV1</a>(taskGroupId) -> Chrt.WebcargoBookingRecord1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.integrations.webcargoBookings.syncV1("task_group_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskGroupId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `WebcargoBookings.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.integrations.webcargoBookings.<a href="/src/api/resources/integrations/resources/webcargoBookings/client/Client.ts">retrieveV1</a>(taskGroupId) -> Chrt.WebcargoBookingRecord1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves the stored WebCargo booking record for a task group. Returns 404 if the booking has never been synced. | () -> (WebcargoBookingRecord1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.integrations.webcargoBookings.retrieveV1("task_group_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskGroupId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `WebcargoBookings.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## Integrations WebcargoEmbed
+
+<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>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.integrations.webcargoEmbed.getEmbedV1("task_group_id", {
+    origin: "origin",
+    destination: "destination",
+    departure: "departure",
+    country: "country",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskGroupId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.integrations.GetWebcargoEmbedReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `WebcargoEmbed.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Notifications AdHoc
 
 <details><summary><code>client.notifications.adHoc.<a href="/src/api/resources/notifications/resources/adHoc/client/Client.ts">listByOrderIdV1</a>(orderId) -> Chrt.NotificationIntentAdHoc1[]</code></summary>
@@ -11872,6 +12531,136 @@ await client.tracking.devices.archiveV1({
 </dl>
 </details>
 
+<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">pauseV1</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Pauses a device. Cargo-by-device and session-by-device data points are marked as paused and excluded from data point queries. | () -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tracking.devices.pauseV1({
+    device_id: "device_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.tracking.DevicesPauseV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Devices.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">unpauseV1</a>({ ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Unpauses a device. | () -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.tracking.devices.unpauseV1({
+    device_id: "device_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.tracking.DevicesUnpauseV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Devices.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.tracking.devices.<a href="/src/api/resources/tracking/resources/devices/client/Client.ts">updateSharedOrgsV1</a>({ ...params }) -> boolean</code></summary>
 <dl>
 <dd>
@@ -15438,7 +16227,7 @@ await client.utils.dev.getUserIdV2();
 </dl>
 </details>
 
-<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">getDecodedJwtV1</a>() -> Chrt.DecodedJwtWithOrgAndUserId</code></summary>
+<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">getCredentialInfoV1</a>() -> Chrt.CredentialInfoRes</code></summary>
 <dl>
 <dd>
 
@@ -15450,7 +16239,7 @@ await client.utils.dev.getUserIdV2();
 <dl>
 <dd>
 
-Returns the complete decoded JWT token information for development purposes. | () -> (DecodedJWTWithOrgAndUserId)
+Returns the verified caller identity and raw credential claims for development purposes. | () -> (CredentialInfoRes)
 
 </dd>
 </dl>
@@ -15466,7 +16255,7 @@ Returns the complete decoded JWT token information for development purposes. | (
 <dd>
 
 ```typescript
-await client.utils.dev.getDecodedJwtV1();
+await client.utils.dev.getCredentialInfoV1();
 ```
 
 </dd>
@@ -15892,7 +16681,7 @@ await client.utils.root.pingUnauthd();
 </dl>
 </details>
 
-<details><summary><code>client.utils.root.<a href="/src/api/resources/utils/resources/root/client/Client.ts">health</a>() -> Record&lt;string, unknown&gt;</code></summary>
+<details><summary><code>client.utils.root.<a href="/src/api/resources/utils/resources/root/client/Client.ts">failure</a>() -> unknown</code></summary>
 <dl>
 <dd>
 
@@ -15904,7 +16693,7 @@ await client.utils.root.pingUnauthd();
 <dl>
 <dd>
 
-Returns a health status message used for monitoring system availability and uptime. | () -> (dict)
+Test endpoint that intentionally fails for error handling validation and monitoring purposes. | () -> (None)
 
 </dd>
 </dl>
@@ -15920,7 +16709,7 @@ Returns a health status message used for monitoring system availability and upti
 <dd>
 
 ```typescript
-await client.utils.root.health();
+await client.utils.root.failure();
 ```
 
 </dd>
@@ -15947,7 +16736,7 @@ await client.utils.root.health();
 </dl>
 </details>
 
-<details><summary><code>client.utils.root.<a href="/src/api/resources/utils/resources/root/client/Client.ts">failure</a>() -> unknown</code></summary>
+<details><summary><code>client.utils.root.<a href="/src/api/resources/utils/resources/root/client/Client.ts">health</a>() -> Record&lt;string, unknown&gt;</code></summary>
 <dl>
 <dd>
 
@@ -15959,7 +16748,7 @@ await client.utils.root.health();
 <dl>
 <dd>
 
-Test endpoint that intentionally fails for error handling validation and monitoring purposes. | () -> (None)
+Returns a health status message used for monitoring system availability and uptime. | () -> (dict)
 
 </dd>
 </dl>
@@ -15975,7 +16764,7 @@ Test endpoint that intentionally fails for error handling validation and monitor
 <dd>
 
 ```typescript
-await client.utils.root.failure();
+await client.utils.root.health();
 ```
 
 </dd>