@chrt-inc/typescript-sdk 1.304.0 → 1.306.0

package/dist/cjs/api/types/OrgPublicData1.d.ts

@@ -4,10 +4,10 @@
 import * as Chrt from "../index.js";
 export interface OrgPublicData1 {
     schema_version: number;
+    org_type: Chrt.OrgTypeEnum;
     /** Must be a string starting with `org_` */
     org_id: string;
     company_name?: string | null;
     handle?: string | null;
-    org_type: Chrt.OrgTypeEnum;
     _id: string;
 }

package/dist/cjs/api/types/OrgRoleEnum.d.ts

@@ -0,0 +1,28 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Organization roles used by Clerk in `jwt.o.rol` field
+ *
+ * Hierarchy (highest to lowest):
+ *     owner > administrator > operator > driver
+ *
+ * Role availability by org type:
+ *     {owner, administrator, operator}  → COURIER | SHIPPER | FORWARDER
+ *     {driver}                          → COURIER only
+ *
+ * Note: Hierarchical enforcement depends on utils_oort_authz helper functions.
+ *
+ * Clerk dashboard with roles settings:
+ * - prod: https://dashboard.clerk.com/apps/app_2rDeFYQ7SBioYoMhG38FgirTE4Q/instances/ins_2rDmMgzRGFXd6Ml6N8eV8pOXeyI/organizations-settings/roles
+ * - dev: https://dashboard.clerk.com/apps/app_2rDeFYQ7SBioYoMhG38FgirTE4Q/instances/ins_2rDeFZFEZ3nIC9VQt3zYfvzL14Z/organizations-settings/roles
+ *
+ * Clerk includes the "org:" prefix automatically, so we use it in the enum.
+ */
+export type OrgRoleEnum = "org:owner" | "org:administrator" | "org:operator" | "org:driver";
+export declare const OrgRoleEnum: {
+    readonly OrgOwner: "org:owner";
+    readonly OrgAdministrator: "org:administrator";
+    readonly OrgOperator: "org:operator";
+    readonly OrgDriver: "org:driver";
+};

package/dist/cjs/api/types/OrgRoleEnum.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrgRoleEnum = void 0;
+exports.OrgRoleEnum = {
+    OrgOwner: "org:owner",
+    OrgAdministrator: "org:administrator",
+    OrgOperator: "org:operator",
+    OrgDriver: "org:driver",
+};

package/dist/cjs/api/types/TaskClientUpdate1.d.ts

@@ -6,6 +6,7 @@ export interface TaskClientUpdate1 {
     location?: Chrt.LocationFeature | null;
     action?: TaskClientUpdate1.Action | null;
     time_windows?: Chrt.TimeWindow1[] | null;
+    order_placer_comments?: string | null;
     shipper_contact_info_ids?: string[] | null;
     flight_number?: string | null;
 }

package/dist/cjs/api/types/TaskGroup1.d.ts

@@ -25,5 +25,6 @@ export interface TaskGroup1 {
     order_cancelled?: boolean;
     task_group_type: Chrt.TaskGroupTypeEnum1;
     task_group_mileage?: Chrt.TaskGroupMileage1 | null;
+    flight_number?: string | null;
     messages?: Chrt.TaskGroupMessage1[];
 }

package/dist/cjs/api/types/UserPublicData1.d.ts

@@ -4,8 +4,7 @@
 export interface UserPublicData1 {
     schema_version: number;
     primary_email_address?: string | null;
+    /** Must be a string starting with `user_` */
     user_id: string;
-    customer_id?: string | null;
-    notes?: Record<string, unknown> | null;
     _id: string;
 }

package/dist/cjs/api/types/index.d.ts

@@ -21,6 +21,7 @@ export * from "./CreateCheckoutSessionRes.js";
 export * from "./CreateConnectAccountLinkRes.js";
 export * from "./CreateConnectAccountRes.js";
 export * from "./CreateConnectionReq.js";
+export * from "./CreateOrgPublicDataRes.js";
 export * from "./CreateShipperPayCourierPaymentReq.js";
 export * from "./CreateShipperPayCourierStatementReq.js";
 export * from "./DecodedJwtWithOrgAndUserId.js";
@@ -69,6 +70,7 @@ export * from "./OrgMemberDetails.js";
 export * from "./OrgMembersAndDrivers.js";
 export * from "./OrgProfileRes1.js";
 export * from "./OrgPublicData1.js";
+export * from "./OrgRoleEnum.js";
 export * from "./OrgTypeEnum.js";
 export * from "./OutlierLabellerEnum.js";
 export * from "./PaymentPreviewResponse.js";

package/dist/cjs/api/types/index.js

@@ -37,6 +37,7 @@ __exportStar(require("./CreateCheckoutSessionRes.js"), exports);
 __exportStar(require("./CreateConnectAccountLinkRes.js"), exports);
 __exportStar(require("./CreateConnectAccountRes.js"), exports);
 __exportStar(require("./CreateConnectionReq.js"), exports);
+__exportStar(require("./CreateOrgPublicDataRes.js"), exports);
 __exportStar(require("./CreateShipperPayCourierPaymentReq.js"), exports);
 __exportStar(require("./CreateShipperPayCourierStatementReq.js"), exports);
 __exportStar(require("./DecodedJwtWithOrgAndUserId.js"), exports);
@@ -85,6 +86,7 @@ __exportStar(require("./OrgMemberDetails.js"), exports);
 __exportStar(require("./OrgMembersAndDrivers.js"), exports);
 __exportStar(require("./OrgProfileRes1.js"), exports);
 __exportStar(require("./OrgPublicData1.js"), exports);
+__exportStar(require("./OrgRoleEnum.js"), exports);
 __exportStar(require("./OrgTypeEnum.js"), exports);
 __exportStar(require("./OutlierLabellerEnum.js"), exports);
 __exportStar(require("./PaymentPreviewResponse.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.304.0";
+export declare const SDK_VERSION = "1.306.0";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "1.304.0";
+exports.SDK_VERSION = "1.306.0";

package/dist/esm/Client.mjs

@@ -35,8 +35,8 @@ export class ChrtClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
-                "X-Fern-SDK-Version": "1.304.0",
-                "User-Agent": "@chrt-inc/typescript-sdk/1.304.0",
+                "X-Fern-SDK-Version": "1.306.0",
+                "User-Agent": "@chrt-inc/typescript-sdk/1.306.0",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

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

@@ -31,7 +31,7 @@ export declare class Drivers {
     protected readonly _options: Drivers.Options;
     constructor(_options?: Drivers.Options);
     /**
-     * Lists all organization members paired with their driver information if they are drivers.
+     * Lists all organization members paired with their driver information if they are drivers. | () -> (list[OrgMembersAndDrivers])
      *
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -41,7 +41,7 @@ export declare class Drivers {
     listOrgMembersAndDriversV1(requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.OrgMembersAndDrivers[]>;
     private __listOrgMembersAndDriversV1;
     /**
-     * Lists all drivers belonging to the authenticated organization.
+     * Lists all drivers belonging to the authenticated organization. | () -> (list[Driver1])
      *
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -51,7 +51,7 @@ export declare class Drivers {
     listV1(requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.Driver1[]>;
     private __listV1;
     /**
-     * Creates a new driver profile for an organization member with optional vehicle type assignments.
+     * Creates a new driver profile for an organization member with optional vehicle type assignments. | (DriverCreateReq) -> (PydanticObjectId)
      *
      * @param {Chrt.DriverCreateReq} request
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
@@ -69,7 +69,7 @@ export declare class Drivers {
     createV1(request: Chrt.DriverCreateReq, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<string>;
     private __createV1;
     /**
-     * Retrieves driver information for the authenticated user within their organization.
+     * Retrieves driver information for the authenticated user within their organization. | () -> (Driver1)
      *
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -79,7 +79,7 @@ export declare class Drivers {
     getV1(requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.Driver1>;
     private __getV1;
     /**
-     * Retrieves detailed driver information by driver ID within the organization.
+     * Retrieves detailed driver information by driver ID within the organization. | () -> (Driver1)
      *
      * @param {string} driverId
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
@@ -92,7 +92,7 @@ export declare class Drivers {
     getByDriverIdV1(driverId: string, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.Driver1>;
     private __getByDriverIdV1;
     /**
-     * Deletes a driver from the organization and removes them from associated rate sheets.
+     * Deletes a driver from the organization and removes them from associated rate sheets. | () -> (bool)
      *
      * @param {string} driverId
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
@@ -105,7 +105,7 @@ export declare class Drivers {
     deleteV1(driverId: string, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
     private __deleteV1;
     /**
-     * Sets the activation status of a driver (active/inactive) within the organization.
+     * Sets the activation status of a driver (active/inactive) within the organization. | (SetDriverActivationReq) -> (bool)
      *
      * @param {Chrt.SetDriverActivationReq} request
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
@@ -121,7 +121,7 @@ export declare class Drivers {
     setActivationV1(request: Chrt.SetDriverActivationReq, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
     private __setActivationV1;
     /**
-     * Updates the driver's last known location and timestamp for tracking purposes.
+     * Updates the driver's last known location and timestamp for tracking purposes. | (DriverLastSeenReq) -> (bool)
      *
      * @param {Chrt.DriverLastSeenReq} request
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
@@ -145,7 +145,7 @@ export declare class Drivers {
     lastSeenV1(request: Chrt.DriverLastSeenReq, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
     private __lastSeenV1;
     /**
-     * Clears the driver's last known location and timestamp.
+     * Clears the driver's last known location and timestamp. | () -> (bool)
      *
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -155,7 +155,7 @@ export declare class Drivers {
     lastSeenClearV1(requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
     private __lastSeenClearV1;
     /**
-     * Updates driver contact details and vehicle type assignments within the organization.
+     * Updates driver contact details and vehicle type assignments within the organization. | (UpdateDriverDetailsReq) -> (bool)
      *
      * @param {Chrt.UpdateDriverDetailsReq} request
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -20,7 +20,7 @@ export class Drivers {
         this._options = _options;
     }
     /**
-     * Lists all organization members paired with their driver information if they are drivers.
+     * Lists all organization members paired with their driver information if they are drivers. | () -> (list[OrgMembersAndDrivers])
      *
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -71,7 +71,7 @@ export class Drivers {
         });
     }
     /**
-     * Lists all drivers belonging to the authenticated organization.
+     * Lists all drivers belonging to the authenticated organization. | () -> (list[Driver1])
      *
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -122,7 +122,7 @@ export class Drivers {
         });
     }
     /**
-     * Creates a new driver profile for an organization member with optional vehicle type assignments.
+     * Creates a new driver profile for an organization member with optional vehicle type assignments. | (DriverCreateReq) -> (PydanticObjectId)
      *
      * @param {Chrt.DriverCreateReq} request
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
@@ -189,7 +189,7 @@ export class Drivers {
         });
     }
     /**
-     * Retrieves driver information for the authenticated user within their organization.
+     * Retrieves driver information for the authenticated user within their organization. | () -> (Driver1)
      *
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -240,7 +240,7 @@ export class Drivers {
         });
     }
     /**
-     * Retrieves detailed driver information by driver ID within the organization.
+     * Retrieves detailed driver information by driver ID within the organization. | () -> (Driver1)
      *
      * @param {string} driverId
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
@@ -299,7 +299,7 @@ export class Drivers {
         });
     }
     /**
-     * Deletes a driver from the organization and removes them from associated rate sheets.
+     * Deletes a driver from the organization and removes them from associated rate sheets. | () -> (bool)
      *
      * @param {string} driverId
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
@@ -358,7 +358,7 @@ export class Drivers {
         });
     }
     /**
-     * Sets the activation status of a driver (active/inactive) within the organization.
+     * Sets the activation status of a driver (active/inactive) within the organization. | (SetDriverActivationReq) -> (bool)
      *
      * @param {Chrt.SetDriverActivationReq} request
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
@@ -423,7 +423,7 @@ export class Drivers {
         });
     }
     /**
-     * Updates the driver's last known location and timestamp for tracking purposes.
+     * Updates the driver's last known location and timestamp for tracking purposes. | (DriverLastSeenReq) -> (bool)
      *
      * @param {Chrt.DriverLastSeenReq} request
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
@@ -496,7 +496,7 @@ export class Drivers {
         });
     }
     /**
-     * Clears the driver's last known location and timestamp.
+     * Clears the driver's last known location and timestamp. | () -> (bool)
      *
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -547,7 +547,7 @@ export class Drivers {
         });
     }
     /**
-     * Updates driver contact details and vehicle type assignments within the organization.
+     * Updates driver contact details and vehicle type assignments within the organization. | (UpdateDriverDetailsReq) -> (bool)
      *
      * @param {Chrt.UpdateDriverDetailsReq} request
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -31,7 +31,7 @@ export declare class OffChrtShipperOrg {
     protected readonly _options: OffChrtShipperOrg.Options;
     constructor(_options?: OffChrtShipperOrg.Options);
     /**
-     * Creates an off-platform shipper organization record.
+     * Creates an off-platform shipper organization record. | (OffChrtShipperOrgClientCreate1) -> (PydanticObjectId)
      *
      * @param {Chrt.OffChrtShipperOrgClientCreate1} request
      * @param {OffChrtShipperOrg.RequestOptions} requestOptions - Request-specific configuration.
@@ -47,7 +47,7 @@ export declare class OffChrtShipperOrg {
     createV1(request: Chrt.OffChrtShipperOrgClientCreate1, requestOptions?: OffChrtShipperOrg.RequestOptions): core.HttpResponsePromise<string>;
     private __createV1;
     /**
-     * Lists all off-platform shipper organizations created by the authenticated organization.
+     * Lists all off-platform shipper organizations created by the authenticated organization. | () -> (list[OffChrtShipperOrg1])
      *
      * @param {OffChrtShipperOrg.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -57,7 +57,7 @@ export declare class OffChrtShipperOrg {
     listV1(requestOptions?: OffChrtShipperOrg.RequestOptions): core.HttpResponsePromise<Chrt.OffChrtShipperOrg1[]>;
     private __listV1;
     /**
-     * Retrieves specific off-platform shipper organization by ID.
+     * Retrieves specific off-platform shipper organization by ID. | () -> (OffChrtShipperOrg1)
      *
      * @param {string} id
      * @param {OffChrtShipperOrg.RequestOptions} requestOptions - Request-specific configuration.
@@ -70,7 +70,7 @@ export declare class OffChrtShipperOrg {
     getByIdV1(id: string, requestOptions?: OffChrtShipperOrg.RequestOptions): core.HttpResponsePromise<Chrt.OffChrtShipperOrg1>;
     private __getByIdV1;
     /**
-     * Deletes off-platform shipper organization owned by the authenticated organization.
+     * Deletes off-platform shipper organization owned by the authenticated organization. | () -> (bool)
      *
      * @param {string} id
      * @param {OffChrtShipperOrg.RequestOptions} requestOptions - Request-specific configuration.
@@ -83,7 +83,7 @@ export declare class OffChrtShipperOrg {
     deleteByIdV1(id: string, requestOptions?: OffChrtShipperOrg.RequestOptions): core.HttpResponsePromise<boolean>;
     private __deleteByIdV1;
     /**
-     * Updates existing off-platform shipper organization owned by the authenticated organization.
+     * Updates existing off-platform shipper organization owned by the authenticated organization. | (OffChrtShipperOrgClientUpdate1) -> (bool)
      *
      * @param {string} id
      * @param {Chrt.OffChrtShipperOrgClientUpdate1} request

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

@@ -20,7 +20,7 @@ export class OffChrtShipperOrg {
         this._options = _options;
     }
     /**
-     * Creates an off-platform shipper organization record.
+     * Creates an off-platform shipper organization record. | (OffChrtShipperOrgClientCreate1) -> (PydanticObjectId)
      *
      * @param {Chrt.OffChrtShipperOrgClientCreate1} request
      * @param {OffChrtShipperOrg.RequestOptions} requestOptions - Request-specific configuration.
@@ -85,7 +85,7 @@ export class OffChrtShipperOrg {
         });
     }
     /**
-     * Lists all off-platform shipper organizations created by the authenticated organization.
+     * Lists all off-platform shipper organizations created by the authenticated organization. | () -> (list[OffChrtShipperOrg1])
      *
      * @param {OffChrtShipperOrg.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -136,7 +136,7 @@ export class OffChrtShipperOrg {
         });
     }
     /**
-     * Retrieves specific off-platform shipper organization by ID.
+     * Retrieves specific off-platform shipper organization by ID. | () -> (OffChrtShipperOrg1)
      *
      * @param {string} id
      * @param {OffChrtShipperOrg.RequestOptions} requestOptions - Request-specific configuration.
@@ -195,7 +195,7 @@ export class OffChrtShipperOrg {
         });
     }
     /**
-     * Deletes off-platform shipper organization owned by the authenticated organization.
+     * Deletes off-platform shipper organization owned by the authenticated organization. | () -> (bool)
      *
      * @param {string} id
      * @param {OffChrtShipperOrg.RequestOptions} requestOptions - Request-specific configuration.
@@ -254,7 +254,7 @@ export class OffChrtShipperOrg {
         });
     }
     /**
-     * Updates existing off-platform shipper organization owned by the authenticated organization.
+     * Updates existing off-platform shipper organization owned by the authenticated organization. | (OffChrtShipperOrgClientUpdate1) -> (bool)
      *
      * @param {string} id
      * @param {Chrt.OffChrtShipperOrgClientUpdate1} request

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

@@ -43,7 +43,7 @@ export declare class OrderDrafts {
     get taskArtifact(): TaskArtifact;
     get cargo(): Cargo;
     /**
-     * Creates a new draft order with org assignments based on caller's organization type.
+     * Creates a new draft order with org assignments based on caller's organization type. | (OrdersNewDraftReq) -> (OrdersNewDraftRes)
      *
      * @param {Chrt.OrdersNewDraftReq} request
      * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
@@ -56,7 +56,7 @@ export declare class OrderDrafts {
     newV1(request?: Chrt.OrdersNewDraftReq, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<Chrt.OrdersNewDraftRes>;
     private __newV1;
     /**
-     * Updates forwarder and/or shipper org assignments for a draft order
+     * Updates forwarder and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)
      *
      * @param {Chrt.OrdersDraftUpdateReq} request
      * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
@@ -71,7 +71,7 @@ export declare class OrderDrafts {
     updateV1(request: Chrt.OrdersDraftUpdateReq, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<Chrt.OrdersDraftUpdateRes>;
     private __updateV1;
     /**
-     * Deletes a draft order and all associated entities
+     * Deletes a draft order and all associated entities. | () -> (bool)
      *
      * @param {string} orderId
      * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
@@ -84,7 +84,7 @@ export declare class OrderDrafts {
     deleteV1(orderId: string, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<boolean>;
     private __deleteV1;
     /**
-     * Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it.
+     * Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it. | (OrderDraftExpandedReq) -> (OrderDraftExpandedRes)
      *
      * @param {string} orderIdOrShortId
      * @param {Chrt.OrderDraftExpandedReq} request
@@ -98,7 +98,7 @@ export declare class OrderDrafts {
     expandedV1(orderIdOrShortId: string, request?: Chrt.OrderDraftExpandedReq, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<Chrt.OrderDraftExpandedRes>;
     private __expandedV1;
     /**
-     * Lists all draft orders created by the authenticated user with optional expanded related data.
+     * Lists all draft orders created by the authenticated user with optional expanded related data. | (OrderDraftExpandedListReq) -> (OrderDraftExpandedListRes)
      *
      * @param {Chrt.OrderDraftExpandedListReq} request
      * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
@@ -111,7 +111,7 @@ export declare class OrderDrafts {
     expandedListV1(request?: Chrt.OrderDraftExpandedListReq, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<Chrt.OrderDraftExpandedListRes>;
     private __expandedListV1;
     /**
-     * Checks whether the draft order satisfies all requirements to move into staging.
+     * Checks whether the draft order satisfies all requirements to move into staging. | () -> (bool)
      *
      * @param {string} orderId
      * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -40,7 +40,7 @@ export class OrderDrafts {
         return ((_a = this._cargo) !== null && _a !== void 0 ? _a : (this._cargo = new Cargo(this._options)));
     }
     /**
-     * Creates a new draft order with org assignments based on caller's organization type.
+     * Creates a new draft order with org assignments based on caller's organization type. | (OrdersNewDraftReq) -> (OrdersNewDraftRes)
      *
      * @param {Chrt.OrdersNewDraftReq} request
      * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
@@ -102,7 +102,7 @@ export class OrderDrafts {
         });
     }
     /**
-     * Updates forwarder and/or shipper org assignments for a draft order
+     * Updates forwarder and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)
      *
      * @param {Chrt.OrdersDraftUpdateReq} request
      * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
@@ -166,7 +166,7 @@ export class OrderDrafts {
         });
     }
     /**
-     * Deletes a draft order and all associated entities
+     * Deletes a draft order and all associated entities. | () -> (bool)
      *
      * @param {string} orderId
      * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
@@ -225,7 +225,7 @@ export class OrderDrafts {
         });
     }
     /**
-     * Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it.
+     * Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it. | (OrderDraftExpandedReq) -> (OrderDraftExpandedRes)
      *
      * @param {string} orderIdOrShortId
      * @param {Chrt.OrderDraftExpandedReq} request
@@ -288,7 +288,7 @@ export class OrderDrafts {
         });
     }
     /**
-     * Lists all draft orders created by the authenticated user with optional expanded related data.
+     * Lists all draft orders created by the authenticated user with optional expanded related data. | (OrderDraftExpandedListReq) -> (OrderDraftExpandedListRes)
      *
      * @param {Chrt.OrderDraftExpandedListReq} request
      * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
@@ -350,7 +350,7 @@ export class OrderDrafts {
         });
     }
     /**
-     * Checks whether the draft order satisfies all requirements to move into staging.
+     * Checks whether the draft order satisfies all requirements to move into staging. | () -> (bool)
      *
      * @param {string} orderId
      * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -31,7 +31,7 @@ export declare class Cargo {
     protected readonly _options: Cargo.Options;
     constructor(_options?: Cargo.Options);
     /**
-     * Adds a cargo item to an existing draft order. Validates order is in DRAFT status and owned by caller.
+     * Adds a cargo item to an existing draft order. Validates order is in DRAFT status and owned by caller. | (OrderDraftAddCargoReq) -> (PydanticObjectId)
      *
      * @param {Chrt.orderDrafts.OrderDraftAddCargoReq} request
      * @param {Cargo.RequestOptions} requestOptions - Request-specific configuration.
@@ -50,7 +50,7 @@ export declare class Cargo {
     addV1(request: Chrt.orderDrafts.OrderDraftAddCargoReq, requestOptions?: Cargo.RequestOptions): core.HttpResponsePromise<string>;
     private __addV1;
     /**
-     * Associates existing cargo with a task in a draft order.
+     * Associates existing cargo with a task in a draft order. | (OrderDraftAssociateCargoWithTaskReq) -> (bool)
      *
      * @param {Chrt.orderDrafts.OrderDraftAssociateCargoWithTaskReq} request
      * @param {Cargo.RequestOptions} requestOptions - Request-specific configuration.
@@ -67,7 +67,7 @@ export declare class Cargo {
     associateWithTaskV1(request: Chrt.orderDrafts.OrderDraftAssociateCargoWithTaskReq, requestOptions?: Cargo.RequestOptions): core.HttpResponsePromise<boolean>;
     private __associateWithTaskV1;
     /**
-     * Updates a cargo item in an existing draft order. Validates order is in DRAFT status and owned by caller.
+     * Updates a cargo item in an existing draft order. Validates order is in DRAFT status and owned by caller. | (OrderDraftUpdateCargoReq) -> (PydanticObjectId)
      *
      * @param {Chrt.orderDrafts.OrderDraftUpdateCargoReq} request
      * @param {Cargo.RequestOptions} requestOptions - Request-specific configuration.
@@ -83,7 +83,7 @@ export declare class Cargo {
     updateV1(request: Chrt.orderDrafts.OrderDraftUpdateCargoReq, requestOptions?: Cargo.RequestOptions): core.HttpResponsePromise<string>;
     private __updateV1;
     /**
-     * Deletes a cargo item from a draft order and removes references from associated tasks
+     * Deletes a cargo item from a draft order and removes references from associated tasks. | () -> (bool)
      *
      * @param {string} cargoId
      * @param {Cargo.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/api/resources/orderDrafts/resources/cargo/client/Client.mjs

@@ -20,7 +20,7 @@ export class Cargo {
         this._options = _options;
     }
     /**
-     * Adds a cargo item to an existing draft order. Validates order is in DRAFT status and owned by caller.
+     * Adds a cargo item to an existing draft order. Validates order is in DRAFT status and owned by caller. | (OrderDraftAddCargoReq) -> (PydanticObjectId)
      *
      * @param {Chrt.orderDrafts.OrderDraftAddCargoReq} request
      * @param {Cargo.RequestOptions} requestOptions - Request-specific configuration.
@@ -88,7 +88,7 @@ export class Cargo {
         });
     }
     /**
-     * Associates existing cargo with a task in a draft order.
+     * Associates existing cargo with a task in a draft order. | (OrderDraftAssociateCargoWithTaskReq) -> (bool)
      *
      * @param {Chrt.orderDrafts.OrderDraftAssociateCargoWithTaskReq} request
      * @param {Cargo.RequestOptions} requestOptions - Request-specific configuration.
@@ -154,7 +154,7 @@ export class Cargo {
         });
     }
     /**
-     * Updates a cargo item in an existing draft order. Validates order is in DRAFT status and owned by caller.
+     * Updates a cargo item in an existing draft order. Validates order is in DRAFT status and owned by caller. | (OrderDraftUpdateCargoReq) -> (PydanticObjectId)
      *
      * @param {Chrt.orderDrafts.OrderDraftUpdateCargoReq} request
      * @param {Cargo.RequestOptions} requestOptions - Request-specific configuration.
@@ -219,7 +219,7 @@ export class Cargo {
         });
     }
     /**
-     * Deletes a cargo item from a draft order and removes references from associated tasks
+     * Deletes a cargo item from a draft order and removes references from associated tasks. | () -> (bool)
      *
      * @param {string} cargoId
      * @param {Cargo.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -31,7 +31,7 @@ export declare class Task {
     protected readonly _options: Task.Options;
     constructor(_options?: Task.Options);
     /**
-     * Adds a task to an existing task group in a draft order. Validates order is in DRAFT status and task action type matches task group type.
+     * Adds a task to an existing task group in a draft order. Validates order is in DRAFT status and task action type matches task group type. | (OrderDraftAddTaskReqV1) -> (PydanticObjectId)
      *
      * @param {Chrt.orderDrafts.OrderDraftAddTaskReqV1} request
      * @param {Task.RequestOptions} requestOptions - Request-specific configuration.
@@ -49,7 +49,7 @@ export declare class Task {
     addV1(request: Chrt.orderDrafts.OrderDraftAddTaskReqV1, requestOptions?: Task.RequestOptions): core.HttpResponsePromise<string>;
     private __addV1;
     /**
-     * Updates a task in an existing draft order
+     * Updates a task in an existing draft order. | (OrderDraftUpdateTaskReq) -> (PydanticObjectId)
      *
      * @param {Chrt.orderDrafts.OrderDraftUpdateTaskReq} request
      * @param {Task.RequestOptions} requestOptions - Request-specific configuration.
@@ -65,7 +65,7 @@ export declare class Task {
     updateV1(request: Chrt.orderDrafts.OrderDraftUpdateTaskReq, requestOptions?: Task.RequestOptions): core.HttpResponsePromise<string>;
     private __updateV1;
     /**
-     * Deletes a task from a draft order, including all task artifacts. Cargo is preserved. Task is removed from task group.
+     * Deletes a task from a draft order, including all task artifacts. Cargo is preserved. Task is removed from task group. | () -> (bool)
      *
      * @param {string} taskId
      * @param {Task.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/api/resources/orderDrafts/resources/task/client/Client.mjs

@@ -20,7 +20,7 @@ export class Task {
         this._options = _options;
     }
     /**
-     * Adds a task to an existing task group in a draft order. Validates order is in DRAFT status and task action type matches task group type.
+     * Adds a task to an existing task group in a draft order. Validates order is in DRAFT status and task action type matches task group type. | (OrderDraftAddTaskReqV1) -> (PydanticObjectId)
      *
      * @param {Chrt.orderDrafts.OrderDraftAddTaskReqV1} request
      * @param {Task.RequestOptions} requestOptions - Request-specific configuration.
@@ -87,7 +87,7 @@ export class Task {
         });
     }
     /**
-     * Updates a task in an existing draft order
+     * Updates a task in an existing draft order. | (OrderDraftUpdateTaskReq) -> (PydanticObjectId)
      *
      * @param {Chrt.orderDrafts.OrderDraftUpdateTaskReq} request
      * @param {Task.RequestOptions} requestOptions - Request-specific configuration.
@@ -152,7 +152,7 @@ export class Task {
         });
     }
     /**
-     * Deletes a task from a draft order, including all task artifacts. Cargo is preserved. Task is removed from task group.
+     * Deletes a task from a draft order, including all task artifacts. Cargo is preserved. Task is removed from task group. | () -> (bool)
      *
      * @param {string} taskId
      * @param {Task.RequestOptions} requestOptions - Request-specific configuration.