@chrt-inc/typescript-sdk 1.920.0 → 1.922.0

package/dist/cjs/api/resources/shipping/resources/taskGroups/client/Client.d.ts

@@ -69,224 +69,6 @@ export declare class TaskGroups {
      */
     addMessageV1(taskGroupId: string, request: Chrt.shipping.AddMessageReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
     private __addMessageV1;
-    /**
-     * Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's PPD vector. Period parties must match the TG's PPD parties. The PPD vector must have no ledger attached and no rate sheet (rate-sheet/ledger exclusivity). Ad-hoc LIGs without a rate sheet may coexist. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (AttachBillingLedgerPeriodReq) -> (BillingLedgerPeriod1)
-     *
-     * @param {string} taskGroupId
-     * @param {Chrt.AttachBillingLedgerPeriodReq} request
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.shipping.taskGroups.attachBillingLedgerPeriodToProviderPayDriverV1("task_group_id", {
-     *         billing_ledger_period_id: "billing_ledger_period_id"
-     *     })
-     */
-    attachBillingLedgerPeriodToProviderPayDriverV1(taskGroupId: string, request: Chrt.AttachBillingLedgerPeriodReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<Chrt.BillingLedgerPeriod1>;
-    private __attachBillingLedgerPeriodToProviderPayDriverV1;
-    /**
-     * Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's PPP vector. Period parties must match the TG's PPP parties. The PPP vector must have no ledger attached and no rate sheet (rate-sheet/ledger exclusivity). Ad-hoc LIGs without a rate sheet may coexist. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachBillingLedgerPeriodReq) -> (BillingLedgerPeriod1)
-     *
-     * @param {string} taskGroupId
-     * @param {Chrt.AttachBillingLedgerPeriodReq} request
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.shipping.taskGroups.attachBillingLedgerPeriodToProviderPayProviderV1("task_group_id", {
-     *         billing_ledger_period_id: "billing_ledger_period_id"
-     *     })
-     */
-    attachBillingLedgerPeriodToProviderPayProviderV1(taskGroupId: string, request: Chrt.AttachBillingLedgerPeriodReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<Chrt.BillingLedgerPeriod1>;
-    private __attachBillingLedgerPeriodToProviderPayProviderV1;
-    /**
-     * Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's SPP vector. Period parties must match the TG's SPP parties. The SPP vector must have no ledger attached and no rate sheet (rate-sheet/ledger exclusivity). Ad-hoc LIGs without a rate sheet may coexist. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachBillingLedgerPeriodReq) -> (BillingLedgerPeriod1)
-     *
-     * @param {string} taskGroupId
-     * @param {Chrt.AttachBillingLedgerPeriodReq} request
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.shipping.taskGroups.attachBillingLedgerPeriodToShipperPayProviderV1("task_group_id", {
-     *         billing_ledger_period_id: "billing_ledger_period_id"
-     *     })
-     */
-    attachBillingLedgerPeriodToShipperPayProviderV1(taskGroupId: string, request: Chrt.AttachBillingLedgerPeriodReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<Chrt.BillingLedgerPeriod1>;
-    private __attachBillingLedgerPeriodToShipperPayProviderV1;
-    /**
-     * Attaches a STAGED, detached LineItemGroup to the PPD vector AND sets `LineItemGroup1.task_group_id` (one txn). The LIG must have `task_group_id is None`, be owned by the executor, and be party-matched to PPD. The PPD vector must have no LIG attached; if the LIG carries `rate_sheet_id`, no billing ledger period may be attached either (rate-sheet/ledger exclusivity). The LIG's `rate_sheet_id` is stamped onto `provider_pay_driver_rate_sheet_id` as a breadcrumb. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (AttachLigToVectorClientReq) -> (bool)
-     *
-     * @param {string} taskGroupId
-     * @param {Chrt.AttachLigToVectorClientReq} request
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.shipping.taskGroups.attachLigToProviderPayDriverV1("task_group_id", {
-     *         line_item_group_id: "line_item_group_id"
-     *     })
-     */
-    attachLigToProviderPayDriverV1(taskGroupId: string, request: Chrt.AttachLigToVectorClientReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __attachLigToProviderPayDriverV1;
-    /**
-     * Attaches a STAGED, detached LineItemGroup to the PPP vector AND sets `LineItemGroup1.task_group_id` (one txn). The LIG must have `task_group_id is None`, be owned by the coordinator, and be party-matched to PPP. The PPP vector must have no LIG attached; if the LIG carries `rate_sheet_id`, no billing ledger period may be attached either (rate-sheet/ledger exclusivity). The LIG's `rate_sheet_id` is stamped onto `provider_pay_provider_rate_sheet_id` as a breadcrumb. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachLigToVectorClientReq) -> (bool)
-     *
-     * @param {string} taskGroupId
-     * @param {Chrt.AttachLigToVectorClientReq} request
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.shipping.taskGroups.attachLigToProviderPayProviderV1("task_group_id", {
-     *         line_item_group_id: "line_item_group_id"
-     *     })
-     */
-    attachLigToProviderPayProviderV1(taskGroupId: string, request: Chrt.AttachLigToVectorClientReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __attachLigToProviderPayProviderV1;
-    /**
-     * Attaches a STAGED, detached LineItemGroup to the SPP vector AND sets `LineItemGroup1.task_group_id` (one txn). The LIG must have `task_group_id is None`, be owned by the coordinator, and be party-matched to SPP. The SPP vector must have no LIG attached; if the LIG carries `rate_sheet_id`, no billing ledger period may be attached either (rate-sheet/ledger exclusivity). The LIG's `rate_sheet_id` is stamped onto `shipper_pay_provider_rate_sheet_id` as a breadcrumb. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachLigToVectorClientReq) -> (bool)
-     *
-     * @param {string} taskGroupId
-     * @param {Chrt.AttachLigToVectorClientReq} request
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.shipping.taskGroups.attachLigToShipperPayProviderV1("task_group_id", {
-     *         line_item_group_id: "line_item_group_id"
-     *     })
-     */
-    attachLigToShipperPayProviderV1(taskGroupId: string, request: Chrt.AttachLigToVectorClientReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __attachLigToShipperPayProviderV1;
-    /**
-     * Detaches the PPD billing ledger period from this TaskGroup. Reverses attach_billing_ledger_period_to_provider_pay_driver/v1. Linked period must be OPEN. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | () -> (bool)
-     *
-     * @param {string} taskGroupId
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.shipping.taskGroups.detachBillingLedgerPeriodFromProviderPayDriverV1("task_group_id")
-     */
-    detachBillingLedgerPeriodFromProviderPayDriverV1(taskGroupId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __detachBillingLedgerPeriodFromProviderPayDriverV1;
-    /**
-     * Detaches the PPP billing ledger period from this TaskGroup. Reverses attach_billing_ledger_period_to_provider_pay_provider/v1. Linked period must be OPEN. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
-     *
-     * @param {string} taskGroupId
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.shipping.taskGroups.detachBillingLedgerPeriodFromProviderPayProviderV1("task_group_id")
-     */
-    detachBillingLedgerPeriodFromProviderPayProviderV1(taskGroupId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __detachBillingLedgerPeriodFromProviderPayProviderV1;
-    /**
-     * Detaches the SPP billing ledger period from this TaskGroup. Reverses attach_billing_ledger_period_to_shipper_pay_provider/v1. Linked period must be OPEN. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
-     *
-     * @param {string} taskGroupId
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.shipping.taskGroups.detachBillingLedgerPeriodFromShipperPayProviderV1("task_group_id")
-     */
-    detachBillingLedgerPeriodFromShipperPayProviderV1(taskGroupId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __detachBillingLedgerPeriodFromShipperPayProviderV1;
-    /**
-     * Clears the PPD vector's `_line_item_group_id` and `_rate_sheet_id` AND clears the LIG's `task_group_id` back-ref (one txn). The LIG document and its line items remain alive but fully detached on both sides. The PPD vector must currently have a LIG attached. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | () -> (bool)
-     *
-     * @param {string} taskGroupId
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.shipping.taskGroups.detachLigFromProviderPayDriverV1("task_group_id")
-     */
-    detachLigFromProviderPayDriverV1(taskGroupId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __detachLigFromProviderPayDriverV1;
-    /**
-     * Clears the PPP vector's `_line_item_group_id` and `_rate_sheet_id` AND clears the LIG's `task_group_id` back-ref (one txn). The LIG document and its line items remain alive but fully detached on both sides. The PPP vector must currently have a LIG attached. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
-     *
-     * @param {string} taskGroupId
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.shipping.taskGroups.detachLigFromProviderPayProviderV1("task_group_id")
-     */
-    detachLigFromProviderPayProviderV1(taskGroupId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __detachLigFromProviderPayProviderV1;
-    /**
-     * Clears the SPP vector's `_line_item_group_id` and `_rate_sheet_id` AND clears the LIG's `task_group_id` back-ref (one txn). The LIG document and its line items remain alive but fully detached on both sides. The SPP vector must currently have a LIG attached. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
-     *
-     * @param {string} taskGroupId
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.shipping.taskGroups.detachLigFromShipperPayProviderV1("task_group_id")
-     */
-    detachLigFromShipperPayProviderV1(taskGroupId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __detachLigFromShipperPayProviderV1;
-    /**
-     * Preview the LineItem materialization that would result from applying a rate sheet to the PPD vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (executor -> driver). Auto-resolves the rate sheet via RateSheetMapping1 for the requested driver unless body.rate_sheet_id is provided. PPD is on-chrt-executor only — TGs with an off-chrt executor are 400'd. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_provider_pay_driver/v1 then attach_lig_to_provider_pay_driver/v1. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (TaskGroupQuoteForProviderPayDriverClientReq) -> (TaskGroupQuoteResp)
-     *
-     * @param {string} taskGroupId
-     * @param {Chrt.shipping.TaskGroupQuoteForProviderPayDriverClientReq} request
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.shipping.taskGroups.quoteForProviderPayDriverV1("task_group_id", {
-     *         driver_id: "driver_id"
-     *     })
-     */
-    quoteForProviderPayDriverV1(taskGroupId: string, request: Chrt.shipping.TaskGroupQuoteForProviderPayDriverClientReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<Chrt.TaskGroupQuoteResp>;
-    private __quoteForProviderPayDriverV1;
-    /**
-     * Preview the LineItem materialization that would result from applying a rate sheet to the PPP vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (coordinator -> executor). Auto-resolves the rate sheet via RateSheetMapping1 for the requested executor unless body.rate_sheet_id is provided. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_provider_pay_provider/v1 then attach_lig_to_provider_pay_provider/v1. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (TaskGroupQuoteForProviderPayProviderClientReq) -> (TaskGroupQuoteResp)
-     *
-     * @param {string} taskGroupId
-     * @param {Chrt.shipping.TaskGroupQuoteForProviderPayProviderClientReq} request
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.shipping.taskGroups.quoteForProviderPayProviderV1("task_group_id")
-     */
-    quoteForProviderPayProviderV1(taskGroupId: string, request?: Chrt.shipping.TaskGroupQuoteForProviderPayProviderClientReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<Chrt.TaskGroupQuoteResp>;
-    private __quoteForProviderPayProviderV1;
-    /**
-     * Preview the LineItem materialization that would result from applying a rate sheet to the SPP vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (shipper -> coordinator). Auto-resolves the rate sheet via RateSheetMapping1 for the requested shipper unless body.rate_sheet_id is provided. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_shipper_pay_provider/v1 then attach_lig_to_shipper_pay_provider/v1. | authz: allowed_org_types=[provider, shipper], min_org_role=operator, authz_personas=[task_group_coordinator_operators, shipper_org_operators] | (TaskGroupQuoteForShipperPayProviderClientReq) -> (TaskGroupQuoteResp)
-     *
-     * @param {string} taskGroupId
-     * @param {Chrt.shipping.TaskGroupQuoteForShipperPayProviderClientReq} request
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.shipping.taskGroups.quoteForShipperPayProviderV1("task_group_id")
-     */
-    quoteForShipperPayProviderV1(taskGroupId: string, request?: Chrt.shipping.TaskGroupQuoteForShipperPayProviderClientReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<Chrt.TaskGroupQuoteResp>;
-    private __quoteForShipperPayProviderV1;
     /**
      * Removes the driver from a task group (sets driver_id to null). Allowed when STAGED or IN_PROGRESS (if no tasks have reached a terminal status). | authz_personas=[executor_org_operators, driver_for_executor] | () -> (bool)
      *
@@ -301,7 +83,7 @@ export declare class TaskGroups {
     removeDriverV1(taskGroupId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
     private __removeDriverV1;
     /**
-     * Clears the executor and assigned driver on a task group. Refuses while PPP or PPD billing is attached; detach billing explicitly first. | authz_personas=[coordinator_org_operators] | () -> (bool)
+     * Clears the executor and assigned driver on a task group. | authz_personas=[coordinator_org_operators] | () -> (bool)
      *
      * @param {string} taskGroupId
      * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
@@ -314,7 +96,7 @@ export declare class TaskGroups {
     removeExecutorV1(taskGroupId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
     private __removeExecutorV1;
     /**
-     * Replaces the ordered list of flights on a task group. | authz_personas=[lig_owner_operators] | (SetFlightInfoReq) -> (bool)
+     * Replaces the ordered list of flights on a task group. | authz_personas=[task_group_operating_org_operators] | (SetFlightInfoReq) -> (bool)
      *
      * @param {string} taskGroupId
      * @param {Chrt.SetFlightInfoReq} request
@@ -338,7 +120,7 @@ export declare class TaskGroups {
     setFlightInfoV1(taskGroupId: string, request: Chrt.SetFlightInfoReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
     private __setFlightInfoV1;
     /**
-     * Sets the ordering of tasks within a task group. Requires complete list of task IDs in desired order. Completed tasks must be before staged tasks. | authz_personas=[lig_owner_operators] | (SetTaskOrderingReq) -> (bool)
+     * Sets the ordering of tasks within a task group. Requires complete list of task IDs in desired order. Completed tasks must be before staged tasks. | authz_personas=[task_group_operating_org_operators] | (SetTaskOrderingReq) -> (bool)
      *
      * @param {string} taskGroupId
      * @param {Chrt.shipping.SetTaskOrderingReq} request