orb-billing 4.32.0 → 4.47.1

package/resources/subscriptions.mjs

@@ -1,19 +1,273 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 import { APIResource } from "../resource.mjs";
 import { isRequestOptions } from "../core.mjs";
-import * as SubscriptionsAPI from "./subscriptions.mjs";
 import { Page } from "../pagination.mjs";
 export class Subscriptions extends APIResource {
-    create(body = {}, options) {
-        if (isRequestOptions(body)) {
-            return this.create({}, body);
-        }
+    /**
+     * A subscription represents the purchase of a plan by a customer. The customer is
+     * identified by either the `customer_id` or the `external_customer_id`, and
+     * exactly one of these fields must be provided.
+     *
+     * 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.
+     *
+     * The default configuration for subscriptions in Orb is **In-advance billing** and
+     * **Beginning of month alignment** (see
+     * [Subscription](../guides/concepts#subscription) for more details).
+     *
+     * In order to change the alignment behavior, Orb also supports billing
+     * subscriptions on the day of the month they are created. If
+     * `align_billing_with_subscription_start_date = true` is specified, subscriptions
+     * have billing cycles that are aligned with their `start_date`. For example, a
+     * subscription that begins on January 15th will have a billing cycle from January
+     * 15th to February 15th. Every subsequent billing cycle will continue to start and
+     * invoice on the 15th.
+     *
+     * If the "day" value is greater than the number of days in the month, the next
+     * billing cycle will start at the end of the month. For example, if the start_date
+     * is January 31st, the next billing cycle will start on February 28th.
+     *
+     * If a customer was created with a currency, Orb only allows subscribing the
+     * customer to a plan with a matching `invoicing_currency`. If the customer does
+     * not have a currency set, on subscription creation, we set the customer's
+     * currency to be the `invoicing_currency` of the plan.
+     *
+     * ## Customize your customer's subscriptions
+     *
+     * Prices and adjustments in a plan can be added, removed, or replaced for the
+     * subscription being created. This is useful when a customer has prices that
+     * differ from the default prices for a specific plan.
+     *
+     * :::info This feature is only available for accounts that have migrated to
+     * Subscription Overrides Version 2. You can find your Subscription Overrides
+     * Version at the bottom of your [Plans page](https://app.withorb.com/plans) :::
+     *
+     * ### Adding Prices
+     *
+     * To add prices, provide a list of objects with the key `add_prices`. An object in
+     * the list must specify an existing add-on price with a `price_id` or
+     * `external_price_id` field, or create a new add-on price by including an object
+     * with the key `price`, identical to what would be used in the request body for
+     * the [create price endpoint](../reference/create-price). See the
+     * [Price resource](../reference/price) for the specification of different price
+     * model configurations possible in this object.
+     *
+     * If the plan has phases, each object in the list must include a number with
+     * `plan_phase_order` key to indicate which phase the price should be added to.
+     *
+     * An object in the list can specify an optional `start_date` and optional
+     * `end_date`. This is equivalent to creating a price interval with the
+     * [add/edit price intervals endpoint](../reference/add-edit-price-intervals). If
+     * unspecified, the start or end date of the phase or subscription will be used.
+     *
+     * An object in the list can specify an optional `minimum_amount`,
+     * `maximum_amount`, or `discounts`. This will create adjustments which apply only
+     * to this price.
+     *
+     * Additionally, an object in the list can specify an optional `reference_id`. This
+     * ID can be used to reference this price when
+     * [adding an adjustment](#adding-adjustments) in the same API call. However the ID
+     * is _transient_ and cannot be used to refer to the price in future API calls.
+     *
+     * ### Removing Prices
+     *
+     * To remove prices, provide a list of objects with the key `remove_prices`. An
+     * object in the list must specify a plan price with either a `price_id` or
+     * `external_price_id` field.
+     *
+     * ### Replacing Prices
+     *
+     * To replace prices, provide a list of objects with the key `replace_prices`. An
+     * object in the list must specify a plan price to replace with the
+     * `replaces_price_id` key, and it must specify a price to replace it with by
+     * either referencing an existing add-on price with a `price_id` or
+     * `external_price_id` field, or by creating a new add-on price by including an
+     * object with the key `price`, identical to what would be used in the request body
+     * for the [create price endpoint](../reference/create-price). See the
+     * [Price resource](../reference/price) for the specification of different price
+     * model configurations possible in this object.
+     *
+     * For fixed fees, an object in the list can supply a `fixed_price_quantity`
+     * instead of a `price`, `price_id`, or `external_price_id` field. This will update
+     * only the quantity for the price, similar to the
+     * [Update price quantity](../reference/update-fixed-fee-quantity) endpoint.
+     *
+     * The replacement price will have the same phase, if applicable, and the same
+     * start and end dates as the price it replaces.
+     *
+     * An object in the list can specify an optional `minimum_amount`,
+     * `maximum_amount`, or `discounts`. This will create adjustments which apply only
+     * to this price.
+     *
+     * Additionally, an object in the list can specify an optional `reference_id`. This
+     * ID can be used to reference the replacement price when
+     * [adding an adjustment](#adding-adjustments) in the same API call. However the ID
+     * is _transient_ and cannot be used to refer to the price in future API calls.
+     *
+     * ### Adding adjustments
+     *
+     * To add adjustments, provide a list of objects with the key `add_adjustments`. An
+     * object in the list must include an object with the key `adjustment`, identical
+     * to the adjustment object in the
+     * [add/edit price intervals endpoint](../reference/add-edit-price-intervals).
+     *
+     * If the plan has phases, each object in the list must include a number with
+     * `plan_phase_order` key to indicate which phase the adjustment should be added
+     * to.
+     *
+     * An object in the list can specify an optional `start_date` and optional
+     * `end_date`. If unspecified, the start or end date of the phase or subscription
+     * will be used.
+     *
+     * ### Removing adjustments
+     *
+     * To remove adjustments, provide a list of objects with the key
+     * `remove_adjustments`. An object in the list must include a key, `adjustment_id`,
+     * with the ID of the adjustment to be removed.
+     *
+     * ### Replacing adjustments
+     *
+     * To replace adjustments, provide a list of objects with the key
+     * `replace_adjustments`. An object in the list must specify a plan adjustment to
+     * replace with the `replaces_adjustment_id` key, and it must specify an adjustment
+     * to replace it with by including an object with the key `adjustment`, identical
+     * to the adjustment object in the
+     * [add/edit price intervals endpoint](../reference/add-edit-price-intervals).
+     *
+     * The replacement adjustment will have the same phase, if applicable, and the same
+     * start and end dates as the adjustment it replaces.
+     *
+     * ## Price overrides (DEPRECATED)
+     *
+     * :::info Price overrides are being phased out in favor adding/removing/replacing
+     * prices. (See
+     * [Customize your customer's subscriptions](../reference/create-subscription#customize-your-customers-subscriptions))
+     * :::
+     *
+     * Price overrides are used to update some or all prices in a plan for the specific
+     * subscription being created. This is useful when a new customer has negotiated a
+     * rate that is unique to the customer.
+     *
+     * To override prices, provide a list of objects with the key `price_overrides`.
+     * The price object in the list of overrides is expected to contain the existing
+     * price id, the `model_type` and configuration. (See the
+     * [Price resource](../reference/price) for the specification of different price
+     * model configurations.) The numerical values can be updated, but the billable
+     * metric, cadence, type, and name of a price can not be overridden.
+     *
+     * ### Maximums and Minimums
+     *
+     * Minimums and maximums, much like price overrides, can be useful when a new
+     * customer has negotiated a new or different minimum or maximum spend cap than the
+     * default for a given price. If one exists for a price and null is provided for
+     * the minimum/maximum override on creation, then there will be no minimum/maximum
+     * on the new subscription. If no value is provided, then the default price maximum
+     * or minimum is used.
+     *
+     * To add a minimum for a specific price, add `minimum_amount` to the specific
+     * price in the `price_overrides` object.
+     *
+     * To add a maximum for a specific price, add `maximum_amount` to the specific
+     * price in the `price_overrides` object.
+     *
+     * ### Minimum override example
+     *
+     * Price minimum override example:
+     *
+     * ```json
+     * {
+     *   ...
+     *   "id": "price_id",
+     *   "model_type": "unit",
+     *   "unit_config": {
+     *     "unit_amount": "0.50"
+     *   },
+     *   "minimum_amount": "100.00"
+     *   ...
+     * }
+     * ```
+     *
+     * Removing an existing minimum example
+     *
+     * ```json
+     * {
+     *   ...
+     *   "id": "price_id",
+     *   "model_type": "unit",
+     *   "unit_config": {
+     *     "unit_amount": "0.50"
+     *   },
+     *   "minimum_amount": null
+     *   ...
+     * }
+     * ```
+     *
+     * ### Discounts
+     *
+     * Discounts, like price overrides, can be useful when a new customer has
+     * negotiated a new or different discount than the default for a price. If a
+     * discount exists for a price and a null discount is provided on creation, then
+     * there will be no discount on the new subscription.
+     *
+     * To add a discount for a specific price, add `discount` to the price in the
+     * `price_overrides` object. Discount should be a dictionary of the format:
+     *
+     * ```ts
+     * {
+     *   "discount_type": "amount" | "percentage" | "usage",
+     *   "amount_discount": string,
+     *   "percentage_discount": string,
+     *   "usage_discount": string
+     * }
+     * ```
+     *
+     * where either `amount_discount`, `percentage_discount`, or `usage_discount` is
+     * provided.
+     *
+     * Price discount example
+     *
+     * ```json
+     * {
+     *   ...
+     *   "id": "price_id",
+     *   "model_type": "unit",
+     *   "unit_config": {
+     *     "unit_amount": "0.50"
+     *   },
+     *   "discount": {"discount_type": "amount", "amount_discount": "175"},
+     * }
+     * ```
+     *
+     * Removing an existing discount example
+     *
+     * ```json
+     * {
+     *   "customer_id": "customer_id",
+     *   "plan_id": "plan_id",
+     *   "discount": null,
+     *   "price_overrides": [ ... ]
+     *   ...
+     * }
+     * ```
+     *
+     * ## Threshold Billing
+     *
+     * Orb supports invoicing for a subscription when a preconfigured usage threshold
+     * is hit. To enable threshold billing, pass in an `invoicing_threshold`, which is
+     * specified in the subscription's invoicing currency, when creating a
+     * subscription. E.g. pass in `10.00` to issue an invoice when usage amounts hit
+     * $10.00 for a subscription that invoices in USD.
+     */
+    create(body, options) {
         return this._client.post('/subscriptions', { body, ...options });
     }
-    update(subscriptionId, body = {}, options) {
-        if (isRequestOptions(body)) {
-            return this.update(subscriptionId, {}, body);
-        }
+    /**
+     * This endpoint can be used to update the `metadata`, `net terms`,
+     * `auto_collection`, `invoicing_threshold`, and `default_invoice_memo` properties
+     * on a subscription.
+     */
+    update(subscriptionId, body, options) {
         return this._client.put(`/subscriptions/${subscriptionId}`, { body, ...options });
     }
     list(query = {}, options) {
@@ -113,10 +367,81 @@ export class Subscriptions extends APIResource {
         }
         return this._client.get(`/subscriptions/${subscriptionId}/usage`, { query, ...options });
     }
-    priceIntervals(subscriptionId, body = {}, options) {
-        if (isRequestOptions(body)) {
-            return this.priceIntervals(subscriptionId, {}, body);
-        }
+    /**
+     * This endpoint is used to add and edit subscription
+     * [price intervals](../reference/price-interval). By making modifications to a
+     * subscription’s price intervals, you can
+     * [flexibly and atomically control the billing behavior of a subscription](../guides/product-catalog/modifying-subscriptions).
+     *
+     * ## Adding price intervals
+     *
+     * Prices can be added as price intervals to a subscription by specifying them in
+     * the `add` array. A `price_id` or `external_price_id` from an add-on price or
+     * previously removed plan price can be specified to reuse an existing price
+     * definition (however, please note that prices from other plans cannot be added to
+     * the subscription). Additionally, a new price can be specified using the `price`
+     * field — this price will be created automatically.
+     *
+     * A `start_date` must be specified for the price interval. This is the date when
+     * the price will start billing on the subscription, so this will notably result in
+     * an immediate charge at this time for any billed in advance fixed fees. The
+     * `end_date` will default to null, resulting in a price interval that will bill on
+     * a continually recurring basis. Both of these dates can be set in the past or the
+     * future and Orb will generate or modify invoices to ensure the subscription’s
+     * invoicing behavior is correct.
+     *
+     * Additionally, a discount, minimum, or maximum can be specified on the price
+     * interval. This will only apply to this price interval, not any other price
+     * intervals on the subscription.
+     *
+     * ## Adjustment intervals
+     *
+     * An adjustment interval represents the time period that a particular adjustment
+     * (a discount, minimum, or maximum) applies to the prices on a subscription.
+     * Adjustment intervals can be added to a subscription by specifying them in the
+     * `add_adjustments` array, or modified via the `edit_adjustments` array. When
+     * creating an adjustment interval, you'll need to provide the definition of the
+     * new adjustment (the type of adjustment, and which prices it applies to), as well
+     * as the start and end dates for the adjustment interval. The start and end dates
+     * of an existing adjustment interval can be edited via the `edit_adjustments`
+     * field (just like price intervals). (To "change" the amount of a discount,
+     * minimum, or maximum, then, you'll need to end the existing interval, and create
+     * a new adjustment interval with the new amount and a start date that matches the
+     * end date of the previous interval.)
+     *
+     * ## Editing price intervals
+     *
+     * Price intervals can be adjusted by specifying edits to make in the `edit` array.
+     * A `price_interval_id` to edit must be specified — this can be retrieved from the
+     * `price_intervals` field on the subscription.
+     *
+     * A new `start_date` or `end_date` can be specified to change the range of the
+     * price interval, which will modify past or future invoices to ensure correctness.
+     * If either of these dates are unspecified, they will default to the existing date
+     * on the price interval. To remove a price interval entirely from a subscription,
+     * set the `end_date` to be equivalent to the `start_date`.
+     *
+     * ## Fixed fee quantity transitions
+     *
+     * The fixed fee quantity transitions for a fixed fee price interval can also be
+     * specified when adding or editing by passing an array for
+     * `fixed_fee_quantity_transitions`. A fixed fee quantity transition must have a
+     * `quantity` and an `effective_date`, which is the date after which the new
+     * quantity will be used for billing. If a fixed fee quantity transition is
+     * scheduled at a billing period boundary, the full quantity will be billed on an
+     * invoice with the other prices on the subscription. If the fixed fee quantity
+     * transition is scheduled mid-billing period, the difference between the existing
+     * quantity and quantity specified in the transition will be prorated for the rest
+     * of the billing period and billed immediately, which will generate a new invoice.
+     *
+     * Notably, the list of fixed fee quantity transitions passed will overwrite the
+     * existing fixed fee quantity transitions on the price interval, so the entire
+     * list of transitions must be specified to add additional transitions. The
+     * existing list of transitions can be retrieved using the
+     * `fixed_fee_quantity_transitions` property on a subscription’s serialized price
+     * intervals.
+     */
+    priceIntervals(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/price_intervals`, { body, ...options });
     }
     /**
@@ -164,8 +489,9 @@ export class Subscriptions extends APIResource {
      * subscription when you schedule the plan change. This is useful when a customer
      * has prices that differ from the default prices for a specific plan.
      *
-     * :::info This feature is only available for accounts that have migrated off of
-     * legacy subscription overrides. :::
+     * :::info This feature is only available for accounts that have migrated to
+     * Subscription Overrides Version 2. You can find your Subscription Overrides
+     * Version at the bottom of your [Plans page](https://app.withorb.com/plans) :::
      *
      * ### Adding Prices
      *
@@ -303,10 +629,11 @@ export class Subscriptions extends APIResource {
     schedulePlanChange(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/schedule_plan_change`, { body, ...options });
     }
-    triggerPhase(subscriptionId, body = {}, options) {
-        if (isRequestOptions(body)) {
-            return this.triggerPhase(subscriptionId, {}, body);
-        }
+    /**
+     * Manually trigger a phase, effective the given date (or the current time, if not
+     * specified).
+     */
+    triggerPhase(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/trigger_phase`, { body, ...options });
     }
     /**
@@ -390,9 +717,6 @@ export class SubscriptionsPage extends Page {
 }
 export class SubscriptionFetchScheduleResponsesPage extends Page {
 }
-(function (Subscriptions) {
-    Subscriptions.Subscriptions = SubscriptionsAPI.Subscriptions;
-    Subscriptions.SubscriptionsPage = SubscriptionsAPI.SubscriptionsPage;
-    Subscriptions.SubscriptionFetchScheduleResponsesPage = SubscriptionsAPI.SubscriptionFetchScheduleResponsesPage;
-})(Subscriptions || (Subscriptions = {}));
+Subscriptions.SubscriptionsPage = SubscriptionsPage;
+Subscriptions.SubscriptionFetchScheduleResponsesPage = SubscriptionFetchScheduleResponsesPage;
 //# sourceMappingURL=subscriptions.mjs.map

package/resources/subscriptions.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"subscriptions.mjs","sourceRoot":"","sources":["../src/resources/subscriptions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,KAAK,gBAAgB;OAKrB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,aAAc,SAAQ,WAAW;IAkQ5C,MAAM,CACJ,OAAuD,EAAE,EACzD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SAC9B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAaD,MAAM,CACJ,cAAsB,EACtB,OAAuD,EAAE,EACzD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SAC9C;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAkBD,IAAI,CACF,QAAsD,EAAE,EACxD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8DG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAsB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAuBD,UAAU,CACR,cAAsB,EACtB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAiBD,aAAa,CACX,cAAsB,EACtB,QAA+D,EAAE,EACjE,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,kBAAkB,cAAc,WAAW,EAC3C,sCAAsC,EACtC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IA4MD,UAAU,CACR,cAAsB,EACtB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAkFD,cAAc,CACZ,cAAsB,EACtB,OAA+D,EAAE,EACjE,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoLG;IACH,kBAAkB,CAChB,cAAsB,EACtB,IAA0C,EAC1C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAYD,YAAY,CACV,cAAsB,EACtB,OAA6D,EAAE,EAC/D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SACpD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;OAOG;IACH,sBAAsB,CACpB,cAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,0BAA0B,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;OAMG;IACH,iCAAiC,CAC/B,cAAsB,EACtB,IAAyD,EACzD,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,wCAAwC,EAAE;YACjG,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,4BAA4B,CAC1B,cAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,sBAAsB,CACpB,cAAsB,EACtB,IAA8C,EAC9C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,4BAA4B,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,CACT,cAAsB,EACtB,IAAmC,EACnC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,IAAkB;CAAG;AAE5D,MAAM,OAAO,sCAAuC,SAAQ,IAAuC;CAAG;AAkwctG,WAAiB,aAAa;IAGd,2BAAa,GAAG,gBAAgB,CAAC,aAAa,CAAC;IAG/C,+BAAiB,GAAG,gBAAgB,CAAC,iBAAiB,CAAC;IACvD,oDAAsC,GAAG,gBAAgB,CAAC,sCAAsC,CAAC;AAcjH,CAAC,EArBgB,aAAa,KAAb,aAAa,QAqB7B"}
+{"version":3,"file":"subscriptions.mjs","sourceRoot":"","sources":["../src/resources/subscriptions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAMpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+PG;IACH,MAAM,CACJ,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAkBD,IAAI,CACF,QAAsD,EAAE,EACxD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8DG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAsB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAuBD,UAAU,CACR,cAAsB,EACtB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAiBD,aAAa,CACX,cAAsB,EACtB,QAA+D,EAAE,EACjE,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,kBAAkB,cAAc,WAAW,EAC3C,sCAAsC,EACtC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IA4MD,UAAU,CACR,cAAsB,EACtB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyEG;IACH,cAAc,CACZ,cAAsB,EACtB,IAAsC,EACtC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqLG;IACH,kBAAkB,CAChB,cAAsB,EACtB,IAA0C,EAC1C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,YAAY,CACV,cAAsB,EACtB,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;OAOG;IACH,sBAAsB,CACpB,cAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,0BAA0B,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;OAMG;IACH,iCAAiC,CAC/B,cAAsB,EACtB,IAAyD,EACzD,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,wCAAwC,EAAE;YACjG,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,4BAA4B,CAC1B,cAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,sBAAsB,CACpB,cAAsB,EACtB,IAA8C,EAC9C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,4BAA4B,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,CACT,cAAsB,EACtB,IAAmC,EACnC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,IAAkB;CAAG;AAE5D,MAAM,OAAO,sCAAuC,SAAQ,IAAuC;CAAG;AAg3tBtG,aAAa,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;AACpD,aAAa,CAAC,sCAAsC,GAAG,sCAAsC,CAAC"}

package/resources/top-level.d.ts

@@ -1,6 +1,5 @@
 import { APIResource } from "../resource.js";
 import * as Core from "../core.js";
-import * as TopLevelAPI from "./top-level.js";
 export declare class TopLevel extends APIResource {
     /**
      * This endpoint allows you to test your connection to the Orb API and check the
@@ -16,6 +15,6 @@ export interface TopLevelPingResponse {
     response: string;
 }
 export declare namespace TopLevel {
-    export import TopLevelPingResponse = TopLevelAPI.TopLevelPingResponse;
+    export { type TopLevelPingResponse as TopLevelPingResponse };
 }
 //# sourceMappingURL=top-level.d.ts.map

package/resources/top-level.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"top-level.d.ts","sourceRoot":"","sources":["../src/resources/top-level.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,WAAW,MAAM,aAAa,CAAC;AAE3C,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;CAG3E;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,QAAQ,CAAC;IACxB,MAAM,QAAQ,oBAAoB,GAAG,WAAW,CAAC,oBAAoB,CAAC;CACvE"}
+{"version":3,"file":"top-level.d.ts","sourceRoot":"","sources":["../src/resources/top-level.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;CAG3E;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EAAE,KAAK,oBAAoB,IAAI,oBAAoB,EAAE,CAAC;CAC9D"}

package/resources/top-level.js

@@ -17,6 +17,4 @@ class TopLevel extends resource_1.APIResource {
     }
 }
 exports.TopLevel = TopLevel;
-(function (TopLevel) {
-})(TopLevel = exports.TopLevel || (exports.TopLevel = {}));
 //# sourceMappingURL=top-level.js.map

package/resources/top-level.js.map

@@ -1 +1 @@
-{"version":3,"file":"top-level.js","sourceRoot":"","sources":["../src/resources/top-level.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAI1C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;OAOG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;CACF;AAZD,4BAYC;AAMD,WAAiB,QAAQ;AAEzB,CAAC,EAFgB,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAExB"}
+{"version":3,"file":"top-level.js","sourceRoot":"","sources":["../src/resources/top-level.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAG1C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;OAOG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;CACF;AAZD,4BAYC"}

package/resources/top-level.mjs

@@ -13,6 +13,4 @@ export class TopLevel extends APIResource {
         return this._client.get('/ping', options);
     }
 }
-(function (TopLevel) {
-})(TopLevel || (TopLevel = {}));
 //# sourceMappingURL=top-level.mjs.map

package/resources/top-level.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"top-level.mjs","sourceRoot":"","sources":["../src/resources/top-level.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;OAOG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;CACF;AAMD,WAAiB,QAAQ;AAEzB,CAAC,EAFgB,QAAQ,KAAR,QAAQ,QAExB"}
+{"version":3,"file":"top-level.mjs","sourceRoot":"","sources":["../src/resources/top-level.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;OAOG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;CACF"}

package/src/core.ts

@@ -163,7 +163,7 @@ export abstract class APIClient {
     maxRetries = 2,
     timeout = 60000, // 1 minute
     httpAgent,
-    fetch: overridenFetch,
+    fetch: overriddenFetch,
   }: {
     baseURL: string;
     maxRetries?: number | undefined;
@@ -176,7 +176,7 @@ export abstract class APIClient {
     this.timeout = validatePositiveInteger('timeout', timeout);
     this.httpAgent = httpAgent;
 
-    this.fetch = overridenFetch ?? fetch;
+    this.fetch = overriddenFetch ?? fetch;
   }
 
   protected authHeaders(opts: FinalRequestOptions): Headers {
@@ -396,7 +396,7 @@ export abstract class APIClient {
     error: Object | undefined,
     message: string | undefined,
     headers: Headers | undefined,
-  ) {
+  ): APIError {
     return APIError.generate(status, error, message, headers);
   }
 
@@ -522,20 +522,24 @@ export abstract class APIClient {
 
     const timeout = setTimeout(() => controller.abort(), ms);
 
+    const fetchOptions = {
+      signal: controller.signal as any,
+      ...options,
+    };
+    if (fetchOptions.method) {
+      // Custom methods like 'patch' need to be uppercased
+      // See https://github.com/nodejs/undici/issues/2294
+      fetchOptions.method = fetchOptions.method.toUpperCase();
+    }
+
     return (
-      this.getRequestClient()
-        // use undefined this binding; fetch errors if bound to something else in browser/cloudflare
-        .fetch.call(undefined, url, { signal: controller.signal as any, ...options })
-        .finally(() => {
-          clearTimeout(timeout);
-        })
+      // use undefined this binding; fetch errors if bound to something else in browser/cloudflare
+      this.fetch.call(undefined, url, fetchOptions).finally(() => {
+        clearTimeout(timeout);
+      })
     );
   }
 
-  protected getRequestClient(): RequestClient {
-    return { fetch: this.fetch };
-  }
-
   private shouldRetry(response: Response): boolean {
     // Note this is not a standard header.
     const shouldRetryHeader = response.headers.get('x-should-retry');
@@ -668,9 +672,9 @@ export abstract class AbstractPage<Item> implements AsyncIterable<Item> {
     return await this.#client.requestAPIList(this.constructor as any, nextOptions);
   }
 
-  async *iterPages() {
+  async *iterPages(): AsyncGenerator<this> {
     // eslint-disable-next-line @typescript-eslint/no-this-alias
-    let page: AbstractPage<Item> = this;
+    let page: this = this;
     yield page;
     while (page.hasNextPage()) {
       page = await page.getNextPage();
@@ -678,7 +682,7 @@ export abstract class AbstractPage<Item> implements AsyncIterable<Item> {
     }
   }
 
-  async *[Symbol.asyncIterator]() {
+  async *[Symbol.asyncIterator](): AsyncGenerator<Item> {
     for await (const page of this.iterPages()) {
       for (const item of page.getPaginatedItems()) {
         yield item;
@@ -721,7 +725,7 @@ export class PagePromise<
    *      console.log(item)
    *    }
    */
-  async *[Symbol.asyncIterator]() {
+  async *[Symbol.asyncIterator](): AsyncGenerator<Item> {
     const page = await this;
     for await (const item of page) {
       yield item;
@@ -976,8 +980,8 @@ export const safeJSON = (text: string) => {
   }
 };
 
-// https://stackoverflow.com/a/19709846
-const startsWithSchemeRegexp = new RegExp('^(?:[a-z]+:)?//', 'i');
+// https://url.spec.whatwg.org/#url-scheme-string
+const startsWithSchemeRegexp = /^[a-z][a-z0-9+.-]*:/i;
 const isAbsoluteURL = (url: string): boolean => {
   return startsWithSchemeRegexp.test(url);
 };