@chrt-inc/typescript-sdk 1.540.0 → 1.559.0

package/reference.md

@@ -1710,6 +1710,7 @@ await client.billing.statements.listV1({
     page_size: 1,
     filter_settlement_type: "stripe_connect",
     filter_order_id: "filter_order_id",
+    filter_order_off_chrt_reference_id: "filter_order_off_chrt_reference_id",
     filter_payment_origin_org_id: "filter_payment_origin_org_id",
     filter_payment_origin_off_chrt_shipper_org_id: "filter_payment_origin_off_chrt_shipper_org_id",
     filter_payment_destination_org_id: "filter_payment_destination_org_id",
@@ -1792,6 +1793,7 @@ await client.billing.statements.expandedListV1({
     page_size: 1,
     filter_settlement_type: "stripe_connect",
     filter_order_id: "filter_order_id",
+    filter_order_off_chrt_reference_id: "filter_order_off_chrt_reference_id",
     filter_payment_origin_org_id: "filter_payment_origin_org_id",
     filter_payment_origin_off_chrt_shipper_org_id: "filter_payment_origin_off_chrt_shipper_org_id",
     filter_payment_destination_org_id: "filter_payment_destination_org_id",
@@ -7606,6 +7608,74 @@ await client.orgs.orgInfoForConnections.forwarder.updateV1();
 </dl>
 </details>
 
+## Shipping Docs
+
+<details><summary><code>client.shipping.docs.<a href="/src/api/resources/shipping/resources/docs/client/Client.ts">postGenerateV1</a>({ ...params }) -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Generates a shipping document (BOL or POD) as a PDF for the given order. | authz_personas=[order_creator_org_operators] | (GenerateShippingDocReq) -> (PDF binary)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipping.docs.postGenerateV1({
+    order_id_or_short_id: "order_id_or_short_id",
+    template: "pod",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.shipping.GenerateShippingDocReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Docs.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Shipping Drivers
 
 <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getForCallerV1</a>() -> Chrt.Driver1</code></summary>
@@ -8665,6 +8735,77 @@ await client.shipping.orders.stageV1("order_id");
 </dl>
 </details>
 
+<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">updateOffChrtReferenceIdV1</a>(orderId, { ...params }) -> Chrt.OrdersUpdateOffChrtReferenceIdRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Updates off_chrt_reference_id on a non-draft order. | authz_personas=[order_creator_org_operators] | (OrdersUpdateOffChrtReferenceIdReq) -> (OrdersUpdateOffChrtReferenceIdRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**orderId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.shipping.OrdersUpdateOffChrtReferenceIdReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Orders.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">cancelV1</a>(orderId) -> boolean</code></summary>
 <dl>
 <dd>
@@ -8793,7 +8934,7 @@ await client.shipping.orderDrafts.newV1();
 </dl>
 </details>
 
-<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">updateV1</a>({ ...params }) -> Chrt.OrdersDraftUpdateRes</code></summary>
+<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">updateV1</a>(orderId, { ...params }) -> Chrt.OrdersDraftUpdateRes</code></summary>
 <dl>
 <dd>
 
@@ -8821,9 +8962,7 @@ Updates forwarder and/or shipper org assignments for a draft order. | (OrdersDra
 <dd>
 
 ```typescript
-await client.shipping.orderDrafts.updateV1({
-    order_id: "order_id",
-});
+await client.shipping.orderDrafts.updateV1("order_id");
 ```
 
 </dd>
@@ -8839,6 +8978,14 @@ await client.shipping.orderDrafts.updateV1({
 <dl>
 <dd>
 
+**orderId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request:** `Chrt.shipping.OrdersDraftUpdateReq`
 
 </dd>
@@ -8921,7 +9068,7 @@ 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">validateV1</a>(orderId) -> boolean</code></summary>
+<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>
 
@@ -8933,7 +9080,7 @@ await client.shipping.orderDrafts.deleteV1("order_id");
 <dl>
 <dd>
 
-Checks whether the draft order satisfies all requirements to move into staging. | () -> (bool)
+Validates the draft order for staging and returns all issues found. | () -> (OrderDraftValidationResult)
 
 </dd>
 </dl>
@@ -12741,7 +12888,7 @@ await client.shipping.taskGroups.expanded.typeaheadV1({
 <dl>
 <dd>
 
-Registers a tracking device to the caller's organization. If the device is already registered to a different organization, returns 409 Conflict. | (DeviceClientCreate1) -> (PydanticObjectId)
+Registers a tracking device to the caller's organization. If the device is already registered to a different organization, returns 409 Conflict. | auth: api_key | (DeviceClientCreate1) -> (PydanticObjectId)
 
 </dd>
 </dl>
@@ -13640,7 +13787,7 @@ await client.tracking.sessions.typeaheadV1({
 <dl>
 <dd>
 
-Creates a new tracking session for a device and automatically starts recording data points. The caller must be the device owner or belong to an org the device is shared with. The device owner remains the session owner (org_id). The device's shared_with_org_ids are copied to the session. The device must not have an active session. Auto-termination is scheduled for ~3 days out at 8 PM PT. Prevent auto termination with `no_auto_termination=True` | (SessionClientCreate1) -> (PydanticObjectId)
+Creates a new tracking session for a device and automatically starts recording data points. The caller must be the device owner or belong to an org the device is shared with. The device owner remains the session owner (org_id). The device's shared_with_org_ids are copied to the session. The device must not have an active session. Auto-termination is scheduled for ~3 days out at 8 PM PT. Prevent auto termination with `no_auto_termination=True` | auth: api_key | (SessionClientCreate1) -> (PydanticObjectId)
 
 </dd>
 </dl>
@@ -16374,7 +16521,73 @@ await client.utils.dev.postAgentOrderBuilderV1({
 <dl>
 <dd>
 
-**request:** `Chrt.utils.OrderBuilderReq`
+**request:** `Chrt.OrderBuilderReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Dev.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">postAgentOrderBuilderStreamV1</a>({ ...params }) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Same as /agent/order-builder/v1 but streams progress events via SSE as each workflow step completes. | (OrderBuilderReq) -> SSE stream of OrderBuilderProgressEvent, final OrderBuilderRes
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.utils.dev.postAgentOrderBuilderStreamV1({
+    order_short_id: "order_short_id",
+    text: "text",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.OrderBuilderReq`
 
 </dd>
 </dl>