@chrt-inc/typescript-sdk 1.562.0 → 1.575.0

package/reference.md

@@ -7610,7 +7610,7 @@ await client.orgs.orgInfoForConnections.forwarder.updateV1();
 
 ## 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>
+<details><summary><code>client.shipping.docs.<a href="/src/api/resources/shipping/resources/docs/client/Client.ts">postGenerateV1</a>({ ...params }) -> core.BinaryResponse</code></summary>
 <dl>
 <dd>
 
@@ -7639,7 +7639,7 @@ Generates a shipping document (BOL or POD) as a PDF for the given order. | authz
 
 ```typescript
 await client.shipping.docs.postGenerateV1({
-    order_id_or_short_id: "order_id_or_short_id",
+    order_ref: "order_ref",
     template: "pod",
 });
 ```
@@ -9784,7 +9784,7 @@ await client.shipping.tasks.addToTaskGroupV1("task_group_id", {
 <dl>
 <dd>
 
-Updates a task. Task must be in STAGED status. | authz_personas=[lig_owner_operators] | (TaskClientUpdate1) -> (PydanticObjectId)
+Updates a task. Operational fields require STAGED status (lig_owner_operators). order_placer_comments can be edited on any non-DRAFT task (order_creator_org_operators). | (TaskClientUpdate1) -> (PydanticObjectId)
 
 </dd>
 </dl>
@@ -11186,7 +11186,7 @@ await client.shipping.orderDrafts.cargo.deleteV1("cargo_id");
 
 ## Shipping OrderDrafts Expanded
 
-<details><summary><code>client.shipping.orderDrafts.expanded.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.ts">retrieveV1</a>(orderIdOrShortId, { ...params }) -> Chrt.OrderDraftExpanded</code></summary>
+<details><summary><code>client.shipping.orderDrafts.expanded.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.ts">retrieveV1</a>(orderRef, { ...params }) -> Chrt.OrderDraftExpanded</code></summary>
 <dl>
 <dd>
 
@@ -11214,7 +11214,7 @@ Fetches a single draft order with optional expanded related data. Any user in th
 <dd>
 
 ```typescript
-await client.shipping.orderDrafts.expanded.retrieveV1("order_id_or_short_id", {});
+await client.shipping.orderDrafts.expanded.retrieveV1("order_ref", {});
 ```
 
 </dd>
@@ -11230,7 +11230,7 @@ await client.shipping.orderDrafts.expanded.retrieveV1("order_id_or_short_id", {}
 <dl>
 <dd>
 
-**orderIdOrShortId:** `string`
+**orderRef:** `string` — Order ID, short ID, or off-chrt reference ID
 
 </dd>
 </dl>
@@ -11330,7 +11330,7 @@ await client.shipping.orderDrafts.expanded.listV1({
 
 ## Shipping Orders Expanded
 
-<details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">forShipperOperatorsV1</a>(orderIdOrShortId, { ...params }) -> Chrt.OrderExpanded</code></summary>
+<details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">forShipperOperatorsV1</a>(orderRef, { ...params }) -> Chrt.OrderExpanded</code></summary>
 <dl>
 <dd>
 
@@ -11358,7 +11358,7 @@ Retrieves an expanded order with optional related data for shipper operators. |
 <dd>
 
 ```typescript
-await client.shipping.orders.expanded.forShipperOperatorsV1("order_id_or_short_id", {});
+await client.shipping.orders.expanded.forShipperOperatorsV1("order_ref", {});
 ```
 
 </dd>
@@ -11374,7 +11374,7 @@ await client.shipping.orders.expanded.forShipperOperatorsV1("order_id_or_short_i
 <dl>
 <dd>
 
-**orderIdOrShortId:** `string`
+**orderRef:** `string` — Order ID, short ID, or off-chrt reference ID
 
 </dd>
 </dl>
@@ -11401,7 +11401,7 @@ await client.shipping.orders.expanded.forShipperOperatorsV1("order_id_or_short_i
 </dl>
 </details>
 
-<details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">forForwarderOperatorsV1</a>(orderIdOrShortId, { ...params }) -> Chrt.OrderExpanded</code></summary>
+<details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">forForwarderOperatorsV1</a>(orderRef, { ...params }) -> Chrt.OrderExpanded</code></summary>
 <dl>
 <dd>
 
@@ -11429,7 +11429,7 @@ Retrieves an expanded order with optional related data for forwarder operators.
 <dd>
 
 ```typescript
-await client.shipping.orders.expanded.forForwarderOperatorsV1("order_id_or_short_id", {});
+await client.shipping.orders.expanded.forForwarderOperatorsV1("order_ref", {});
 ```
 
 </dd>
@@ -11445,7 +11445,7 @@ await client.shipping.orders.expanded.forForwarderOperatorsV1("order_id_or_short
 <dl>
 <dd>
 
-**orderIdOrShortId:** `string`
+**orderRef:** `string` — Order ID, short ID, or off-chrt reference ID
 
 </dd>
 </dl>
@@ -11518,6 +11518,7 @@ await client.shipping.orders.expanded.listForForwarderOperatorsV1({
     filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
     filter_order_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
     filter_order_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_order_cancelled: true,
     body: {},
 });
 ```
@@ -11600,6 +11601,7 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
     filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
     filter_order_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
     filter_order_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_order_cancelled: true,
     body: {},
 });
 ```
@@ -11968,7 +11970,7 @@ await client.shipping.taskArtifacts.s3Object.deleteV1("task_artifact_s3_object_m
 
 ## Shipping TaskGroups TaskGroupId
 
-<details><summary><code>client.shipping.taskGroups.taskGroupId.<a href="/src/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.ts">forCourierOperatorsV1</a>(orderIdOrShortId) -> string[]</code></summary>
+<details><summary><code>client.shipping.taskGroups.taskGroupId.<a href="/src/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.ts">forCourierOperatorsV1</a>(orderRef) -> string[]</code></summary>
 <dl>
 <dd>
 
@@ -11996,7 +11998,7 @@ Retrieves the task group IDs for the courier organization assigned to an order's
 <dd>
 
 ```typescript
-await client.shipping.taskGroups.taskGroupId.forCourierOperatorsV1("order_id_or_short_id");
+await client.shipping.taskGroups.taskGroupId.forCourierOperatorsV1("order_ref");
 ```
 
 </dd>
@@ -12012,7 +12014,7 @@ await client.shipping.taskGroups.taskGroupId.forCourierOperatorsV1("order_id_or_
 <dl>
 <dd>
 
-**orderIdOrShortId:** `string`
+**orderRef:** `string` — Order ID, short ID, or off-chrt reference ID
 
 </dd>
 </dl>
@@ -12031,7 +12033,7 @@ await client.shipping.taskGroups.taskGroupId.forCourierOperatorsV1("order_id_or_
 </dl>
 </details>
 
-<details><summary><code>client.shipping.taskGroups.taskGroupId.<a href="/src/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.ts">forCourierDriverV1</a>(orderIdOrShortId) -> string[]</code></summary>
+<details><summary><code>client.shipping.taskGroups.taskGroupId.<a href="/src/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.ts">forCourierDriverV1</a>(orderRef) -> string[]</code></summary>
 <dl>
 <dd>
 
@@ -12059,7 +12061,7 @@ Retrieves the task group IDs for the courier driver assigned to an order's task
 <dd>
 
 ```typescript
-await client.shipping.taskGroups.taskGroupId.forCourierDriverV1("order_id_or_short_id");
+await client.shipping.taskGroups.taskGroupId.forCourierDriverV1("order_ref");
 ```
 
 </dd>
@@ -12075,7 +12077,7 @@ await client.shipping.taskGroups.taskGroupId.forCourierDriverV1("order_id_or_sho
 <dl>
 <dd>
 
-**orderIdOrShortId:** `string`
+**orderRef:** `string` — Order ID, short ID, or off-chrt reference ID
 
 </dd>
 </dl>
@@ -12690,6 +12692,7 @@ await client.shipping.taskGroups.expanded.listForCourierOperatorsV1({
     filter_skipped_at_timestamp_gte: "2024-01-15T09:30:00Z",
     filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
     filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_order_cancelled: true,
     body: {},
 });
 ```
@@ -12772,6 +12775,7 @@ await client.shipping.taskGroups.expanded.listForCourierDriverV1({
     filter_skipped_at_timestamp_gte: "2024-01-15T09:30:00Z",
     filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
     filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_order_cancelled: true,
     body: {},
 });
 ```
@@ -14441,7 +14445,7 @@ await client.tracking.sharingSettings.cargoByDeviceSettingsV1({
 </dl>
 </details>
 
-<details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">getSettingsV1</a>(orderIdOrShortId) -> Chrt.TrackingSharingSettingsRes[]</code></summary>
+<details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">getSettingsV1</a>(orderRef) -> Chrt.TrackingSharingSettingsRes[]</code></summary>
 <dl>
 <dd>
 
@@ -14453,7 +14457,7 @@ await client.tracking.sharingSettings.cargoByDeviceSettingsV1({
 <dl>
 <dd>
 
-Get all tracking datasets and their sharing settings for a given order. If authenticated, returns datasets the user has direct access to plus public datasets. If unauthenticated, returns only datasets with public=True. | () -> (list[TrackingSharingSettingsRes])
+Get all tracking datasets and their sharing settings for a given order. If authenticated, returns datasets the user has direct access to plus public datasets. If unauthenticated, returns only datasets with public=True. Note: looking up by off_chrt_reference_id requires authentication because it is only org-level unique and needs the caller's org_id to resolve unambiguously. | () -> (list[TrackingSharingSettingsRes])
 
 </dd>
 </dl>
@@ -14469,7 +14473,7 @@ Get all tracking datasets and their sharing settings for a given order. If authe
 <dd>
 
 ```typescript
-await client.tracking.sharingSettings.getSettingsV1("order_id_or_short_id");
+await client.tracking.sharingSettings.getSettingsV1("order_ref");
 ```
 
 </dd>
@@ -14485,7 +14489,7 @@ await client.tracking.sharingSettings.getSettingsV1("order_id_or_short_id");
 <dl>
 <dd>
 
-**orderIdOrShortId:** `string`
+**orderRef:** `string` — Order ID, short ID, or off-chrt reference ID
 
 </dd>
 </dl>
@@ -16540,7 +16544,7 @@ await client.utils.dev.postAgentOrderBuilderV1({
 </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>
+<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">postAgentOrderBuilderStreamV1</a>({ ...params }) -> core.Stream&lt;Chrt.OrderBuilderStreamEvent&gt;</code></summary>
 <dl>
 <dd>
 
@@ -16552,7 +16556,7 @@ await client.utils.dev.postAgentOrderBuilderV1({
 <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
+Same as /agent/order-builder/v1 but streams progress events via SSE as each workflow step completes. | (OrderBuilderReq) -> SSE stream of OrderBuilderStreamEvent
 
 </dd>
 </dl>
@@ -16568,10 +16572,13 @@ Same as /agent/order-builder/v1 but streams progress events via SSE as each work
 <dd>
 
 ```typescript
-await client.utils.dev.postAgentOrderBuilderStreamV1({
+const response = await client.utils.dev.postAgentOrderBuilderStreamV1({
     order_short_id: "order_short_id",
     text: "text",
 });
+for await (const item of response) {
+    console.log(item);
+}
 ```
 
 </dd>