@chrt-inc/typescript-sdk 1.899.0 → 1.900.0

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

@@ -0,0 +1,168 @@
+/**
+ * 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 BillingPeriods {
+    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 BillingPeriods {
+    protected readonly _options: BillingPeriods.Options;
+    constructor(_options?: BillingPeriods.Options);
+    /**
+     * Closes an open billing period and creates one approved line item on the matching draft invoice. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (BillingPeriodExpanded1)
+     *
+     * @param {string} billingPeriodId
+     * @param {BillingPeriods.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.billingPeriods.closeV1("billing_period_id")
+     */
+    closeV1(billingPeriodId: string, requestOptions?: BillingPeriods.RequestOptions): core.HttpResponsePromise<Chrt.BillingPeriodExpanded1>;
+    private __closeV1;
+    /**
+     * Creates an open owner-scoped billing period. | authz: allowed_org_types=[provider], min_org_role=operator | (BillingPeriodClientCreate1) -> (BillingPeriod1)
+     *
+     * @param {Chrt.billingNew.BillingPeriodClientCreate1} request
+     * @param {BillingPeriods.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.billingPeriods.createV1({
+     *         amount: 1.1,
+     *         currency_code: "USD",
+     *         cycle: "daily",
+     *         description: "description",
+     *         invoice_type: "accounts_receivable",
+     *         period_end_at_timestamp: "2024-01-15T09:30:00Z",
+     *         period_start_at_timestamp: "2024-01-15T09:30:00Z",
+     *         schema_version: 1
+     *     })
+     */
+    createV1(request: Chrt.billingNew.BillingPeriodClientCreate1, requestOptions?: BillingPeriods.RequestOptions): core.HttpResponsePromise<Chrt.BillingPeriod1>;
+    private __createV1;
+    /**
+     * Deletes an open owner-scoped billing period. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (bool)
+     *
+     * @param {string} billingPeriodId
+     * @param {BillingPeriods.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.billingPeriods.deleteV1("billing_period_id")
+     */
+    deleteV1(billingPeriodId: string, requestOptions?: BillingPeriods.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __deleteV1;
+    /**
+     * Gets an owner-scoped billing period with its generated line item and invoice when present. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (BillingPeriodExpanded1)
+     *
+     * @param {string} billingPeriodId
+     * @param {BillingPeriods.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.billingPeriods.getExpandedV1("billing_period_id")
+     */
+    getExpandedV1(billingPeriodId: string, requestOptions?: BillingPeriods.RequestOptions): core.HttpResponsePromise<Chrt.BillingPeriodExpanded1>;
+    private __getExpandedV1;
+    /**
+     * Lists owner-scoped billing periods with generated line items and invoices. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (BillingPeriodListRes)
+     *
+     * @param {Chrt.billingNew.BillingPeriodsListV1Request} request
+     * @param {BillingPeriods.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.billingPeriods.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_driver_id: "filter_counterparty_driver_id",
+     *         filter_shipper_account_id: "filter_shipper_account_id",
+     *         filter_task_group_id: "filter_task_group_id",
+     *         filter_period_start_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_period_start_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_period_end_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_period_end_at_timestamp_lte: "2024-01-15T09:30:00Z"
+     *     })
+     */
+    listV1(request?: Chrt.billingNew.BillingPeriodsListV1Request, requestOptions?: BillingPeriods.RequestOptions): core.HttpResponsePromise<Chrt.BillingPeriodListRes>;
+    private __listV1;
+    /**
+     * Adds visible TaskGroups to an open owner-scoped billing period. | authz: allowed_org_types=[provider], min_org_role=operator | (BillingPeriodTaskGroupsReq) -> (BillingPeriod1)
+     *
+     * @param {string} billingPeriodId
+     * @param {Chrt.BillingPeriodTaskGroupsReq} request
+     * @param {BillingPeriods.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.billingPeriods.addTaskGroupsV1("billing_period_id", {
+     *         task_group_ids: ["task_group_ids"]
+     *     })
+     */
+    addTaskGroupsV1(billingPeriodId: string, request: Chrt.BillingPeriodTaskGroupsReq, requestOptions?: BillingPeriods.RequestOptions): core.HttpResponsePromise<Chrt.BillingPeriod1>;
+    private __addTaskGroupsV1;
+    /**
+     * Removes linked TaskGroups from an open owner-scoped billing period. | authz: allowed_org_types=[provider], min_org_role=operator | (BillingPeriodTaskGroupsReq) -> (BillingPeriod1)
+     *
+     * @param {string} billingPeriodId
+     * @param {Chrt.BillingPeriodTaskGroupsReq} request
+     * @param {BillingPeriods.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.billingPeriods.removeTaskGroupsV1("billing_period_id", {
+     *         task_group_ids: ["task_group_ids"]
+     *     })
+     */
+    removeTaskGroupsV1(billingPeriodId: string, request: Chrt.BillingPeriodTaskGroupsReq, requestOptions?: BillingPeriods.RequestOptions): core.HttpResponsePromise<Chrt.BillingPeriod1>;
+    private __removeTaskGroupsV1;
+    /**
+     * Updates an open owner-scoped billing period. | authz: allowed_org_types=[provider], min_org_role=operator | (BillingPeriodClientUpdate1) -> (BillingPeriod1)
+     *
+     * @param {string} billingPeriodId
+     * @param {Chrt.billingNew.BillingPeriodClientUpdate1} request
+     * @param {BillingPeriods.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.billingNew.billingPeriods.updateV1("billing_period_id")
+     */
+    updateV1(billingPeriodId: string, request?: Chrt.billingNew.BillingPeriodClientUpdate1, requestOptions?: BillingPeriods.RequestOptions): core.HttpResponsePromise<Chrt.BillingPeriod1>;
+    private __updateV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}