stripe 16.12.0 → 17.0.0

package/esm/resources/V2.js

@@ -0,0 +1,11 @@
+// File generated from our OpenAPI spec
+import { StripeResource } from '../StripeResource.js';
+import { Billing } from './V2/Billing.js';
+import { Core } from './V2/Core.js';
+export const V2 = StripeResource.extend({
+    constructor: function (...args) {
+        StripeResource.apply(this, args);
+        this.billing = new Billing(...args);
+        this.core = new Core(...args);
+    },
+});

package/esm/resources.js

@@ -13,6 +13,9 @@ import { Configurations as BillingPortalConfigurations } from './resources/Billi
 import { Configurations as TerminalConfigurations } from './resources/Terminal/Configurations.js';
 import { ConfirmationTokens as TestHelpersConfirmationTokens } from './resources/TestHelpers/ConfirmationTokens.js';
 import { ConnectionTokens as TerminalConnectionTokens } from './resources/Terminal/ConnectionTokens.js';
+import { CreditBalanceSummary as BillingCreditBalanceSummary } from './resources/Billing/CreditBalanceSummary.js';
+import { CreditBalanceTransactions as BillingCreditBalanceTransactions } from './resources/Billing/CreditBalanceTransactions.js';
+import { CreditGrants as BillingCreditGrants } from './resources/Billing/CreditGrants.js';
 import { CreditReversals as TreasuryCreditReversals } from './resources/Treasury/CreditReversals.js';
 import { Customers as TestHelpersCustomers } from './resources/TestHelpers/Customers.js';
 import { DebitReversals as TreasuryDebitReversals } from './resources/Treasury/DebitReversals.js';
@@ -117,10 +120,14 @@ export { TaxRates } from './resources/TaxRates.js';
 export { Tokens } from './resources/Tokens.js';
 export { Topups } from './resources/Topups.js';
 export { Transfers } from './resources/Transfers.js';
+export { V2 } from './resources/V2.js';
 export { WebhookEndpoints } from './resources/WebhookEndpoints.js';
 export const Apps = resourceNamespace('apps', { Secrets: AppsSecrets });
 export const Billing = resourceNamespace('billing', {
     Alerts: BillingAlerts,
+    CreditBalanceSummary: BillingCreditBalanceSummary,
+    CreditBalanceTransactions: BillingCreditBalanceTransactions,
+    CreditGrants: BillingCreditGrants,
     MeterEventAdjustments: BillingMeterEventAdjustments,
     MeterEvents: BillingMeterEvents,
     Meters: BillingMeters,

package/esm/stripe.core.js

@@ -2,20 +2,21 @@ import * as _Error from './Error.js';
 import { RequestSender } from './RequestSender.js';
 import { StripeResource } from './StripeResource.js';
 import { createWebhooks } from './Webhooks.js';
-import * as apiVersion from './apiVersion.js';
+import { ApiVersion } from './apiVersion.js';
 import { CryptoProvider } from './crypto/CryptoProvider.js';
 import { HttpClient, HttpClientResponse } from './net/HttpClient.js';
 import * as resources from './resources.js';
-import { determineProcessUserAgentProperties, pascalToCamelCase, validateInteger, } from './utils.js';
+import { createApiKeyAuthenticator, determineProcessUserAgentProperties, pascalToCamelCase, validateInteger, } from './utils.js';
 const DEFAULT_HOST = 'api.stripe.com';
 const DEFAULT_PORT = '443';
 const DEFAULT_BASE_PATH = '/v1/';
-const DEFAULT_API_VERSION = apiVersion.ApiVersion;
+const DEFAULT_API_VERSION = ApiVersion;
 const DEFAULT_TIMEOUT = 80000;
-const MAX_NETWORK_RETRY_DELAY_SEC = 2;
+const MAX_NETWORK_RETRY_DELAY_SEC = 5;
 const INITIAL_NETWORK_RETRY_DELAY_SEC = 0.5;
 const APP_INFO_PROPERTIES = ['name', 'version', 'url', 'partner_id'];
 const ALLOWED_CONFIG_PROPERTIES = [
+    'authenticator',
     'apiVersion',
     'typescript',
     'maxNetworkRetries',
@@ -28,10 +29,11 @@ const ALLOWED_CONFIG_PROPERTIES = [
     'telemetry',
     'appInfo',
     'stripeAccount',
+    'stripeContext',
 ];
 const defaultRequestSenderFactory = (stripe) => new RequestSender(stripe, StripeResource.MAX_BUFFERED_REQUEST_METRICS);
 export function createStripe(platformFunctions, requestSender = defaultRequestSenderFactory) {
-    Stripe.PACKAGE_VERSION = '16.12.0';
+    Stripe.PACKAGE_VERSION = '17.0.0';
     Stripe.USER_AGENT = Object.assign({ bindings_version: Stripe.PACKAGE_VERSION, lang: 'node', publisher: 'stripe', uname: null, typescript: false }, determineProcessUserAgentProperties());
     Stripe.StripeResource = StripeResource;
     Stripe.resources = resources;
@@ -66,14 +68,13 @@ export function createStripe(platformFunctions, requestSender = defaultRequestSe
         this.off = this._emitter.removeListener.bind(this._emitter);
         const agent = props.httpAgent || null;
         this._api = {
-            auth: null,
             host: props.host || DEFAULT_HOST,
             port: props.port || DEFAULT_PORT,
             protocol: props.protocol || 'https',
             basePath: DEFAULT_BASE_PATH,
             version: props.apiVersion || DEFAULT_API_VERSION,
             timeout: validateInteger('timeout', props.timeout, DEFAULT_TIMEOUT),
-            maxNetworkRetries: validateInteger('maxNetworkRetries', props.maxNetworkRetries, 1),
+            maxNetworkRetries: validateInteger('maxNetworkRetries', props.maxNetworkRetries, 2),
             agent: agent,
             httpClient: props.httpClient ||
                 (agent
@@ -81,6 +82,7 @@ export function createStripe(platformFunctions, requestSender = defaultRequestSe
                     : this._platformFunctions.createDefaultHttpClient()),
             dev: false,
             stripeAccount: props.stripeAccount || null,
+            stripeContext: props.stripeContext || null,
         };
         const typescript = props.typescript || false;
         if (typescript !== Stripe.USER_AGENT.typescript) {
@@ -94,7 +96,7 @@ export function createStripe(platformFunctions, requestSender = defaultRequestSe
             this._setAppInfo(props.appInfo);
         }
         this._prepResources();
-        this._setApiKey(key);
+        this._setAuthenticator(key, props.authenticator);
         this.errors = _Error;
         // Once Stripe.webhooks looses the factory function signature in a future release
         // then this should become this.webhooks = Stripe.webhooks
@@ -147,13 +149,22 @@ export function createStripe(platformFunctions, requestSender = defaultRequestSe
         _enableTelemetry: null,
         _requestSender: null,
         _platformFunctions: null,
+        rawRequest(method, path, params, options) {
+            return this._requestSender._rawRequest(method, path, params, options);
+        },
         /**
          * @private
          */
-        _setApiKey(key) {
-            if (key) {
-                this._setApiField('auth', `Bearer ${key}`);
+        _setAuthenticator(key, authenticator) {
+            if (key && authenticator) {
+                throw new Error("Can't specify both apiKey and authenticator");
+            }
+            if (!key && !authenticator) {
+                throw new Error('Neither apiKey nor config.authenticator provided');
             }
+            this._authenticator = key
+                ? createApiKeyAuthenticator(key)
+                : authenticator;
         },
         /**
          * @private
@@ -352,6 +363,10 @@ export function createStripe(platformFunctions, requestSender = defaultRequestSe
             }
             return config;
         },
+        parseThinEvent(payload, header, secret, tolerance, cryptoProvider, receivedAt) {
+            // parses and validates the event payload all in one go
+            return this.webhooks.constructEvent(payload, header, secret, tolerance, cryptoProvider, receivedAt);
+        },
     };
     return Stripe;
 }

package/esm/utils.js

@@ -7,6 +7,9 @@ const OPTIONS_KEYS = [
     'maxNetworkRetries',
     'timeout',
     'host',
+    'authenticator',
+    'stripeContext',
+    'additionalHeaders',
 ];
 export function isOptionsHash(o) {
     return (o &&
@@ -17,10 +20,11 @@ export function isOptionsHash(o) {
  * Stringifies an Object, accommodating nested objects
  * (forming the conventional key 'parent[child]=value')
  */
-export function stringifyRequestData(data) {
+export function queryStringifyRequestData(data, apiMode) {
     return (qs
         .stringify(data, {
         serializeDate: (d) => Math.floor(d.getTime() / 1000).toString(),
+        arrayFormat: apiMode == 'v2' ? 'repeat' : 'indices',
     })
         // Don't use strict form encoding by changing the square bracket control
         // characters back to their literals. This is fine by the server, and
@@ -87,7 +91,6 @@ export function getDataFromArgs(args) {
  */
 export function getOptionsFromArgs(args) {
     const opts = {
-        auth: null,
         host: null,
         headers: {},
         settings: {},
@@ -95,7 +98,7 @@ export function getOptionsFromArgs(args) {
     if (args.length > 0) {
         const arg = args[args.length - 1];
         if (typeof arg === 'string') {
-            opts.auth = args.pop();
+            opts.authenticator = createApiKeyAuthenticator(args.pop());
         }
         else if (isOptionsHash(arg)) {
             const params = Object.assign({}, args.pop());
@@ -104,7 +107,7 @@ export function getOptionsFromArgs(args) {
                 emitWarning(`Invalid options found (${extraKeys.join(', ')}); ignoring.`);
             }
             if (params.apiKey) {
-                opts.auth = params.apiKey;
+                opts.authenticator = createApiKeyAuthenticator(params.apiKey);
             }
             if (params.idempotencyKey) {
                 opts.headers['Idempotency-Key'] = params.idempotencyKey;
@@ -112,6 +115,12 @@ export function getOptionsFromArgs(args) {
             if (params.stripeAccount) {
                 opts.headers['Stripe-Account'] = params.stripeAccount;
             }
+            if (params.stripeContext) {
+                if (opts.headers['Stripe-Account']) {
+                    throw new Error("Can't specify both stripeAccount and stripeContext.");
+                }
+                opts.headers['Stripe-Context'] = params.stripeContext;
+            }
             if (params.apiVersion) {
                 opts.headers['Stripe-Version'] = params.apiVersion;
             }
@@ -124,6 +133,19 @@ export function getOptionsFromArgs(args) {
             if (params.host) {
                 opts.host = params.host;
             }
+            if (params.authenticator) {
+                if (params.apiKey) {
+                    throw new Error("Can't specify both apiKey and authenticator.");
+                }
+                if (typeof params.authenticator !== 'function') {
+                    throw new Error('The authenticator must be a function ' +
+                        'receiving a request as the first parameter.');
+                }
+                opts.authenticator = params.authenticator;
+            }
+            if (params.additionalHeaders) {
+                opts.headers = params.additionalHeaders;
+            }
         }
     }
     return opts;
@@ -270,6 +292,15 @@ export function determineProcessUserAgentProperties() {
             platform: process.platform,
         };
 }
+export function createApiKeyAuthenticator(apiKey) {
+    const authenticator = (request) => {
+        request.headers.Authorization = 'Bearer ' + apiKey;
+        return Promise.resolve();
+    };
+    // For testing
+    authenticator._apiKey = apiKey;
+    return authenticator;
+}
 /**
  * Joins an array of Uint8Arrays into a single Uint8Array
  */
@@ -283,3 +314,27 @@ export function concat(arrays) {
     });
     return merged;
 }
+/**
+ * Replaces Date objects with Unix timestamps
+ */
+function dateTimeReplacer(key, value) {
+    if (this[key] instanceof Date) {
+        return Math.floor(this[key].getTime() / 1000).toString();
+    }
+    return value;
+}
+/**
+ * JSON stringifies an Object, replacing Date objects with Unix timestamps
+ */
+export function jsonStringifyRequestData(data) {
+    return JSON.stringify(data, dateTimeReplacer);
+}
+/**
+ * Inspects the given path to determine if the endpoint is for v1 or v2 API
+ */
+export function getAPIMode(path) {
+    if (!path) {
+        return 'v1';
+    }
+    return path.startsWith('/v2') ? 'v2' : 'v1';
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stripe",
-  "version": "16.12.0",
+  "version": "17.0.0",
   "description": "Stripe API wrapper",
   "keywords": [
     "stripe",

package/types/Billing/Alerts.d.ts

@@ -22,11 +22,6 @@ declare module 'stripe' {
          */
         alert_type: 'usage_threshold';
 
-        /**
-         * Limits the scope of the alert to a specific [customer](https://stripe.com/docs/api/customers).
-         */
-        filter: Alert.Filter | null;
-
         /**
          * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          */
@@ -45,20 +40,18 @@ declare module 'stripe' {
         /**
          * Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter).
          */
-        usage_threshold_config: Alert.UsageThresholdConfig | null;
+        usage_threshold: Alert.UsageThreshold | null;
       }
 
       namespace Alert {
-        interface Filter {
+        type Status = 'active' | 'archived' | 'inactive';
+
+        interface UsageThreshold {
           /**
-           * Limit the scope of the alert to this customer ID
+           * The filters allow limiting the scope of this usage alert. You can only specify up to one filter at this time.
            */
-          customer: string | Stripe.Customer | null;
-        }
+          filters: Array<UsageThreshold.Filter> | null;
 
-        type Status = 'active' | 'archived' | 'inactive';
-
-        interface UsageThresholdConfig {
           /**
            * The value at which this alert will trigger.
            */
@@ -74,6 +67,17 @@ declare module 'stripe' {
            */
           recurrence: 'one_time';
         }
+
+        namespace UsageThreshold {
+          interface Filter {
+            /**
+             * Limit the scope of the alert to this customer ID
+             */
+            customer: string | Stripe.Customer | null;
+
+            type: 'customer';
+          }
+        }
       }
     }
   }

package/types/Billing/AlertsResource.d.ts

@@ -19,36 +19,19 @@ declare module 'stripe' {
          */
         expand?: Array<string>;
 
-        /**
-         * Filters to limit the scope of an alert.
-         */
-        filter?: AlertCreateParams.Filter;
-
         /**
          * The configuration of the usage threshold.
          */
-        usage_threshold_config?: AlertCreateParams.UsageThresholdConfig;
+        usage_threshold?: AlertCreateParams.UsageThreshold;
       }
 
       namespace AlertCreateParams {
-        interface Filter {
-          /**
-           * Limit the scope to this alert only to this customer.
-           */
-          customer?: string;
-
+        interface UsageThreshold {
           /**
-           * Limit the scope of this rated usage alert to this subscription.
+           * The filters allows limiting the scope of this usage alert. You can only specify up to one filter at this time.
            */
-          subscription?: string;
+          filters?: Array<UsageThreshold.Filter>;
 
-          /**
-           * Limit the scope of this rated usage alert to this subscription item.
-           */
-          subscription_item?: string;
-        }
-
-        interface UsageThresholdConfig {
           /**
            * Defines at which value the alert will fire.
            */
@@ -64,6 +47,20 @@ declare module 'stripe' {
            */
           recurrence: 'one_time';
         }
+
+        namespace UsageThreshold {
+          interface Filter {
+            /**
+             * Limit the scope to this usage alert only to this customer.
+             */
+            customer?: string;
+
+            /**
+             * What type of filter is being applied to this usage alert.
+             */
+            type: 'customer';
+          }
+        }
       }
 
       interface AlertRetrieveParams {

package/types/Billing/CreditBalanceSummary.d.ts

@@ -0,0 +1,94 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      /**
+       * Indicates the credit balance for credits granted to a customer.
+       */
+      interface CreditBalanceSummary {
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'billing.credit_balance_summary';
+
+        /**
+         * The credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry.
+         */
+        balances: Array<CreditBalanceSummary.Balance>;
+
+        /**
+         * The customer the balance is for.
+         */
+        customer: string | Stripe.Customer | Stripe.DeletedCustomer;
+
+        /**
+         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+         */
+        livemode: boolean;
+      }
+
+      namespace CreditBalanceSummary {
+        interface Balance {
+          available_balance: Balance.AvailableBalance;
+
+          ledger_balance: Balance.LedgerBalance;
+        }
+
+        namespace Balance {
+          interface AvailableBalance {
+            /**
+             * The monetary amount.
+             */
+            monetary: AvailableBalance.Monetary | null;
+
+            /**
+             * The type of this amount. We currently only support `monetary` credits.
+             */
+            type: 'monetary';
+          }
+
+          namespace AvailableBalance {
+            interface Monetary {
+              /**
+               * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+               */
+              currency: string;
+
+              /**
+               * A positive integer representing the amount.
+               */
+              value: number;
+            }
+          }
+
+          interface LedgerBalance {
+            /**
+             * The monetary amount.
+             */
+            monetary: LedgerBalance.Monetary | null;
+
+            /**
+             * The type of this amount. We currently only support `monetary` credits.
+             */
+            type: 'monetary';
+          }
+
+          namespace LedgerBalance {
+            interface Monetary {
+              /**
+               * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+               */
+              currency: string;
+
+              /**
+               * A positive integer representing the amount.
+               */
+              value: number;
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/types/Billing/CreditBalanceSummaryResource.d.ts

@@ -0,0 +1,64 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      interface CreditBalanceSummaryRetrieveParams {
+        /**
+         * The customer for which to fetch credit balance summary.
+         */
+        customer: string;
+
+        /**
+         * The filter criteria for the credit balance summary.
+         */
+        filter: CreditBalanceSummaryRetrieveParams.Filter;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      namespace CreditBalanceSummaryRetrieveParams {
+        interface Filter {
+          /**
+           * The credit applicability scope for which to fetch balance summary.
+           */
+          applicability_scope?: Filter.ApplicabilityScope;
+
+          /**
+           * The credit grant for which to fetch balance summary.
+           */
+          credit_grant?: string;
+
+          /**
+           * Specify the type of this filter.
+           */
+          type: Filter.Type;
+        }
+
+        namespace Filter {
+          interface ApplicabilityScope {
+            /**
+             * The price type to which credit grants can apply to. We currently only support `metered` price type.
+             */
+            price_type: 'metered';
+          }
+
+          type Type = 'applicability_scope' | 'credit_grant';
+        }
+      }
+
+      class CreditBalanceSummaryResource {
+        /**
+         * Retrieves the credit balance summary for a customer
+         */
+        retrieve(
+          params: CreditBalanceSummaryRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.CreditBalanceSummary>>;
+      }
+    }
+  }
+}