@chrt-inc/typescript-sdk 1.326.0 → 1.333.0

package/dist/cjs/api/resources/{tracking/resources/cargoByDevice → flights}/client/Client.d.ts

@@ -1,10 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as environments from "../../../../../../environments.js";
-import * as core from "../../../../../../core/index.js";
-import * as Chrt from "../../../../../index.js";
-export declare namespace CargoByDevice {
+import * as environments from "../../../../environments.js";
+import * as core from "../../../../core/index.js";
+import * as Chrt from "../../../index.js";
+export declare namespace Flights {
     interface Options {
         environment?: core.Supplier<environments.ChrtEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
@@ -27,24 +27,21 @@ export declare namespace CargoByDevice {
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
-export declare class CargoByDevice {
-    protected readonly _options: CargoByDevice.Options;
-    constructor(_options?: CargoByDevice.Options);
+export declare class Flights {
+    protected readonly _options: Flights.Options;
+    constructor(_options?: Flights.Options);
     /**
-     * Returns the most recent device location data point for cargo within a task group. Access granted to courier or shipper organization. | () -> (TrackingCargoByDeviceDataPoint1 | None)
+     * Returns flight info from an adjacent FLIGHT task group for TENDER_TO_AIRLINE or RECOVER_FROM_AIRLINE tasks. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators, shipper_org_operators] | () -> (FlightInfoForTaskRes)
      *
-     * @param {Chrt.tracking.CargoByDeviceLastSeenV1Request} request
-     * @param {CargoByDevice.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {string} taskId
+     * @param {Flights.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.cargoByDevice.lastSeenV1({
-     *         cargo_id: "cargo_id",
-     *         task_group_id: "task_group_id"
-     *     })
+     *     await client.flights.getFlightInfoForTaskV1("task_id")
      */
-    lastSeenV1(request: Chrt.tracking.CargoByDeviceLastSeenV1Request, requestOptions?: CargoByDevice.RequestOptions): core.HttpResponsePromise<(Chrt.TrackingCargoByDeviceDataPoint1 | null) | undefined>;
-    private __lastSeenV1;
+    getFlightInfoForTaskV1(taskId: string, requestOptions?: Flights.RequestOptions): core.HttpResponsePromise<Chrt.FlightInfoForTaskRes>;
+    private __getFlightInfoForTaskV1;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/dist/cjs/api/resources/{tracking/resources/taskGroupByDriver → flights}/client/Client.js

@@ -45,53 +45,45 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TaskGroupByDriver = void 0;
-const environments = __importStar(require("../../../../../../environments.js"));
-const core = __importStar(require("../../../../../../core/index.js"));
-const Chrt = __importStar(require("../../../../../index.js"));
-const headers_js_1 = require("../../../../../../core/headers.js");
-const errors = __importStar(require("../../../../../../errors/index.js"));
-class TaskGroupByDriver {
+exports.Flights = void 0;
+const environments = __importStar(require("../../../../environments.js"));
+const core = __importStar(require("../../../../core/index.js"));
+const Chrt = __importStar(require("../../../index.js"));
+const headers_js_1 = require("../../../../core/headers.js");
+const errors = __importStar(require("../../../../errors/index.js"));
+class Flights {
     constructor(_options = {}) {
         this._options = _options;
     }
     /**
-     * Returns the most recent driver location data point for a task group. Access granted to courier or shipper organization. Data written by the driver update endpoint. | () -> (TrackingTaskGroupByDriverDataPoint1 | None)
+     * Returns flight info from an adjacent FLIGHT task group for TENDER_TO_AIRLINE or RECOVER_FROM_AIRLINE tasks. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators, shipper_org_operators] | () -> (FlightInfoForTaskRes)
      *
-     * @param {Chrt.tracking.TaskGroupByDriverLastSeenV1Request} request
-     * @param {TaskGroupByDriver.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {string} taskId
+     * @param {Flights.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.tracking.taskGroupByDriver.lastSeenV1({
-     *         task_group_id: "task_group_id"
-     *     })
+     *     await client.flights.getFlightInfoForTaskV1("task_id")
      */
-    lastSeenV1(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__lastSeenV1(request, requestOptions));
+    getFlightInfoForTaskV1(taskId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getFlightInfoForTaskV1(taskId, requestOptions));
     }
-    __lastSeenV1(request, requestOptions) {
+    __getFlightInfoForTaskV1(taskId, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
-            const { task_group_id: taskGroupId } = request;
-            const _queryParams = {};
-            _queryParams["task_group_id"] = taskGroupId;
             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, "tracking/task_group_by_driver/last_seen/v1"),
+                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, `flights/flight_info/for_task/v1/${encodeURIComponent(taskId)}`),
                 method: "GET",
                 headers: _headers,
-                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 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,
             });
             if (_response.ok) {
-                return {
-                    data: _response.body,
-                    rawResponse: _response.rawResponse,
-                };
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
@@ -113,7 +105,7 @@ class TaskGroupByDriver {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /tracking/task_group_by_driver/last_seen/v1.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /flights/flight_info/for_task/v1/{task_id}.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,
@@ -132,4 +124,4 @@ class TaskGroupByDriver {
         });
     }
 }
-exports.TaskGroupByDriver = TaskGroupByDriver;
+exports.Flights = Flights;

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

@@ -14,6 +14,7 @@ export * as shipperPayCourierRateSheets from "./shipperPayCourierRateSheets/inde
 export * as shipperPayCourierStatements from "./shipperPayCourierStatements/index.js";
 export * as orgProfiles from "./orgProfiles/index.js";
 export * as dev from "./dev/index.js";
+export * as flights from "./flights/index.js";
 export * as taskArtifactNotifications from "./taskArtifactNotifications/index.js";
 export * as drivers from "./drivers/index.js";
 export * as cargos from "./cargos/index.js";

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

@@ -36,7 +36,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tracking = exports.orgInfoForConnections = exports.notifications = exports.utils = exports.users = exports.root = exports.orgs = exports.shipperContactInfo = exports.tasks = exports.offChrtShipperOrg = exports.taskArtifacts = exports.cargos = exports.drivers = exports.taskArtifactNotifications = exports.dev = exports.orgProfiles = exports.shipperPayCourierStatements = exports.shipperPayCourierRateSheets = exports.shipperPayCourierPayments = exports.shipperPayCourierLineItemGroups = exports.courierPayDriverStatements = exports.courierPayDriverRateSheets = exports.courierPayDriverPayouts = exports.courierPayDriverLineItemGroups = exports.payments = exports.taskGroups = exports.orders = exports.orderDrafts = exports.connections = void 0;
+exports.tracking = exports.orgInfoForConnections = exports.notifications = exports.utils = exports.users = exports.root = exports.orgs = exports.shipperContactInfo = exports.tasks = exports.offChrtShipperOrg = exports.taskArtifacts = exports.cargos = exports.drivers = exports.taskArtifactNotifications = exports.flights = exports.dev = exports.orgProfiles = exports.shipperPayCourierStatements = exports.shipperPayCourierRateSheets = exports.shipperPayCourierPayments = exports.shipperPayCourierLineItemGroups = exports.courierPayDriverStatements = exports.courierPayDriverRateSheets = exports.courierPayDriverPayouts = exports.courierPayDriverLineItemGroups = exports.payments = exports.taskGroups = exports.orders = exports.orderDrafts = exports.connections = void 0;
 exports.connections = __importStar(require("./connections/index.js"));
 __exportStar(require("./connections/types/index.js"), exports);
 exports.orderDrafts = __importStar(require("./orderDrafts/index.js"));
@@ -53,6 +53,7 @@ exports.shipperPayCourierRateSheets = __importStar(require("./shipperPayCourierR
 exports.shipperPayCourierStatements = __importStar(require("./shipperPayCourierStatements/index.js"));
 exports.orgProfiles = __importStar(require("./orgProfiles/index.js"));
 exports.dev = __importStar(require("./dev/index.js"));
+exports.flights = __importStar(require("./flights/index.js"));
 exports.taskArtifactNotifications = __importStar(require("./taskArtifactNotifications/index.js"));
 exports.drivers = __importStar(require("./drivers/index.js"));
 exports.cargos = __importStar(require("./cargos/index.js"));

package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/Client.d.ts

@@ -47,21 +47,19 @@ export declare class TaskGroup {
     addV1(request: Chrt.orderDrafts.OrderDraftAddTaskGroupReq, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<string>;
     private __addV1;
     /**
-     * Sets the flight number on a draft task group. | (SetFlightNumberDraftReq) -> (bool)
+     * Sets the flight number and/or fa_flight_id on a draft task group. | (SetFlightInfoReq) -> (bool)
      *
      * @param {string} taskGroupId
-     * @param {Chrt.orderDrafts.SetFlightNumberDraftReq} request
+     * @param {Chrt.SetFlightInfoReq} request
      * @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.orderDrafts.taskGroup.setFlightNumberV1("task_group_id", {
-     *         flight_number: "flight_number"
-     *     })
+     *     await client.orderDrafts.taskGroup.setFlightInfoV1("task_group_id", {})
      */
-    setFlightNumberV1(taskGroupId: string, request: Chrt.orderDrafts.SetFlightNumberDraftReq, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __setFlightNumberV1;
+    setFlightInfoV1(taskGroupId: string, request: Chrt.SetFlightInfoReq, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __setFlightInfoV1;
     /**
      * Updates the courier organization assigned to a draft task group. | (UpdateCourierOrgDraftReq) -> (bool)
      *

package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/Client.js

@@ -121,28 +121,26 @@ class TaskGroup {
         });
     }
     /**
-     * Sets the flight number on a draft task group. | (SetFlightNumberDraftReq) -> (bool)
+     * Sets the flight number and/or fa_flight_id on a draft task group. | (SetFlightInfoReq) -> (bool)
      *
      * @param {string} taskGroupId
-     * @param {Chrt.orderDrafts.SetFlightNumberDraftReq} request
+     * @param {Chrt.SetFlightInfoReq} request
      * @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.orderDrafts.taskGroup.setFlightNumberV1("task_group_id", {
-     *         flight_number: "flight_number"
-     *     })
+     *     await client.orderDrafts.taskGroup.setFlightInfoV1("task_group_id", {})
      */
-    setFlightNumberV1(taskGroupId, request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__setFlightNumberV1(taskGroupId, request, requestOptions));
+    setFlightInfoV1(taskGroupId, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__setFlightInfoV1(taskGroupId, request, requestOptions));
     }
-    __setFlightNumberV1(taskGroupId, request, requestOptions) {
+    __setFlightInfoV1(taskGroupId, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             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/order_drafts/task_group/set_flight_number/v1/${encodeURIComponent(taskGroupId)}`),
+                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/order_drafts/task_group/set_flight_info/v1/${encodeURIComponent(taskGroupId)}`),
                 method: "PATCH",
                 headers: _headers,
                 contentType: "application/json",
@@ -176,7 +174,7 @@ class TaskGroup {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /oort/order_drafts/task_group/set_flight_number/v1/{task_group_id}.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /oort/order_drafts/task_group/set_flight_info/v1/{task_group_id}.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,

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

@@ -1,4 +1,3 @@
 export { type OrderDraftAddTaskGroupReq } from "./OrderDraftAddTaskGroupReq.js";
-export { type SetFlightNumberDraftReq } from "./SetFlightNumberDraftReq.js";
 export { type UpdateCourierOrgDraftReq } from "./UpdateCourierOrgDraftReq.js";
 export { type SetTaskOrderingDraftReq } from "./SetTaskOrderingDraftReq.js";

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.