@chrt-inc/typescript-sdk 1.314.0 → 1.318.0

package/reference.md

@@ -5497,132 +5497,6 @@ await client.offChrtShipperOrg.updateByIdV1("id");
 
 ## Orders
 
-<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">postExpandedListForShipperOperatorsV1</a>({ ...params }) -> Chrt.OrdersExpandedListRes</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Retrieves a list of expanded orders with optional filters and related data for shipper operators. | authz_personas=[shipper_org_operators] | (OrdersExpandedListForShipperReq) -> (OrdersExpandedListRes)
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.orders.postExpandedListForShipperOperatorsV1();
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Chrt.OrdersExpandedListForShipperReq`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Orders.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">postExpandedListForForwarderOperatorsV1</a>({ ...params }) -> Chrt.OrdersExpandedListRes</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Retrieves a list of expanded orders with optional filters and related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (OrdersExpandedListForForwarderReq) -> (OrdersExpandedListRes)
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.orders.postExpandedListForForwarderOperatorsV1();
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Chrt.OrdersExpandedListForForwarderReq`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Orders.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 <details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">stageV1</a>(orderId) -> boolean</code></summary>
 <dl>
 <dd>
@@ -6078,7 +5952,7 @@ await client.orderDrafts.validateV1("order_id");
 
 ## TaskGroups
 
-<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">postExpandedListForCourierOperatorsV1</a>({ ...params }) -> Chrt.TaskGroupExpandedListRes</code></summary>
+<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">getTaskGroupIdForCourierOperatorsV1</a>(byOrderIdOrShortId) -> string</code></summary>
 <dl>
 <dd>
 
@@ -6090,7 +5964,7 @@ await client.orderDrafts.validateV1("order_id");
 <dl>
 <dd>
 
-Retrieves a list of expanded task groups with optional filters and related data for courier operators. | authz_personas=[courier_org_operators] | (TaskGroupExpandedListReq) -> (TaskGroupExpandedListRes)
+Retrieves the task group ID for the courier organization assigned to an order. | authz_personas=[courier_org_operators] | () -> (PydanticObjectId)
 
 </dd>
 </dl>
@@ -6106,7 +5980,7 @@ Retrieves a list of expanded task groups with optional filters and related data
 <dd>
 
 ```typescript
-await client.taskGroups.postExpandedListForCourierOperatorsV1({});
+await client.taskGroups.getTaskGroupIdForCourierOperatorsV1("by_order_id_or_short_id");
 ```
 
 </dd>
@@ -6122,7 +5996,7 @@ await client.taskGroups.postExpandedListForCourierOperatorsV1({});
 <dl>
 <dd>
 
-**request:** `Chrt.TaskGroupExpandedListReq`
+**byOrderIdOrShortId:** `string`
 
 </dd>
 </dl>
@@ -6141,7 +6015,7 @@ await client.taskGroups.postExpandedListForCourierOperatorsV1({});
 </dl>
 </details>
 
-<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">postExpandedListForCourierDriverV1</a>({ ...params }) -> Chrt.TaskGroupExpandedListRes</code></summary>
+<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">getTaskGroupIdForCourierDriverV1</a>(byOrderIdOrShortId) -> string</code></summary>
 <dl>
 <dd>
 
@@ -6153,7 +6027,7 @@ await client.taskGroups.postExpandedListForCourierOperatorsV1({});
 <dl>
 <dd>
 
-Retrieves a list of expanded task groups with optional filters and related data for courier drivers. | authz_personas=[courier_driver] | (TaskGroupExpandedListReq) -> (TaskGroupExpandedListRes)
+Retrieves the task group ID for the courier driver assigned to an order. | authz_personas=[courier_driver] | () -> (PydanticObjectId)
 
 </dd>
 </dl>
@@ -6169,7 +6043,7 @@ Retrieves a list of expanded task groups with optional filters and related data
 <dd>
 
 ```typescript
-await client.taskGroups.postExpandedListForCourierDriverV1({});
+await client.taskGroups.getTaskGroupIdForCourierDriverV1("by_order_id_or_short_id");
 ```
 
 </dd>
@@ -6185,70 +6059,7 @@ await client.taskGroups.postExpandedListForCourierDriverV1({});
 <dl>
 <dd>
 
-**request:** `Chrt.TaskGroupExpandedListReq`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `TaskGroups.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">postExpandedListForForwarderOperatorsV1</a>({ ...params }) -> Chrt.TaskGroupExpandedListRes</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Retrieves a list of expanded task groups with optional filters and related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (TaskGroupExpandedListReq) -> (TaskGroupExpandedListRes)
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.taskGroups.postExpandedListForForwarderOperatorsV1({});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Chrt.TaskGroupExpandedListReq`
+**byOrderIdOrShortId:** `string`
 
 </dd>
 </dl>
@@ -9527,7 +9338,7 @@ await client.orderDrafts.cargo.deleteV1("cargo_id");
 
 ## Orders Expanded
 
-<details><summary><code>client.orders.expanded.<a href="/src/api/resources/orders/resources/expanded/client/Client.ts">forShipperOperatorsV1</a>(orderId, { ...params }) -> Chrt.OrderExpanded</code></summary>
+<details><summary><code>client.orders.expanded.<a href="/src/api/resources/orders/resources/expanded/client/Client.ts">forShipperOperatorsV1</a>(orderIdOrShortId, { ...params }) -> Chrt.OrderExpanded</code></summary>
 <dl>
 <dd>
 
@@ -9555,7 +9366,7 @@ Retrieves an expanded order with optional related data for shipper operators. |
 <dd>
 
 ```typescript
-await client.orders.expanded.forShipperOperatorsV1("order_id", {});
+await client.orders.expanded.forShipperOperatorsV1("order_id_or_short_id", {});
 ```
 
 </dd>
@@ -9571,7 +9382,7 @@ await client.orders.expanded.forShipperOperatorsV1("order_id", {});
 <dl>
 <dd>
 
-**orderId:** `string`
+**orderIdOrShortId:** `string`
 
 </dd>
 </dl>
@@ -9598,7 +9409,7 @@ await client.orders.expanded.forShipperOperatorsV1("order_id", {});
 </dl>
 </details>
 
-<details><summary><code>client.orders.expanded.<a href="/src/api/resources/orders/resources/expanded/client/Client.ts">forForwarderOperatorsV1</a>(orderId, { ...params }) -> Chrt.OrderExpanded</code></summary>
+<details><summary><code>client.orders.expanded.<a href="/src/api/resources/orders/resources/expanded/client/Client.ts">forForwarderOperatorsV1</a>(orderIdOrShortId, { ...params }) -> Chrt.OrderExpanded</code></summary>
 <dl>
 <dd>
 
@@ -9626,7 +9437,7 @@ Retrieves an expanded order with optional related data for forwarder operators.
 <dd>
 
 ```typescript
-await client.orders.expanded.forForwarderOperatorsV1("order_id", {});
+await client.orders.expanded.forForwarderOperatorsV1("order_id_or_short_id", {});
 ```
 
 </dd>
@@ -9642,7 +9453,7 @@ await client.orders.expanded.forForwarderOperatorsV1("order_id", {});
 <dl>
 <dd>
 
-**orderId:** `string`
+**orderIdOrShortId:** `string`
 
 </dd>
 </dl>
@@ -9669,6 +9480,168 @@ await client.orders.expanded.forForwarderOperatorsV1("order_id", {});
 </dl>
 </details>
 
+<details><summary><code>client.orders.expanded.<a href="/src/api/resources/orders/resources/expanded/client/Client.ts">listForForwarderOperatorsV1</a>({ ...params }) -> Chrt.OrdersExpandedListRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists expanded orders for forwarder operators with filtering, sorting, and pagination. | authz_personas=[forwarder_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orders.expanded.listForForwarderOperatorsV1({
+    sort_by: "draft_started_at_timestamp",
+    sort_order: "ascending",
+    page: 1,
+    page_size: 1,
+    filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_in_progress_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_completed_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_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_order_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    body: {},
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.orders.ExpandedListForForwarderOperatorsV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Expanded.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.orders.expanded.<a href="/src/api/resources/orders/resources/expanded/client/Client.ts">listForShipperOperatorsV1</a>({ ...params }) -> Chrt.OrdersExpandedListRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists expanded orders for shipper operators with filtering, sorting, and pagination. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.orders.expanded.listForShipperOperatorsV1({
+    sort_by: "draft_started_at_timestamp",
+    sort_order: "ascending",
+    page: 1,
+    page_size: 1,
+    filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_in_progress_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_completed_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_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_order_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    body: {},
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.orders.ExpandedListForShipperOperatorsV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Expanded.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## OrgInfoForConnections Shipper
 
 <details><summary><code>client.orgInfoForConnections.shipper.<a href="/src/api/resources/orgInfoForConnections/resources/shipper/client/Client.ts">getV1</a>() -> Chrt.ShipperOrgInfoForConnections1</code></summary>
@@ -11231,6 +11204,164 @@ await client.taskGroups.expanded.forForwarderOperatorsV1("task_group_id", {});
 </dl>
 </details>
 
+<details><summary><code>client.taskGroups.expanded.<a href="/src/api/resources/taskGroups/resources/expanded/client/Client.ts">listForCourierOperatorsV1</a>({ ...params }) -> Chrt.TaskGroupExpandedListRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists expanded task groups for courier operators with filtering, sorting, and pagination. | authz_personas=[courier_org_operators] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpandedListRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.taskGroups.expanded.listForCourierOperatorsV1({
+    sort_by: "draft_started_at_timestamp",
+    sort_order: "ascending",
+    page: 1,
+    page_size: 1,
+    filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_in_progress_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_completed_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",
+    body: {},
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.taskGroups.ExpandedListForCourierOperatorsV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Expanded.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.taskGroups.expanded.<a href="/src/api/resources/taskGroups/resources/expanded/client/Client.ts">listForCourierDriverV1</a>({ ...params }) -> Chrt.TaskGroupExpandedListRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists expanded task groups for courier driver with filtering, sorting, and pagination. | authz_personas=[courier_driver] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpandedListRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.taskGroups.expanded.listForCourierDriverV1({
+    sort_by: "draft_started_at_timestamp",
+    sort_order: "ascending",
+    page: 1,
+    page_size: 1,
+    filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_in_progress_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_completed_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",
+    body: {},
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.taskGroups.ExpandedListForCourierDriverV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Expanded.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Tracking CargoByDevice
 
 <details><summary><code>client.tracking.cargoByDevice.<a href="/src/api/resources/tracking/resources/cargoByDevice/client/Client.ts">lastSeenV1</a>({ ...params }) -> (Chrt.TrackingCargoByDeviceDataPoint1 | null) | undefined</code></summary>

package/dist/cjs/api/resources/orders/client/requests/OrdersExpandedListForForwarderReq.d.ts

@@ -1,28 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../../../../index.js";
-/**
- * @example
- *     {}
- */
-export interface OrdersExpandedListForForwarderReq {
-    expand_forwarder_org_company_name?: boolean;
-    expand_forwarder_org_handle?: boolean;
-    expand_shipper_org_company_name?: boolean;
-    expand_off_chrt_shipper_org_company_name?: boolean;
-    expand_tasks?: boolean;
-    expand_cargos?: boolean;
-    expand_task_artifacts?: boolean;
-    expand_shipper_contacts?: boolean;
-    expand_driver?: boolean;
-    expand_courier_org_company_name?: boolean;
-    expand_courier_org_handle?: boolean;
-    creator_org_ids_include?: string[] | null;
-    creator_org_ids_exclude?: string[] | null;
-    shipper_org_ids_include?: string[] | null;
-    shipper_org_ids_exclude?: string[] | null;
-    status?: Chrt.OrderStatusEnum1 | null;
-    skip?: number;
-    limit?: number;
-}

package/dist/cjs/api/resources/orders/client/requests/OrdersExpandedListForShipperReq.d.ts

@@ -1,28 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../../../../index.js";
-/**
- * @example
- *     {}
- */
-export interface OrdersExpandedListForShipperReq {
-    expand_forwarder_org_company_name?: boolean;
-    expand_forwarder_org_handle?: boolean;
-    expand_shipper_org_company_name?: boolean;
-    expand_off_chrt_shipper_org_company_name?: boolean;
-    expand_tasks?: boolean;
-    expand_cargos?: boolean;
-    expand_task_artifacts?: boolean;
-    expand_shipper_contacts?: boolean;
-    expand_driver?: boolean;
-    expand_courier_org_company_name?: boolean;
-    expand_courier_org_handle?: boolean;
-    creator_org_ids_include?: string[] | null;
-    creator_org_ids_exclude?: string[] | null;
-    forwarder_org_ids_include?: string[] | null;
-    forwarder_org_ids_exclude?: string[] | null;
-    status?: Chrt.OrderStatusEnum1 | null;
-    skip?: number;
-    limit?: number;
-}

package/dist/cjs/api/resources/orders/client/requests/index.d.ts

@@ -1,2 +0,0 @@
-export { type OrdersExpandedListForShipperReq } from "./OrdersExpandedListForShipperReq.js";
-export { type OrdersExpandedListForForwarderReq } from "./OrdersExpandedListForForwarderReq.js";