@chrt-inc/typescript-sdk 1.708.0 → 1.718.0

package/reference.md

@@ -18091,6 +18091,71 @@ await client.shipping.orderDrafts.deleteV1("order_id");
 </dl>
 </details>
 
+<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">imageToTextV1</a>({ ...params }) -> string</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Converts an order screenshot into lightly structured text for the AI order builder. | (UploadFile) -> (str)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipping.orderDrafts.imageToTextV1({
+    file: fs.createReadStream("/path/to/your/file"),
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.shipping.BodyPostShippingOrderDraftsImageToTextV1ShippingOrderDraftsImageToTextV1Post`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrderDrafts.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">validateV1</a>(orderId) -> Chrt.OrderDraftValidationResult</code></summary>
 <dl>
 <dd>
@@ -21729,6 +21794,72 @@ await client.shipping.drivers.complianceDocuments.s3Object.deleteV1("driver_comp
 
 ## Shipping OrderDrafts Agentic
 
+<details><summary><code>client.shipping.orderDrafts.agentic.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.ts">precheckV1</a>({ ...params }) -> Chrt.OrderBuilderPrecheckRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Predicts whether input is complete enough for the AI order builder. | (OrderBuilderReq) -> (OrderBuilderPrecheckRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipping.orderDrafts.agentic.precheckV1({
+    order_short_id: "order_short_id",
+    text: "text",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.OrderBuilderReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Agentic.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.shipping.orderDrafts.agentic.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrderBuilderRes</code></summary>
 <dl>
 <dd>
@@ -23886,6 +24017,156 @@ await client.shipping.taskArtifacts.s3Object.writeAiImageDescriptionV1("task_art
 </dl>
 </details>
 
+## Shipping TaskArtifacts Scan
+
+<details><summary><code>client.shipping.taskArtifacts.scan.<a href="/src/api/resources/shipping/resources/taskArtifacts/resources/scan/client/Client.ts">addV1</a>(taskArtifactId, { ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Appends a barcode/QR scan payload to a SCAN-type task artifact's expected or observed array (deduplicated). | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | (AddScanPayloadReq) -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipping.taskArtifacts.scan.addV1("task_artifact_id", {
+    kind: "expected",
+    payload: "payload",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskArtifactId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.shipping.taskArtifacts.AddScanPayloadReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Scan.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shipping.taskArtifacts.scan.<a href="/src/api/resources/shipping/resources/taskArtifacts/resources/scan/client/Client.ts">deleteV1</a>(taskArtifactId, { ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Removes a barcode/QR scan payload (by value) from a SCAN-type task artifact's expected or observed array. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | () -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipping.taskArtifacts.scan.deleteV1("task_artifact_id", {
+    kind: "expected",
+    payload: "payload",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskArtifactId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.shipping.taskArtifacts.ScanDeleteV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Scan.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Shipping TaskGroups TaskGroupId
 
 <details><summary><code>client.shipping.taskGroups.taskGroupId.<a href="/src/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.ts">forExecutorOperatorsV1</a>(orderRef) -> string[]</code></summary>