@chrt-inc/typescript-sdk 1.953.0 → 1.959.0

package/reference.md

@@ -17199,7 +17199,7 @@ await client.shipping.orders.getSuggestedDepartmentV1("order_id");
 <dl>
 <dd>
 
-Sets task-group ordering on an active order unless a task group or task is completed. | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | (OrdersTaskGroupOrderingReq) -> (bool)
+Sets task-group ordering on an order ensuring terminal task groups precede non-terminal task groups. | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | (OrdersTaskGroupOrderingReq) -> (bool)
 
 </dd>
 </dl>
@@ -21743,6 +21743,152 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
 </dl>
 </details>
 
+## Shipping Orders OrderEvents
+
+<details><summary><code>client.shipping.orders.orderEvents.<a href="/src/api/resources/shipping/resources/orders/resources/orderEvents/client/Client.ts">listV1</a>(orderId, { ...params }) -> Chrt.OrderEventListRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists event log entries for an order with organization and user public data hydrated, filtering, sorting, and pagination. | authz: min_org_role=administrator | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | () -> (OrderEventListRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipping.orders.orderEvents.listV1("order_id", {
+    sort_by: "timestamp",
+    sort_order: "asc",
+    page: 1,
+    page_size: 1,
+    filter_action: ["shipping.order.draft_started"],
+    filter_user_id: "filter_user_id",
+    filter_org_id: "filter_org_id",
+    filter_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_timestamp_lte: "2024-01-15T09:30:00Z",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**orderId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.shipping.orders.OrderEventsListV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrderEvents.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shipping.orders.orderEvents.<a href="/src/api/resources/shipping/resources/orders/resources/orderEvents/client/Client.ts">getV1</a>(orderEventId) -> Chrt.OrderEventExpanded1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves a single order event log entry by its ID with organization and user public data hydrated. | authz: min_org_role=administrator | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | () -> (OrderEventExpanded1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipping.orders.orderEvents.getV1("order_event_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**orderEventId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrderEvents.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Shipping Orders Task
 
 <details><summary><code>client.shipping.orders.task.<a href="/src/api/resources/shipping/resources/orders/resources/task/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>