@chrt-inc/typescript-sdk 1.983.0 → 1.990.0

package/reference.md

@@ -139,7 +139,7 @@ await client.orgs.getInfoV1();
 <dl>
 <dd>
 
-Lists all members of the caller's organization with their roles and details. Supports search by name, filtering by role, sorting, and pagination. | () -> (OrgMemberListRes)
+Lists all members of the caller's organization with their roles and details. Supports search by name, filtering by role and user IDs, sorting, and pagination. | () -> (OrgMemberListRes)
 
 </dd>
 </dl>
@@ -157,6 +157,7 @@ Lists all members of the caller's organization with their roles and details. Sup
 ```typescript
 await client.orgs.listMembersV1({
     filter_role: ["owner"],
+    filter_user_ids: ["filter_user_ids"],
     sort_by: "first_name",
     sort_order: "asc",
     page: 1,
@@ -5071,7 +5072,7 @@ await client.integrations.webcargoEmbed.getEmbedV1("task_group_id", {
 <dl>
 <dd>
 
-Pushes a bidder-side ACCEPT onto an OPEN thread. References the most recent lister-side pro_forma (or the listing's opening for DISPATCH). On `auto_award_first_accept=True` listings, fires the full cascade immediately (thread ACCEPTED, listing AWARDED, shipping and BillingNew side-effects). Otherwise leaves the thread OPEN for the lister to finalise via confirm_accept. Lister-side finalisation lives on confirm_accept; calling /accept/v1 from the lister side is rejected (400). | authz: allowed_org_types=[provider], min_org_role=driver | (BidAppendReq) -> (bool)
+Accepts an offer; lister acceptance awards immediately, while bidder acceptance follows the listing's auto-award setting. | authz: allowed_org_types=[provider], min_org_role=member; lister min_org_role=operator | (BidAppendReq) -> (bool)
 
 </dd>
 </dl>
@@ -5205,7 +5206,7 @@ await client.listing.bidThreads.byIdV1("bid_thread_id");
 <dl>
 <dd>
 
-Lister confirmation of a bidder's ACCEPT on this thread, used when `listing.auto_award_first_accept == False`. Runs the full award cascade: thread ACCEPTED, listing AWARDED, sibling threads / listings cancelled, and shipping and BillingNew side-effects. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (bool)
+Confirms a pending bidder acceptance and awards at its recorded price. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (bool)
 
 </dd>
 </dl>
@@ -5268,7 +5269,7 @@ await client.listing.bidThreads.confirmAcceptV1("bid_thread_id");
 <dl>
 <dd>
 
-Pushes a COUNTER Bid carrying revised pro_forma_line_items onto an OPEN NEGOTIATION thread. Both sides of the thread may COUNTER. | authz: allowed_org_types=[provider], min_org_role=driver | (BidAppendReq) -> (bool)
+Adds a counteroffer to an open negotiation. | authz: allowed_org_types=[provider], min_org_role=member | (BidAppendReq) -> (bool)
 
 </dd>
 </dl>
@@ -5339,7 +5340,7 @@ await client.listing.bidThreads.counterV1("bid_thread_id", {});
 <dl>
 <dd>
 
-Opens a new BidThread on a Listing. The body carries the thread's first Bid (SUBMIT / ACCEPT / DENY). Bidder identity is resolved server-side from the caller's JWT + the listing's audience. | authz: allowed_org_types=[provider], min_org_role=driver | (BidThreadClientCreate1) -> (PydanticObjectId)
+Opens a bid thread with an offer, acceptance, or denial. | authz: allowed_org_types=[provider], min_org_role=member | (BidThreadClientCreate1) -> (PydanticObjectId)
 
 </dd>
 </dl>
@@ -5405,7 +5406,7 @@ await client.listing.bidThreads.createV1({
 <dl>
 <dd>
 
-Pushes a DENY onto an OPEN thread, flipping its status to DENIED (terminal). Both sides may deny. References the most recent opposite-side Bid; carries no pro_forma. | authz: allowed_org_types=[provider], min_org_role=driver | (BidAppendReq) -> (bool)
+Declines an open negotiation and closes its thread. | authz: allowed_org_types=[provider], min_org_role=member | (BidAppendReq) -> (bool)
 
 </dd>
 </dl>
@@ -5636,7 +5637,7 @@ await client.listing.bidThreads.listForListingV1("listing_id", {
 <dl>
 <dd>
 
-Pushes a bidder-side WITHDRAW onto an OPEN thread, flipping its status to WITHDRAWN (terminal). Bidder-only — the lister equivalent is CANCEL on the listing. | authz: allowed_org_types=[provider], min_org_role=driver | (BidAppendReq) -> (bool)
+Withdraws the bidder's offer and closes its thread. | authz: allowed_org_types=[provider], min_org_role=member | (BidAppendReq) -> (bool)
 
 </dd>
 </dl>
@@ -5972,7 +5973,7 @@ await client.listing.driverBiddingGroups.deleteV1("group_id");
 <dl>
 <dd>
 
-Lists driver bidding groups owned by the caller's org with filtering, sorting, and pagination. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (DriverBiddingGroupListRes)
+Lists driver bidding groups owned by the caller's org with filtering, sorting, pagination, and member driver profiles. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (DriverBiddingGroupListRes)
 
 </dd>
 </dl>
@@ -7367,7 +7368,7 @@ await client.listing.orgBiddingGroups.deleteV1("group_id");
 <dl>
 <dd>
 
-Lists org bidding groups owned by the caller's org with filtering, sorting, and pagination. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (OrgBiddingGroupListRes)
+Lists org bidding groups owned by the caller's org with filtering, sorting, pagination, and member organization public data. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (OrgBiddingGroupListRes)
 
 </dd>
 </dl>
@@ -9304,7 +9305,7 @@ await client.operations.departments.addOperatorV1("department_id", "user_id");
 <dl>
 <dd>
 
-Lists department configurations for the caller's organization. | authz: min_org_role=operator | () -> (DepartmentListRes)
+Lists department configurations for the caller's organization with filtering, sorting, pagination, and Atlas Search. | authz: min_org_role=operator | () -> (DepartmentListRes)
 
 </dd>
 </dl>
@@ -9323,6 +9324,7 @@ Lists department configurations for the caller's organization. | authz: min_org_
 await client.operations.departments.listV1({
     sort_by: "created_at",
     sort_order: "asc",
+    search: "search",
     page: 1,
     page_size: 1,
     filter_department_type: ["aerospace"],
@@ -9710,7 +9712,7 @@ await client.operations.departments.updateV1("department_id");
 <dl>
 <dd>
 
-Materializes each entry of an OperationsTaskList into an OperationsTask on the Order (status=not_started, source_task_list_id set). Deadlines resolve per-entry from its anchor+offset; initial_deadline_timestamp, if set, pins the first entry and the chain follows. department_id overrides the caller's Order department when supplied. No dedup — applying twice creates duplicate tasks. | authz: min_org_role=operator | () -> (list[PydanticObjectId])
+Materializes each entry of an OperationsTaskList into an OperationsTask on the Order (status=not_started, source_task_list_id set). Deadlines resolve per-entry from its anchor+offset; initial_deadline_timestamp, if set, pins the first entry and the chain follows. department_id explicitly assigns the materialized tasks; omitted leaves them unassigned. No dedup — applying twice creates duplicate tasks. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | () -> (list[PydanticObjectId])
 
 </dd>
 </dl>
@@ -9728,6 +9730,7 @@ Materializes each entry of an OperationsTaskList into an OperationsTask on the O
 ```typescript
 await client.operations.operationsTaskLists.applyToOrderV1("task_list_id", "order_id", {
     department_id: "department_id",
+    entry_tag: "entry_tag",
     initial_deadline_timestamp: "2024-01-15T09:30:00Z",
 });
 ```
@@ -10155,7 +10158,7 @@ await client.operations.operationsTaskLists.reorderEntriesV1("task_list_id");
 <dl>
 <dd>
 
-Lists OperationsTaskLists for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OperationsTaskListListRes)
+Lists OperationsTaskLists for the caller's organization with filtering, sorting, pagination, and Atlas Search. | authz: min_org_role=operator | () -> (OperationsTaskListListRes)
 
 </dd>
 </dl>
@@ -10174,6 +10177,7 @@ Lists OperationsTaskLists for the caller's organization with filtering, sorting,
 await client.operations.operationsTaskLists.listV1({
     sort_by: "created_at_timestamp",
     sort_order: "asc",
+    search: "search",
     page: 1,
     page_size: 1,
     filter_archived: true,
@@ -10224,7 +10228,7 @@ await client.operations.operationsTaskLists.listV1({
 <dl>
 <dd>
 
-Removes the OperationsTasks this OperationsTaskList added to the Order (matched by source_task_list_id). Only untouched (not_started) tasks are deleted; started/completed/skipped/cancelled tasks are kept. Returns deleted and kept counts. | authz: min_org_role=operator | () -> (OperationsTaskListRemoveFromOrderRes1)
+Removes the OperationsTasks this OperationsTaskList added to the Order (matched by source_task_list_id). Only untouched (not_started) tasks are deleted; started/completed/skipped/cancelled tasks are kept. Returns deleted and kept counts. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | () -> (OperationsTaskListRemoveFromOrderRes1)
 
 </dd>
 </dl>
@@ -10800,6 +10804,7 @@ await client.operations.operationsTasks.expandedListV1({
     filter_status: ["not_started"],
     filter_assigned_user_id: "filter_assigned_user_id",
     filter_source_task_list_id: "filter_source_task_list_id",
+    filter_entry_tag: "filter_entry_tag",
     filter_deadline_gte: "2024-01-15T09:30:00Z",
     filter_deadline_lte: "2024-01-15T09:30:00Z",
 });
@@ -10849,7 +10854,7 @@ await client.operations.operationsTasks.expandedListV1({
 <dl>
 <dd>
 
-Lists OperationsTasks for the caller's organization, with order ids / order short id / order off-CHRT reference id / department / type / status / assignee / source task list / deadline filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OperationsTaskListRes)
+Lists OperationsTasks for the caller's organization, with order ids / order short id / order off-CHRT reference id / department / type / status / assignee / source task list / entry tag / deadline filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OperationsTaskListRes)
 
 </dd>
 </dl>
@@ -10879,6 +10884,7 @@ await client.operations.operationsTasks.listV1({
     filter_status: ["not_started"],
     filter_assigned_user_id: "filter_assigned_user_id",
     filter_source_task_list_id: "filter_source_task_list_id",
+    filter_entry_tag: "filter_entry_tag",
     filter_deadline_gte: "2024-01-15T09:30:00Z",
     filter_deadline_lte: "2024-01-15T09:30:00Z",
 });
@@ -11052,6 +11058,71 @@ await client.operations.operationsTasks.setStatusV1({
 </dl>
 </details>
 
+<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">updateDepartmentManyV1</a>({ ...params }) -> Chrt.OperationsTasksUpdateDepartmentManyRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Assigns or clears one department on selected tasks across orders. Missing and other-org tasks are skipped. | authz: min_org_role=operator | (OperationsTasksUpdateDepartmentManyReq) -> (OperationsTasksUpdateDepartmentManyRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.operations.operationsTasks.updateDepartmentManyV1({
+    operations_task_ids: ["operations_task_ids"],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.operations.OperationsTasksUpdateDepartmentManyReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OperationsTasks.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
 <dl>
 <dd>
@@ -11064,7 +11135,7 @@ await client.operations.operationsTasks.setStatusV1({
 <dl>
 <dd>
 
-Creates a new OperationsTask on an Order where the caller is coordinator or executor. Seeds department_id from the caller's Order department fields. | authz: min_org_role=operator | (OperationsTaskClientCreate1) -> (PydanticObjectId)
+Creates a new OperationsTask on an Order where the caller is coordinator or executor. Uses the explicit department_id or leaves the task unassigned. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OperationsTaskClientCreate1) -> (PydanticObjectId)
 
 </dd>
 </dl>
@@ -14728,6 +14799,69 @@ await client.orgs.connections.shippers.typeaheadV1({
 
 ## Shipping Drivers
 
+<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">archiveV1</a>(driverId) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Archives a driver after draft, staged, and in-progress assignments are resolved, and denies their open bid threads. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipping.drivers.archiveV1("driver_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**driverId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Drivers.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
 <dl>
 <dd>
@@ -14937,6 +15071,8 @@ await client.shipping.drivers.listV1({
     page: 1,
     page_size: 1,
     search: "search",
+    filter_by_driver_id: "filter_by_driver_id",
+    filter_archived: true,
     filter_available_according_to_driver: true,
     filter_available_according_to_operators: true,
     filter_status: ["unassigned"],
@@ -15005,6 +15141,7 @@ Lists all organization members paired with their driver information if they are
 ```typescript
 await client.shipping.drivers.listOrgMembersAndDriversV1({
     search: "search",
+    filter_archived: true,
     filter_role: ["owner"],
     filter_available_according_to_driver: true,
     filter_available_according_to_operators: true,
@@ -15557,6 +15694,69 @@ await client.shipping.drivers.getStatsV1("driver_id", {
 </dl>
 </details>
 
+<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">unarchiveV1</a>(driverId) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Restores an archived driver with active organization membership. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipping.drivers.unarchiveV1("driver_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**driverId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Drivers.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateV1</a>(driverId, { ...params }) -> boolean</code></summary>
 <dl>
 <dd>
@@ -17012,6 +17212,7 @@ Adds or updates a coordinator task list to apply when the draft is staged. | aut
 ```typescript
 await client.shipping.orders.addCoordinatorTaskListToApplyAtOrderStagingV1("order_id", "task_list_id", {
     department_id: "department_id",
+    entry_tag: "entry_tag",
     body: "2024-01-15T09:30:00Z",
 });
 ```
@@ -17338,7 +17539,7 @@ await client.shipping.orders.stageV1("order_id");
 <dl>
 <dd>
 
-Returns the coordinator's account-level default department for the order's shipper. | authz: min_org_role=operator | () -> (PydanticObjectId | None)
+Returns the coordinator's account-level default department for the order's shipper. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | () -> (PydanticObjectId | None)
 
 </dd>
 </dl>
@@ -17730,7 +17931,7 @@ await client.shipping.orders.undoCancelV1("order_id");
 </dl>
 </details>
 
-<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">updateDepartmentV1</a>(orderId, { ...params }) -> boolean</code></summary>
+<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">updateDepartmentsV1</a>(orderId, { ...params }) -> boolean</code></summary>
 <dl>
 <dd>
 
@@ -17742,7 +17943,7 @@ await client.shipping.orders.undoCancelV1("order_id");
 <dl>
 <dd>
 
-Updates department_id for the caller's role on the order. Coordinator writes coordinator_department_id; executor writes executor_department_id on matching task_group_details rows. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OrdersUpdateDepartmentReq) -> (bool)
+Replaces department_ids for the caller's role on the order. Coordinator writes coordinator_department_ids; executor writes executor_department_ids on matching task_group_details rows. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OrdersUpdateDepartmentsReq) -> (bool)
 
 </dd>
 </dl>
@@ -17758,7 +17959,7 @@ Updates department_id for the caller's role on the order. Coordinator writes coo
 <dd>
 
 ```typescript
-await client.shipping.orders.updateDepartmentV1("order_id");
+await client.shipping.orders.updateDepartmentsV1("order_id");
 ```
 
 </dd>
@@ -17782,7 +17983,7 @@ await client.shipping.orders.updateDepartmentV1("order_id");
 <dl>
 <dd>
 
-**request:** `Chrt.shipping.OrdersUpdateDepartmentReq`
+**request:** `Chrt.shipping.OrdersUpdateDepartmentsReq`
 
 </dd>
 </dl>
@@ -22017,13 +22218,13 @@ await client.shipping.orders.expanded.listForProviderOperatorsV1({
     filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
     filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
     filter_executor_org_id: "filter_executor_org_id",
-    filter_executor_department_id: "filter_executor_department_id",
+    filter_executor_department_ids: ["filter_executor_department_ids"],
     filter_off_chrt_executor_org_data_id: "filter_off_chrt_executor_org_data_id",
     filter_coordinator_org_id: "filter_coordinator_org_id",
     filter_shipper_org_id: "filter_shipper_org_id",
     filter_off_chrt_shipper_org_data_id: "filter_off_chrt_shipper_org_data_id",
     filter_coordinator_shipper_account_ids: ["filter_coordinator_shipper_account_ids"],
-    filter_coordinator_department_id: "filter_coordinator_department_id",
+    filter_coordinator_department_ids: ["filter_coordinator_department_ids"],
     filter_coordinator_assigned_user_ids: ["filter_coordinator_assigned_user_ids"],
     filter_coordinator_label: "filter_coordinator_label",
     body: {},
@@ -23138,7 +23339,7 @@ await client.shipping.orders.taskGroup.setTaskOrderingV1("task_group_id", {
 <dl>
 <dd>
 
-Sets the task-group vehicle type in any lifecycle state. | authz_personas=[draft_creator_org_operator, task_group_coordinator_operators] | (OrdersSetTaskGroupVehicleTypeReq) -> (bool)
+Sets the task-group vehicle type in any lifecycle state; vehicle_type\_\_set_to_None clears it. | authz_personas=[draft_creator_org_operator, task_group_coordinator_operators] | (OrdersSetTaskGroupVehicleTypeReq) -> (bool)
 
 </dd>
 </dl>
@@ -23154,9 +23355,7 @@ Sets the task-group vehicle type in any lifecycle state. | authz_personas=[draft
 <dd>
 
 ```typescript
-await client.shipping.orders.taskGroup.setVehicleTypeV1("task_group_id", {
-    vehicle_type: "sedan",
-});
+await client.shipping.orders.taskGroup.setVehicleTypeV1("task_group_id");
 ```
 
 </dd>