lark-billing 0.1.4 → 0.2.0

package/resources/pricing-metrics.d.ts

@@ -0,0 +1,229 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class PricingMetrics extends APIResource {
+    /**
+     * Create Pricing Metric
+     *
+     * @example
+     * ```ts
+     * const pricingMetricResource =
+     *   await client.pricingMetrics.create({
+     *     aggregation: {
+     *       aggregation_type: 'sum',
+     *       value_field: 'compute_hours',
+     *     },
+     *     event_name: 'job_completed',
+     *     name: 'Compute Hours',
+     *     unit: 'hours',
+     *   });
+     * ```
+     */
+    create(body: PricingMetricCreateParams, options?: RequestOptions): APIPromise<PricingMetricResource>;
+    /**
+     * Get Pricing Metric
+     *
+     * @example
+     * ```ts
+     * const pricingMetricResource =
+     *   await client.pricingMetrics.retrieve('pricing_metric_id');
+     * ```
+     */
+    retrieve(pricingMetricID: string, options?: RequestOptions): APIPromise<PricingMetricResource>;
+    /**
+     * List Pricing Metrics
+     *
+     * @example
+     * ```ts
+     * const pricingMetrics = await client.pricingMetrics.list();
+     * ```
+     */
+    list(query?: PricingMetricListParams | null | undefined, options?: RequestOptions): APIPromise<PricingMetricListResponse>;
+    /**
+     * Create Pricing Metric Summary
+     *
+     * @example
+     * ```ts
+     * const response = await client.pricingMetrics.createSummary(
+     *   'pricing_metric_id',
+     *   {
+     *     period: {
+     *       end: '2025-11-01T00:00:00Z',
+     *       start: '2025-10-01T00:00:00Z',
+     *     },
+     *     subject_id: 'subj_VyX6Q96h5avMho8O7QWlKeXE',
+     *   },
+     * );
+     * ```
+     */
+    createSummary(pricingMetricID: string, body: PricingMetricCreateSummaryParams, options?: RequestOptions): APIPromise<PricingMetricCreateSummaryResponse>;
+}
+export interface Period {
+    end: string;
+    start: string;
+    inclusive_end?: boolean;
+    inclusive_start?: boolean;
+}
+export interface PricingMetricResource {
+    /**
+     * The ID of the pricing metric.
+     */
+    id: string;
+    /**
+     * The aggregation function used to compute the value of the pricing metric.
+     */
+    aggregation: PricingMetricResource.SumAggregationPricingMetricResource | PricingMetricResource.CountAggregationPricingMetricResource | PricingMetricResource.MaxAggregationPricingMetricResource | PricingMetricResource.LastAggregationPricingMetricResource;
+    /**
+     * The event name that the pricing metric is computed on.
+     */
+    event_name: string;
+    /**
+     * The name of the pricing metric.
+     */
+    name: string;
+    /**
+     * The unit of the value computed by the pricing metric.
+     */
+    unit: string;
+}
+export declare namespace PricingMetricResource {
+    interface SumAggregationPricingMetricResource {
+        aggregation_type: 'sum';
+        /**
+         * The field to sum over.
+         */
+        value_field: string;
+    }
+    interface CountAggregationPricingMetricResource {
+        aggregation_type: 'count';
+    }
+    interface MaxAggregationPricingMetricResource {
+        aggregation_type: 'max';
+        /**
+         * The field to get the max value of.
+         */
+        value_field: string;
+    }
+    interface LastAggregationPricingMetricResource {
+        aggregation_type: 'last';
+        /**
+         * The field to get the last value of.
+         */
+        value_field: string;
+    }
+}
+export interface PricingMetricListResponse {
+    has_more: boolean;
+    pricing_metrics: Array<PricingMetricResource>;
+}
+export interface PricingMetricCreateSummaryResponse {
+    /**
+     * The ID of the pricing metric summary.
+     */
+    id: string;
+    /**
+     * The period that the summary is computed over.
+     */
+    period: Period;
+    /**
+     * The ID of the pricing metric that the summary is for.
+     */
+    pricing_metric_id: string;
+    /**
+     * The ID of the subject that the summary is for.
+     */
+    subject_id: string;
+    /**
+     * The computed value of the pricing metric for the period. If the pricing metric
+     * does not have any usage events for the period, this will be `null`.
+     */
+    value: string | null;
+}
+export interface PricingMetricCreateParams {
+    /**
+     * The aggregation function used to compute the value of the pricing metric.
+     */
+    aggregation: PricingMetricCreateParams.SumAggregationPricingMetricInterface | PricingMetricCreateParams.CountAggregationPricingMetricInterface | PricingMetricCreateParams.MaxAggregationPricingMetricInterface | PricingMetricCreateParams.LastAggregationPricingMetricInterface | PricingMetricCreateParams.CustomAggregationPricingMetricInterface;
+    /**
+     * The name of the event that the pricing metric is computed on.
+     */
+    event_name: string;
+    /**
+     * The name of the pricing metric.
+     */
+    name: string;
+    /**
+     * Unit of measurement for the pricing metric.
+     */
+    unit: string;
+}
+export declare namespace PricingMetricCreateParams {
+    /**
+     * Computes the sum of the `value_field` over all usage events with the specified
+     * `event_name`.
+     */
+    interface SumAggregationPricingMetricInterface {
+        aggregation_type: 'sum';
+        /**
+         * Field to sum over.
+         */
+        value_field: string;
+    }
+    /**
+     * Computes the number of usage events with the specified `event_name`.
+     */
+    interface CountAggregationPricingMetricInterface {
+        aggregation_type: 'count';
+    }
+    /**
+     * Computes the max value of the `value_field` over all usage events with the
+     * specified `event_name`.
+     */
+    interface MaxAggregationPricingMetricInterface {
+        aggregation_type: 'max';
+        /**
+         * Field to get the max value of.
+         */
+        value_field: string;
+    }
+    /**
+     * Computes the last value of the `value_field` over all usage events with the
+     * specified `event_name`.
+     */
+    interface LastAggregationPricingMetricInterface {
+        aggregation_type: 'last';
+        /**
+         * Field to get the last value of.
+         */
+        value_field: string;
+    }
+    /**
+     * Custom aggregation for use cases not supported by the other aggregation types.
+     * Please email team@uselark.ai to enable this feature.
+     */
+    interface CustomAggregationPricingMetricInterface {
+        aggregation_type: 'custom';
+        /**
+         * Custom expression to compute the pricing metric. Please email team@uselark.ai to
+         * enable this feature.
+         */
+        custom_expression: string;
+    }
+}
+export interface PricingMetricListParams {
+    limit?: number;
+}
+export interface PricingMetricCreateSummaryParams {
+    /**
+     * The period that the summary should be computed over.
+     */
+    period: Period;
+    /**
+     * The ID or external ID of the subject that the summary should be computed for.
+     */
+    subject_id: string;
+}
+export declare namespace PricingMetrics {
+    export { type Period as Period, type PricingMetricResource as PricingMetricResource, type PricingMetricListResponse as PricingMetricListResponse, type PricingMetricCreateSummaryResponse as PricingMetricCreateSummaryResponse, type PricingMetricCreateParams as PricingMetricCreateParams, type PricingMetricListParams as PricingMetricListParams, type PricingMetricCreateSummaryParams as PricingMetricCreateSummaryParams, };
+}
+//# sourceMappingURL=pricing-metrics.d.ts.map

package/resources/pricing-metrics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pricing-metrics.d.ts","sourceRoot":"","sources":["../src/resources/pricing-metrics.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAIpG;;;;;;;;OAQG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;;;;;;;OAgBG;IACH,aAAa,CACX,eAAe,EAAE,MAAM,EACvB,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;CAGlD;AAED,MAAM,WAAW,MAAM;IACrB,GAAG,EAAE,MAAM,CAAC;IAEZ,KAAK,EAAE,MAAM,CAAC;IAEd,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EACP,qBAAqB,CAAC,mCAAmC,GACzD,qBAAqB,CAAC,qCAAqC,GAC3D,qBAAqB,CAAC,mCAAmC,GACzD,qBAAqB,CAAC,oCAAoC,CAAC;IAE/D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,mCAAmC;QAClD,gBAAgB,EAAE,KAAK,CAAC;QAExB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,qCAAqC;QACpD,gBAAgB,EAAE,OAAO,CAAC;KAC3B;IAED,UAAiB,mCAAmC;QAClD,gBAAgB,EAAE,KAAK,CAAC;QAExB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;KACrB;IAED,UAAiB,oCAAoC;QACnD,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,EAAE,OAAO,CAAC;IAElB,eAAe,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;CAC/C;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,WAAW,EACP,yBAAyB,CAAC,oCAAoC,GAC9D,yBAAyB,CAAC,sCAAsC,GAChE,yBAAyB,CAAC,oCAAoC,GAC9D,yBAAyB,CAAC,qCAAqC,GAC/D,yBAAyB,CAAC,uCAAuC,CAAC;IAEtE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;;OAGG;IACH,UAAiB,oCAAoC;QACnD,gBAAgB,EAAE,KAAK,CAAC;QAExB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;KACrB;IAED;;OAEG;IACH,UAAiB,sCAAsC;QACrD,gBAAgB,EAAE,OAAO,CAAC;KAC3B;IAED;;;OAGG;IACH,UAAiB,oCAAoC;QACnD,gBAAgB,EAAE,KAAK,CAAC;QAExB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;KACrB;IAED;;;OAGG;IACH,UAAiB,qCAAqC;QACpD,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;KACrB;IAED;;;OAGG;IACH,UAAiB,uCAAuC;QACtD,gBAAgB,EAAE,QAAQ,CAAC;QAE3B;;;WAGG;QACH,iBAAiB,EAAE,MAAM,CAAC;KAC3B;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;CACH"}

package/resources/pricing-metrics.js

@@ -0,0 +1,73 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PricingMetrics = void 0;
+const resource_1 = require("../core/resource.js");
+const path_1 = require("../internal/utils/path.js");
+class PricingMetrics extends resource_1.APIResource {
+    /**
+     * Create Pricing Metric
+     *
+     * @example
+     * ```ts
+     * const pricingMetricResource =
+     *   await client.pricingMetrics.create({
+     *     aggregation: {
+     *       aggregation_type: 'sum',
+     *       value_field: 'compute_hours',
+     *     },
+     *     event_name: 'job_completed',
+     *     name: 'Compute Hours',
+     *     unit: 'hours',
+     *   });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/pricing-metrics', { body, ...options });
+    }
+    /**
+     * Get Pricing Metric
+     *
+     * @example
+     * ```ts
+     * const pricingMetricResource =
+     *   await client.pricingMetrics.retrieve('pricing_metric_id');
+     * ```
+     */
+    retrieve(pricingMetricID, options) {
+        return this._client.get((0, path_1.path) `/pricing-metrics/${pricingMetricID}`, options);
+    }
+    /**
+     * List Pricing Metrics
+     *
+     * @example
+     * ```ts
+     * const pricingMetrics = await client.pricingMetrics.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/pricing-metrics', { query, ...options });
+    }
+    /**
+     * Create Pricing Metric Summary
+     *
+     * @example
+     * ```ts
+     * const response = await client.pricingMetrics.createSummary(
+     *   'pricing_metric_id',
+     *   {
+     *     period: {
+     *       end: '2025-11-01T00:00:00Z',
+     *       start: '2025-10-01T00:00:00Z',
+     *     },
+     *     subject_id: 'subj_VyX6Q96h5avMho8O7QWlKeXE',
+     *   },
+     * );
+     * ```
+     */
+    createSummary(pricingMetricID, body, options) {
+        return this._client.post((0, path_1.path) `/pricing-metrics/${pricingMetricID}/summary`, { body, ...options });
+    }
+}
+exports.PricingMetrics = PricingMetrics;
+//# sourceMappingURL=pricing-metrics.js.map

package/resources/pricing-metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pricing-metrics.js","sourceRoot":"","sources":["../src/resources/pricing-metrics.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,cAAe,SAAQ,sBAAW;IAC7C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAA+B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,eAAuB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,oBAAoB,eAAe,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,aAAa,CACX,eAAuB,EACvB,IAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,oBAAoB,eAAe,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;CACF;AA1ED,wCA0EC"}

package/resources/pricing-metrics.mjs

@@ -0,0 +1,69 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class PricingMetrics extends APIResource {
+    /**
+     * Create Pricing Metric
+     *
+     * @example
+     * ```ts
+     * const pricingMetricResource =
+     *   await client.pricingMetrics.create({
+     *     aggregation: {
+     *       aggregation_type: 'sum',
+     *       value_field: 'compute_hours',
+     *     },
+     *     event_name: 'job_completed',
+     *     name: 'Compute Hours',
+     *     unit: 'hours',
+     *   });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/pricing-metrics', { body, ...options });
+    }
+    /**
+     * Get Pricing Metric
+     *
+     * @example
+     * ```ts
+     * const pricingMetricResource =
+     *   await client.pricingMetrics.retrieve('pricing_metric_id');
+     * ```
+     */
+    retrieve(pricingMetricID, options) {
+        return this._client.get(path `/pricing-metrics/${pricingMetricID}`, options);
+    }
+    /**
+     * List Pricing Metrics
+     *
+     * @example
+     * ```ts
+     * const pricingMetrics = await client.pricingMetrics.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/pricing-metrics', { query, ...options });
+    }
+    /**
+     * Create Pricing Metric Summary
+     *
+     * @example
+     * ```ts
+     * const response = await client.pricingMetrics.createSummary(
+     *   'pricing_metric_id',
+     *   {
+     *     period: {
+     *       end: '2025-11-01T00:00:00Z',
+     *       start: '2025-10-01T00:00:00Z',
+     *     },
+     *     subject_id: 'subj_VyX6Q96h5avMho8O7QWlKeXE',
+     *   },
+     * );
+     * ```
+     */
+    createSummary(pricingMetricID, body, options) {
+        return this._client.post(path `/pricing-metrics/${pricingMetricID}/summary`, { body, ...options });
+    }
+}
+//# sourceMappingURL=pricing-metrics.mjs.map

package/resources/pricing-metrics.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"pricing-metrics.mjs","sourceRoot":"","sources":["../src/resources/pricing-metrics.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAA+B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,eAAuB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oBAAoB,eAAe,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,aAAa,CACX,eAAuB,EACvB,IAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,oBAAoB,eAAe,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;CACF"}

package/resources/rate-cards.d.mts

@@ -0,0 +1,200 @@
+import { APIResource } from "../core/resource.mjs";
+import * as RateCardsAPI from "./rate-cards.mjs";
+import * as InvoicesAPI from "./invoices.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class RateCards extends APIResource {
+    /**
+     * Create Rate Card
+     */
+    create(body: RateCardCreateParams, options?: RequestOptions): APIPromise<RateCardResource>;
+    /**
+     * Get Rate Card
+     */
+    retrieve(rateCardID: string, options?: RequestOptions): APIPromise<RateCardResource>;
+    /**
+     * List Rate Cards
+     */
+    list(query?: RateCardListParams | null | undefined, options?: RequestOptions): APIPromise<RateCardListResponse>;
+}
+export interface AmountInput {
+    /**
+     * The currency code of the amount.
+     */
+    currency_code: string;
+    /**
+     * The value of the amount in the smallest unit of the currency.
+     */
+    value: number | string;
+}
+/**
+ * Flat price is a price that linearly scales with the quantity.
+ */
+export interface FlatPriceInput {
+    amount: AmountInput;
+    price_type?: 'flat';
+}
+/**
+ * Flat price is a price that linearly scales with the quantity.
+ */
+export interface FlatPriceOutput {
+    amount: InvoicesAPI.AmountOutput;
+    price_type?: 'flat';
+}
+/**
+ * Package price is a price that is charged for a fixed number of units. For
+ * example, $10 per 1000 units. If the quantity is not a multiple of the package
+ * units, the rounding behavior will be applied.
+ */
+export interface PackagePriceInput {
+    amount: AmountInput;
+    package_units: number;
+    rounding_behavior: 'round_up' | 'round_down';
+    price_type?: 'package';
+}
+/**
+ * Package price is a price that is charged for a fixed number of units. For
+ * example, $10 per 1000 units. If the quantity is not a multiple of the package
+ * units, the rounding behavior will be applied.
+ */
+export interface PackagePriceOutput {
+    amount: InvoicesAPI.AmountOutput;
+    package_units: number;
+    rounding_behavior: 'round_up' | 'round_down';
+    price_type?: 'package';
+}
+export interface RateCardResource {
+    /**
+     * The ID of the rate card.
+     */
+    id: string;
+    billing_interval: 'monthly' | 'yearly';
+    /**
+     * The date and time the rate card was created.
+     */
+    created_at: string;
+    /**
+     * The fixed rates of the rate card.
+     */
+    fixed_rates: Array<RateCardResource.FixedRate>;
+    metadata: {
+        [key: string]: string;
+    };
+    /**
+     * The name of the rate card.
+     */
+    name: string;
+    /**
+     * The date and time the rate card was last updated.
+     */
+    updated_at: string;
+    /**
+     * The usage based rates of the rate card.
+     */
+    usage_based_rates: Array<RateCardResource.UsageBasedRate>;
+    /**
+     * The description of the rate card.
+     */
+    description?: string | null;
+}
+export declare namespace RateCardResource {
+    interface FixedRate {
+        id: string;
+        description: string | null;
+        name: string;
+        /**
+         * Flat price is a price that linearly scales with the quantity.
+         */
+        price: RateCardsAPI.FlatPriceOutput | RateCardsAPI.PackagePriceOutput;
+    }
+    interface UsageBasedRate {
+        id: string;
+        description: string | null;
+        included_units: number;
+        name: string;
+        /**
+         * Flat price is a price that linearly scales with the quantity.
+         */
+        price: RateCardsAPI.FlatPriceOutput | RateCardsAPI.PackagePriceOutput;
+        pricing_metric_id: string;
+        usage_based_rate_type?: 'simple';
+    }
+}
+export interface RateCardListResponse {
+    has_more: boolean;
+    rate_cards: Array<RateCardResource>;
+}
+export interface RateCardCreateParams {
+    /**
+     * How often the customer will be billed for this rate card.
+     */
+    billing_interval: 'monthly' | 'yearly';
+    /**
+     * The name of the rate card displayed to the customer.
+     */
+    name: string;
+    /**
+     * The description of the rate card displayed to the customer.
+     */
+    description?: string | null;
+    /**
+     * The fixed rates of the rate card. These are billed at the start of each billing
+     * cycle.
+     */
+    fixed_rates?: Array<RateCardCreateParams.FixedRate>;
+    metadata?: {
+        [key: string]: string;
+    };
+    /**
+     * The usage based rates of the rate card. These are billed at the end of each
+     * billing cycle.
+     */
+    usage_based_rates?: Array<RateCardCreateParams.UsageBasedRate>;
+}
+export declare namespace RateCardCreateParams {
+    interface FixedRate {
+        /**
+         * The name of the rate displayed to the customer.
+         */
+        name: string;
+        /**
+         * Flat price is a price that linearly scales with the quantity.
+         */
+        price: RateCardsAPI.FlatPriceInput | RateCardsAPI.PackagePriceInput;
+        /**
+         * The description of the rate displayed to the customer.
+         */
+        description?: string | null;
+    }
+    interface UsageBasedRate {
+        /**
+         * The name of the rate displayed to the customer.
+         */
+        name: string;
+        /**
+         * Flat price is a price that linearly scales with the quantity.
+         */
+        price: RateCardsAPI.FlatPriceInput | RateCardsAPI.PackagePriceInput;
+        /**
+         * The ID of the pricing metric to use for this rate.
+         */
+        pricing_metric_id: string;
+        usage_based_rate_type: 'simple';
+        /**
+         * The description of the rate displayed to the customer.
+         */
+        description?: string | null;
+        /**
+         * The number of units included in the rate before the price is applied.
+         */
+        included_units?: number;
+    }
+}
+export interface RateCardListParams {
+    limit?: number;
+    offset?: number;
+}
+export declare namespace RateCards {
+    export { type AmountInput as AmountInput, type FlatPriceInput as FlatPriceInput, type FlatPriceOutput as FlatPriceOutput, type PackagePriceInput as PackagePriceInput, type PackagePriceOutput as PackagePriceOutput, type RateCardResource as RateCardResource, type RateCardListResponse as RateCardListResponse, type RateCardCreateParams as RateCardCreateParams, type RateCardListParams as RateCardListParams, };
+}
+//# sourceMappingURL=rate-cards.d.mts.map

package/resources/rate-cards.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-cards.d.mts","sourceRoot":"","sources":["../src/resources/rate-cards.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAI1F;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAIpF;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;CAGpC;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,WAAW,CAAC;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,WAAW,CAAC,YAAY,CAAC;IAEjC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,WAAW,CAAC;IAEpB,aAAa,EAAE,MAAM,CAAC;IAEtB,iBAAiB,EAAE,UAAU,GAAG,YAAY,CAAC;IAE7C,UAAU,CAAC,EAAE,SAAS,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,WAAW,CAAC,YAAY,CAAC;IAEjC,aAAa,EAAE,MAAM,CAAC;IAEtB,iBAAiB,EAAE,UAAU,GAAG,YAAY,CAAC;IAE7C,UAAU,CAAC,EAAE,SAAS,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,gBAAgB,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEvC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAE/C,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,EAAE,KAAK,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC;IAE1D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,SAAS;QACxB,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,YAAY,CAAC,eAAe,GAAG,YAAY,CAAC,kBAAkB,CAAC;KACvE;IAED,UAAiB,cAAc;QAC7B,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,cAAc,EAAE,MAAM,CAAC;QAEvB,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,YAAY,CAAC,eAAe,GAAG,YAAY,CAAC,kBAAkB,CAAC;QAEtE,iBAAiB,EAAE,MAAM,CAAC;QAE1B,qBAAqB,CAAC,EAAE,QAAQ,CAAC;KAClC;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,OAAO,CAAC;IAElB,UAAU,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CACrC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,gBAAgB,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;IAEpD,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;CAChE;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,SAAS;QACxB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,YAAY,CAAC,cAAc,GAAG,YAAY,CAAC,iBAAiB,CAAC;QAEpE;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC7B;IAED,UAAiB,cAAc;QAC7B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,YAAY,CAAC,cAAc,GAAG,YAAY,CAAC,iBAAiB,CAAC;QAEpE;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B,qBAAqB,EAAE,QAAQ,CAAC;QAEhC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}