@chrt-inc/typescript-sdk 1.891.0 → 1.892.0

package/dist/esm/api/resources/billingNew/resources/invoiceLineItems/client/Client.d.mts

@@ -0,0 +1,180 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../environments.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import * as Chrt from "../../../../../index.mjs";
+export declare namespace InvoiceLineItems {
+    interface Options {
+        environment?: core.Supplier<environments.ChrtEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token?: core.Supplier<core.BearerToken | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+}
+export declare class InvoiceLineItems {
+    protected readonly _options: InvoiceLineItems.Options;
+    constructor(_options?: InvoiceLineItems.Options);
+    /**
+     * Applies a caller-owned CHRT-ground rate sheet to a TaskGroup and atomically creates line items on a draft invoice. | authz: allowed_org_types=[provider], min_org_role=operator | (ApplyChrtGroundProviderRatesReq) -> (ApplyChrtGroundProviderRatesRes)
+     *
+     * @param {Chrt.billingNew.ApplyChrtGroundProviderRatesReq} request
+     * @param {InvoiceLineItems.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.invoiceLineItems.applyChrtGroundProviderRatesV1({
+     *         invoice_type: "accounts_receivable",
+     *         org_id: "org_id",
+     *         rate_sheet_id: "rate_sheet_id",
+     *         task_group_id: "task_group_id"
+     *     })
+     */
+    applyChrtGroundProviderRatesV1(request: Chrt.billingNew.ApplyChrtGroundProviderRatesReq, requestOptions?: InvoiceLineItems.RequestOptions): core.HttpResponsePromise<Chrt.ApplyChrtGroundProviderRatesRes>;
+    private __applyChrtGroundProviderRatesV1;
+    /**
+     * Lists owner-scoped line items for an order with counterparties and accounts expanded. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (InvoiceLineItemsByOrderExpandedRes)
+     *
+     * @param {string} orderId
+     * @param {InvoiceLineItems.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.invoiceLineItems.listByOrderV1("order_id")
+     */
+    listByOrderV1(orderId: string, requestOptions?: InvoiceLineItems.RequestOptions): core.HttpResponsePromise<Chrt.InvoiceLineItemsByOrderExpandedRes>;
+    private __listByOrderV1;
+    /**
+     * Creates optionally order-attributed line items from an amount and attaches them to a draft invoice. | authz: allowed_org_types=[provider], min_org_role=operator | authz_personas=[coordinator_org_operators, order_executor_org_operators, task_group_coordinator_operators, executor_org_operators] when order-attributed | (CreateInvoiceLineItemsFromAmountReq) -> (CreateInvoiceLineItemsFromAmountRes)
+     *
+     * @param {Chrt.billingNew.CreateInvoiceLineItemsFromAmountReq} request
+     * @param {InvoiceLineItems.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.invoiceLineItems.createFromAmountV1({
+     *         amount: 1.1,
+     *         currency_code: "USD",
+     *         description: "description",
+     *         invoice_type: "accounts_receivable",
+     *         line_item_type: "base_rate",
+     *         org_id: "org_id"
+     *     })
+     */
+    createFromAmountV1(request: Chrt.billingNew.CreateInvoiceLineItemsFromAmountReq, requestOptions?: InvoiceLineItems.RequestOptions): core.HttpResponsePromise<Chrt.CreateInvoiceLineItemsFromAmountRes>;
+    private __createFromAmountV1;
+    /**
+     * Creates optionally order-attributed line items by transforming submitted line items and attaches them to a draft invoice. | authz: allowed_org_types=[provider], min_org_role=operator | authz_personas=[coordinator_org_operators, order_executor_org_operators, task_group_coordinator_operators, executor_org_operators] when order-attributed | (CreateInvoiceLineItemsFromLineItemsReq) -> (CreateInvoiceLineItemsFromLineItemsRes)
+     *
+     * @param {Chrt.billingNew.CreateInvoiceLineItemsFromLineItemsReq} request
+     * @param {InvoiceLineItems.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.invoiceLineItems.createFromLineItemsV1({
+     *         description: "description",
+     *         invoice_line_item_amount_transformation: {
+     *             transformation_type: "percent",
+     *             value: 1.1
+     *         },
+     *         invoice_type: "accounts_receivable",
+     *         line_item_type: "base_rate",
+     *         org_id: "org_id",
+     *         source_invoice_line_items: [{
+     *                 _id: "_id",
+     *                 created_at_timestamp: "2024-01-15T09:30:00Z",
+     *                 created_by_user_id: "created_by_user_id",
+     *                 currency_code: "USD",
+     *                 description: "description",
+     *                 invoice_type: "accounts_receivable",
+     *                 last_edited_at_timestamp: "2024-01-15T09:30:00Z",
+     *                 last_edited_by_user_id: "last_edited_by_user_id",
+     *                 line_item_type: "base_rate",
+     *                 owned_by_org_id: "owned_by_org_id",
+     *                 quantity: 1.1,
+     *                 schema_version: 1,
+     *                 unit_price: 1.1
+     *             }]
+     *     })
+     */
+    createFromLineItemsV1(request: Chrt.billingNew.CreateInvoiceLineItemsFromLineItemsReq, requestOptions?: InvoiceLineItems.RequestOptions): core.HttpResponsePromise<Chrt.CreateInvoiceLineItemsFromLineItemsRes>;
+    private __createFromLineItemsV1;
+    /**
+     * Deletes owner-scoped line items and rebuilds every affected draft invoice. | authz: allowed_org_types=[provider], min_org_role=operator | (InvoiceLineItemsDeleteManyReq) -> (InvoiceLineItemsDeleteManyRes)
+     *
+     * @param {Chrt.billingNew.InvoiceLineItemsDeleteManyReq} request
+     * @param {InvoiceLineItems.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.invoiceLineItems.deleteManyV1({
+     *         invoice_line_item_ids: ["invoice_line_item_ids"]
+     *     })
+     */
+    deleteManyV1(request: Chrt.billingNew.InvoiceLineItemsDeleteManyReq, requestOptions?: InvoiceLineItems.RequestOptions): core.HttpResponsePromise<Chrt.InvoiceLineItemsDeleteManyRes>;
+    private __deleteManyV1;
+    /**
+     * Lists owner-scoped invoice line items with filtering, sorting, and pagination. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (InvoiceLineItemListRes)
+     *
+     * @param {Chrt.billingNew.InvoiceLineItemsListV1Request} request
+     * @param {InvoiceLineItems.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.invoiceLineItems.listV1({
+     *         sort_by: "created_at_timestamp",
+     *         sort_order: "asc",
+     *         page: 1,
+     *         page_size: 1,
+     *         filter_counterparty_org_id: "filter_counterparty_org_id",
+     *         filter_counterparty_off_chrt_org_data_id: "filter_counterparty_off_chrt_org_data_id",
+     *         filter_counterparty_account_id: "filter_counterparty_account_id",
+     *         filter_invoice_id: "filter_invoice_id",
+     *         filter_is_invoiced: true,
+     *         filter_order_id: "filter_order_id",
+     *         filter_task_group_id: "filter_task_group_id",
+     *         filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z"
+     *     })
+     */
+    listV1(request?: Chrt.billingNew.InvoiceLineItemsListV1Request, requestOptions?: InvoiceLineItems.RequestOptions): core.HttpResponsePromise<Chrt.InvoiceLineItemListRes>;
+    private __listV1;
+    /**
+     * Updates an owner-scoped line item and rebuilds its draft invoice when attached. | authz: allowed_org_types=[provider], min_org_role=operator | (InvoiceLineItemClientUpdate1) -> (bool)
+     *
+     * @param {string} invoiceLineItemId
+     * @param {Chrt.billingNew.InvoiceLineItemClientUpdate1} request
+     * @param {InvoiceLineItems.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.invoiceLineItems.updateV1("invoice_line_item_id")
+     */
+    updateV1(invoiceLineItemId: string, request?: Chrt.billingNew.InvoiceLineItemClientUpdate1, requestOptions?: InvoiceLineItems.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}