@chrt-inc/typescript-sdk 1.891.0 → 1.892.0

package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/requests/ApplyChrtGroundProviderRatesReq.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../../../index.js";
+/**
+ * @example
+ *     {
+ *         invoice_type: "accounts_receivable",
+ *         org_id: "org_id",
+ *         rate_sheet_id: "rate_sheet_id",
+ *         task_group_id: "task_group_id"
+ *     }
+ */
+export interface ApplyChrtGroundProviderRatesReq {
+    account_id?: string | null;
+    invoice_id?: string | null;
+    invoice_type: Chrt.InvoiceTypeEnum1;
+    /** Must be a string starting with `org_` */
+    org_id: string;
+    rate_sheet_id: string;
+    task_group_id: string;
+}

package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/requests/ApplyChrtGroundProviderRatesReq.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/requests/CreateInvoiceLineItemsFromAmountReq.d.ts

@@ -0,0 +1,28 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../../../index.js";
+/**
+ * @example
+ *     {
+ *         amount: 1.1,
+ *         currency_code: "USD",
+ *         description: "description",
+ *         invoice_type: "accounts_receivable",
+ *         line_item_type: "base_rate",
+ *         org_id: "org_id"
+ *     }
+ */
+export interface CreateInvoiceLineItemsFromAmountReq {
+    account_ids?: string[];
+    amount: number;
+    currency_code: Chrt.BillingCurrencyCodeEnum1;
+    description: string;
+    invoice_id?: string | null;
+    invoice_type: Chrt.InvoiceTypeEnum1;
+    line_item_type: Chrt.InvoiceLineItemTypeEnum1;
+    order_id?: string | null;
+    /** Must be a string starting with `org_` */
+    org_id: string;
+    task_group_id?: string | null;
+}

package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/requests/CreateInvoiceLineItemsFromAmountReq.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/requests/CreateInvoiceLineItemsFromLineItemsReq.d.ts

@@ -0,0 +1,45 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../../../index.js";
+/**
+ * @example
+ *     {
+ *         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
+ *             }]
+ *     }
+ */
+export interface CreateInvoiceLineItemsFromLineItemsReq {
+    account_ids?: string[];
+    description: string;
+    invoice_id?: string | null;
+    invoice_line_item_amount_transformation: Chrt.InvoiceLineItemAmountTransformation1;
+    invoice_type: Chrt.InvoiceTypeEnum1;
+    line_item_type: Chrt.InvoiceLineItemTypeEnum1;
+    order_id?: string | null;
+    /** Must be a string starting with `org_` */
+    org_id: string;
+    source_invoice_line_items: Chrt.InvoiceLineItem1[];
+    task_group_id?: string | null;
+}

package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/requests/CreateInvoiceLineItemsFromLineItemsReq.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/requests/InvoiceLineItemClientUpdate1.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../../../index.js";
+/**
+ * @example
+ *     {}
+ */
+export interface InvoiceLineItemClientUpdate1 {
+    currency_code?: Chrt.BillingCurrencyCodeEnum1 | null;
+    description?: string | null;
+    export_ref__sage__item_id?: string | null;
+    export_ref__sage__item_id__set_to_None?: boolean;
+    invoice_type?: Chrt.InvoiceTypeEnum1 | null;
+    quantity?: number | null;
+    unit?: Chrt.InvoiceLineItemUnitEnum1 | null;
+    unit__set_to_None?: boolean;
+    unit_price?: number | null;
+}

package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/requests/InvoiceLineItemClientUpdate1.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/requests/InvoiceLineItemsDeleteManyReq.d.ts

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

package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/requests/InvoiceLineItemsDeleteManyReq.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/requests/InvoiceLineItemsListV1Request.d.ts

@@ -0,0 +1,62 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../../../index.js";
+/**
+ * @example
+ *     {
+ *         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"
+ *     }
+ */
+export interface InvoiceLineItemsListV1Request {
+    /** Field to sort by. */
+    sort_by?: Chrt.InvoiceLineItemSortByEnum | null;
+    /** Sort order. */
+    sort_order?: Chrt.SortOrderEnum | null;
+    page?: number | null;
+    page_size?: number | null;
+    /** Filter by one or more invoice types. */
+    filter_invoice_types?: (Chrt.InvoiceTypeEnum1 | null) | (Chrt.InvoiceTypeEnum1 | null)[];
+    /** Filter by one or more currency codes. */
+    filter_currency_codes?: (Chrt.BillingCurrencyCodeEnum1 | null) | (Chrt.BillingCurrencyCodeEnum1 | null)[];
+    /** Filter by one or more line item types. */
+    filter_line_item_types?: (Chrt.InvoiceLineItemTypeEnum1 | null) | (Chrt.InvoiceLineItemTypeEnum1 | null)[];
+    /** Filter by one or more units. */
+    filter_units?: (Chrt.InvoiceLineItemUnitEnum1 | null) | (Chrt.InvoiceLineItemUnitEnum1 | null)[];
+    /** Filter by an on-CHRT counterparty organization. */
+    filter_counterparty_org_id?: string | null;
+    /** Filter by off-CHRT counterparty organization data. */
+    filter_counterparty_off_chrt_org_data_id?: string | null;
+    /** Filter by an associated counterparty account. */
+    filter_counterparty_account_id?: string | null;
+    /** Filter by an attached invoice. */
+    filter_invoice_id?: string | null;
+    /** Filter by whether a line item is attached to an invoice. */
+    filter_is_invoiced?: boolean | null;
+    /** Filter by an attributed order. */
+    filter_order_id?: string | null;
+    /** Filter by an attributed task group. */
+    filter_task_group_id?: string | null;
+    /** Filter by created_at_timestamp greater than or equal. */
+    filter_created_at_timestamp_gte?: string | null;
+    /** Filter by created_at_timestamp less than or equal. */
+    filter_created_at_timestamp_lte?: string | null;
+    /** Filter by last_edited_at_timestamp greater than or equal. */
+    filter_last_edited_at_timestamp_gte?: string | null;
+    /** Filter by last_edited_at_timestamp less than or equal. */
+    filter_last_edited_at_timestamp_lte?: string | null;
+}

package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/requests/InvoiceLineItemsListV1Request.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/requests/index.d.ts

@@ -0,0 +1,6 @@
+export { type ApplyChrtGroundProviderRatesReq } from "./ApplyChrtGroundProviderRatesReq.js";
+export { type CreateInvoiceLineItemsFromAmountReq } from "./CreateInvoiceLineItemsFromAmountReq.js";
+export { type CreateInvoiceLineItemsFromLineItemsReq } from "./CreateInvoiceLineItemsFromLineItemsReq.js";
+export { type InvoiceLineItemsDeleteManyReq } from "./InvoiceLineItemsDeleteManyReq.js";
+export { type InvoiceLineItemsListV1Request } from "./InvoiceLineItemsListV1Request.js";
+export { type InvoiceLineItemClientUpdate1 } from "./InvoiceLineItemClientUpdate1.js";

package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1 @@
+export * from "./client/index.js";

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

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/billingNew/resources/invoices/client/Client.d.ts

@@ -0,0 +1,217 @@
+/**
+ * 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 Invoices {
+    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 Invoices {
+    protected readonly _options: Invoices.Options;
+    constructor(_options?: Invoices.Options);
+    /**
+     * Approves a draft invoice owned by the caller's organization. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (Invoice1)
+     *
+     * @param {string} invoiceId
+     * @param {Invoices.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.invoices.approveV1("invoice_id")
+     */
+    approveV1(invoiceId: string, requestOptions?: Invoices.RequestOptions): core.HttpResponsePromise<Chrt.Invoice1>;
+    private __approveV1;
+    /**
+     * Creates a draft invoice owned by the caller's organization. | authz: allowed_org_types=[provider], min_org_role=operator | (InvoiceClientCreate1) -> (PydanticObjectId)
+     *
+     * @param {Chrt.billingNew.InvoiceClientCreate1} request
+     * @param {Invoices.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.invoices.createV1({
+     *         currency_code: "USD",
+     *         invoice_type: "accounts_receivable",
+     *         schema_version: 1
+     *     })
+     */
+    createV1(request: Chrt.billingNew.InvoiceClientCreate1, requestOptions?: Invoices.RequestOptions): core.HttpResponsePromise<string>;
+    private __createV1;
+    /**
+     * Hard-deletes a draft invoice and detaches its line items. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (bool)
+     *
+     * @param {string} invoiceId
+     * @param {Invoices.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.invoices.deleteV1("invoice_id")
+     */
+    deleteV1(invoiceId: string, requestOptions?: Invoices.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __deleteV1;
+    /**
+     * Retrieves an owner-scoped invoice with its line items, counterparty organization data, and accounts expanded. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (InvoiceExpandedRes)
+     *
+     * @param {string} invoiceId
+     * @param {Invoices.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.invoices.getExpandedV1("invoice_id")
+     */
+    getExpandedV1(invoiceId: string, requestOptions?: Invoices.RequestOptions): core.HttpResponsePromise<Chrt.InvoiceExpandedRes>;
+    private __getExpandedV1;
+    /**
+     * Attaches one line item to a draft invoice, moving it from another draft invoice when needed, and synchronizes both invoices. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (Invoice1)
+     *
+     * @param {string} invoiceId
+     * @param {string} invoiceLineItemId
+     * @param {Invoices.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.invoices.addLineItemV1("invoice_id", "invoice_line_item_id")
+     */
+    addLineItemV1(invoiceId: string, invoiceLineItemId: string, requestOptions?: Invoices.RequestOptions): core.HttpResponsePromise<Chrt.Invoice1>;
+    private __addLineItemV1;
+    /**
+     * Detaches one line item from a draft invoice and synchronizes the invoice total and accounts. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (Invoice1)
+     *
+     * @param {string} invoiceId
+     * @param {string} invoiceLineItemId
+     * @param {Invoices.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.invoices.removeLineItemV1("invoice_id", "invoice_line_item_id")
+     */
+    removeLineItemV1(invoiceId: string, invoiceLineItemId: string, requestOptions?: Invoices.RequestOptions): core.HttpResponsePromise<Chrt.Invoice1>;
+    private __removeLineItemV1;
+    /**
+     * Attaches existing line items to a draft invoice, moving them from any other draft invoices, and synchronizes all affected invoice totals and accounts. | authz: allowed_org_types=[provider], min_org_role=operator | (InvoiceLineItemsAddReq) -> (Invoice1)
+     *
+     * @param {string} invoiceId
+     * @param {Chrt.billingNew.InvoiceLineItemsAddReq} request
+     * @param {Invoices.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.invoices.addLineItemsV1("invoice_id", {
+     *         invoice_line_item_ids: ["invoice_line_item_ids"]
+     *     })
+     */
+    addLineItemsV1(invoiceId: string, request: Chrt.billingNew.InvoiceLineItemsAddReq, requestOptions?: Invoices.RequestOptions): core.HttpResponsePromise<Chrt.Invoice1>;
+    private __addLineItemsV1;
+    /**
+     * Detaches existing line items from a draft invoice and synchronizes derived invoice fields. | authz: allowed_org_types=[provider], min_org_role=operator | (InvoiceLineItemsRemoveReq) -> (Invoice1)
+     *
+     * @param {string} invoiceId
+     * @param {Chrt.billingNew.InvoiceLineItemsRemoveReq} request
+     * @param {Invoices.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.invoices.removeLineItemsV1("invoice_id", {
+     *         invoice_line_item_ids: ["invoice_line_item_ids"]
+     *     })
+     */
+    removeLineItemsV1(invoiceId: string, request: Chrt.billingNew.InvoiceLineItemsRemoveReq, requestOptions?: Invoices.RequestOptions): core.HttpResponsePromise<Chrt.Invoice1>;
+    private __removeLineItemsV1;
+    /**
+     * Lists owner-scoped invoices with search, filtering, sorting, and pagination. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (InvoiceListRes)
+     *
+     * @param {Chrt.billingNew.InvoicesListV1Request} request
+     * @param {Invoices.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.invoices.listV1({
+     *         search: "search",
+     *         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_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.InvoicesListV1Request, requestOptions?: Invoices.RequestOptions): core.HttpResponsePromise<Chrt.InvoiceListRes>;
+    private __listV1;
+    /**
+     * Updates the name or description of a draft invoice owned by the caller's organization. | authz: allowed_org_types=[provider], min_org_role=operator | (InvoiceClientUpdate1) -> (bool)
+     *
+     * @param {string} invoiceId
+     * @param {Chrt.billingNew.InvoiceClientUpdate1} request
+     * @param {Invoices.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.invoices.updateV1("invoice_id")
+     */
+    updateV1(invoiceId: string, request?: Chrt.billingNew.InvoiceClientUpdate1, requestOptions?: Invoices.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateV1;
+    /**
+     * Retrieves an invoice owned by the caller's organization. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (Invoice1)
+     *
+     * @param {string} invoiceId
+     * @param {Invoices.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.invoices.getV1("invoice_id")
+     */
+    getV1(invoiceId: string, requestOptions?: Invoices.RequestOptions): core.HttpResponsePromise<Chrt.Invoice1>;
+    private __getV1;
+    /**
+     * Voids a draft or approved invoice owned by the caller's organization. | authz: allowed_org_types=[provider], min_org_role=operator | (InvoiceVoidReq) -> (Invoice1)
+     *
+     * @param {string} invoiceId
+     * @param {Chrt.billingNew.InvoiceVoidReq} request
+     * @param {Invoices.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.invoices.voidV1("invoice_id")
+     */
+    voidV1(invoiceId: string, request?: Chrt.billingNew.InvoiceVoidReq, requestOptions?: Invoices.RequestOptions): core.HttpResponsePromise<Chrt.Invoice1>;
+    private __voidV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}