@chrt-inc/typescript-sdk 1.325.0 → 1.331.0

package/dist/cjs/api/resources/drivers/client/Client.js

@@ -44,6 +44,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Drivers = void 0;
 const environments = __importStar(require("../../../../environments.js"));
@@ -306,7 +317,7 @@ class Drivers {
         });
     }
     /**
-     * Creates a new driver profile for the caller. Returns existing driver ID if one already exists. Courier orgs only, min role: operator. | (DriverClientCreate1) -> (PydanticObjectId)
+     * Creates a new driver profile for the target user (defaults to caller). Drivers can create themselves; operators+ can create any org member. Courier orgs only. | (DriverClientCreate1) -> (PydanticObjectId)
      *
      * @param {Chrt.DriverClientCreate1} request
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
@@ -315,6 +326,7 @@ class Drivers {
      *
      * @example
      *     await client.drivers.createV1({
+     *         target_user_id: "target_user_id",
      *         schema_version: 1
      *     })
      */
@@ -324,15 +336,20 @@ class Drivers {
     __createV1(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
+            const { target_user_id: targetUserId } = request, _body = __rest(request, ["target_user_id"]);
+            const _queryParams = {};
+            if (targetUserId !== undefined) {
+                _queryParams["target_user_id"] = targetUserId;
+            }
             let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.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, "oort/drivers/create/v1"),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
                 requestType: "json",
-                body: request,
+                body: _body,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,

package/dist/cjs/api/resources/drivers/client/requests/DriverClientCreate1.d.ts

@@ -5,10 +5,12 @@ import * as Chrt from "../../../../index.js";
 /**
  * @example
  *     {
+ *         target_user_id: "target_user_id",
  *         schema_version: 1
  *     }
  */
 export interface DriverClientCreate1 {
+    target_user_id?: string | null;
     schema_version: number;
     email_address_primary?: string | null;
     email_address_secondary?: string | null;

package/dist/cjs/api/resources/orders/resources/expanded/client/Client.d.ts

@@ -59,7 +59,7 @@ export declare class Expanded {
     forForwarderOperatorsV1(orderIdOrShortId: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderExpanded>;
     private __forForwarderOperatorsV1;
     /**
-     * Lists expanded orders for forwarder operators with filtering, sorting, and pagination. | authz_personas=[forwarder_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
+     * Lists expanded orders for forwarder operators with filtering, sorting, and pagination. | authz: allowed_org_types=[forwarder], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
      *
      * @param {Chrt.orders.ExpandedListForForwarderOperatorsV1Request} request
      * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
@@ -90,7 +90,7 @@ export declare class Expanded {
     listForForwarderOperatorsV1(request: Chrt.orders.ExpandedListForForwarderOperatorsV1Request, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrdersExpandedListRes>;
     private __listForForwarderOperatorsV1;
     /**
-     * Lists expanded orders for shipper operators with filtering, sorting, and pagination. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
+     * Lists expanded orders for shipper operators with filtering, sorting, and pagination. | authz: allowed_org_types=[shipper], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
      *
      * @param {Chrt.orders.ExpandedListForShipperOperatorsV1Request} request
      * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/orders/resources/expanded/client/Client.js

@@ -182,7 +182,7 @@ class Expanded {
         });
     }
     /**
-     * Lists expanded orders for forwarder operators with filtering, sorting, and pagination. | authz_personas=[forwarder_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
+     * Lists expanded orders for forwarder operators with filtering, sorting, and pagination. | authz: allowed_org_types=[forwarder], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
      *
      * @param {Chrt.orders.ExpandedListForForwarderOperatorsV1Request} request
      * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
@@ -320,7 +320,7 @@ class Expanded {
         });
     }
     /**
-     * Lists expanded orders for shipper operators with filtering, sorting, and pagination. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
+     * Lists expanded orders for shipper operators with filtering, sorting, and pagination. | authz: allowed_org_types=[shipper], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
      *
      * @param {Chrt.orders.ExpandedListForShipperOperatorsV1Request} request
      * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/payments/client/Client.d.ts

@@ -31,7 +31,7 @@ export declare class Payments {
     protected readonly _options: Payments.Options;
     constructor(_options?: Payments.Options);
     /**
-     * Generates and sends a Stripe invoice for a shipper statement to a courier organization's Connect account. Applies a 10% application fee.
+     * Generates and sends a Stripe invoice for a shipper statement to a courier organization's Connect account. Applies a 10% application fee. | (GenerateInvoiceReq) -> (GenerateInvoiceRes)
      *
      * @param {Chrt.GenerateInvoiceReq} request
      * @param {Payments.RequestOptions} requestOptions - Request-specific configuration.
@@ -46,7 +46,7 @@ export declare class Payments {
     generateInvoiceV1(request: Chrt.GenerateInvoiceReq, requestOptions?: Payments.RequestOptions): core.HttpResponsePromise<Chrt.GenerateInvoiceRes>;
     private __generateInvoiceV1;
     /**
-     * Creates a Stripe checkout session for a subscription with pricing based on the selected plan.
+     * Creates a Stripe checkout session for a subscription with pricing based on the selected plan. | (CreateCheckoutSessionReq) -> (CreateCheckoutSessionRes)
      *
      * @param {Chrt.CreateCheckoutSessionReq} request
      * @param {Payments.RequestOptions} requestOptions - Request-specific configuration.
@@ -61,7 +61,7 @@ export declare class Payments {
     createCheckoutSessionV1(request: Chrt.CreateCheckoutSessionReq, requestOptions?: Payments.RequestOptions): core.HttpResponsePromise<Chrt.CreateCheckoutSessionRes>;
     private __createCheckoutSessionV1;
     /**
-     * Synchronizes subscription data from Stripe to the authentication service for the current user.
+     * Synchronizes subscription data from Stripe to the authentication service for the current user. | () -> (bool)
      *
      * @param {Payments.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -71,7 +71,7 @@ export declare class Payments {
     syncStripeToClerkV1(requestOptions?: Payments.RequestOptions): core.HttpResponsePromise<boolean>;
     private __syncStripeToClerkV1;
     /**
-     * Creates a Stripe Connect account for the organization to receive payments. Idempotent - returns existing account if already created.
+     * Creates a Stripe Connect account for the organization to receive payments. Idempotent - returns existing account if already created. | () -> (CreateConnectAccountRes)
      *
      * @param {Payments.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -81,7 +81,7 @@ export declare class Payments {
     createConnectAccountV1(requestOptions?: Payments.RequestOptions): core.HttpResponsePromise<Chrt.CreateConnectAccountRes>;
     private __createConnectAccountV1;
     /**
-     * Creates an onboarding link for a Stripe Connect account. Used to complete or update account setup.
+     * Creates an onboarding link for a Stripe Connect account. Used to complete or update account setup. | () -> (CreateConnectAccountLinkRes)
      *
      * @param {Payments.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/cjs/api/resources/payments/client/Client.js

@@ -56,7 +56,7 @@ class Payments {
         this._options = _options;
     }
     /**
-     * Generates and sends a Stripe invoice for a shipper statement to a courier organization's Connect account. Applies a 10% application fee.
+     * Generates and sends a Stripe invoice for a shipper statement to a courier organization's Connect account. Applies a 10% application fee. | (GenerateInvoiceReq) -> (GenerateInvoiceRes)
      *
      * @param {Chrt.GenerateInvoiceReq} request
      * @param {Payments.RequestOptions} requestOptions - Request-specific configuration.
@@ -120,7 +120,7 @@ class Payments {
         });
     }
     /**
-     * Creates a Stripe checkout session for a subscription with pricing based on the selected plan.
+     * Creates a Stripe checkout session for a subscription with pricing based on the selected plan. | (CreateCheckoutSessionReq) -> (CreateCheckoutSessionRes)
      *
      * @param {Chrt.CreateCheckoutSessionReq} request
      * @param {Payments.RequestOptions} requestOptions - Request-specific configuration.
@@ -184,7 +184,7 @@ class Payments {
         });
     }
     /**
-     * Synchronizes subscription data from Stripe to the authentication service for the current user.
+     * Synchronizes subscription data from Stripe to the authentication service for the current user. | () -> (bool)
      *
      * @param {Payments.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -235,7 +235,7 @@ class Payments {
         });
     }
     /**
-     * Creates a Stripe Connect account for the organization to receive payments. Idempotent - returns existing account if already created.
+     * Creates a Stripe Connect account for the organization to receive payments. Idempotent - returns existing account if already created. | () -> (CreateConnectAccountRes)
      *
      * @param {Payments.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -286,7 +286,7 @@ class Payments {
         });
     }
     /**
-     * Creates an onboarding link for a Stripe Connect account. Used to complete or update account setup.
+     * Creates an onboarding link for a Stripe Connect account. Used to complete or update account setup. | () -> (CreateConnectAccountLinkRes)
      *
      * @param {Payments.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/client/Client.d.ts

@@ -43,7 +43,7 @@ export declare class ShipperPayCourierLineItemGroups {
     get addLineItems(): AddLineItems;
     get removeLineItems(): RemoveLineItems;
     /**
-     * Retrieves a shipper pay courier line item group by its ID for the caller's courier organization.
+     * Retrieves a shipper pay courier line item group by its ID for the caller's courier organization. | () -> (ShipperPayCourierLineItemGroup1)
      *
      * @param {string} id
      * @param {ShipperPayCourierLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.
@@ -56,7 +56,7 @@ export declare class ShipperPayCourierLineItemGroups {
     getByIdV1(id: string, requestOptions?: ShipperPayCourierLineItemGroups.RequestOptions): core.HttpResponsePromise<Chrt.ShipperPayCourierLineItemGroup1>;
     private __getByIdV1;
     /**
-     * Deletes a shipper pay courier line item group by its ID if not referenced by any payment.
+     * Deletes a shipper pay courier line item group by its ID if not referenced by any payment. | () -> (bool)
      *
      * @param {string} id
      * @param {ShipperPayCourierLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.
@@ -69,7 +69,7 @@ export declare class ShipperPayCourierLineItemGroups {
     deleteByIdV1(id: string, requestOptions?: ShipperPayCourierLineItemGroups.RequestOptions): core.HttpResponsePromise<boolean>;
     private __deleteByIdV1;
     /**
-     * Retrieves a shipper pay courier line item group by its associated task group ID for the caller's courier organization.
+     * Retrieves a shipper pay courier line item group by its associated task group ID for the caller's courier organization. | () -> (ShipperPayCourierLineItemGroup1)
      *
      * @param {string} taskGroupId
      * @param {ShipperPayCourierLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.
@@ -82,7 +82,7 @@ export declare class ShipperPayCourierLineItemGroups {
     byTaskGroupIdV1(taskGroupId: string, requestOptions?: ShipperPayCourierLineItemGroups.RequestOptions): core.HttpResponsePromise<Chrt.ShipperPayCourierLineItemGroup1>;
     private __byTaskGroupIdV1;
     /**
-     * Previews calculated line items for a shipper pay courier based on rate sheet and task group without creating the group.
+     * Previews calculated line items for a shipper pay courier based on rate sheet and task group without creating the group. | (ShipperPayCourierLineItemGroupCreateReq) -> (ShipperPayCourierLineItemGroupServerCreate1)
      *
      * @param {Chrt.ShipperPayCourierLineItemGroupCreateReq} request
      * @param {ShipperPayCourierLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.
@@ -98,7 +98,7 @@ export declare class ShipperPayCourierLineItemGroups {
     previewV1(request: Chrt.ShipperPayCourierLineItemGroupCreateReq, requestOptions?: ShipperPayCourierLineItemGroups.RequestOptions): core.HttpResponsePromise<Chrt.ShipperPayCourierLineItemGroupServerCreate1>;
     private __previewV1;
     /**
-     * Creates a shipper pay courier line item group by calculating items from rate sheet and task group.
+     * Creates a shipper pay courier line item group by calculating items from rate sheet and task group. | (ShipperPayCourierLineItemGroupCreateReq) -> (PydanticObjectId)
      *
      * @param {Chrt.ShipperPayCourierLineItemGroupCreateReq} request
      * @param {ShipperPayCourierLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/client/Client.js

@@ -76,7 +76,7 @@ class ShipperPayCourierLineItemGroups {
         return ((_a = this._removeLineItems) !== null && _a !== void 0 ? _a : (this._removeLineItems = new Client_js_4.RemoveLineItems(this._options)));
     }
     /**
-     * Retrieves a shipper pay courier line item group by its ID for the caller's courier organization.
+     * Retrieves a shipper pay courier line item group by its ID for the caller's courier organization. | () -> (ShipperPayCourierLineItemGroup1)
      *
      * @param {string} id
      * @param {ShipperPayCourierLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.
@@ -135,7 +135,7 @@ class ShipperPayCourierLineItemGroups {
         });
     }
     /**
-     * Deletes a shipper pay courier line item group by its ID if not referenced by any payment.
+     * Deletes a shipper pay courier line item group by its ID if not referenced by any payment. | () -> (bool)
      *
      * @param {string} id
      * @param {ShipperPayCourierLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.
@@ -194,7 +194,7 @@ class ShipperPayCourierLineItemGroups {
         });
     }
     /**
-     * Retrieves a shipper pay courier line item group by its associated task group ID for the caller's courier organization.
+     * Retrieves a shipper pay courier line item group by its associated task group ID for the caller's courier organization. | () -> (ShipperPayCourierLineItemGroup1)
      *
      * @param {string} taskGroupId
      * @param {ShipperPayCourierLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.
@@ -253,7 +253,7 @@ class ShipperPayCourierLineItemGroups {
         });
     }
     /**
-     * Previews calculated line items for a shipper pay courier based on rate sheet and task group without creating the group.
+     * Previews calculated line items for a shipper pay courier based on rate sheet and task group without creating the group. | (ShipperPayCourierLineItemGroupCreateReq) -> (ShipperPayCourierLineItemGroupServerCreate1)
      *
      * @param {Chrt.ShipperPayCourierLineItemGroupCreateReq} request
      * @param {ShipperPayCourierLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.
@@ -321,7 +321,7 @@ class ShipperPayCourierLineItemGroups {
         });
     }
     /**
-     * Creates a shipper pay courier line item group by calculating items from rate sheet and task group.
+     * Creates a shipper pay courier line item group by calculating items from rate sheet and task group. | (ShipperPayCourierLineItemGroupCreateReq) -> (PydanticObjectId)
      *
      * @param {Chrt.ShipperPayCourierLineItemGroupCreateReq} request
      * @param {ShipperPayCourierLineItemGroups.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/resources/addLineItems/client/Client.d.ts

@@ -31,7 +31,7 @@ export declare class AddLineItems {
     protected readonly _options: AddLineItems.Options;
     constructor(_options?: AddLineItems.Options);
     /**
-     * Adds additional line items to an existing shipper pay courier line item group.
+     * Adds additional line items to an existing shipper pay courier line item group. | (ShipperPayCourierLineItemGroupAddLineItemsReq) -> (ShipperPayCourierLineItemGroup1)
      *
      * @param {string} id
      * @param {Chrt.shipperPayCourierLineItemGroups.ShipperPayCourierLineItemGroupAddLineItemsReq} request

package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/resources/addLineItems/client/Client.js

@@ -56,7 +56,7 @@ class AddLineItems {
         this._options = _options;
     }
     /**
-     * Adds additional line items to an existing shipper pay courier line item group.
+     * Adds additional line items to an existing shipper pay courier line item group. | (ShipperPayCourierLineItemGroupAddLineItemsReq) -> (ShipperPayCourierLineItemGroup1)
      *
      * @param {string} id
      * @param {Chrt.shipperPayCourierLineItemGroups.ShipperPayCourierLineItemGroupAddLineItemsReq} request

package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/resources/courier/client/Client.d.ts

@@ -31,7 +31,7 @@ export declare class Courier {
     protected readonly _options: Courier.Options;
     constructor(_options?: Courier.Options);
     /**
-     * Lists all shipper pay courier line item groups for the caller's courier organization.
+     * Lists all shipper pay courier line item groups for the caller's courier organization. | () -> (list[ShipperPayCourierLineItemGroup1])
      *
      * @param {Courier.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/resources/courier/client/Client.js

@@ -55,7 +55,7 @@ class Courier {
         this._options = _options;
     }
     /**
-     * Lists all shipper pay courier line item groups for the caller's courier organization.
+     * Lists all shipper pay courier line item groups for the caller's courier organization. | () -> (list[ShipperPayCourierLineItemGroup1])
      *
      * @param {Courier.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/resources/removeLineItems/client/Client.d.ts

@@ -31,7 +31,7 @@ export declare class RemoveLineItems {
     protected readonly _options: RemoveLineItems.Options;
     constructor(_options?: RemoveLineItems.Options);
     /**
-     * Removes specific line items from a shipper pay courier line item group by their UUID identifiers.
+     * Removes specific line items from a shipper pay courier line item group by their UUID identifiers. | (ShipperPayCourierLineItemGroupRemoveLineItemsReq) -> (ShipperPayCourierLineItemGroup1)
      *
      * @param {string} id
      * @param {Chrt.shipperPayCourierLineItemGroups.ShipperPayCourierLineItemGroupRemoveLineItemsReq} request

package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/resources/removeLineItems/client/Client.js

@@ -56,7 +56,7 @@ class RemoveLineItems {
         this._options = _options;
     }
     /**
-     * Removes specific line items from a shipper pay courier line item group by their UUID identifiers.
+     * Removes specific line items from a shipper pay courier line item group by their UUID identifiers. | (ShipperPayCourierLineItemGroupRemoveLineItemsReq) -> (ShipperPayCourierLineItemGroup1)
      *
      * @param {string} id
      * @param {Chrt.shipperPayCourierLineItemGroups.ShipperPayCourierLineItemGroupRemoveLineItemsReq} request

package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/resources/shipper/client/Client.d.ts

@@ -31,7 +31,7 @@ export declare class Shipper {
     protected readonly _options: Shipper.Options;
     constructor(_options?: Shipper.Options);
     /**
-     * Lists all shipper pay courier line item groups for the caller's shipper organization.
+     * Lists all shipper pay courier line item groups for the caller's shipper organization. | () -> (list[ShipperPayCourierLineItemGroup1])
      *
      * @param {Shipper.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -41,7 +41,7 @@ export declare class Shipper {
     listV1(requestOptions?: Shipper.RequestOptions): core.HttpResponsePromise<Chrt.ShipperPayCourierLineItemGroup1[]>;
     private __listV1;
     /**
-     * Retrieves a shipper pay courier line item group by its ID for the caller's shipper organization.
+     * Retrieves a shipper pay courier line item group by its ID for the caller's shipper organization. | () -> (ShipperPayCourierLineItemGroup1)
      *
      * @param {string} id
      * @param {Shipper.RequestOptions} requestOptions - Request-specific configuration.
@@ -54,7 +54,7 @@ export declare class Shipper {
     getByIdV1(id: string, requestOptions?: Shipper.RequestOptions): core.HttpResponsePromise<Chrt.ShipperPayCourierLineItemGroup1>;
     private __getByIdV1;
     /**
-     * Retrieves a shipper pay courier line item group by its associated task group ID for the caller's shipper organization.
+     * Retrieves a shipper pay courier line item group by its associated task group ID for the caller's shipper organization. | () -> (ShipperPayCourierLineItemGroup1)
      *
      * @param {string} taskGroupId
      * @param {Shipper.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/resources/shipper/client/Client.js

@@ -56,7 +56,7 @@ class Shipper {
         this._options = _options;
     }
     /**
-     * Lists all shipper pay courier line item groups for the caller's shipper organization.
+     * Lists all shipper pay courier line item groups for the caller's shipper organization. | () -> (list[ShipperPayCourierLineItemGroup1])
      *
      * @param {Shipper.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -110,7 +110,7 @@ class Shipper {
         });
     }
     /**
-     * Retrieves a shipper pay courier line item group by its ID for the caller's shipper organization.
+     * Retrieves a shipper pay courier line item group by its ID for the caller's shipper organization. | () -> (ShipperPayCourierLineItemGroup1)
      *
      * @param {string} id
      * @param {Shipper.RequestOptions} requestOptions - Request-specific configuration.
@@ -169,7 +169,7 @@ class Shipper {
         });
     }
     /**
-     * Retrieves a shipper pay courier line item group by its associated task group ID for the caller's shipper organization.
+     * Retrieves a shipper pay courier line item group by its associated task group ID for the caller's shipper organization. | () -> (ShipperPayCourierLineItemGroup1)
      *
      * @param {string} taskGroupId
      * @param {Shipper.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/shipperPayCourierPayments/client/Client.d.ts

@@ -31,7 +31,7 @@ export declare class ShipperPayCourierPayments {
     protected readonly _options: ShipperPayCourierPayments.Options;
     constructor(_options?: ShipperPayCourierPayments.Options);
     /**
-     * Retrieves a shipper pay courier payment by its ID with Stripe invoice sync.
+     * Retrieves a shipper pay courier payment by its ID with Stripe invoice sync. | () -> (ShipperPayCourierStatement1)
      *
      * @param {string} shipperPayCourierPaymentId
      * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.
@@ -44,7 +44,7 @@ export declare class ShipperPayCourierPayments {
     getByIdV1(shipperPayCourierPaymentId: string, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<Chrt.ShipperPayCourierStatement1>;
     private __getByIdV1;
     /**
-     * Deletes a shipper-to-courier payment record if invoice not yet created.
+     * Deletes a shipper-to-courier payment record if invoice not yet created. | () -> (bool)
      *
      * @param {string} shipperPayCourierPaymentId
      * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.
@@ -57,7 +57,7 @@ export declare class ShipperPayCourierPayments {
     deleteV1(shipperPayCourierPaymentId: string, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<boolean>;
     private __deleteV1;
     /**
-     * Retrieves a shipper pay courier payment by order ID or short ID with Stripe invoice sync.
+     * Retrieves a shipper pay courier payment by order ID or short ID with Stripe invoice sync. | () -> (ShipperPayCourierStatement1)
      *
      * @param {string} orderIdOrShortId
      * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.
@@ -70,7 +70,7 @@ export declare class ShipperPayCourierPayments {
     getByOrderIdOrShortIdV1(orderIdOrShortId: string, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<Chrt.ShipperPayCourierStatement1>;
     private __getByOrderIdOrShortIdV1;
     /**
-     * Lists shipper pay courier payments by shipper org ID with status filtering and Stripe sync.
+     * Lists shipper pay courier payments by shipper org ID with status filtering and Stripe sync. | (ListPaymentsByShipperReq) -> (GetShipperPayCourierPaymentsForShipperRes)
      *
      * @param {Chrt.ListPaymentsByShipperReq} request
      * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.
@@ -85,7 +85,7 @@ export declare class ShipperPayCourierPayments {
     listByShipperOrgIdV1(request: Chrt.ListPaymentsByShipperReq, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<Chrt.GetShipperPayCourierPaymentsForShipperRes>;
     private __listByShipperOrgIdV1;
     /**
-     * Lists shipper pay courier payments by courier org ID with status filtering and Stripe sync.
+     * Lists shipper pay courier payments by courier org ID with status filtering and Stripe sync. | (ListPaymentsByCourierReq) -> (GetShipperPayCourierPaymentsForShipperRes)
      *
      * @param {Chrt.ListPaymentsByCourierReq} request
      * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.
@@ -100,7 +100,7 @@ export declare class ShipperPayCourierPayments {
     listByCourierOrgIdV1(request: Chrt.ListPaymentsByCourierReq, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<Chrt.GetShipperPayCourierPaymentsForShipperRes>;
     private __listByCourierOrgIdV1;
     /**
-     * Creates a shipper-to-courier payment record based on all task groups in an order.
+     * Creates a shipper-to-courier payment record based on all task groups in an order. | (CreateShipperPayCourierPaymentReq) -> (PydanticObjectId)
      *
      * @param {Chrt.CreateShipperPayCourierPaymentReq} request
      * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.
@@ -115,7 +115,7 @@ export declare class ShipperPayCourierPayments {
     createV1(request: Chrt.CreateShipperPayCourierPaymentReq, requestOptions?: ShipperPayCourierPayments.RequestOptions): core.HttpResponsePromise<string>;
     private __createV1;
     /**
-     * Previews a shipper-to-courier payment showing task groups, line item groups, total amount, and readiness status.
+     * Previews a shipper-to-courier payment showing task groups, line item groups, total amount, and readiness status. | (CreateShipperPayCourierPaymentReq) -> (PaymentPreviewResponse)
      *
      * @param {Chrt.CreateShipperPayCourierPaymentReq} request
      * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/shipperPayCourierPayments/client/Client.js

@@ -56,7 +56,7 @@ class ShipperPayCourierPayments {
         this._options = _options;
     }
     /**
-     * Retrieves a shipper pay courier payment by its ID with Stripe invoice sync.
+     * Retrieves a shipper pay courier payment by its ID with Stripe invoice sync. | () -> (ShipperPayCourierStatement1)
      *
      * @param {string} shipperPayCourierPaymentId
      * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.
@@ -115,7 +115,7 @@ class ShipperPayCourierPayments {
         });
     }
     /**
-     * Deletes a shipper-to-courier payment record if invoice not yet created.
+     * Deletes a shipper-to-courier payment record if invoice not yet created. | () -> (bool)
      *
      * @param {string} shipperPayCourierPaymentId
      * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.
@@ -174,7 +174,7 @@ class ShipperPayCourierPayments {
         });
     }
     /**
-     * Retrieves a shipper pay courier payment by order ID or short ID with Stripe invoice sync.
+     * Retrieves a shipper pay courier payment by order ID or short ID with Stripe invoice sync. | () -> (ShipperPayCourierStatement1)
      *
      * @param {string} orderIdOrShortId
      * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.
@@ -233,7 +233,7 @@ class ShipperPayCourierPayments {
         });
     }
     /**
-     * Lists shipper pay courier payments by shipper org ID with status filtering and Stripe sync.
+     * Lists shipper pay courier payments by shipper org ID with status filtering and Stripe sync. | (ListPaymentsByShipperReq) -> (GetShipperPayCourierPaymentsForShipperRes)
      *
      * @param {Chrt.ListPaymentsByShipperReq} request
      * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.
@@ -300,7 +300,7 @@ class ShipperPayCourierPayments {
         });
     }
     /**
-     * Lists shipper pay courier payments by courier org ID with status filtering and Stripe sync.
+     * Lists shipper pay courier payments by courier org ID with status filtering and Stripe sync. | (ListPaymentsByCourierReq) -> (GetShipperPayCourierPaymentsForShipperRes)
      *
      * @param {Chrt.ListPaymentsByCourierReq} request
      * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.
@@ -367,7 +367,7 @@ class ShipperPayCourierPayments {
         });
     }
     /**
-     * Creates a shipper-to-courier payment record based on all task groups in an order.
+     * Creates a shipper-to-courier payment record based on all task groups in an order. | (CreateShipperPayCourierPaymentReq) -> (PydanticObjectId)
      *
      * @param {Chrt.CreateShipperPayCourierPaymentReq} request
      * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.
@@ -431,7 +431,7 @@ class ShipperPayCourierPayments {
         });
     }
     /**
-     * Previews a shipper-to-courier payment showing task groups, line item groups, total amount, and readiness status.
+     * Previews a shipper-to-courier payment showing task groups, line item groups, total amount, and readiness status. | (CreateShipperPayCourierPaymentReq) -> (PaymentPreviewResponse)
      *
      * @param {Chrt.CreateShipperPayCourierPaymentReq} request
      * @param {ShipperPayCourierPayments.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/shipperPayCourierRateSheets/client/Client.d.ts

@@ -31,7 +31,7 @@ export declare class ShipperPayCourierRateSheets {
     protected readonly _options: ShipperPayCourierRateSheets.Options;
     constructor(_options?: ShipperPayCourierRateSheets.Options);
     /**
-     * Lists all rate sheets created by the authenticated courier organization.
+     * Lists all rate sheets created by the authenticated courier organization. | () -> (list[ShipperPayCourierRateSheet1])
      *
      * @param {ShipperPayCourierRateSheets.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -41,7 +41,7 @@ export declare class ShipperPayCourierRateSheets {
     listByCourierOrgIdV1(requestOptions?: ShipperPayCourierRateSheets.RequestOptions): core.HttpResponsePromise<Chrt.ShipperPayCourierRateSheet1[]>;
     private __listByCourierOrgIdV1;
     /**
-     * Creates a new rate sheet for a courier to charge shippers.
+     * Creates a new rate sheet for a courier to charge shippers. | (ShipperPayCourierRateSheetClientCreate1) -> (PydanticObjectId)
      *
      * @param {Chrt.ShipperPayCourierRateSheetClientCreate1} request
      * @param {ShipperPayCourierRateSheets.RequestOptions} requestOptions - Request-specific configuration.
@@ -69,7 +69,7 @@ export declare class ShipperPayCourierRateSheets {
     createV1(request: Chrt.ShipperPayCourierRateSheetClientCreate1, requestOptions?: ShipperPayCourierRateSheets.RequestOptions): core.HttpResponsePromise<string>;
     private __createV1;
     /**
-     * Retrieves a single rate sheet by its ID (courier access only).
+     * Retrieves a single rate sheet by its ID (courier access only). | () -> (ShipperPayCourierRateSheet1)
      *
      * @param {string} id
      * @param {ShipperPayCourierRateSheets.RequestOptions} requestOptions - Request-specific configuration.
@@ -82,7 +82,7 @@ export declare class ShipperPayCourierRateSheets {
     getV1(id: string, requestOptions?: ShipperPayCourierRateSheets.RequestOptions): core.HttpResponsePromise<Chrt.ShipperPayCourierRateSheet1>;
     private __getV1;
     /**
-     * Deletes a rate sheet owned by the authenticated courier organization.
+     * Deletes a rate sheet owned by the authenticated courier organization. | () -> (bool)
      *
      * @param {string} id
      * @param {ShipperPayCourierRateSheets.RequestOptions} requestOptions - Request-specific configuration.
@@ -95,7 +95,7 @@ export declare class ShipperPayCourierRateSheets {
     deleteByIdV1(id: string, requestOptions?: ShipperPayCourierRateSheets.RequestOptions): core.HttpResponsePromise<boolean>;
     private __deleteByIdV1;
     /**
-     * Updates an existing rate sheet owned by the authenticated courier organization.
+     * Updates an existing rate sheet owned by the authenticated courier organization. | (ShipperPayCourierRateSheetClientUpdate1) -> (ShipperPayCourierRateSheet1)
      *
      * @param {string} id
      * @param {Chrt.ShipperPayCourierRateSheetClientUpdate1} request

package/dist/cjs/api/resources/shipperPayCourierRateSheets/client/Client.js

@@ -56,7 +56,7 @@ class ShipperPayCourierRateSheets {
         this._options = _options;
     }
     /**
-     * Lists all rate sheets created by the authenticated courier organization.
+     * Lists all rate sheets created by the authenticated courier organization. | () -> (list[ShipperPayCourierRateSheet1])
      *
      * @param {ShipperPayCourierRateSheets.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -107,7 +107,7 @@ class ShipperPayCourierRateSheets {
         });
     }
     /**
-     * Creates a new rate sheet for a courier to charge shippers.
+     * Creates a new rate sheet for a courier to charge shippers. | (ShipperPayCourierRateSheetClientCreate1) -> (PydanticObjectId)
      *
      * @param {Chrt.ShipperPayCourierRateSheetClientCreate1} request
      * @param {ShipperPayCourierRateSheets.RequestOptions} requestOptions - Request-specific configuration.
@@ -184,7 +184,7 @@ class ShipperPayCourierRateSheets {
         });
     }
     /**
-     * Retrieves a single rate sheet by its ID (courier access only).
+     * Retrieves a single rate sheet by its ID (courier access only). | () -> (ShipperPayCourierRateSheet1)
      *
      * @param {string} id
      * @param {ShipperPayCourierRateSheets.RequestOptions} requestOptions - Request-specific configuration.
@@ -243,7 +243,7 @@ class ShipperPayCourierRateSheets {
         });
     }
     /**
-     * Deletes a rate sheet owned by the authenticated courier organization.
+     * Deletes a rate sheet owned by the authenticated courier organization. | () -> (bool)
      *
      * @param {string} id
      * @param {ShipperPayCourierRateSheets.RequestOptions} requestOptions - Request-specific configuration.
@@ -302,7 +302,7 @@ class ShipperPayCourierRateSheets {
         });
     }
     /**
-     * Updates an existing rate sheet owned by the authenticated courier organization.
+     * Updates an existing rate sheet owned by the authenticated courier organization. | (ShipperPayCourierRateSheetClientUpdate1) -> (ShipperPayCourierRateSheet1)
      *
      * @param {string} id
      * @param {Chrt.ShipperPayCourierRateSheetClientUpdate1} request