orb-billing 1.0.1

package/dist/sdk/plan.js

@@ -0,0 +1,422 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Plan = void 0;
+var utils = __importStar(require("../internal/utils"));
+var operations = __importStar(require("./models/operations"));
+var shared = __importStar(require("./models/shared"));
+/**
+ * The [Plan](../guides/core-concepts.mdx#plan-and-price) resource represents a plan that can be subscribed to by a customer. Plans define the billing behavior of the subscription.
+ *
+ * @remarks
+ *  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 quantites, 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 Plan = /** @class */ (function () {
+    function Plan(sdkConfig) {
+        this.sdkConfiguration = sdkConfig;
+    }
+    /**
+     * Fetch plan
+     *
+     * @remarks
+     * This endpoint is used to fetch [plan](../guides/concepts##plan-and-price) details given a plan identifier. It returns information about the prices included in the plan and their configuration, as well as the product that the plan is attached to.
+     *
+     * ## Serialized prices
+     * Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given [Price](../guides/concepts#plan-and-price) object. The `model_type` field determines the key for the configuration object that is present. A detailed explanation of price types can be found in the [Price schema](../guides/concepts#plan-and-price).
+     *
+     * ## Phases
+     * Orb supports plan phases, also known as contract ramps. For plans with phases, the serialized prices refer to all prices across all phases.
+     */
+    Plan.prototype.fetch = function (req, config) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function () {
+            var baseURL, url, client, headers, httpRes, contentType, res, decodedRes;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (!(req instanceof utils.SpeakeasyBase)) {
+                            req = new operations.FetchPlanRequest(req);
+                        }
+                        baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
+                        url = utils.generateURL(baseURL, "/plans/{plan_id}", req);
+                        client = this.sdkConfiguration.securityClient || this.sdkConfiguration.defaultClient;
+                        headers = __assign({}, config === null || config === void 0 ? void 0 : config.headers);
+                        headers["Accept"] = "application/json";
+                        headers["user-agent"] = "speakeasy-sdk/".concat(this.sdkConfiguration.language, " ").concat(this.sdkConfiguration.sdkVersion, " ").concat(this.sdkConfiguration.genVersion, " ").concat(this.sdkConfiguration.openapiDocVersion);
+                        return [4 /*yield*/, client.request(__assign({ validateStatus: function () { return true; }, url: url, method: "get", headers: headers, responseType: "arraybuffer" }, config))];
+                    case 1:
+                        httpRes = _c.sent();
+                        contentType = (_b = (_a = httpRes === null || httpRes === void 0 ? void 0 : httpRes.headers) === null || _a === void 0 ? void 0 : _a["content-type"]) !== null && _b !== void 0 ? _b : "";
+                        if ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == null) {
+                            throw new Error("status code not found in response: ".concat(httpRes));
+                        }
+                        res = new operations.FetchPlanResponse({
+                            statusCode: httpRes.status,
+                            contentType: contentType,
+                            rawResponse: httpRes,
+                        });
+                        decodedRes = new TextDecoder().decode(httpRes === null || httpRes === void 0 ? void 0 : httpRes.data);
+                        switch (true) {
+                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 200:
+                                if (utils.matchContentType(contentType, "application/json")) {
+                                    res.plan = utils.objectToClass(JSON.parse(decodedRes), shared.Plan);
+                                }
+                                break;
+                        }
+                        return [2 /*return*/, res];
+                }
+            });
+        });
+    };
+    /**
+     * Fetch plan by external ID
+     *
+     * @remarks
+     * This endpoint is used to fetch [plan](../guides/concepts##plan-and-price) details given an external_plan_id identifier. It returns information about the prices included in the plan and their configuration, as well as the product that the plan is attached to.
+     *
+     * ## Serialized prices
+     * Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given [Price](../guides/concepts#plan-and-price) object. The `model_type` field determines the key for the configuration object that is present. A detailed explanation of price types can be found in the [Price schema](../guides/concepts#plan-and-price).
+     */
+    Plan.prototype.getByExternalId = function (req, config) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function () {
+            var baseURL, url, client, headers, httpRes, contentType, res, decodedRes;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (!(req instanceof utils.SpeakeasyBase)) {
+                            req = new operations.FetchPlanExternalIdRequest(req);
+                        }
+                        baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
+                        url = utils.generateURL(baseURL, "/plans/external_plan_id/{external_plan_id}", req);
+                        client = this.sdkConfiguration.securityClient || this.sdkConfiguration.defaultClient;
+                        headers = __assign({}, config === null || config === void 0 ? void 0 : config.headers);
+                        headers["Accept"] = "application/json";
+                        headers["user-agent"] = "speakeasy-sdk/".concat(this.sdkConfiguration.language, " ").concat(this.sdkConfiguration.sdkVersion, " ").concat(this.sdkConfiguration.genVersion, " ").concat(this.sdkConfiguration.openapiDocVersion);
+                        return [4 /*yield*/, client.request(__assign({ validateStatus: function () { return true; }, url: url, method: "get", headers: headers, responseType: "arraybuffer" }, config))];
+                    case 1:
+                        httpRes = _c.sent();
+                        contentType = (_b = (_a = httpRes === null || httpRes === void 0 ? void 0 : httpRes.headers) === null || _a === void 0 ? void 0 : _a["content-type"]) !== null && _b !== void 0 ? _b : "";
+                        if ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == null) {
+                            throw new Error("status code not found in response: ".concat(httpRes));
+                        }
+                        res = new operations.FetchPlanExternalIdResponse({
+                            statusCode: httpRes.status,
+                            contentType: contentType,
+                            rawResponse: httpRes,
+                        });
+                        decodedRes = new TextDecoder().decode(httpRes === null || httpRes === void 0 ? void 0 : httpRes.data);
+                        switch (true) {
+                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 200:
+                                if (utils.matchContentType(contentType, "application/json")) {
+                                    res.plan = utils.objectToClass(JSON.parse(decodedRes), shared.Plan);
+                                }
+                                break;
+                        }
+                        return [2 /*return*/, res];
+                }
+            });
+        });
+    };
+    /**
+     * List plans
+     *
+     * @remarks
+     * This endpoint returns a list of all [plans](../guides/concepts##plan-and-price) for an account in a list format.
+     *
+     * The list of plans is ordered starting from the most recently created plan. The response also includes [`pagination_metadata`](../reference/pagination), which lets the caller retrieve the next page of results if they exist.
+     *
+     */
+    Plan.prototype.list = function (req, config) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function () {
+            var baseURL, url, client, headers, queryParams, httpRes, contentType, res, decodedRes;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (!(req instanceof utils.SpeakeasyBase)) {
+                            req = new operations.ListPlansRequest(req);
+                        }
+                        baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
+                        url = baseURL.replace(/\/$/, "") + "/plans";
+                        client = this.sdkConfiguration.securityClient || this.sdkConfiguration.defaultClient;
+                        headers = __assign({}, config === null || config === void 0 ? void 0 : config.headers);
+                        queryParams = utils.serializeQueryParams(req);
+                        headers["Accept"] = "application/json";
+                        headers["user-agent"] = "speakeasy-sdk/".concat(this.sdkConfiguration.language, " ").concat(this.sdkConfiguration.sdkVersion, " ").concat(this.sdkConfiguration.genVersion, " ").concat(this.sdkConfiguration.openapiDocVersion);
+                        return [4 /*yield*/, client.request(__assign({ validateStatus: function () { return true; }, url: url + queryParams, method: "get", headers: headers, responseType: "arraybuffer" }, config))];
+                    case 1:
+                        httpRes = _c.sent();
+                        contentType = (_b = (_a = httpRes === null || httpRes === void 0 ? void 0 : httpRes.headers) === null || _a === void 0 ? void 0 : _a["content-type"]) !== null && _b !== void 0 ? _b : "";
+                        if ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == null) {
+                            throw new Error("status code not found in response: ".concat(httpRes));
+                        }
+                        res = new operations.ListPlansResponse({
+                            statusCode: httpRes.status,
+                            contentType: contentType,
+                            rawResponse: httpRes,
+                        });
+                        decodedRes = new TextDecoder().decode(httpRes === null || httpRes === void 0 ? void 0 : httpRes.data);
+                        switch (true) {
+                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 200:
+                                if (utils.matchContentType(contentType, "application/json")) {
+                                    res.plans = utils.objectToClass(JSON.parse(decodedRes), shared.Plans);
+                                }
+                                break;
+                        }
+                        return [2 /*return*/, res];
+                }
+            });
+        });
+    };
+    return Plan;
+}());
+exports.Plan = Plan;