@chrt-inc/typescript-sdk 1.625.0 → 1.638.0

package/dist/esm/api/resources/billing/resources/statements/client/Client.d.mts

@@ -140,71 +140,119 @@ export declare class Statements {
     expandedListV1(request?: Chrt.billing.StatementsExpandedListV1Request, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.StatementsExpandedListRes>;
     private __expandedListV1;
     /**
-     * Creates a new statement without LIG IDs, starting in STAGED status. Requires payment vector, origin, and destination. | authz: org_type=[courier, forwarder], min_org_role=operator | (CreateStatementReq) -> (Statement1)
+     * Creates an empty STAGED Statement carrying payment parties + settlement_type. Items are attached via the attach_* routes. | authz: allowed_org_types=[provider], min_org_role=operator | (StatementCreateClientReq) -> (Statement1)
      *
-     * @param {Chrt.billing.CreateStatementReq} request
+     * @param {Chrt.billing.StatementCreateClientReq} request
      * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
      *     await client.billing.statements.createV1({
-     *         payment_vector_type: "shipper_pay_forwarder",
      *         settlement_type: "stripe_connect"
      *     })
      */
-    createV1(request: Chrt.billing.CreateStatementReq, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
+    createV1(request: Chrt.billing.StatementCreateClientReq, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
     private __createV1;
     /**
-     * Deletes a statement. Only allowed if statement has no LineItemGroup IDs. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators] | () -> (bool)
+     * Attaches a FINALIZED, unbundled LineItemGroup to a STAGED Statement. Parties must match; the Statement's settlement_type is written onto the LIG (or matched if previously stamped). | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[statement_owner_operators] | () -> (Statement1)
      *
      * @param {string} statementId
+     * @param {string} lineItemGroupId
      * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.billing.statements.deleteV1("statement_id")
+     *     await client.billing.statements.attachLineItemGroupV1("statement_id", "line_item_group_id")
      */
-    deleteV1(statementId: string, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __deleteV1;
+    attachLineItemGroupV1(statementId: string, lineItemGroupId: string, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
+    private __attachLineItemGroupV1;
     /**
-     * Updates the settlement type of a statement. Statement must be in STAGED status. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=STAGED | (SettlementTypeEnum1) -> (Statement1)
+     * Detaches a LineItemGroup from a STAGED Statement and recomputes order denormalization. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[statement_owner_operators] | () -> (Statement1)
      *
      * @param {string} statementId
-     * @param {Chrt.billing.BodyStatementsPatchUpdateSettlementTypeV1BillingStatementsUpdateSettlementTypeV1StatementIdPatch} request
+     * @param {string} lineItemGroupId
      * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.billing.statements.updateSettlementTypeV1("statement_id", {
-     *         settlement_type: "stripe_connect"
-     *     })
+     *     await client.billing.statements.detachLineItemGroupV1("statement_id", "line_item_group_id")
      */
-    updateSettlementTypeV1(statementId: string, request: Chrt.billing.BodyStatementsPatchUpdateSettlementTypeV1BillingStatementsUpdateSettlementTypeV1StatementIdPatch, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
-    private __updateSettlementTypeV1;
+    detachLineItemGroupV1(statementId: string, lineItemGroupId: string, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
+    private __detachLineItemGroupV1;
     /**
-     * Updates the status of an off-CHRT settlement statement. Used to manually transition OFF_CHRT statements between STAGED, OPEN, PAID, and VOID. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators] | (StatementStatusEnum1) -> (Statement1)
+     * Attaches a CLOSED, unbundled BillingLedgerPeriod to a STAGED Statement. Parties must match. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[statement_owner_operators] | () -> (Statement1)
      *
      * @param {string} statementId
-     * @param {Chrt.billing.BodyStatementsPatchUpdateOffChrtSettlementStateV1BillingStatementsUpdateOffChrtSettlementStateV1StatementIdPatch} request
+     * @param {string} billingLedgerPeriodId
      * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.billing.statements.updateOffChrtSettlementStateV1("statement_id", {
-     *         new_status: "staged"
-     *     })
+     *     await client.billing.statements.attachBillingLedgerPeriodV1("statement_id", "billing_ledger_period_id")
+     */
+    attachBillingLedgerPeriodV1(statementId: string, billingLedgerPeriodId: string, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
+    private __attachBillingLedgerPeriodV1;
+    /**
+     * Detaches a BillingLedgerPeriod from a STAGED Statement, freeing it for re-bundling. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[statement_owner_operators] | () -> (Statement1)
+     *
+     * @param {string} statementId
+     * @param {string} billingLedgerPeriodId
+     * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.statements.detachBillingLedgerPeriodV1("statement_id", "billing_ledger_period_id")
+     */
+    detachBillingLedgerPeriodV1(statementId: string, billingLedgerPeriodId: string, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
+    private __detachBillingLedgerPeriodV1;
+    /**
+     * Off-chrt manual transition: STAGED → OPEN. Cascades attached LineItemGroups FINALIZED → OPEN. Stripe-Connect statements take a separate Stripe-invoice path. Requires settlement_type=OFF_CHRT and at least one bundled LIG or period. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[statement_owner_operators] | () -> (Statement1)
+     *
+     * @param {string} statementId
+     * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.statements.openOffChrtV1("statement_id")
      */
-    updateOffChrtSettlementStateV1(statementId: string, request: Chrt.billing.BodyStatementsPatchUpdateOffChrtSettlementStateV1BillingStatementsUpdateOffChrtSettlementStateV1StatementIdPatch, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
-    private __updateOffChrtSettlementStateV1;
+    openOffChrtV1(statementId: string, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
+    private __openOffChrtV1;
     /**
-     * Opens a Stripe Connect invoice for a statement and attempt to send via email. Org must have a Stripe Connect account. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=STAGED, line_item_groups_status=FINALIZED | (OpenInvoiceReq) -> (Statement1)
+     * Off-chrt manual transition: OPEN → PAID. Cascades attached LineItemGroups OPEN → PAID. Stripe-Connect statements transition via Stripe webhook + sync, not this route. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[statement_owner_operators] | () -> (Statement1)
+     *
+     * @param {string} statementId
+     * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.statements.markPaidOffChrtV1("statement_id")
+     */
+    markPaidOffChrtV1(statementId: string, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
+    private __markPaidOffChrtV1;
+    /**
+     * Off-chrt manual write-off: OPEN → UNCOLLECTIBLE. Cascades attached LineItemGroups OPEN → UNCOLLECTIBLE. Stripe-Connect statements transition via Stripe webhook + sync_invoice/v1, not this route. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[statement_owner_operators] | () -> (Statement1)
+     *
+     * @param {string} statementId
+     * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.statements.markUncollectibleOffChrtV1("statement_id")
+     */
+    markUncollectibleOffChrtV1(statementId: string, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
+    private __markUncollectibleOffChrtV1;
+    /**
+     * Stripe-Connect transition: STAGED → OPEN. Creates and finalizes a Stripe invoice for the Statement; cascades attached LineItemGroups FINALIZED → OPEN. Requires settlement_type=STRIPE_CONNECT and at least one bundled FINALIZED LIG. Off-chrt statements take open_off_chrt/v1 instead. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[statement_owner_operators] | () -> (Statement1)
      *
      * @param {string} statementId
-     * @param {Chrt.billing.OpenInvoiceReq} request
      * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
@@ -212,10 +260,10 @@ export declare class Statements {
      * @example
      *     await client.billing.statements.openInvoiceV1("statement_id")
      */
-    openInvoiceV1(statementId: string, request?: Chrt.billing.OpenInvoiceReq, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
+    openInvoiceV1(statementId: string, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
     private __openInvoiceV1;
     /**
-     * Syncs invoice state from Stripe Connect to the Statement and LineItemGroups. The webhook usually keeps invoices up to date, but users can manually trigger a sync. | authz: org_type=[courier, forwarder, shipper], min_org_role=operator, authz_personas=[statement_org_operators] | () -> (Statement1)
+     * Stripe-Connect manual reconciliation: pulls the live Stripe invoice status and updates the Statement (and cascaded LIG statuses) accordingly. Same backend as the Stripe webhook handler — idempotent, no-op when already in sync. Handles PAID, UNCOLLECTIBLE, and VOID/DELETED transitions. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[statement_owner_operators] | () -> (Statement1)
      *
      * @param {string} statementId
      * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
@@ -228,7 +276,7 @@ export declare class Statements {
     syncInvoiceV1(statementId: string, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
     private __syncInvoiceV1;
     /**
-     * Voids a Stripe Connect invoice. Statement reverts to STAGED and LIGs revert to FINALIZED. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=OPEN | () -> (Statement1)
+     * Stripe-Connect transition: OPEN → STAGED. Voids the Stripe invoice, clears stripe_* fields on the Statement, and cascades attached LineItemGroups OPEN → FINALIZED so they remain re-bundleable into a new Statement. Reversible — the Statement can be re-opened with a fresh open_invoice/v1. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[statement_owner_operators] | () -> (Statement1)
      *
      * @param {string} statementId
      * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
@@ -240,5 +288,34 @@ export declare class Statements {
      */
     voidInvoiceV1(statementId: string, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
     private __voidInvoiceV1;
+    /**
+     * Flips a STAGED Statement's settlement_type between STRIPE_CONNECT and OFF_CHRT and cascades the new value onto every attached LineItemGroup. Rejects if the new value matches the current value. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[statement_owner_operators] | (StatementUpdateSettlementTypeReq) -> (Statement1)
+     *
+     * @param {string} statementId
+     * @param {Chrt.billing.StatementUpdateSettlementTypeReq} request
+     * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.statements.updateSettlementTypeV1("statement_id", {
+     *         settlement_type: "stripe_connect"
+     *     })
+     */
+    updateSettlementTypeV1(statementId: string, request: Chrt.billing.StatementUpdateSettlementTypeReq, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
+    private __updateSettlementTypeV1;
+    /**
+     * Deletes a STAGED Statement that has no attached LineItemGroups or BillingLedgerPeriods. Detach all children first via the detach_* routes. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[statement_owner_operators] | () -> (bool)
+     *
+     * @param {string} statementId
+     * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.statements.deleteV1("statement_id")
+     */
+    deleteV1(statementId: string, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __deleteV1;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }