orb-billing 1.20.2 → 1.22.0

package/dist/sdk/sdk.d.ts

@@ -1,389 +0,0 @@
-import * as utils from "../internal/utils";
-import { Availability } from "./availability";
-import { Coupon } from "./coupon";
-import { Credit } from "./credit";
-import { CreditNote } from "./creditnote";
-import { Customer } from "./customer";
-import { Event } from "./event";
-import { Invoice } from "./invoice";
-import { Item } from "./item";
-import { Metric } from "./metric";
-import * as shared from "./models/shared";
-import { Plan } from "./plan";
-import { Price } from "./price";
-import { PriceInterval } from "./priceinterval";
-import { Subscription } from "./subscription";
-import { AxiosInstance } from "axios";
-/**
- * Contains the list of servers available to the SDK
- */
-export declare const ServerList: readonly ["https://api.withorb.com/v1"];
-/**
- * The available configuration options for the SDK
- */
-export type SDKProps = {
-    /**
-     * The security details required to authenticate the SDK
-     */
-    security?: shared.Security | (() => Promise<shared.Security>);
-    /**
-     * Allows overriding the default axios client used by the SDK
-     */
-    defaultClient?: AxiosInstance;
-    /**
-     * Allows overriding the default server used by the SDK
-     */
-    serverIdx?: number;
-    /**
-     * Allows overriding the default server URL used by the SDK
-     */
-    serverURL?: string;
-    /**
-     * Allows overriding the default retry config used by the SDK
-     */
-    retryConfig?: utils.RetryConfig;
-};
-export declare class SDKConfiguration {
-    defaultClient: AxiosInstance;
-    security?: shared.Security | (() => Promise<shared.Security>);
-    serverURL: string;
-    serverDefaults: any;
-    language: string;
-    openapiDocVersion: string;
-    sdkVersion: string;
-    genVersion: string;
-    userAgent: string;
-    retryConfig?: utils.RetryConfig;
-    constructor(init?: Partial<SDKConfiguration>);
-}
-/**
- * API Reference: Orb's API is built with the following principles in mind:
- *
- * @remarks
- *
- * 1. **Predictable developer experience**: Where applicable, the Orb API uses industry-standard patterns such as
- * cursor-based pagination and standardized error output. To help with debugging in critical API
- * actions, the API always strives to provide detailed and actionable error messages. Aliases
- * such as external customer IDs aid in fast integration times.
- * 2. **Reliably real time**: Orb's event-based APIs, such as event ingestion are designed to handle extremely high
- * throughput and scale with concurrent load. Orb also provides a real-time event-level credits
- * ledger and a highly performant webhooks architecture.
- * 3. **Flexibility at the forefront**: Features like timezone localization and the ability to amend historical usage
- * show the flexible nature of the platform.
- *
- * You can download the latest OpenAPI spec [here](pathname:///spec.json).
- */
-export declare class Orb {
-    availability: Availability;
-    /**
-     * A coupon represents a reusable discount configuration, and have an attached redemption code that can be issued to
-     *
-     * @remarks
-     * your end users. Coupons are most often used in self-serve signup or upgrade flows in your checkout experience or
-     * billing portal.
-     *
-     * To redeem a coupon, pass the `redemption_code` property in the [create subscription](create-subscription.api.mdx)
-     * or [schedule plan change](schedule-plan-change.api.mdx) request.
-     */
-    coupon: Coupon;
-    /**
-     * The [Credit Ledger Entry resource](/guides/product-catalog/prepurchase) models prepaid credits within Orb.
-     */
-    credit: Credit;
-    /**
-     * The [Credit Note](/guides/invoicing/credit-notes) resource represents a credit that has been applied to a
-     *
-     * @remarks
-     * particular invoice.
-     */
-    creditNote: CreditNote;
-    /**
-     * A customer is a buyer of your products, and the other party to the billing relationship.
-     *
-     * @remarks
-     *
-     * In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these
-     * match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an
-     * `external_customer_id` with your own identifier. See
-     * [Customer ID Aliases](../guides/events-and-metrics/customer-aliases) for further information about how these
-     * aliases work in Orb.
-     *
-     * In addition to having an identifier in your system, a customer may exist in a payment provider solution like
-     * Stripe. Use the `payment_provider_id` and the `payment_provider` enum field to express this mapping.
-     *
-     * A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which
-     * defaults to your account's timezone. See [Timezone localization](../guides/product-catalog/timezones.md) for
-     * information on what this timezone parameter influences within Orb.
-     */
-    customer: Customer;
-    /**
-     * The [Event](../guides/core-concepts.mdx#event) resource represents a usage event that has been created for a
-     *
-     * @remarks
-     * customer. Events are the core of Orb's usage-based billing model, and are used to calculate the usage charges for
-     * a given billing period.
-     */
-    event: Event;
-    /**
-     * An [`Invoice`](../guides/concepts#invoice) is a fundamental billing entity, representing the request for payment for
-     *
-     * @remarks
-     * a single subscription. This includes a set of line items, which correspond to prices in the subscription's plan and
-     * can represent fixed recurring fees or usage-based fees. They are generated at the end of a billing period, or as
-     * the result of an action, such as a cancellation.
-     */
-    invoice: Invoice;
-    /**
-     * The Item resource represents a sellable product or good. Items are associated with all line items, billable metrics,
-     *
-     * @remarks
-     * and prices and are used for defining external sync behavior for invoices and tax calculation purposes.
-     */
-    item: Item;
-    /**
-     * The Metric resource represents a calculation of a quantity based on events.
-     *
-     * @remarks
-     * Metrics are defined by the query that transforms raw usage events into meaningful values for your customers.
-     */
-    metric: Metric;
-    /**
-     * The [Plan](../guides/core-concepts.mdx#plan-and-price) resource represents a plan that can be subscribed to by a
-     *
-     * @remarks
-     * customer. Plans define the billing behavior of the subscription. You can see more about how to configure prices
-     * in the [Price resource](/reference/price).
-     */
-    plan: Plan;
-    /**
-     * 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
-     *     ...
-     * }
-     * ```
-     */
-    price: Price;
-    /**
-     * The Price Interval resource represents a period of time for which a price will bill on a subscription. A
-     *
-     * @remarks
-     * subscription’s price intervals define its billing behavior.
-     */
-    priceInterval: PriceInterval;
-    /**
-     * A [subscription](../guides/core-concepts.mdx#subscription) represents the purchase of a plan by a customer.
-     *
-     * @remarks
-     *
-     * By default, subscriptions begin on the day that they're created and renew automatically for each billing cycle at
-     * the cadence that's configured in the plan definition.
-     *
-     * Subscriptions also default to **beginning of month alignment**, which means the first invoice issued for the
-     * subscription will have pro-rated charges between the `start_date` and the first of the following month. Subsequent
-     * billing periods will always start and end on a month boundary (e.g. subsequent month starts for monthly billing).
-     *
-     * Depending on the plan configuration, any _flat_ recurring fees will be billed either at the beginning (in-advance)
-     * or end (in-arrears) of each billing cycle. Plans default to **in-advance billing**. Usage-based fees are billed in
-     * arrears as usage is accumulated. In the normal course of events, you can expect an invoice to contain usage-based
-     * charges for the previous period, and a recurring fee for the following period.
-     */
-    subscription: Subscription;
-    private sdkConfiguration;
-    constructor(props?: SDKProps);
-}

package/dist/sdk/sdk.js

@@ -1,93 +0,0 @@
-"use strict";
-/*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Orb = exports.SDKConfiguration = exports.ServerList = void 0;
-var availability_1 = require("./availability");
-var coupon_1 = require("./coupon");
-var credit_1 = require("./credit");
-var creditnote_1 = require("./creditnote");
-var customer_1 = require("./customer");
-var event_1 = require("./event");
-var invoice_1 = require("./invoice");
-var item_1 = require("./item");
-var metric_1 = require("./metric");
-var plan_1 = require("./plan");
-var price_1 = require("./price");
-var priceinterval_1 = require("./priceinterval");
-var subscription_1 = require("./subscription");
-var axios_1 = __importDefault(require("axios"));
-/**
- * Contains the list of servers available to the SDK
- */
-exports.ServerList = [
-    /**
-     * Production server
-     */
-    "https://api.withorb.com/v1",
-];
-var SDKConfiguration = /** @class */ (function () {
-    function SDKConfiguration(init) {
-        this.language = "typescript";
-        this.openapiDocVersion = "1.0";
-        this.sdkVersion = "1.20.2";
-        this.genVersion = "2.150.1";
-        this.userAgent = "speakeasy-sdk/typescript 1.20.2 2.150.1 1.0 orb-billing";
-        Object.assign(this, init);
-    }
-    return SDKConfiguration;
-}());
-exports.SDKConfiguration = SDKConfiguration;
-/**
- * API Reference: Orb's API is built with the following principles in mind:
- *
- * @remarks
- *
- * 1. **Predictable developer experience**: Where applicable, the Orb API uses industry-standard patterns such as
- * cursor-based pagination and standardized error output. To help with debugging in critical API
- * actions, the API always strives to provide detailed and actionable error messages. Aliases
- * such as external customer IDs aid in fast integration times.
- * 2. **Reliably real time**: Orb's event-based APIs, such as event ingestion are designed to handle extremely high
- * throughput and scale with concurrent load. Orb also provides a real-time event-level credits
- * ledger and a highly performant webhooks architecture.
- * 3. **Flexibility at the forefront**: Features like timezone localization and the ability to amend historical usage
- * show the flexible nature of the platform.
- *
- * You can download the latest OpenAPI spec [here](pathname:///spec.json).
- */
-var Orb = /** @class */ (function () {
-    function Orb(props) {
-        var _a, _b;
-        var serverURL = props === null || props === void 0 ? void 0 : props.serverURL;
-        var serverIdx = (_a = props === null || props === void 0 ? void 0 : props.serverIdx) !== null && _a !== void 0 ? _a : 0;
-        if (!serverURL) {
-            serverURL = exports.ServerList[serverIdx];
-        }
-        var defaultClient = (_b = props === null || props === void 0 ? void 0 : props.defaultClient) !== null && _b !== void 0 ? _b : axios_1.default.create({ baseURL: serverURL });
-        this.sdkConfiguration = new SDKConfiguration({
-            defaultClient: defaultClient,
-            security: props === null || props === void 0 ? void 0 : props.security,
-            serverURL: serverURL,
-            retryConfig: props === null || props === void 0 ? void 0 : props.retryConfig,
-        });
-        this.availability = new availability_1.Availability(this.sdkConfiguration);
-        this.coupon = new coupon_1.Coupon(this.sdkConfiguration);
-        this.credit = new credit_1.Credit(this.sdkConfiguration);
-        this.creditNote = new creditnote_1.CreditNote(this.sdkConfiguration);
-        this.customer = new customer_1.Customer(this.sdkConfiguration);
-        this.event = new event_1.Event(this.sdkConfiguration);
-        this.invoice = new invoice_1.Invoice(this.sdkConfiguration);
-        this.item = new item_1.Item(this.sdkConfiguration);
-        this.metric = new metric_1.Metric(this.sdkConfiguration);
-        this.plan = new plan_1.Plan(this.sdkConfiguration);
-        this.price = new price_1.Price(this.sdkConfiguration);
-        this.priceInterval = new priceinterval_1.PriceInterval(this.sdkConfiguration);
-        this.subscription = new subscription_1.Subscription(this.sdkConfiguration);
-    }
-    return Orb;
-}());
-exports.Orb = Orb;