orb-billing 4.17.1 → 4.19.0

package/src/internal/qs/utils.ts

@@ -0,0 +1,265 @@
+import { RFC1738 } from './formats';
+import type { DefaultEncoder, Format } from './types';
+
+const has = Object.prototype.hasOwnProperty;
+const is_array = Array.isArray;
+
+const hex_table = (() => {
+  const array = [];
+  for (let i = 0; i < 256; ++i) {
+    array.push('%' + ((i < 16 ? '0' : '') + i.toString(16)).toUpperCase());
+  }
+
+  return array;
+})();
+
+function compact_queue<T extends Record<string, any>>(queue: Array<{ obj: T; prop: string }>) {
+  while (queue.length > 1) {
+    const item = queue.pop();
+    if (!item) continue;
+
+    const obj = item.obj[item.prop];
+
+    if (is_array(obj)) {
+      const compacted: unknown[] = [];
+
+      for (let j = 0; j < obj.length; ++j) {
+        if (typeof obj[j] !== 'undefined') {
+          compacted.push(obj[j]);
+        }
+      }
+
+      // @ts-ignore
+      item.obj[item.prop] = compacted;
+    }
+  }
+}
+
+function array_to_object(source: any[], options: { plainObjects: boolean }) {
+  const obj = options && options.plainObjects ? Object.create(null) : {};
+  for (let i = 0; i < source.length; ++i) {
+    if (typeof source[i] !== 'undefined') {
+      obj[i] = source[i];
+    }
+  }
+
+  return obj;
+}
+
+export function merge(
+  target: any,
+  source: any,
+  options: { plainObjects?: boolean; allowPrototypes?: boolean } = {},
+) {
+  if (!source) {
+    return target;
+  }
+
+  if (typeof source !== 'object') {
+    if (is_array(target)) {
+      target.push(source);
+    } else if (target && typeof target === 'object') {
+      if (
+        (options && (options.plainObjects || options.allowPrototypes)) ||
+        !has.call(Object.prototype, source)
+      ) {
+        target[source] = true;
+      }
+    } else {
+      return [target, source];
+    }
+
+    return target;
+  }
+
+  if (!target || typeof target !== 'object') {
+    return [target].concat(source);
+  }
+
+  let mergeTarget = target;
+  if (is_array(target) && !is_array(source)) {
+    // @ts-ignore
+    mergeTarget = array_to_object(target, options);
+  }
+
+  if (is_array(target) && is_array(source)) {
+    source.forEach(function (item, i) {
+      if (has.call(target, i)) {
+        const targetItem = target[i];
+        if (targetItem && typeof targetItem === 'object' && item && typeof item === 'object') {
+          target[i] = merge(targetItem, item, options);
+        } else {
+          target.push(item);
+        }
+      } else {
+        target[i] = item;
+      }
+    });
+    return target;
+  }
+
+  return Object.keys(source).reduce(function (acc, key) {
+    const value = source[key];
+
+    if (has.call(acc, key)) {
+      acc[key] = merge(acc[key], value, options);
+    } else {
+      acc[key] = value;
+    }
+    return acc;
+  }, mergeTarget);
+}
+
+export function assign_single_source(target: any, source: any) {
+  return Object.keys(source).reduce(function (acc, key) {
+    acc[key] = source[key];
+    return acc;
+  }, target);
+}
+
+export function decode(str: string, _: any, charset: string) {
+  const strWithoutPlus = str.replace(/\+/g, ' ');
+  if (charset === 'iso-8859-1') {
+    // unescape never throws, no try...catch needed:
+    return strWithoutPlus.replace(/%[0-9a-f]{2}/gi, unescape);
+  }
+  // utf-8
+  try {
+    return decodeURIComponent(strWithoutPlus);
+  } catch (e) {
+    return strWithoutPlus;
+  }
+}
+
+const limit = 1024;
+
+export const encode: (
+  str: any,
+  defaultEncoder: DefaultEncoder,
+  charset: string,
+  type: 'key' | 'value',
+  format: Format,
+) => string = (str, _defaultEncoder, charset, _kind, format: Format) => {
+  // This code was originally written by Brian White for the io.js core querystring library.
+  // It has been adapted here for stricter adherence to RFC 3986
+  if (str.length === 0) {
+    return str;
+  }
+
+  let string = str;
+  if (typeof str === 'symbol') {
+    string = Symbol.prototype.toString.call(str);
+  } else if (typeof str !== 'string') {
+    string = String(str);
+  }
+
+  if (charset === 'iso-8859-1') {
+    return escape(string).replace(/%u[0-9a-f]{4}/gi, function ($0) {
+      return '%26%23' + parseInt($0.slice(2), 16) + '%3B';
+    });
+  }
+
+  let out = '';
+  for (let j = 0; j < string.length; j += limit) {
+    const segment = string.length >= limit ? string.slice(j, j + limit) : string;
+    const arr = [];
+
+    for (let i = 0; i < segment.length; ++i) {
+      let c = segment.charCodeAt(i);
+      if (
+        c === 0x2d || // -
+        c === 0x2e || // .
+        c === 0x5f || // _
+        c === 0x7e || // ~
+        (c >= 0x30 && c <= 0x39) || // 0-9
+        (c >= 0x41 && c <= 0x5a) || // a-z
+        (c >= 0x61 && c <= 0x7a) || // A-Z
+        (format === RFC1738 && (c === 0x28 || c === 0x29)) // ( )
+      ) {
+        arr[arr.length] = segment.charAt(i);
+        continue;
+      }
+
+      if (c < 0x80) {
+        arr[arr.length] = hex_table[c];
+        continue;
+      }
+
+      if (c < 0x800) {
+        arr[arr.length] = hex_table[0xc0 | (c >> 6)]! + hex_table[0x80 | (c & 0x3f)];
+        continue;
+      }
+
+      if (c < 0xd800 || c >= 0xe000) {
+        arr[arr.length] =
+          hex_table[0xe0 | (c >> 12)]! + hex_table[0x80 | ((c >> 6) & 0x3f)] + hex_table[0x80 | (c & 0x3f)];
+        continue;
+      }
+
+      i += 1;
+      c = 0x10000 + (((c & 0x3ff) << 10) | (segment.charCodeAt(i) & 0x3ff));
+
+      arr[arr.length] =
+        hex_table[0xf0 | (c >> 18)]! +
+        hex_table[0x80 | ((c >> 12) & 0x3f)] +
+        hex_table[0x80 | ((c >> 6) & 0x3f)] +
+        hex_table[0x80 | (c & 0x3f)];
+    }
+
+    out += arr.join('');
+  }
+
+  return out;
+};
+
+export function compact(value: any) {
+  const queue = [{ obj: { o: value }, prop: 'o' }];
+  const refs = [];
+
+  for (let i = 0; i < queue.length; ++i) {
+    const item = queue[i];
+    // @ts-ignore
+    const obj = item.obj[item.prop];
+
+    const keys = Object.keys(obj);
+    for (let j = 0; j < keys.length; ++j) {
+      const key = keys[j]!;
+      const val = obj[key];
+      if (typeof val === 'object' && val !== null && refs.indexOf(val) === -1) {
+        queue.push({ obj: obj, prop: key });
+        refs.push(val);
+      }
+    }
+  }
+
+  compact_queue(queue);
+
+  return value;
+}
+
+export function is_regexp(obj: any) {
+  return Object.prototype.toString.call(obj) === '[object RegExp]';
+}
+
+export function is_buffer(obj: any) {
+  if (!obj || typeof obj !== 'object') {
+    return false;
+  }
+
+  return !!(obj.constructor && obj.constructor.isBuffer && obj.constructor.isBuffer(obj));
+}
+
+export function combine(a: any, b: any) {
+  return [].concat(a, b);
+}
+
+export function maybe_map<T>(val: T[], fn: (v: T) => T) {
+  if (is_array(val)) {
+    const mapped = [];
+    for (let i = 0; i < val.length; i += 1) {
+      mapped.push(fn(val[i]!));
+    }
+    return mapped;
+  }
+  return fn(val);
+}

package/src/resources/coupons/coupons.ts

@@ -85,6 +85,20 @@ export class CouponsPage extends Page<Coupon> {}
  * "UPGRADE20" that offers a 20% discount on the first month of the new plan. This
  * code can be applied during the upgrade process in your billing portal, making it
  * straightforward for users to benefit from the new features at a reduced cost.
+ *
+ * ## Coupon scoping
+ *
+ * When a coupon is applied on a subscription, it creates a discount adjustment
+ * that applies to all of the prices on the subscription at the time of the coupon
+ * application. Notably, coupons do not scope in new price additions to a
+ * subscription automatically — if a new price is added to the subscription with a
+ * subscription edit or plan version migration, the discount created with the
+ * coupon will not apply to it automatically. If you'd like the coupon to apply to
+ * newly added prices, you can
+ * [edit the adjustment intervals](add-edit-price-intervals.api.mdx) to end the
+ * discount interval created by the coupon at the time of the migration and add a
+ * new one starting at the time of the migration that includes the newly added
+ * prices you'd like the coupon to apply to.
  */
 export interface Coupon {
   /**

package/src/resources/events/backfills.ts

@@ -121,8 +121,8 @@ export interface BackfillCreateResponse {
   created_at: string;
 
   /**
-   * The customer ID this backfill is scoped to. If null, this backfill is not scoped
-   * to a single customer.
+   * The Orb-generated ID of the customer to which this backfill is scoped. If
+   * `null`, this backfill is scoped to all customers.
    */
   customer_id: string | null;
 
@@ -169,8 +169,8 @@ export interface BackfillListResponse {
   created_at: string;
 
   /**
-   * The customer ID this backfill is scoped to. If null, this backfill is not scoped
-   * to a single customer.
+   * The Orb-generated ID of the customer to which this backfill is scoped. If
+   * `null`, this backfill is scoped to all customers.
    */
   customer_id: string | null;
 
@@ -217,8 +217,8 @@ export interface BackfillCloseResponse {
   created_at: string;
 
   /**
-   * The customer ID this backfill is scoped to. If null, this backfill is not scoped
-   * to a single customer.
+   * The Orb-generated ID of the customer to which this backfill is scoped. If
+   * `null`, this backfill is scoped to all customers.
    */
   customer_id: string | null;
 
@@ -265,8 +265,8 @@ export interface BackfillFetchResponse {
   created_at: string;
 
   /**
-   * The customer ID this backfill is scoped to. If null, this backfill is not scoped
-   * to a single customer.
+   * The Orb-generated ID of the customer to which this backfill is scoped. If
+   * `null`, this backfill is scoped to all customers.
    */
   customer_id: string | null;
 
@@ -313,8 +313,8 @@ export interface BackfillRevertResponse {
   created_at: string;
 
   /**
-   * The customer ID this backfill is scoped to. If null, this backfill is not scoped
-   * to a single customer.
+   * The Orb-generated ID of the customer to which this backfill is scoped. If
+   * `null`, this backfill is scoped to all customers.
    */
   customer_id: string | null;
 
@@ -364,7 +364,8 @@ export interface BackfillCreateParams {
   close_time?: string | null;
 
   /**
-   * The ID of the customer to which this backfill is scoped.
+   * The Orb-generated ID of the customer to which this backfill is scoped. Omitting
+   * this field will scope the backfill to all customers.
    */
   customer_id?: string | null;
 
@@ -377,6 +378,7 @@ export interface BackfillCreateParams {
 
   /**
    * The external customer ID of the customer to which this backfill is scoped.
+   * Omitting this field will scope the backfill to all customers.
    */
   external_customer_id?: string | null;
 

package/src/resources/invoices.ts

@@ -50,6 +50,10 @@ export class Invoices extends APIResource {
    * the next page of results if they exist.
    *
    * By default, this only returns invoices that are `issued`, `paid`, or `synced`.
+   *
+   * When fetching any `draft` invoices, this returns the last-computed invoice
+   * values for each draft invoice, which may not always be up-to-date since Orb
+   * regularly refreshes invoices asynchronously.
    */
   list(query?: InvoiceListParams, options?: Core.RequestOptions): Core.PagePromise<InvoicesPage, Invoice>;
   list(options?: Core.RequestOptions): Core.PagePromise<InvoicesPage, Invoice>;
@@ -284,9 +288,9 @@ export interface Invoice {
    * provided, the first discount in the list will be returned. If the list is empty,
    * `None` will be returned.
    */
-  discount: Shared.Discount | null;
+  discount: Invoice.PercentageDiscount | Invoice.AmountDiscount | Invoice.TrialDiscount | null;
 
-  discounts: Array<Shared.Discount>;
+  discounts: Array<Invoice.PercentageDiscount | Invoice.AmountDiscount | Invoice.TrialDiscount>;
 
   /**
    * When the invoice payment is due.
@@ -301,7 +305,8 @@ export interface Invoice {
   eligible_to_issue_at: string | null;
 
   /**
-   * A URL for the invoice portal.
+   * A URL for the customer-facing invoice portal. This URL expires 30 days after the
+   * invoice's due date, or 60 days after being re-generated through the UI.
    */
   hosted_invoice_url: string | null;
 
@@ -826,6 +831,120 @@ export namespace Invoice {
     value: string;
   }
 
+  export interface PercentageDiscount {
+    /**
+     * List of price_ids that this discount applies to. For plan/plan phase discounts,
+     * this can be a subset of prices.
+     */
+    applies_to_price_ids: Array<string>;
+
+    discount_type: 'percentage';
+
+    /**
+     * Only available if discount_type is `percentage`. This is a number between 0
+     * and 1.
+     */
+    percentage_discount: number;
+
+    reason?: string | null;
+  }
+
+  export interface AmountDiscount {
+    /**
+     * Only available if discount_type is `amount`.
+     */
+    amount_discount: string;
+
+    /**
+     * List of price_ids that this discount applies to. For plan/plan phase discounts,
+     * this can be a subset of prices.
+     */
+    applies_to_price_ids: Array<string>;
+
+    discount_type: 'amount';
+
+    reason?: string | null;
+  }
+
+  export interface TrialDiscount {
+    /**
+     * List of price_ids that this discount applies to. For plan/plan phase discounts,
+     * this can be a subset of prices.
+     */
+    applies_to_price_ids: Array<string>;
+
+    discount_type: 'trial';
+
+    reason?: string | null;
+
+    /**
+     * Only available if discount_type is `trial`
+     */
+    trial_amount_discount?: string | null;
+
+    /**
+     * Only available if discount_type is `trial`
+     */
+    trial_percentage_discount?: number | null;
+  }
+
+  export interface PercentageDiscount {
+    /**
+     * List of price_ids that this discount applies to. For plan/plan phase discounts,
+     * this can be a subset of prices.
+     */
+    applies_to_price_ids: Array<string>;
+
+    discount_type: 'percentage';
+
+    /**
+     * Only available if discount_type is `percentage`. This is a number between 0
+     * and 1.
+     */
+    percentage_discount: number;
+
+    reason?: string | null;
+  }
+
+  export interface AmountDiscount {
+    /**
+     * Only available if discount_type is `amount`.
+     */
+    amount_discount: string;
+
+    /**
+     * List of price_ids that this discount applies to. For plan/plan phase discounts,
+     * this can be a subset of prices.
+     */
+    applies_to_price_ids: Array<string>;
+
+    discount_type: 'amount';
+
+    reason?: string | null;
+  }
+
+  export interface TrialDiscount {
+    /**
+     * List of price_ids that this discount applies to. For plan/plan phase discounts,
+     * this can be a subset of prices.
+     */
+    applies_to_price_ids: Array<string>;
+
+    discount_type: 'trial';
+
+    reason?: string | null;
+
+    /**
+     * Only available if discount_type is `trial`
+     */
+    trial_amount_discount?: string | null;
+
+    /**
+     * Only available if discount_type is `trial`
+     */
+    trial_percentage_discount?: number | null;
+  }
+
   export interface LineItem {
     /**
      * A unique ID for this line item.
@@ -1457,9 +1576,17 @@ export interface InvoiceFetchUpcomingResponse {
    * provided, the first discount in the list will be returned. If the list is empty,
    * `None` will be returned.
    */
-  discount: Shared.Discount | null;
+  discount:
+    | InvoiceFetchUpcomingResponse.PercentageDiscount
+    | InvoiceFetchUpcomingResponse.AmountDiscount
+    | InvoiceFetchUpcomingResponse.TrialDiscount
+    | null;
 
-  discounts: Array<Shared.Discount>;
+  discounts: Array<
+    | InvoiceFetchUpcomingResponse.PercentageDiscount
+    | InvoiceFetchUpcomingResponse.AmountDiscount
+    | InvoiceFetchUpcomingResponse.TrialDiscount
+  >;
 
   /**
    * When the invoice payment is due.
@@ -1474,7 +1601,8 @@ export interface InvoiceFetchUpcomingResponse {
   eligible_to_issue_at: string | null;
 
   /**
-   * A URL for the invoice portal.
+   * A URL for the customer-facing invoice portal. This URL expires 30 days after the
+   * invoice's due date, or 60 days after being re-generated through the UI.
    */
   hosted_invoice_url: string | null;
 
@@ -1999,6 +2127,120 @@ export namespace InvoiceFetchUpcomingResponse {
     value: string;
   }
 
+  export interface PercentageDiscount {
+    /**
+     * List of price_ids that this discount applies to. For plan/plan phase discounts,
+     * this can be a subset of prices.
+     */
+    applies_to_price_ids: Array<string>;
+
+    discount_type: 'percentage';
+
+    /**
+     * Only available if discount_type is `percentage`. This is a number between 0
+     * and 1.
+     */
+    percentage_discount: number;
+
+    reason?: string | null;
+  }
+
+  export interface AmountDiscount {
+    /**
+     * Only available if discount_type is `amount`.
+     */
+    amount_discount: string;
+
+    /**
+     * List of price_ids that this discount applies to. For plan/plan phase discounts,
+     * this can be a subset of prices.
+     */
+    applies_to_price_ids: Array<string>;
+
+    discount_type: 'amount';
+
+    reason?: string | null;
+  }
+
+  export interface TrialDiscount {
+    /**
+     * List of price_ids that this discount applies to. For plan/plan phase discounts,
+     * this can be a subset of prices.
+     */
+    applies_to_price_ids: Array<string>;
+
+    discount_type: 'trial';
+
+    reason?: string | null;
+
+    /**
+     * Only available if discount_type is `trial`
+     */
+    trial_amount_discount?: string | null;
+
+    /**
+     * Only available if discount_type is `trial`
+     */
+    trial_percentage_discount?: number | null;
+  }
+
+  export interface PercentageDiscount {
+    /**
+     * List of price_ids that this discount applies to. For plan/plan phase discounts,
+     * this can be a subset of prices.
+     */
+    applies_to_price_ids: Array<string>;
+
+    discount_type: 'percentage';
+
+    /**
+     * Only available if discount_type is `percentage`. This is a number between 0
+     * and 1.
+     */
+    percentage_discount: number;
+
+    reason?: string | null;
+  }
+
+  export interface AmountDiscount {
+    /**
+     * Only available if discount_type is `amount`.
+     */
+    amount_discount: string;
+
+    /**
+     * List of price_ids that this discount applies to. For plan/plan phase discounts,
+     * this can be a subset of prices.
+     */
+    applies_to_price_ids: Array<string>;
+
+    discount_type: 'amount';
+
+    reason?: string | null;
+  }
+
+  export interface TrialDiscount {
+    /**
+     * List of price_ids that this discount applies to. For plan/plan phase discounts,
+     * this can be a subset of prices.
+     */
+    applies_to_price_ids: Array<string>;
+
+    discount_type: 'trial';
+
+    reason?: string | null;
+
+    /**
+     * Only available if discount_type is `trial`
+     */
+    trial_amount_discount?: string | null;
+
+    /**
+     * Only available if discount_type is `trial`
+     */
+    trial_percentage_discount?: number | null;
+  }
+
   export interface LineItem {
     /**
      * A unique ID for this line item.

package/src/resources/plans/plans.ts

@@ -103,8 +103,8 @@ export interface Plan {
   created_at: string;
 
   /**
-   * An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's
-   * prices.
+   * @deprecated: An ISO 4217 currency string or custom pricing unit (`credits`) for
+   * this plan's prices.
    */
   currency: string;
 

package/src/resources/subscriptions.ts

@@ -93,11 +93,11 @@ export class Subscriptions extends APIResource {
    *     "tiers": [
    *       {
    *         "first_unit":"1",
-   *         "last_unit": "10",
+   *         "last_unit": "11",
    *         "unit_amount": "0.50"
    *       },
    *       {
-   *         "first_unit": "10",
+   *         "first_unit": "11",
    *         "last_unit": null,
    *         "unit_amount": "0.10"
    *       }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.17.1'; // x-release-please-version
+export const VERSION = '4.19.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.17.1";
+export declare const VERSION = "4.19.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '4.17.1'; // x-release-please-version
+exports.VERSION = '4.19.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map