stripe 8.213.0 → 8.214.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 8.214.0 - 2022-03-30
+* [#1386](https://github.com/stripe/stripe-node/pull/1386) API Updates
+  * Add support for `cancel_action`, `process_payment_intent`, `process_setup_intent`, and `set_reader_display` methods on resource `Terminal.Reader`
+  * Change `Charge.failure_balance_transaction`, `Invoice.payment_settings.payment_method_options.us_bank_account`, `PaymentIntent.next_action.verify_with_microdeposits.microdeposit_type`, `SetupIntent.next_action.verify_with_microdeposits.microdeposit_type`, and `Subscription.payment_settings.payment_method_options.us_bank_account` to be required
+  * Add support for `action` on `Terminal.Reader`
+
 ## 8.213.0 - 2022-03-28
 * [#1383](https://github.com/stripe/stripe-node/pull/1383) API Updates
   * Add support for Search API

package/VERSION

@@ -1 +1 @@
-8.213.0
+8.214.0

package/lib/resources/Terminal/Readers.js

@@ -33,4 +33,24 @@ module.exports = StripeResource.extend({
     method: 'DELETE',
     path: '/{reader}',
   }),
+
+  cancelAction: stripeMethod({
+    method: 'POST',
+    path: '/{reader}/cancel_action',
+  }),
+
+  processPaymentIntent: stripeMethod({
+    method: 'POST',
+    path: '/{reader}/process_payment_intent',
+  }),
+
+  processSetupIntent: stripeMethod({
+    method: 'POST',
+    path: '/{reader}/process_setup_intent',
+  }),
+
+  setReaderDisplay: stripeMethod({
+    method: 'POST',
+    path: '/{reader}/set_reader_display',
+  }),
 });

package/lib/resources/TestHelpers/Terminal/Readers.js

@@ -0,0 +1,15 @@
+// File generated from our OpenAPI spec
+
+'use strict';
+
+const StripeResource = require('../../../StripeResource');
+const stripeMethod = StripeResource.method;
+
+module.exports = StripeResource.extend({
+  path: 'test_helpers/terminal/readers',
+
+  presentPaymentMethod: stripeMethod({
+    method: 'POST',
+    path: '/{reader}/present_payment_method',
+  }),
+});

package/lib/resources.js

@@ -93,5 +93,8 @@ module.exports = {
   }),
   TestHelpers: resourceNamespace('testHelpers', {
     TestClocks: require('./resources/TestHelpers/TestClocks'),
+    Terminal: resourceNamespace('terminal', {
+      Readers: require('./resources/TestHelpers/Terminal/Readers'),
+    }),
   }),
 };

package/package.json

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

package/types/2020-08-27/Charges.d.ts

@@ -108,7 +108,7 @@ declare module 'stripe' {
       /**
        * ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.
        */
-      failure_balance_transaction?: string | Stripe.BalanceTransaction | null;
+      failure_balance_transaction: string | Stripe.BalanceTransaction | null;
 
       /**
        * Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes).
@@ -2136,7 +2136,10 @@ declare module 'stripe' {
       ): Promise<Stripe.Response<Stripe.Charge>>;
 
       /**
-       * Search for charges you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language)
+       * Search for charges you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
+       * Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
+       * conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
+       * to an hour behind during outages. Search functionality is not available to merchants in India.
        */
       search(
         params: ChargeSearchParams,

package/types/2020-08-27/Checkout/Sessions.d.ts

@@ -1310,7 +1310,7 @@ declare module 'stripe' {
               metadata?: Stripe.MetadataParam;
 
               /**
-               * The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions.
+               * The product's name, meant to be displayable to the customer.
                */
               name: string;
 

package/types/2020-08-27/Customers.d.ts

@@ -827,7 +827,10 @@ declare module 'stripe' {
       ): ApiListPromise<Stripe.PaymentMethod>;
 
       /**
-       * Search for customers you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language)
+       * Search for customers you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
+       * Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
+       * conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
+       * to an hour behind during outages. Search functionality is not available to merchants in India.
        */
       search(
         params: CustomerSearchParams,

package/types/2020-08-27/Invoices.d.ts

@@ -620,7 +620,7 @@ declare module 'stripe' {
           /**
            * If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
            */
-          us_bank_account?: PaymentMethodOptions.UsBankAccount | null;
+          us_bank_account: PaymentMethodOptions.UsBankAccount | null;
         }
 
         namespace PaymentMethodOptions {
@@ -2163,7 +2163,10 @@ declare module 'stripe' {
       ): Promise<Stripe.Response<Stripe.Invoice>>;
 
       /**
-       * Search for invoices you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language)
+       * Search for invoices you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
+       * Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
+       * conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
+       * to an hour behind during outages. Search functionality is not available to merchants in India.
        */
       search(
         params: InvoiceSearchParams,

package/types/2020-08-27/PaymentIntents.d.ts

@@ -577,7 +577,7 @@ declare module 'stripe' {
           /**
            * The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
            */
-          microdeposit_type?: VerifyWithMicrodeposits.MicrodepositType | null;
+          microdeposit_type: VerifyWithMicrodeposits.MicrodepositType | null;
         }
 
         namespace VerifyWithMicrodeposits {
@@ -5994,7 +5994,10 @@ declare module 'stripe' {
       ): Promise<Stripe.Response<Stripe.PaymentIntent>>;
 
       /**
-       * Search for PaymentIntents you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language)
+       * Search for PaymentIntents you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
+       * Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
+       * conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
+       * to an hour behind during outages. Search functionality is not available to merchants in India.
        */
       search(
         params: PaymentIntentSearchParams,

package/types/2020-08-27/Plans.d.ts

@@ -297,7 +297,7 @@ declare module 'stripe' {
         metadata?: Stripe.MetadataParam;
 
         /**
-         * The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions.
+         * The product's name, meant to be displayable to the customer.
          */
         name: string;
 

package/types/2020-08-27/Prices.d.ts

@@ -323,7 +323,7 @@ declare module 'stripe' {
         metadata?: Stripe.MetadataParam;
 
         /**
-         * The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions.
+         * The product's name, meant to be displayable to the customer.
          */
         name: string;
 
@@ -619,7 +619,10 @@ declare module 'stripe' {
       list(options?: RequestOptions): ApiListPromise<Stripe.Price>;
 
       /**
-       * Search for prices you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language)
+       * Search for prices you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
+       * Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
+       * conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
+       * to an hour behind during outages. Search functionality is not available to merchants in India.
        */
       search(
         params: PriceSearchParams,

package/types/2020-08-27/Products.d.ts

@@ -64,7 +64,7 @@ declare module 'stripe' {
       metadata: Stripe.Metadata;
 
       /**
-       * The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions.
+       * The product's name, meant to be displayable to the customer.
        */
       name: string;
 
@@ -157,7 +157,7 @@ declare module 'stripe' {
 
     interface ProductCreateParams {
       /**
-       * The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions.
+       * The product's name, meant to be displayable to the customer.
        */
       name: string;
 
@@ -320,7 +320,7 @@ declare module 'stripe' {
       metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
 
       /**
-       * The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions.
+       * The product's name, meant to be displayable to the customer.
        */
       name?: string;
 
@@ -503,7 +503,10 @@ declare module 'stripe' {
       ): Promise<Stripe.Response<Stripe.DeletedProduct>>;
 
       /**
-       * Search for products you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language)
+       * Search for products you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
+       * Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
+       * conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
+       * to an hour behind during outages. Search functionality is not available to merchants in India.
        */
       search(
         params: ProductSearchParams,

package/types/2020-08-27/SetupIntents.d.ts

@@ -271,7 +271,7 @@ declare module 'stripe' {
           /**
            * The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
            */
-          microdeposit_type?: VerifyWithMicrodeposits.MicrodepositType | null;
+          microdeposit_type: VerifyWithMicrodeposits.MicrodepositType | null;
         }
 
         namespace VerifyWithMicrodeposits {

package/types/2020-08-27/Subscriptions.d.ts

@@ -272,7 +272,7 @@ declare module 'stripe' {
           /**
            * This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.
            */
-          us_bank_account?: PaymentMethodOptions.UsBankAccount | null;
+          us_bank_account: PaymentMethodOptions.UsBankAccount | null;
         }
 
         namespace PaymentMethodOptions {
@@ -1705,7 +1705,10 @@ declare module 'stripe' {
       ): Promise<Stripe.Response<Stripe.DeletedDiscount>>;
 
       /**
-       * Search for subscriptions you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language)
+       * Search for subscriptions you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
+       * Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
+       * conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
+       * to an hour behind during outages. Search functionality is not available to merchants in India.
        */
       search(
         params: SubscriptionSearchParams,

package/types/2020-08-27/Terminal/Readers.d.ts

@@ -17,6 +17,11 @@ declare module 'stripe' {
          */
         object: 'terminal.reader';
 
+        /**
+         * The most recent action performed by the reader.
+         */
+        action?: Reader.Action | null;
+
         deleted?: void;
 
         /**
@@ -66,6 +71,123 @@ declare module 'stripe' {
       }
 
       namespace Reader {
+        interface Action {
+          /**
+           * Failure code, only set if status is `failed`.
+           */
+          failure_code: string | null;
+
+          /**
+           * Detailed failure message, only set if status is `failed`.
+           */
+          failure_message: string | null;
+
+          /**
+           * Represents a reader action to process a payment intent
+           */
+          process_payment_intent?: Action.ProcessPaymentIntent;
+
+          /**
+           * Represents a reader action to process a setup intent
+           */
+          process_setup_intent?: Action.ProcessSetupIntent;
+
+          /**
+           * Represents a reader action to set the reader display
+           */
+          set_reader_display?: Action.SetReaderDisplay;
+
+          /**
+           * Status of the action performed by the reader.
+           */
+          status: Action.Status;
+
+          /**
+           * Type of action performed by the reader.
+           */
+          type: Action.Type;
+        }
+
+        namespace Action {
+          interface ProcessPaymentIntent {
+            /**
+             * Most recent PaymentIntent processed by the reader.
+             */
+            payment_intent: string | Stripe.PaymentIntent;
+          }
+
+          interface ProcessSetupIntent {
+            generated_card?: string;
+
+            /**
+             * Most recent SetupIntent processed by the reader.
+             */
+            setup_intent: string | Stripe.SetupIntent;
+          }
+
+          interface SetReaderDisplay {
+            /**
+             * Cart object to be displayed by the reader.
+             */
+            cart: SetReaderDisplay.Cart | null;
+
+            /**
+             * Type of information to be displayed by the reader.
+             */
+            type: 'cart';
+          }
+
+          namespace SetReaderDisplay {
+            interface Cart {
+              /**
+               * 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;
+
+              /**
+               * List of line items in the cart.
+               */
+              line_items: Array<Cart.LineItem>;
+
+              /**
+               * Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
+               */
+              tax: number | null;
+
+              /**
+               * Total amount for the entire cart, including tax. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
+               */
+              total: number;
+            }
+
+            namespace Cart {
+              interface LineItem {
+                /**
+                 * The amount of the line item. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
+                 */
+                amount: number;
+
+                /**
+                 * Description of the line item.
+                 */
+                description: string;
+
+                /**
+                 * The quantity of the line item.
+                 */
+                quantity: number;
+              }
+            }
+          }
+
+          type Status = 'failed' | 'in_progress' | 'succeeded';
+
+          type Type =
+            | 'process_payment_intent'
+            | 'process_setup_intent'
+            | 'set_reader_display';
+        }
+
         type DeviceType =
           | 'bbpos_chipper2x'
           | 'bbpos_wisepad3'
@@ -180,6 +302,116 @@ declare module 'stripe' {
 
       interface ReaderDeleteParams {}
 
+      interface ReaderCancelActionParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface ReaderProcessPaymentIntentParams {
+        /**
+         * PaymentIntent ID
+         */
+        payment_intent: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Configuration overrides
+         */
+        process_config?: ReaderProcessPaymentIntentParams.ProcessConfig;
+      }
+
+      namespace ReaderProcessPaymentIntentParams {
+        interface ProcessConfig {
+          /**
+           * Override showing a tipping selection screen on this transaction.
+           */
+          skip_tipping?: boolean;
+        }
+      }
+
+      interface ReaderProcessSetupIntentParams {
+        /**
+         * Customer Consent Collected
+         */
+        customer_consent_collected: boolean;
+
+        /**
+         * SetupIntent ID
+         */
+        setup_intent: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface ReaderSetReaderDisplayParams {
+        /**
+         * Type
+         */
+        type: 'cart';
+
+        /**
+         * Cart
+         */
+        cart?: ReaderSetReaderDisplayParams.Cart;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      namespace ReaderSetReaderDisplayParams {
+        interface Cart {
+          /**
+           * 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;
+
+          /**
+           * Array of line items that were purchased.
+           */
+          line_items: Array<Cart.LineItem>;
+
+          /**
+           * The amount of tax in cents.
+           */
+          tax?: number;
+
+          /**
+           * Total balance of cart due in cents.
+           */
+          total: number;
+        }
+
+        namespace Cart {
+          interface LineItem {
+            /**
+             * The price of the item in cents.
+             */
+            amount: number;
+
+            /**
+             * The description or name of the item.
+             */
+            description: string;
+
+            /**
+             * The quantity of the line item being purchased.
+             */
+            quantity: number;
+          }
+        }
+      }
+
       class ReadersResource {
         /**
          * Creates a new Reader object.
@@ -244,6 +476,46 @@ declare module 'stripe' {
           id: string,
           options?: RequestOptions
         ): Promise<Stripe.Response<Stripe.Terminal.DeletedReader>>;
+
+        /**
+         * Cancels the current reader action
+         */
+        cancelAction(
+          id: string,
+          params?: ReaderCancelActionParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
+        cancelAction(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
+
+        /**
+         * Initiates a payment flow on a Reader
+         */
+        processPaymentIntent(
+          id: string,
+          params: ReaderProcessPaymentIntentParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
+
+        /**
+         * Initiates a setup intent flow on a Reader
+         */
+        processSetupIntent(
+          id: string,
+          params: ReaderProcessSetupIntentParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
+
+        /**
+         * Sets reader display
+         */
+        setReaderDisplay(
+          id: string,
+          params: ReaderSetReaderDisplayParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
       }
     }
   }

package/types/2020-08-27/TestHelpers/Terminal/Readers.d.ts

@@ -0,0 +1,52 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace TestHelpers {
+      namespace Terminal {
+        interface ReaderPresentPaymentMethodParams {
+          /**
+           * Simulated card present data
+           */
+          card_present?: ReaderPresentPaymentMethodParams.CardPresent;
+
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+
+          /**
+           * Simulated payment type
+           */
+          type?: 'card_present';
+        }
+
+        namespace ReaderPresentPaymentMethodParams {
+          interface CardPresent {
+            /**
+             * Card Number
+             */
+            number?: string;
+          }
+        }
+      }
+
+      namespace Terminal {
+        class ReadersResource {
+          /**
+           * Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction
+           */
+          presentPaymentMethod(
+            id: string,
+            params?: ReaderPresentPaymentMethodParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
+          presentPaymentMethod(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
+        }
+      }
+    }
+  }
+}

package/types/2020-08-27/index.d.ts

@@ -97,6 +97,7 @@
 ///<reference path='./Terminal/ConnectionTokens.d.ts' />
 ///<reference path='./Terminal/Locations.d.ts' />
 ///<reference path='./Terminal/Readers.d.ts' />
+///<reference path='./TestHelpers/Terminal/Readers.d.ts' />
 ///<reference path='./TestHelpers/TestClocks.d.ts' />
 ///<reference path='./Tokens.d.ts' />
 ///<reference path='./Topups.d.ts' />
@@ -213,6 +214,9 @@ declare module 'stripe' {
     };
     testHelpers: {
       testClocks: Stripe.TestHelpers.TestClocksResource;
+      terminal: {
+        readers: Stripe.TestHelpers.Terminal.ReadersResource;
+      };
     };
     /**
      * API Errors