@chrt-inc/typescript-sdk 1.563.0 → 1.576.0

package/dist/esm/api/resources/orgs/resources/connections/client/Client.d.mts

@@ -31,7 +31,7 @@ export declare class Connections {
     protected readonly _options: Connections.Options;
     constructor(_options?: Connections.Options);
     /**
-     * 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)
      *
      * @param {Chrt.orgs.ConnectionsListShippersV1Request} request
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
@@ -40,6 +40,7 @@ export declare class Connections {
      *
      * @example
      *     await client.orgs.connections.listShippersV1({
+     *         search: "search",
      *         page: 1,
      *         page_size: 1
      *     })
@@ -47,7 +48,7 @@ export declare class Connections {
     listShippersV1(request?: Chrt.orgs.ConnectionsListShippersV1Request, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<Chrt.ShipperConnectionListRes>;
     private __listShippersV1;
     /**
-     * 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)
      *
      * @param {Chrt.orgs.ConnectionsListCouriersV1Request} request
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
@@ -56,6 +57,7 @@ export declare class Connections {
      *
      * @example
      *     await client.orgs.connections.listCouriersV1({
+     *         search: "search",
      *         page: 1,
      *         page_size: 1
      *     })
@@ -63,7 +65,7 @@ export declare class Connections {
     listCouriersV1(request?: Chrt.orgs.ConnectionsListCouriersV1Request, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<Chrt.CourierConnectionListRes>;
     private __listCouriersV1;
     /**
-     * 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)
      *
      * @param {Chrt.orgs.ConnectionsListForwardersV1Request} request
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
@@ -72,6 +74,7 @@ export declare class Connections {
      *
      * @example
      *     await client.orgs.connections.listForwardersV1({
+     *         search: "search",
      *         page: 1,
      *         page_size: 1
      *     })

package/dist/esm/api/resources/orgs/resources/connections/client/Client.mjs

@@ -20,7 +20,7 @@ export class Connections {
         this._options = _options;
     }
     /**
-     * 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)
      *
      * @param {Chrt.orgs.ConnectionsListShippersV1Request} request
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
@@ -29,6 +29,7 @@ export class Connections {
      *
      * @example
      *     await client.orgs.connections.listShippersV1({
+     *         search: "search",
      *         page: 1,
      *         page_size: 1
      *     })
@@ -39,8 +40,11 @@ export class Connections {
     __listShippersV1() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f;
-            const { page, page_size: pageSize } = request;
+            const { search, page, page_size: pageSize } = request;
             const _queryParams = {};
+            if (search !== undefined) {
+                _queryParams["search"] = search;
+            }
             if (page !== undefined) {
                 _queryParams["page"] = (_a = page === null || page === void 0 ? void 0 : page.toString()) !== null && _a !== void 0 ? _a : null;
             }
@@ -90,7 +94,7 @@ export class Connections {
         });
     }
     /**
-     * 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)
      *
      * @param {Chrt.orgs.ConnectionsListCouriersV1Request} request
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
@@ -99,6 +103,7 @@ export class Connections {
      *
      * @example
      *     await client.orgs.connections.listCouriersV1({
+     *         search: "search",
      *         page: 1,
      *         page_size: 1
      *     })
@@ -109,8 +114,11 @@ export class Connections {
     __listCouriersV1() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f;
-            const { page, page_size: pageSize } = request;
+            const { search, page, page_size: pageSize } = request;
             const _queryParams = {};
+            if (search !== undefined) {
+                _queryParams["search"] = search;
+            }
             if (page !== undefined) {
                 _queryParams["page"] = (_a = page === null || page === void 0 ? void 0 : page.toString()) !== null && _a !== void 0 ? _a : null;
             }
@@ -160,7 +168,7 @@ export class Connections {
         });
     }
     /**
-     * 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)
      *
      * @param {Chrt.orgs.ConnectionsListForwardersV1Request} request
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
@@ -169,6 +177,7 @@ export class Connections {
      *
      * @example
      *     await client.orgs.connections.listForwardersV1({
+     *         search: "search",
      *         page: 1,
      *         page_size: 1
      *     })
@@ -179,8 +188,11 @@ export class Connections {
     __listForwardersV1() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f;
-            const { page, page_size: pageSize } = request;
+            const { search, page, page_size: pageSize } = request;
             const _queryParams = {};
+            if (search !== undefined) {
+                _queryParams["search"] = search;
+            }
             if (page !== undefined) {
                 _queryParams["page"] = (_a = page === null || page === void 0 ? void 0 : page.toString()) !== null && _a !== void 0 ? _a : null;
             }

package/dist/esm/api/resources/orgs/resources/connections/client/requests/ConnectionsListCouriersV1Request.d.mts

@@ -4,11 +4,14 @@
 /**
  * @example
  *     {
+ *         search: "search",
  *         page: 1,
  *         page_size: 1
  *     }
  */
 export interface ConnectionsListCouriersV1Request {
+    /** Search by company name or handle */
+    search?: string | null;
     page?: number | null;
     page_size?: number | null;
 }

package/dist/esm/api/resources/orgs/resources/connections/client/requests/ConnectionsListForwardersV1Request.d.mts

@@ -4,11 +4,14 @@
 /**
  * @example
  *     {
+ *         search: "search",
  *         page: 1,
  *         page_size: 1
  *     }
  */
 export interface ConnectionsListForwardersV1Request {
+    /** Search by company name or handle */
+    search?: string | null;
     page?: number | null;
     page_size?: number | null;
 }

package/dist/esm/api/resources/orgs/resources/connections/client/requests/ConnectionsListShippersV1Request.d.mts

@@ -4,11 +4,14 @@
 /**
  * @example
  *     {
+ *         search: "search",
  *         page: 1,
  *         page_size: 1
  *     }
  */
 export interface ConnectionsListShippersV1Request {
+    /** Search by company name or handle */
+    search?: string | null;
     page?: number | null;
     page_size?: number | null;
 }

package/dist/esm/api/resources/orgs/resources/offChrtShipperOrg/client/Client.d.mts

@@ -47,7 +47,7 @@ export declare class OffChrtShipperOrg {
     createV1(request: Chrt.orgs.OffChrtShipperOrgClientCreate1, requestOptions?: OffChrtShipperOrg.RequestOptions): core.HttpResponsePromise<string>;
     private __createV1;
     /**
-     * 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)
      *
      * @param {Chrt.orgs.OffChrtShipperOrgListV1Request} request
      * @param {OffChrtShipperOrg.RequestOptions} requestOptions - Request-specific configuration.
@@ -56,6 +56,7 @@ export declare class OffChrtShipperOrg {
      *
      * @example
      *     await client.orgs.offChrtShipperOrg.listV1({
+     *         search: "search",
      *         page: 1,
      *         page_size: 1
      *     })

package/dist/esm/api/resources/orgs/resources/offChrtShipperOrg/client/Client.mjs

@@ -85,7 +85,7 @@ export class OffChrtShipperOrg {
         });
     }
     /**
-     * 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)
      *
      * @param {Chrt.orgs.OffChrtShipperOrgListV1Request} request
      * @param {OffChrtShipperOrg.RequestOptions} requestOptions - Request-specific configuration.
@@ -94,6 +94,7 @@ export class OffChrtShipperOrg {
      *
      * @example
      *     await client.orgs.offChrtShipperOrg.listV1({
+     *         search: "search",
      *         page: 1,
      *         page_size: 1
      *     })
@@ -104,8 +105,11 @@ export class OffChrtShipperOrg {
     __listV1() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f;
-            const { page, page_size: pageSize } = request;
+            const { search, page, page_size: pageSize } = request;
             const _queryParams = {};
+            if (search !== undefined) {
+                _queryParams["search"] = search;
+            }
             if (page !== undefined) {
                 _queryParams["page"] = (_a = page === null || page === void 0 ? void 0 : page.toString()) !== null && _a !== void 0 ? _a : null;
             }

package/dist/esm/api/resources/orgs/resources/offChrtShipperOrg/client/requests/OffChrtShipperOrgListV1Request.d.mts

@@ -4,11 +4,14 @@
 /**
  * @example
  *     {
+ *         search: "search",
  *         page: 1,
  *         page_size: 1
  *     }
  */
 export interface OffChrtShipperOrgListV1Request {
+    /** Search by company name */
+    search?: string | null;
     page?: number | null;
     page_size?: number | null;
 }

package/dist/esm/api/resources/orgs/resources/orgProfiles/client/requests/CourierOrgProfileClientCreate1.d.mts

@@ -14,5 +14,6 @@ export interface CourierOrgProfileClientCreate1 {
     schema_version: number;
     description: string;
     email_address_primary: string;
+    /** E.164 formatted phone number (e.g. +16505551234). Assumes US country code if none provided. */
     phone_number_primary: string;
 }

package/dist/esm/api/resources/orgs/resources/orgProfiles/client/requests/ForwarderOrgProfileClientCreate1.d.mts

@@ -14,5 +14,6 @@ export interface ForwarderOrgProfileClientCreate1 {
     schema_version: number;
     description: string;
     email_address_primary: string;
+    /** E.164 formatted phone number (e.g. +16505551234). Assumes US country code if none provided. */
     phone_number_primary: string;
 }

package/dist/esm/api/resources/orgs/resources/publicData/client/requests/CreateOrgPublicDataReq.d.mts

@@ -6,6 +6,7 @@
  *     {}
  */
 export interface CreateOrgPublicDataReq {
+    /** Must be a string starting with `@`. May only contain a-z, A-Z, 0-9, _, -. May not be longer than 30 characters. */
     handle?: string | null;
     company_name?: string | null;
 }

package/dist/esm/api/resources/orgs/resources/publicData/client/requests/UpdateOrgPublicDataReq.d.mts

@@ -6,6 +6,7 @@
  *     {}
  */
 export interface UpdateOrgPublicDataReq {
+    /** Must be a string starting with `@`. May only contain a-z, A-Z, 0-9, _, -. May not be longer than 30 characters. */
     handle?: string | null;
     company_name?: string | null;
 }

package/dist/esm/api/resources/shipping/resources/docs/client/requests/GenerateShippingDocReq.d.mts

@@ -5,11 +5,11 @@ import * as Chrt from "../../../../../../index.mjs";
 /**
  * @example
  *     {
- *         order_id_or_short_id: "order_id_or_short_id",
+ *         order_ref: "order_ref",
  *         template: "pod"
  *     }
  */
 export interface GenerateShippingDocReq {
-    order_id_or_short_id: string;
+    order_ref: string;
     template: Chrt.ShippingDocTemplateEnum;
 }

package/dist/esm/api/resources/shipping/resources/drivers/client/Client.d.mts

@@ -54,7 +54,7 @@ export declare class Drivers {
     getByDriverIdV1(driverId: string, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.Driver1>;
     private __getByDriverIdV1;
     /**
-     * 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)
      *
      * @param {Chrt.shipping.DriversListOrgMembersAndDriversV1Request} request
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
@@ -63,8 +63,11 @@ export declare class Drivers {
      *
      * @example
      *     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
      *     })

package/dist/esm/api/resources/shipping/resources/drivers/client/Client.mjs

@@ -141,7 +141,7 @@ export class Drivers {
         });
     }
     /**
-     * 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)
      *
      * @param {Chrt.shipping.DriversListOrgMembersAndDriversV1Request} request
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
@@ -150,8 +150,11 @@ export class Drivers {
      *
      * @example
      *     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
      *     })
@@ -162,8 +165,11 @@ export class Drivers {
     __listOrgMembersAndDriversV1() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h;
-            const { filter_role: filterRole, filter_available_according_to_driver: filterAvailableAccordingToDriver, filter_available_according_to_operators: filterAvailableAccordingToOperators, page, page_size: pageSize, } = request;
+            const { search, filter_role: filterRole, filter_available_according_to_driver: filterAvailableAccordingToDriver, filter_available_according_to_operators: filterAvailableAccordingToOperators, sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize, } = request;
             const _queryParams = {};
+            if (search !== undefined) {
+                _queryParams["search"] = search;
+            }
             if (filterRole !== undefined) {
                 if (Array.isArray(filterRole)) {
                     _queryParams["filter_role"] = filterRole.map((item) => item);
@@ -179,6 +185,12 @@ export class Drivers {
                 _queryParams["filter_available_according_to_operators"] =
                     (_b = filterAvailableAccordingToOperators === null || filterAvailableAccordingToOperators === void 0 ? void 0 : filterAvailableAccordingToOperators.toString()) !== null && _b !== void 0 ? _b : null;
             }
+            if (sortBy !== undefined) {
+                _queryParams["sort_by"] = sortBy;
+            }
+            if (sortOrder !== undefined) {
+                _queryParams["sort_order"] = sortOrder;
+            }
             if (page !== undefined) {
                 _queryParams["page"] = (_c = page === null || page === void 0 ? void 0 : page.toString()) !== null && _c !== void 0 ? _c : null;
             }

package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriversListOrgMembersAndDriversV1Request.d.mts

@@ -5,19 +5,28 @@ import * as Chrt from "../../../../../../index.mjs";
 /**
  * @example
  *     {
+ *         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
  *     }
  */
 export interface DriversListOrgMembersAndDriversV1Request {
+    /** Search by first or last name */
+    search?: string | null;
     /** Filter by organization role(s) */
     filter_role?: (Chrt.OrgRoleEnum | null) | (Chrt.OrgRoleEnum | null)[];
     /** Filter by driver's self-reported availability. */
     filter_available_according_to_driver?: boolean | null;
     /** Filter by operator-set availability. */
     filter_available_according_to_operators?: boolean | null;
+    /** Field to sort by */
+    sort_by?: Chrt.OrgMemberSortByEnum | null;
+    /** Sort order (asc or desc) */
+    sort_order?: Chrt.SortOrderEnum | null;
     page?: number | null;
     page_size?: number | null;
 }

package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/OrdersDraftUpdateReq.d.mts

@@ -14,6 +14,7 @@ export interface OrdersDraftUpdateReq {
     shipper_org_id__set_to_None?: boolean;
     off_chrt_shipper_org_id?: string | null;
     off_chrt_shipper_org_id__set_to_None?: boolean;
+    /** Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved). */
     off_chrt_reference_id?: string | null;
     off_chrt_reference_id__set_to_None?: boolean;
 }

package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/OrdersNewDraftReq.d.mts

@@ -11,5 +11,6 @@ export interface OrdersNewDraftReq {
     /** Must be a string starting with `org_` */
     shipper_org_id?: string | null;
     off_chrt_shipper_org_id?: string | null;
+    /** Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved). */
     off_chrt_reference_id?: string | null;
 }

package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.d.mts

@@ -33,16 +33,16 @@ export declare class Expanded {
     /**
      * Fetches a single draft order with optional expanded related data. Any user in the org (with operator+ role) can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)
      *
-     * @param {string} orderIdOrShortId
+     * @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
      * @param {Chrt.OrderAndTaskGroupExpandedReq} request
      * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipping.orderDrafts.expanded.retrieveV1("order_id_or_short_id", {})
+     *     await client.shipping.orderDrafts.expanded.retrieveV1("order_ref", {})
      */
-    retrieveV1(orderIdOrShortId: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderDraftExpanded>;
+    retrieveV1(orderRef: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderDraftExpanded>;
     private __retrieveV1;
     /**
      * Lists expanded draft orders for the organization with filtering, sorting, and pagination. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpandedListRes)

package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.mjs

@@ -22,24 +22,24 @@ export class Expanded {
     /**
      * Fetches a single draft order with optional expanded related data. Any user in the org (with operator+ role) can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)
      *
-     * @param {string} orderIdOrShortId
+     * @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
      * @param {Chrt.OrderAndTaskGroupExpandedReq} request
      * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipping.orderDrafts.expanded.retrieveV1("order_id_or_short_id", {})
+     *     await client.shipping.orderDrafts.expanded.retrieveV1("order_ref", {})
      */
-    retrieveV1(orderIdOrShortId, request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__retrieveV1(orderIdOrShortId, request, requestOptions));
+    retrieveV1(orderRef, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__retrieveV1(orderRef, request, requestOptions));
     }
-    __retrieveV1(orderIdOrShortId, request, requestOptions) {
+    __retrieveV1(orderRef, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
-                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/order_drafts/expanded/retrieve/v1/${encodeURIComponent(orderIdOrShortId)}`),
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/order_drafts/expanded/retrieve/v1/${encodeURIComponent(orderRef)}`),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
@@ -73,7 +73,7 @@ export class Expanded {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/order_drafts/expanded/retrieve/v1/{order_id_or_short_id}.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/order_drafts/expanded/retrieve/v1/{order_ref}.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,

package/dist/esm/api/resources/shipping/resources/orders/client/requests/OrdersUpdateOffChrtReferenceIdReq.d.mts

@@ -6,6 +6,7 @@
  *     {}
  */
 export interface OrdersUpdateOffChrtReferenceIdReq {
+    /** Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved). */
     off_chrt_reference_id?: string | null;
     off_chrt_reference_id__set_to_None?: boolean;
 }

package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.mts

@@ -33,30 +33,30 @@ export declare class Expanded {
     /**
      * Retrieves an expanded order with optional related data for shipper operators. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)
      *
-     * @param {string} orderIdOrShortId
+     * @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
      * @param {Chrt.OrderAndTaskGroupExpandedReq} request
      * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipping.orders.expanded.forShipperOperatorsV1("order_id_or_short_id", {})
+     *     await client.shipping.orders.expanded.forShipperOperatorsV1("order_ref", {})
      */
-    forShipperOperatorsV1(orderIdOrShortId: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderExpanded>;
+    forShipperOperatorsV1(orderRef: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderExpanded>;
     private __forShipperOperatorsV1;
     /**
      * Retrieves an expanded order with optional related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)
      *
-     * @param {string} orderIdOrShortId
+     * @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
      * @param {Chrt.OrderAndTaskGroupExpandedReq} request
      * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipping.orders.expanded.forForwarderOperatorsV1("order_id_or_short_id", {})
+     *     await client.shipping.orders.expanded.forForwarderOperatorsV1("order_ref", {})
      */
-    forForwarderOperatorsV1(orderIdOrShortId: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderExpanded>;
+    forForwarderOperatorsV1(orderRef: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderExpanded>;
     private __forForwarderOperatorsV1;
     /**
      * Lists expanded orders for forwarder operators with filtering, sorting, pagination, and optional search. | authz: allowed_org_types=[forwarder], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)

package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.mjs

@@ -22,24 +22,24 @@ export class Expanded {
     /**
      * Retrieves an expanded order with optional related data for shipper operators. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)
      *
-     * @param {string} orderIdOrShortId
+     * @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
      * @param {Chrt.OrderAndTaskGroupExpandedReq} request
      * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipping.orders.expanded.forShipperOperatorsV1("order_id_or_short_id", {})
+     *     await client.shipping.orders.expanded.forShipperOperatorsV1("order_ref", {})
      */
-    forShipperOperatorsV1(orderIdOrShortId, request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__forShipperOperatorsV1(orderIdOrShortId, request, requestOptions));
+    forShipperOperatorsV1(orderRef, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__forShipperOperatorsV1(orderRef, request, requestOptions));
     }
-    __forShipperOperatorsV1(orderIdOrShortId, request, requestOptions) {
+    __forShipperOperatorsV1(orderRef, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
-                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/orders/expanded/for_shipper_operators/v1/${encodeURIComponent(orderIdOrShortId)}`),
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/orders/expanded/for_shipper_operators/v1/${encodeURIComponent(orderRef)}`),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
@@ -73,7 +73,7 @@ export class Expanded {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/orders/expanded/for_shipper_operators/v1/{order_id_or_short_id}.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/orders/expanded/for_shipper_operators/v1/{order_ref}.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,
@@ -85,24 +85,24 @@ export class Expanded {
     /**
      * Retrieves an expanded order with optional related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)
      *
-     * @param {string} orderIdOrShortId
+     * @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
      * @param {Chrt.OrderAndTaskGroupExpandedReq} request
      * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipping.orders.expanded.forForwarderOperatorsV1("order_id_or_short_id", {})
+     *     await client.shipping.orders.expanded.forForwarderOperatorsV1("order_ref", {})
      */
-    forForwarderOperatorsV1(orderIdOrShortId, request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__forForwarderOperatorsV1(orderIdOrShortId, request, requestOptions));
+    forForwarderOperatorsV1(orderRef, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__forForwarderOperatorsV1(orderRef, request, requestOptions));
     }
-    __forForwarderOperatorsV1(orderIdOrShortId, request, requestOptions) {
+    __forForwarderOperatorsV1(orderRef, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
-                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/orders/expanded/for_forwarder_operators/v1/${encodeURIComponent(orderIdOrShortId)}`),
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/orders/expanded/for_forwarder_operators/v1/${encodeURIComponent(orderRef)}`),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
@@ -136,7 +136,7 @@ export class Expanded {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/orders/expanded/for_forwarder_operators/v1/{order_id_or_short_id}.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/orders/expanded/for_forwarder_operators/v1/{order_ref}.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,