@chrt-inc/typescript-sdk 1.526.0 → 1.527.0

package/dist/esm/api/resources/billing/resources/lineItemGroups/client/Client.mjs

@@ -105,6 +105,7 @@ export class LineItemGroups {
      *     await client.billing.lineItemGroups.listForCourierOrgV1({
      *         filter_driver_id: "filter_driver_id",
      *         filter_attached_to_statement: true,
+     *         filter_order_id: "filter_order_id",
      *         filter_payment_role: "origin",
      *         page: 1,
      *         page_size: 1
@@ -116,7 +117,7 @@ export class LineItemGroups {
     __listForCourierOrgV1() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g;
-            const { filter_driver_id: filterDriverId, filter_status: filterStatus, filter_attached_to_statement: filterAttachedToStatement, filter_payment_role: filterPaymentRole, page, page_size: pageSize, } = request;
+            const { filter_driver_id: filterDriverId, filter_status: filterStatus, filter_attached_to_statement: filterAttachedToStatement, filter_order_id: filterOrderId, filter_payment_role: filterPaymentRole, page, page_size: pageSize, } = request;
             const _queryParams = {};
             if (filterDriverId !== undefined) {
                 _queryParams["filter_driver_id"] = filterDriverId;
@@ -132,6 +133,9 @@ export class LineItemGroups {
             if (filterAttachedToStatement !== undefined) {
                 _queryParams["filter_attached_to_statement"] = (_a = filterAttachedToStatement === null || filterAttachedToStatement === void 0 ? void 0 : filterAttachedToStatement.toString()) !== null && _a !== void 0 ? _a : null;
             }
+            if (filterOrderId !== undefined) {
+                _queryParams["filter_order_id"] = filterOrderId;
+            }
             if (filterPaymentRole !== undefined) {
                 _queryParams["filter_payment_role"] = filterPaymentRole;
             }

package/dist/esm/api/resources/billing/resources/lineItemGroups/client/requests/LineItemGroupsListForCourierOrgV1Request.d.mts

@@ -7,6 +7,7 @@ import * as Chrt from "../../../../../../index.mjs";
  *     {
  *         filter_driver_id: "filter_driver_id",
  *         filter_attached_to_statement: true,
+ *         filter_order_id: "filter_order_id",
  *         filter_payment_role: "origin",
  *         page: 1,
  *         page_size: 1
@@ -19,6 +20,8 @@ export interface LineItemGroupsListForCourierOrgV1Request {
     filter_status?: (Chrt.LineItemGroupStatusEnum1 | null) | (Chrt.LineItemGroupStatusEnum1 | null)[];
     /** Filter by whether line item group is attached to a statement */
     filter_attached_to_statement?: boolean | null;
+    /** Filter by order ID */
+    filter_order_id?: string | null;
     /** Filter by payment role: origin (courier pays) or destination (courier receives). Returns both if not specified. */
     filter_payment_role?: Chrt.PaymentRoleFilterEnum | null;
     page?: number | null;

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

@@ -31,7 +31,7 @@ export declare class AdHoc {
     protected readonly _options: AdHoc.Options;
     constructor(_options?: AdHoc.Options);
     /**
-     * Creates an ad-hoc line item group (not associated with a TaskGroup). Starts as ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator | (CreateAdHocLineItemGroupReq) -> (LineItemGroup1)
+     * Creates an ad-hoc line item group. Optionally associates with a TaskGroup. Starts as ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator | (CreateAdHocLineItemGroupReq) -> (LineItemGroup1)
      *
      * @param {Chrt.billing.lineItemGroups.CreateAdHocLineItemGroupReq} request
      * @param {AdHoc.RequestOptions} requestOptions - Request-specific configuration.
@@ -47,7 +47,7 @@ export declare class AdHoc {
     createV1(request: Chrt.billing.lineItemGroups.CreateAdHocLineItemGroupReq, requestOptions?: AdHoc.RequestOptions): core.HttpResponsePromise<Chrt.LineItemGroup1>;
     private __createV1;
     /**
-     * Adds a line item to an ad-hoc line item group. LIG must be ad-hoc (task_group_id is None) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (LineItemClientCreate1) -> (LineItemGroup1)
+     * Adds a line item to an ad-hoc line item group. LIG must be ad-hoc (is_ad_hoc=True) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (LineItemClientCreate1) -> (LineItemGroup1)
      *
      * @param {string} lineItemGroupId
      * @param {Chrt.billing.lineItemGroups.LineItemClientCreate1} request
@@ -65,7 +65,7 @@ export declare class AdHoc {
     addLineItemV1(lineItemGroupId: string, request: Chrt.billing.lineItemGroups.LineItemClientCreate1, requestOptions?: AdHoc.RequestOptions): core.HttpResponsePromise<Chrt.LineItemGroup1>;
     private __addLineItemV1;
     /**
-     * Removes a line item from an ad-hoc line item group. LIG must be ad-hoc (task_group_id is None) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (line_item_uuid_str) -> (LineItemGroup1)
+     * Removes a line item from an ad-hoc line item group. LIG must be ad-hoc (is_ad_hoc=True) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (line_item_uuid_str) -> (LineItemGroup1)
      *
      * @param {string} lineItemGroupId
      * @param {Chrt.billing.lineItemGroups.AdHocRemoveLineItemV1Request} request
@@ -81,7 +81,7 @@ export declare class AdHoc {
     removeLineItemV1(lineItemGroupId: string, request: Chrt.billing.lineItemGroups.AdHocRemoveLineItemV1Request, requestOptions?: AdHoc.RequestOptions): core.HttpResponsePromise<Chrt.LineItemGroup1>;
     private __removeLineItemV1;
     /**
-     * Deletes an ad-hoc line item group. LIG must be ad-hoc (task_group_id is None) and ADJUSTABLE or FINALIZED. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (bool)
+     * Deletes an ad-hoc line item group. LIG must be ad-hoc (is_ad_hoc=True) and ADJUSTABLE or FINALIZED. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (bool)
      *
      * @param {string} lineItemGroupId
      * @param {AdHoc.RequestOptions} requestOptions - Request-specific configuration.
@@ -93,5 +93,21 @@ export declare class AdHoc {
      */
     deleteV1(lineItemGroupId: string, requestOptions?: AdHoc.RequestOptions): core.HttpResponsePromise<boolean>;
     private __deleteV1;
+    /**
+     * Sets or updates the task_group_id on an existing ad-hoc LIG, deriving order_id and order_short_id from the task group. If the LIG is on a statement, recalculates the statement's order refs. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators, courier_org_operators, forwarder_org_operators] | (SetAdHocTaskGroupReq) -> (LineItemGroup1)
+     *
+     * @param {string} lineItemGroupId
+     * @param {Chrt.billing.lineItemGroups.SetAdHocTaskGroupReq} request
+     * @param {AdHoc.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.lineItemGroups.adHoc.setTaskGroupV1("line_item_group_id", {
+     *         task_group_id: "task_group_id"
+     *     })
+     */
+    setTaskGroupV1(lineItemGroupId: string, request: Chrt.billing.lineItemGroups.SetAdHocTaskGroupReq, requestOptions?: AdHoc.RequestOptions): core.HttpResponsePromise<Chrt.LineItemGroup1>;
+    private __setTaskGroupV1;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/dist/esm/api/resources/billing/resources/lineItemGroups/resources/adHoc/client/Client.mjs

@@ -20,7 +20,7 @@ export class AdHoc {
         this._options = _options;
     }
     /**
-     * Creates an ad-hoc line item group (not associated with a TaskGroup). Starts as ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator | (CreateAdHocLineItemGroupReq) -> (LineItemGroup1)
+     * Creates an ad-hoc line item group. Optionally associates with a TaskGroup. Starts as ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator | (CreateAdHocLineItemGroupReq) -> (LineItemGroup1)
      *
      * @param {Chrt.billing.lineItemGroups.CreateAdHocLineItemGroupReq} request
      * @param {AdHoc.RequestOptions} requestOptions - Request-specific configuration.
@@ -85,7 +85,7 @@ export class AdHoc {
         });
     }
     /**
-     * Adds a line item to an ad-hoc line item group. LIG must be ad-hoc (task_group_id is None) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (LineItemClientCreate1) -> (LineItemGroup1)
+     * Adds a line item to an ad-hoc line item group. LIG must be ad-hoc (is_ad_hoc=True) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (LineItemClientCreate1) -> (LineItemGroup1)
      *
      * @param {string} lineItemGroupId
      * @param {Chrt.billing.lineItemGroups.LineItemClientCreate1} request
@@ -152,7 +152,7 @@ export class AdHoc {
         });
     }
     /**
-     * Removes a line item from an ad-hoc line item group. LIG must be ad-hoc (task_group_id is None) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (line_item_uuid_str) -> (LineItemGroup1)
+     * Removes a line item from an ad-hoc line item group. LIG must be ad-hoc (is_ad_hoc=True) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (line_item_uuid_str) -> (LineItemGroup1)
      *
      * @param {string} lineItemGroupId
      * @param {Chrt.billing.lineItemGroups.AdHocRemoveLineItemV1Request} request
@@ -217,7 +217,7 @@ export class AdHoc {
         });
     }
     /**
-     * Deletes an ad-hoc line item group. LIG must be ad-hoc (task_group_id is None) and ADJUSTABLE or FINALIZED. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (bool)
+     * Deletes an ad-hoc line item group. LIG must be ad-hoc (is_ad_hoc=True) and ADJUSTABLE or FINALIZED. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (bool)
      *
      * @param {string} lineItemGroupId
      * @param {AdHoc.RequestOptions} requestOptions - Request-specific configuration.
@@ -275,6 +275,71 @@ export class AdHoc {
             }
         });
     }
+    /**
+     * Sets or updates the task_group_id on an existing ad-hoc LIG, deriving order_id and order_short_id from the task group. If the LIG is on a statement, recalculates the statement's order refs. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators, courier_org_operators, forwarder_org_operators] | (SetAdHocTaskGroupReq) -> (LineItemGroup1)
+     *
+     * @param {string} lineItemGroupId
+     * @param {Chrt.billing.lineItemGroups.SetAdHocTaskGroupReq} request
+     * @param {AdHoc.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.lineItemGroups.adHoc.setTaskGroupV1("line_item_group_id", {
+     *         task_group_id: "task_group_id"
+     *     })
+     */
+    setTaskGroupV1(lineItemGroupId, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__setTaskGroupV1(lineItemGroupId, request, requestOptions));
+    }
+    __setTaskGroupV1(lineItemGroupId, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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, `billing/line_item_groups/ad_hoc/set_task_group/v1/${encodeURIComponent(lineItemGroupId)}`),
+                method: "PATCH",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                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 };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.ChrtError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.ChrtError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /billing/line_item_groups/ad_hoc/set_task_group/v1/{line_item_group_id}.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
             const bearer = yield core.Supplier.get(this._options.token);

package/dist/esm/api/resources/billing/resources/lineItemGroups/resources/adHoc/client/requests/CreateAdHocLineItemGroupReq.d.mts

@@ -10,6 +10,8 @@ import * as Chrt from "../../../../../../../../index.mjs";
  *     }
  */
 export interface CreateAdHocLineItemGroupReq {
+    /** Optional task group ID to associate this ad-hoc LIG with (e.g. for adding extra charges to a flight TG) */
+    task_group_id?: string | null;
     /** Payment vector type */
     payment_vector_type: Chrt.PaymentVectorTypeEnum1;
     /** Settlement type for this line item group */

package/dist/esm/api/resources/billing/resources/lineItemGroups/resources/adHoc/client/requests/SetAdHocTaskGroupReq.d.mts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         task_group_id: "task_group_id"
+ *     }
+ */
+export interface SetAdHocTaskGroupReq {
+    task_group_id: string;
+}

package/dist/esm/api/resources/billing/resources/lineItemGroups/resources/adHoc/client/requests/index.d.mts

@@ -1,3 +1,4 @@
 export { type CreateAdHocLineItemGroupReq } from "./CreateAdHocLineItemGroupReq.mjs";
 export { type LineItemClientCreate1 } from "./LineItemClientCreate1.mjs";
 export { type AdHocRemoveLineItemV1Request } from "./AdHocRemoveLineItemV1Request.mjs";
+export { type SetAdHocTaskGroupReq } from "./SetAdHocTaskGroupReq.mjs";

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

@@ -86,6 +86,7 @@ export declare class Statements {
      *         page: 1,
      *         page_size: 1,
      *         filter_settlement_type: "stripe_connect",
+     *         filter_order_id: "filter_order_id",
      *         filter_payment_origin_org_id: "filter_payment_origin_org_id",
      *         filter_payment_destination_org_id: "filter_payment_destination_org_id",
      *         filter_owned_by_org_id: "filter_owned_by_org_id",
@@ -99,6 +100,35 @@ export declare class Statements {
      */
     listV1(request?: Chrt.billing.StatementsListV1Request, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.StatementsListRes>;
     private __listV1;
+    /**
+     * Lists statements with expanded LIGs and task groups, using filtering, sorting, and pagination. | authz_personas=[statement_org_operators, statement_driver] | () -> (StatementsExpandedListRes)
+     *
+     * @param {Chrt.billing.StatementsExpandedListV1Request} request
+     * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billing.statements.expandedListV1({
+     *         sort_by: "amount",
+     *         sort_order: "asc",
+     *         page: 1,
+     *         page_size: 1,
+     *         filter_settlement_type: "stripe_connect",
+     *         filter_order_id: "filter_order_id",
+     *         filter_payment_origin_org_id: "filter_payment_origin_org_id",
+     *         filter_payment_destination_org_id: "filter_payment_destination_org_id",
+     *         filter_owned_by_org_id: "filter_owned_by_org_id",
+     *         filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_opened_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_opened_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_paid_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_paid_at_timestamp_lte: "2024-01-15T09:30:00Z"
+     *     })
+     */
+    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)
      *
@@ -132,7 +162,7 @@ export declare class Statements {
      * 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)
      *
      * @param {string} statementId
-     * @param {Chrt.billing.BodyStatementsPatchUpdateSettlementTypeV1BillingUpdateSettlementTypeV1StatementIdPatch} request
+     * @param {Chrt.billing.BodyStatementsPatchUpdateSettlementTypeV1BillingStatementsUpdateSettlementTypeV1StatementIdPatch} request
      * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
@@ -142,13 +172,13 @@ export declare class Statements {
      *         settlement_type: "stripe_connect"
      *     })
      */
-    updateSettlementTypeV1(statementId: string, request: Chrt.billing.BodyStatementsPatchUpdateSettlementTypeV1BillingUpdateSettlementTypeV1StatementIdPatch, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
+    updateSettlementTypeV1(statementId: string, request: Chrt.billing.BodyStatementsPatchUpdateSettlementTypeV1BillingStatementsUpdateSettlementTypeV1StatementIdPatch, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
     private __updateSettlementTypeV1;
     /**
      * 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)
      *
      * @param {string} statementId
-     * @param {Chrt.billing.BodyStatementsPatchUpdateOffChrtSettlementStateV1BillingUpdateOffChrtSettlementStateV1StatementIdPatch} request
+     * @param {Chrt.billing.BodyStatementsPatchUpdateOffChrtSettlementStateV1BillingStatementsUpdateOffChrtSettlementStateV1StatementIdPatch} request
      * @param {Statements.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
@@ -158,7 +188,7 @@ export declare class Statements {
      *         new_status: "staged"
      *     })
      */
-    updateOffChrtSettlementStateV1(statementId: string, request: Chrt.billing.BodyStatementsPatchUpdateOffChrtSettlementStateV1BillingUpdateOffChrtSettlementStateV1StatementIdPatch, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
+    updateOffChrtSettlementStateV1(statementId: string, request: Chrt.billing.BodyStatementsPatchUpdateOffChrtSettlementStateV1BillingStatementsUpdateOffChrtSettlementStateV1StatementIdPatch, requestOptions?: Statements.RequestOptions): core.HttpResponsePromise<Chrt.Statement1>;
     private __updateOffChrtSettlementStateV1;
     /**
      * 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)