@chrt-inc/typescript-sdk 1.563.0 → 1.576.0

package/reference.md

@@ -69,7 +69,7 @@ await client.orgs.getInfoV1();
 <dl>
 <dd>
 
-Lists all members of the caller's organization with their roles and details. | () -> (OrgMemberListRes)
+Lists all members of the caller's organization with their roles and details. Supports search by name, filtering by role, sorting, and pagination. | () -> (OrgMemberListRes)
 
 </dd>
 </dl>
@@ -90,6 +90,7 @@ await client.orgs.listMembersV1({
     sort_order: "asc",
     page: 1,
     page_size: 1,
+    search: "search",
 });
 ```
 
@@ -5409,7 +5410,7 @@ await client.notifications.webhookSetup.turnOffV1();
 <dl>
 <dd>
 
-Lists shipper organizations based on the caller's organization type. Couriers see connected shippers, forwarders see connected shippers. | () -> (ShipperConnectionListRes)
+Lists shipper organizations based on the caller's organization type with optional search by company name or handle. | () -> (ShipperConnectionListRes)
 
 </dd>
 </dl>
@@ -5426,6 +5427,7 @@ Lists shipper organizations based on the caller's organization type. Couriers se
 
 ```typescript
 await client.orgs.connections.listShippersV1({
+    search: "search",
     page: 1,
     page_size: 1,
 });
@@ -5475,7 +5477,7 @@ await client.orgs.connections.listShippersV1({
 <dl>
 <dd>
 
-Lists courier organizations based on the caller's organization type. Shippers see connected couriers, forwarders see connected couriers. | () -> (CourierConnectionListRes)
+Lists courier organizations based on the caller's organization type with optional search by company name or handle. | () -> (CourierConnectionListRes)
 
 </dd>
 </dl>
@@ -5492,6 +5494,7 @@ Lists courier organizations based on the caller's organization type. Shippers se
 
 ```typescript
 await client.orgs.connections.listCouriersV1({
+    search: "search",
     page: 1,
     page_size: 1,
 });
@@ -5541,7 +5544,7 @@ await client.orgs.connections.listCouriersV1({
 <dl>
 <dd>
 
-Lists forwarder organizations based on the caller's organization type. Shippers see connected forwarders, couriers see connected forwarders. | () -> (ForwarderConnectionListRes)
+Lists forwarder organizations based on the caller's organization type with optional search by company name or handle. | () -> (ForwarderConnectionListRes)
 
 </dd>
 </dl>
@@ -5558,6 +5561,7 @@ Lists forwarder organizations based on the caller's organization type. Shippers
 
 ```typescript
 await client.orgs.connections.listForwardersV1({
+    search: "search",
     page: 1,
     page_size: 1,
 });
@@ -5933,7 +5937,7 @@ await client.orgs.offChrtShipperOrg.createV1({
 <dl>
 <dd>
 
-Lists all off-platform shipper organizations created by the caller's organization. | () -> (OffChrtShipperOrgListRes)
+Lists all off-platform shipper organizations created by the caller's organization with optional search by company name. | () -> (OffChrtShipperOrgListRes)
 
 </dd>
 </dl>
@@ -5950,6 +5954,7 @@ Lists all off-platform shipper organizations created by the caller's organizatio
 
 ```typescript
 await client.orgs.offChrtShipperOrg.listV1({
+    search: "search",
     page: 1,
     page_size: 1,
 });
@@ -7639,7 +7644,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",
 });
 ```
@@ -7808,7 +7813,7 @@ await client.shipping.drivers.getByDriverIdV1("driver_id");
 <dl>
 <dd>
 
-Lists all organization members paired with their driver information if they are drivers. Filter by availability. | () -> (OrgMembersAndDriversListRes)
+Lists all organization members paired with their driver information if they are drivers. Supports search by name, filtering, sorting, and pagination. | () -> (OrgMembersAndDriversListRes)
 
 </dd>
 </dl>
@@ -7825,8 +7830,11 @@ Lists all organization members paired with their driver information if they are
 
 ```typescript
 await client.shipping.drivers.listOrgMembersAndDriversV1({
+    search: "search",
     filter_available_according_to_driver: true,
     filter_available_according_to_operators: true,
+    sort_by: "first_name",
+    sort_order: "asc",
     page: 1,
     page_size: 1,
 });
@@ -11186,7 +11194,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 +11222,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 +11238,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 +11338,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 +11366,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 +11382,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 +11409,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 +11437,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 +11453,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>
@@ -11970,7 +11978,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>
 
@@ -11998,7 +12006,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>
@@ -12014,7 +12022,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>
@@ -12033,7 +12041,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>
 
@@ -12061,7 +12069,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>
@@ -12077,7 +12085,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>
@@ -14445,7 +14453,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>
 
@@ -14457,7 +14465,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>
@@ -14473,7 +14481,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>
@@ -14489,7 +14497,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>
@@ -16092,7 +16100,7 @@ await client.users.directoryEntries.getV1("directory_entry_id");
 <dl>
 <dd>
 
-Lists directory entries with pagination and optional full-text search. | authz: min_org_role=operator | () -> (DirectoryEntryListRes)
+Lists directory entries with pagination, optional filtering by entry_org_id, and optional full-text search. | authz: min_org_role=operator | () -> (DirectoryEntryListRes)
 
 </dd>
 </dl>
@@ -16110,6 +16118,7 @@ Lists directory entries with pagination and optional full-text search. | authz:
 ```typescript
 await client.users.directoryEntries.listV1({
     search: "search",
+    filter_entry_org_id: "filter_entry_org_id",
     sort_by: "company_name",
     sort_order: "asc",
     page: 1,