orb-billing 1.19.5 → 1.20.0

package/dist/sdk/models/shared/testratingfunctionprice.d.ts

@@ -1,241 +0,0 @@
-import { SpeakeasyBase } from "../../../internal/utils";
-import { BillableMetricTiny } from "./billablemetrictiny";
-import { ItemSlim } from "./itemslim";
-import { Maximum } from "./maximum";
-import { Minimum } from "./minimum";
-export declare enum TestRatingFunctionPriceCadence {
-    OneTime = "one_time",
-    Monthly = "monthly",
-    Quarterly = "quarterly",
-    Annual = "annual"
-}
-export declare enum TestRatingFunctionPriceModelType {
-    TestRatingFunction = "test_rating_function"
-}
-export declare enum TestRatingFunctionPricePriceType {
-    UsagePrice = "usage_price",
-    FixedPrice = "fixed_price"
-}
-/**
- * The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in
- *
- * @remarks
- * the form of an invoice line item. Prices take a quantity and determine an amount to bill.
- *
- * Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a
- * given Price object. The model_type field determines the key for the configuration object that is present.
- *
- * ## Unit pricing
- * With unit pricing, each unit costs a fixed amount.
- * ```json
- * {
- *     ...
- *     "model_type": "unit",
- *     "unit_config": {
- *         "unit_amount": "0.50"
- *     }
- *     ...
- * }
- * ```
- *
- * ## Tiered pricing
- * In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is
- * defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter
- * may cost $0.10 each.
- * ```json
- * {
- *     ...
- *     "model_type": "tiered",
- *     "tiered_config": {
- *         "tiers": [
- *             {
- *                 "first_unit": 1,
- *                 "last_unit": 10,
- *                 "unit_amount": "0.50"
- *             },
- *             {
- *                 "first_unit": 11,
- *                 "last_unit": null,
- *                 "unit_amount": "0.10"
- *             }
- *         ]
- *     }
- *     ...
- * ```
- *
- * ## Bulk pricing
- * Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less
- * than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may
- * now be priced at $0.40 (i.e. 101 units total would be $40.40).
- * ```json
- * {
- *     ...
- *     "model_type": "bulk",
- *     "bulk_config": {
- *         "tiers": [
- *             {
- *                 "maximum_units": 10,
- *                 "unit_amount": "0.50"
- *             },
- *             {
- *                 "maximum_units": 1000,
- *                 "unit_amount": "0.40"
- *             }
- *         ]
- *     }
- *     ...
- * }
- * ```
- *
- * ## Package pricing
- * Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is
- * set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
- * ```json
- * {
- *     ...
- *     "model_type": "package",
- *     "package_config": {
- *         "package_amount": "0.80",
- *         "package_size": 10
- *     }
- *     ...
- * }
- * ```
- *
- * ## BPS pricing
- * BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points
- * to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on
- * every payment you process, with a maximum charge of $25 per payment.
- * ```json
- * {
- *     ...
- *     "model_type": "bps",
- *     "bps_config": {
- *        "bps": 125,
- *        "per_unit_maximum": "11.00"
- *     }
- *     ...
- *  }
- * ```
- *
- * ## Bulk BPS pricing
- * Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events.
- * Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period
- * falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached,
- * each individual payment may have a lower cap or a smaller take-rate.
- * ```json
- *     ...
- *     "model_type": "bulk_bps",
- *     "bulk_bps_config": {
- *         "tiers": [
- *            {
- *                 "maximum_amount": "1000000.00",
- *                 "bps": 125,
- *                 "per_unit_maximum": "19.00"
- *            },
- *           {
- *                 "maximum_amount": null,
- *                 "bps": 115,
- *                 "per_unit_maximum": "4.00"
- *             }
- *         ]
- *     }
- *     ...
- * }
- * ```
- *
- * ## Tiered BPS pricing
- * Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a
- * function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given
- * event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound.
- * For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may
- * incur a take-rate of 0.5 BPS each.
- * ```json
- *     ...
- *     "model_type": "tiered_bps",
- *     "tiered_bps_config": {
- *         "tiers": [
- *            {
- *                 "minimum_amount": "0",
- *                 "maximum_amount": "1000000.00",
- *                 "bps": 125,
- *                 "per_unit_maximum": "19.00"
- *            },
- *           {
- *                 "minimum_amount": "1000000.00",
- *                 "maximum_amount": null,
- *                 "bps": 115,
- *                 "per_unit_maximum": "4.00"
- *             }
- *         ]
- *     }
- *     ...
- * }
- * ```
- *
- * ## Matrix pricing
- * Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. `dimensions` defines the two event
- * property values evaluated in this pricing model. In a one-dimensional matrix, the second value is `null`. Every
- * configuration has a list of `matrix_values` which give the unit prices for specified property values. In a
- * one-dimensional matrix, the matrix values will have `dimension_values` where the second value of the pair is null.
- * If an event does not match any of the dimension values in the matrix, it will resort to the `default_unit_amount`.
- * ```json
- * {
- *     "model_type": "matrix"
- *     "matrix_config": {
- *         "default_unit_amount": "3.00",
- *         "dimensions": [
- *             "cluster_name",
- *             "region"
- *         ],
- *         "matrix_values": [
- *             {
- *                 "dimension_values": [
- *                     "alpha",
- *                     "west"
- *                 ],
- *                 "unit_amount": "2.00"
- *             },
- *             ...
- *         ]
- *     }
- * }
- * ```
- *
- * ### Fixed fees
- * Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an
- * additional parameter `fixed_price_quantity`. If the Price represents a fixed cost, this represents the quantity of
- * units applied.
- * ```json
- * {
- *     ...
- *     "id": "price_id",
- *     "model_type": "unit",
- *     "unit_config": {
- *        "unit_amount": "2.00"
- *     },
- *     "fixed_price_quantity": 3.0
- *     ...
- * }
- * ```
- */
-export declare class TestRatingFunctionPrice extends SpeakeasyBase {
-    billableMetric: BillableMetricTiny;
-    cadence: TestRatingFunctionPriceCadence;
-    createdAt: Date;
-    currency: string;
-    discount?: any;
-    externalPriceId: string;
-    fixedPriceQuantity: number;
-    id: string;
-    item: ItemSlim;
-    maximum?: Maximum;
-    maximumAmount?: string;
-    minimum?: Minimum;
-    minimumAmount?: string;
-    modelType: TestRatingFunctionPriceModelType;
-    name: string;
-    planPhaseOrder: number;
-    priceType: TestRatingFunctionPricePriceType;
-    testRatingFunctionConfig: Record<string, any>;
-}

package/dist/sdk/models/shared/testratingfunctionprice.js

@@ -1,361 +0,0 @@
-"use strict";
-/*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
- */
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TestRatingFunctionPrice = exports.TestRatingFunctionPricePriceType = exports.TestRatingFunctionPriceModelType = exports.TestRatingFunctionPriceCadence = void 0;
-var utils_1 = require("../../../internal/utils");
-var billablemetrictiny_1 = require("./billablemetrictiny");
-var itemslim_1 = require("./itemslim");
-var maximum_1 = require("./maximum");
-var minimum_1 = require("./minimum");
-var class_transformer_1 = require("class-transformer");
-var TestRatingFunctionPriceCadence;
-(function (TestRatingFunctionPriceCadence) {
-    TestRatingFunctionPriceCadence["OneTime"] = "one_time";
-    TestRatingFunctionPriceCadence["Monthly"] = "monthly";
-    TestRatingFunctionPriceCadence["Quarterly"] = "quarterly";
-    TestRatingFunctionPriceCadence["Annual"] = "annual";
-})(TestRatingFunctionPriceCadence = exports.TestRatingFunctionPriceCadence || (exports.TestRatingFunctionPriceCadence = {}));
-var TestRatingFunctionPriceModelType;
-(function (TestRatingFunctionPriceModelType) {
-    TestRatingFunctionPriceModelType["TestRatingFunction"] = "test_rating_function";
-})(TestRatingFunctionPriceModelType = exports.TestRatingFunctionPriceModelType || (exports.TestRatingFunctionPriceModelType = {}));
-var TestRatingFunctionPricePriceType;
-(function (TestRatingFunctionPricePriceType) {
-    TestRatingFunctionPricePriceType["UsagePrice"] = "usage_price";
-    TestRatingFunctionPricePriceType["FixedPrice"] = "fixed_price";
-})(TestRatingFunctionPricePriceType = exports.TestRatingFunctionPricePriceType || (exports.TestRatingFunctionPricePriceType = {}));
-/**
- * The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in
- *
- * @remarks
- * the form of an invoice line item. Prices take a quantity and determine an amount to bill.
- *
- * Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a
- * given Price object. The model_type field determines the key for the configuration object that is present.
- *
- * ## Unit pricing
- * With unit pricing, each unit costs a fixed amount.
- * ```json
- * {
- *     ...
- *     "model_type": "unit",
- *     "unit_config": {
- *         "unit_amount": "0.50"
- *     }
- *     ...
- * }
- * ```
- *
- * ## Tiered pricing
- * In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is
- * defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter
- * may cost $0.10 each.
- * ```json
- * {
- *     ...
- *     "model_type": "tiered",
- *     "tiered_config": {
- *         "tiers": [
- *             {
- *                 "first_unit": 1,
- *                 "last_unit": 10,
- *                 "unit_amount": "0.50"
- *             },
- *             {
- *                 "first_unit": 11,
- *                 "last_unit": null,
- *                 "unit_amount": "0.10"
- *             }
- *         ]
- *     }
- *     ...
- * ```
- *
- * ## Bulk pricing
- * Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less
- * than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may
- * now be priced at $0.40 (i.e. 101 units total would be $40.40).
- * ```json
- * {
- *     ...
- *     "model_type": "bulk",
- *     "bulk_config": {
- *         "tiers": [
- *             {
- *                 "maximum_units": 10,
- *                 "unit_amount": "0.50"
- *             },
- *             {
- *                 "maximum_units": 1000,
- *                 "unit_amount": "0.40"
- *             }
- *         ]
- *     }
- *     ...
- * }
- * ```
- *
- * ## Package pricing
- * Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is
- * set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
- * ```json
- * {
- *     ...
- *     "model_type": "package",
- *     "package_config": {
- *         "package_amount": "0.80",
- *         "package_size": 10
- *     }
- *     ...
- * }
- * ```
- *
- * ## BPS pricing
- * BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points
- * to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on
- * every payment you process, with a maximum charge of $25 per payment.
- * ```json
- * {
- *     ...
- *     "model_type": "bps",
- *     "bps_config": {
- *        "bps": 125,
- *        "per_unit_maximum": "11.00"
- *     }
- *     ...
- *  }
- * ```
- *
- * ## Bulk BPS pricing
- * Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events.
- * Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period
- * falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached,
- * each individual payment may have a lower cap or a smaller take-rate.
- * ```json
- *     ...
- *     "model_type": "bulk_bps",
- *     "bulk_bps_config": {
- *         "tiers": [
- *            {
- *                 "maximum_amount": "1000000.00",
- *                 "bps": 125,
- *                 "per_unit_maximum": "19.00"
- *            },
- *           {
- *                 "maximum_amount": null,
- *                 "bps": 115,
- *                 "per_unit_maximum": "4.00"
- *             }
- *         ]
- *     }
- *     ...
- * }
- * ```
- *
- * ## Tiered BPS pricing
- * Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a
- * function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given
- * event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound.
- * For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may
- * incur a take-rate of 0.5 BPS each.
- * ```json
- *     ...
- *     "model_type": "tiered_bps",
- *     "tiered_bps_config": {
- *         "tiers": [
- *            {
- *                 "minimum_amount": "0",
- *                 "maximum_amount": "1000000.00",
- *                 "bps": 125,
- *                 "per_unit_maximum": "19.00"
- *            },
- *           {
- *                 "minimum_amount": "1000000.00",
- *                 "maximum_amount": null,
- *                 "bps": 115,
- *                 "per_unit_maximum": "4.00"
- *             }
- *         ]
- *     }
- *     ...
- * }
- * ```
- *
- * ## Matrix pricing
- * Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. `dimensions` defines the two event
- * property values evaluated in this pricing model. In a one-dimensional matrix, the second value is `null`. Every
- * configuration has a list of `matrix_values` which give the unit prices for specified property values. In a
- * one-dimensional matrix, the matrix values will have `dimension_values` where the second value of the pair is null.
- * If an event does not match any of the dimension values in the matrix, it will resort to the `default_unit_amount`.
- * ```json
- * {
- *     "model_type": "matrix"
- *     "matrix_config": {
- *         "default_unit_amount": "3.00",
- *         "dimensions": [
- *             "cluster_name",
- *             "region"
- *         ],
- *         "matrix_values": [
- *             {
- *                 "dimension_values": [
- *                     "alpha",
- *                     "west"
- *                 ],
- *                 "unit_amount": "2.00"
- *             },
- *             ...
- *         ]
- *     }
- * }
- * ```
- *
- * ### Fixed fees
- * Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an
- * additional parameter `fixed_price_quantity`. If the Price represents a fixed cost, this represents the quantity of
- * units applied.
- * ```json
- * {
- *     ...
- *     "id": "price_id",
- *     "model_type": "unit",
- *     "unit_config": {
- *        "unit_amount": "2.00"
- *     },
- *     "fixed_price_quantity": 3.0
- *     ...
- * }
- * ```
- */
-var TestRatingFunctionPrice = /** @class */ (function (_super) {
-    __extends(TestRatingFunctionPrice, _super);
-    function TestRatingFunctionPrice() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "billable_metric" }),
-        (0, class_transformer_1.Type)(function () { return billablemetrictiny_1.BillableMetricTiny; }),
-        __metadata("design:type", billablemetrictiny_1.BillableMetricTiny)
-    ], TestRatingFunctionPrice.prototype, "billableMetric", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "cadence" }),
-        __metadata("design:type", String)
-    ], TestRatingFunctionPrice.prototype, "cadence", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "created_at" }),
-        (0, class_transformer_1.Transform)(function (_a) {
-            var value = _a.value;
-            return new Date(value);
-        }, { toClassOnly: true }),
-        __metadata("design:type", Date)
-    ], TestRatingFunctionPrice.prototype, "createdAt", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "currency" }),
-        __metadata("design:type", String)
-    ], TestRatingFunctionPrice.prototype, "currency", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "discount" }),
-        __metadata("design:type", Object)
-    ], TestRatingFunctionPrice.prototype, "discount", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "external_price_id" }),
-        __metadata("design:type", String)
-    ], TestRatingFunctionPrice.prototype, "externalPriceId", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "fixed_price_quantity" }),
-        __metadata("design:type", Number)
-    ], TestRatingFunctionPrice.prototype, "fixedPriceQuantity", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "id" }),
-        __metadata("design:type", String)
-    ], TestRatingFunctionPrice.prototype, "id", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "item" }),
-        (0, class_transformer_1.Type)(function () { return itemslim_1.ItemSlim; }),
-        __metadata("design:type", itemslim_1.ItemSlim)
-    ], TestRatingFunctionPrice.prototype, "item", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "maximum" }),
-        (0, class_transformer_1.Type)(function () { return maximum_1.Maximum; }),
-        __metadata("design:type", maximum_1.Maximum)
-    ], TestRatingFunctionPrice.prototype, "maximum", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "maximum_amount" }),
-        __metadata("design:type", String)
-    ], TestRatingFunctionPrice.prototype, "maximumAmount", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "minimum" }),
-        (0, class_transformer_1.Type)(function () { return minimum_1.Minimum; }),
-        __metadata("design:type", minimum_1.Minimum)
-    ], TestRatingFunctionPrice.prototype, "minimum", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "minimum_amount" }),
-        __metadata("design:type", String)
-    ], TestRatingFunctionPrice.prototype, "minimumAmount", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "model_type" }),
-        __metadata("design:type", String)
-    ], TestRatingFunctionPrice.prototype, "modelType", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "name" }),
-        __metadata("design:type", String)
-    ], TestRatingFunctionPrice.prototype, "name", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "plan_phase_order" }),
-        __metadata("design:type", Number)
-    ], TestRatingFunctionPrice.prototype, "planPhaseOrder", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "price_type" }),
-        __metadata("design:type", String)
-    ], TestRatingFunctionPrice.prototype, "priceType", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "test_rating_function_config" }),
-        __metadata("design:type", Object)
-    ], TestRatingFunctionPrice.prototype, "testRatingFunctionConfig", void 0);
-    return TestRatingFunctionPrice;
-}(utils_1.SpeakeasyBase));
-exports.TestRatingFunctionPrice = TestRatingFunctionPrice;