stripe 19.2.0-alpha.4 → 19.2.0

package/types/Tax/Registrations.d.ts

@@ -234,6 +234,8 @@ declare module 'stripe' {
 
           tr?: CountryOptions.Tr;
 
+          tw?: CountryOptions.Tw;
+
           tz?: CountryOptions.Tz;
 
           ua?: CountryOptions.Ua;
@@ -1552,6 +1554,13 @@ declare module 'stripe' {
             type: 'simplified';
           }
 
+          interface Tw {
+            /**
+             * Type of registration in `country`.
+             */
+            type: 'simplified';
+          }
+
           interface Tz {
             /**
              * Type of registration in `country`.

package/types/Tax/RegistrationsResource.d.ts

@@ -477,6 +477,11 @@ declare module 'stripe' {
            */
           tr?: CountryOptions.Tr;
 
+          /**
+           * Options for the registration in TW.
+           */
+          tw?: CountryOptions.Tw;
+
           /**
            * Options for the registration in TZ.
            */
@@ -2275,6 +2280,13 @@ declare module 'stripe' {
             type: 'simplified';
           }
 
+          interface Tw {
+            /**
+             * Type of registration to be created in `country`.
+             */
+            type: 'simplified';
+          }
+
           interface Tz {
             /**
              * Type of registration to be created in `country`.

package/types/TaxIds.d.ts

@@ -54,11 +54,6 @@ declare module 'stripe' {
        */
       customer: string | Stripe.Customer | null;
 
-      /**
-       * ID of the account.
-       */
-      customer_account?: string | null;
-
       /**
        * Always true for a deleted object
        */
@@ -107,11 +102,6 @@ declare module 'stripe' {
          */
         customer?: string | Stripe.Customer;
 
-        /**
-         * The account being referenced when `type` is `customer`.
-         */
-        customer_account?: string | null;
-
         /**
          * Type of owner referenced.
          */

package/types/TaxIdsResource.d.ts

@@ -36,11 +36,6 @@ declare module 'stripe' {
          */
         customer?: string;
 
-        /**
-         * v2 Account the tax ID belongs to. Can be used in place of `customer` when `type=customer`
-         */
-        customer_account?: string;
-
         /**
          * Type of owner referenced.
          */
@@ -195,11 +190,6 @@ declare module 'stripe' {
          */
         customer?: string;
 
-        /**
-         * v2 Account the tax ID belongs to. Can be used in place of `customer` when `type=customer`
-         */
-        customer_account?: string;
-
         /**
          * Type of owner referenced.
          */

package/types/Terminal/Configurations.d.ts

@@ -44,8 +44,6 @@ declare module 'stripe' {
 
         offline?: Configuration.Offline;
 
-        reader_security?: Configuration.ReaderSecurity;
-
         reboot_window?: Configuration.RebootWindow;
 
         stripe_s700?: Configuration.StripeS700;
@@ -79,13 +77,6 @@ declare module 'stripe' {
           enabled: boolean | null;
         }
 
-        interface ReaderSecurity {
-          /**
-           * Passcode used to access a reader's admin menu.
-           */
-          admin_menu_passcode: string;
-        }
-
         interface RebootWindow {
           /**
            * Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.
@@ -124,6 +115,8 @@ declare module 'stripe' {
 
           gbp?: Tipping.Gbp;
 
+          gip?: Tipping.Gip;
+
           hkd?: Tipping.Hkd;
 
           huf?: Tipping.Huf;
@@ -303,6 +296,23 @@ declare module 'stripe' {
             smart_tip_threshold?: number;
           }
 
+          interface Gip {
+            /**
+             * Fixed amounts displayed when collecting a tip
+             */
+            fixed_amounts?: Array<number> | null;
+
+            /**
+             * Percentages displayed when collecting a tip
+             */
+            percentages?: Array<number> | null;
+
+            /**
+             * Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
+             */
+            smart_tip_threshold?: number;
+          }
+
           interface Hkd {
             /**
              * Fixed amounts displayed when collecting a tip

package/types/Terminal/ConfigurationsResource.d.ts

@@ -29,13 +29,6 @@ declare module 'stripe' {
          */
         offline?: Stripe.Emptyable<ConfigurationCreateParams.Offline>;
 
-        /**
-         * Configurations for reader security settings.
-         */
-        reader_security?: Stripe.Emptyable<
-          ConfigurationCreateParams.ReaderSecurity
-        >;
-
         /**
          * Reboot time settings for readers that support customized reboot time configuration.
          */
@@ -84,13 +77,6 @@ declare module 'stripe' {
           enabled: boolean;
         }
 
-        interface ReaderSecurity {
-          /**
-           * Passcode used to access a reader's admin menu.
-           */
-          admin_menu_passcode?: Stripe.Emptyable<string>;
-        }
-
         interface RebootWindow {
           /**
            * Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.
@@ -156,6 +142,11 @@ declare module 'stripe' {
            */
           gbp?: Tipping.Gbp;
 
+          /**
+           * Tipping configuration for GIP
+           */
+          gip?: Tipping.Gip;
+
           /**
            * Tipping configuration for HKD
            */
@@ -371,6 +362,23 @@ declare module 'stripe' {
             smart_tip_threshold?: number;
           }
 
+          interface Gip {
+            /**
+             * Fixed amounts displayed when collecting a tip
+             */
+            fixed_amounts?: Array<number>;
+
+            /**
+             * Percentages displayed when collecting a tip
+             */
+            percentages?: Array<number>;
+
+            /**
+             * Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
+             */
+            smart_tip_threshold?: number;
+          }
+
           interface Hkd {
             /**
              * Fixed amounts displayed when collecting a tip
@@ -711,13 +719,6 @@ declare module 'stripe' {
          */
         offline?: Stripe.Emptyable<ConfigurationUpdateParams.Offline>;
 
-        /**
-         * Configurations for reader security settings.
-         */
-        reader_security?: Stripe.Emptyable<
-          ConfigurationUpdateParams.ReaderSecurity
-        >;
-
         /**
          * Reboot time settings for readers that support customized reboot time configuration.
          */
@@ -770,13 +771,6 @@ declare module 'stripe' {
           enabled: boolean;
         }
 
-        interface ReaderSecurity {
-          /**
-           * Passcode used to access a reader's admin menu.
-           */
-          admin_menu_passcode?: Stripe.Emptyable<string>;
-        }
-
         interface RebootWindow {
           /**
            * Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.
@@ -842,6 +836,11 @@ declare module 'stripe' {
            */
           gbp?: Tipping.Gbp;
 
+          /**
+           * Tipping configuration for GIP
+           */
+          gip?: Tipping.Gip;
+
           /**
            * Tipping configuration for HKD
            */
@@ -1057,6 +1056,23 @@ declare module 'stripe' {
             smart_tip_threshold?: number;
           }
 
+          interface Gip {
+            /**
+             * Fixed amounts displayed when collecting a tip
+             */
+            fixed_amounts?: Array<number>;
+
+            /**
+             * Percentages displayed when collecting a tip
+             */
+            percentages?: Array<number>;
+
+            /**
+             * Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
+             */
+            smart_tip_threshold?: number;
+          }
+
           interface Hkd {
             /**
              * Fixed amounts displayed when collecting a tip

package/types/Terminal/Readers.d.ts

@@ -69,6 +69,11 @@ declare module 'stripe' {
          */
         label: string;
 
+        /**
+         * The last time this reader reported to Stripe backend.
+         */
+        last_seen_at: number | null;
+
         /**
          * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          */
@@ -288,17 +293,17 @@ declare module 'stripe' {
               namespace Selection {
                 interface Choice {
                   /**
-                   * The id to be selected
+                   * The identifier for the selected choice. Maximum 50 characters.
                    */
                   id: string | null;
 
                   /**
-                   * The button style for the choice
+                   * The button style for the choice. Can be `primary` or `secondary`.
                    */
                   style: Choice.Style | null;
 
                   /**
-                   * The text to be selected
+                   * The text to be selected. Maximum 30 characters.
                    */
                   text: string;
                 }
@@ -324,22 +329,22 @@ declare module 'stripe' {
 
               interface Toggle {
                 /**
-                 * The toggle's default value
+                 * The toggle's default value. Can be `enabled` or `disabled`.
                  */
                 default_value: Toggle.DefaultValue | null;
 
                 /**
-                 * The toggle's description text
+                 * The toggle's description text. Maximum 50 characters.
                  */
                 description: string | null;
 
                 /**
-                 * The toggle's title text
+                 * The toggle's title text. Maximum 50 characters.
                  */
                 title: string | null;
 
                 /**
-                 * The toggle's collected value
+                 * The toggle's collected value. Can be `enabled` or `disabled`.
                  */
                 value: Toggle.Value | null;
               }
@@ -361,11 +366,6 @@ declare module 'stripe' {
           }
 
           interface CollectPaymentMethod {
-            /**
-             * Account the payment intent belongs to.
-             */
-            account?: string;
-
             /**
              * Represents a per-transaction override of a reader configuration
              */
@@ -415,11 +415,6 @@ declare module 'stripe' {
           }
 
           interface ConfirmPaymentIntent {
-            /**
-             * Account the payment intent belongs to.
-             */
-            account?: string;
-
             /**
              * Represents a per-transaction override of a reader configuration
              */
@@ -441,11 +436,6 @@ declare module 'stripe' {
           }
 
           interface ProcessPaymentIntent {
-            /**
-             * Account the payment intent belongs to.
-             */
-            account?: string;
-
             /**
              * Most recent PaymentIntent processed by the reader.
              */
@@ -517,11 +507,6 @@ declare module 'stripe' {
           }
 
           interface RefundPayment {
-            /**
-             * Account the payment intent belongs to.
-             */
-            account?: string;
-
             /**
              * The amount being refunded.
              */
@@ -581,12 +566,12 @@ declare module 'stripe' {
 
           interface SetReaderDisplay {
             /**
-             * Cart object to be displayed by the reader.
+             * Cart object to be displayed by the reader, including line items, amounts, and currency.
              */
             cart: SetReaderDisplay.Cart | null;
 
             /**
-             * Type of information to be displayed by the reader.
+             * Type of information to be displayed by the reader. Only `cart` is currently supported.
              */
             type: 'cart';
           }

package/types/Terminal/ReadersResource.d.ts

@@ -107,7 +107,7 @@ declare module 'stripe' {
 
       interface ReaderCollectInputsParams {
         /**
-         * List of inputs to be collected using the Reader
+         * List of inputs to be collected from the customer using the Reader. Maximum 5 inputs.
          */
         inputs: Array<ReaderCollectInputsParams.Input>;
 
@@ -158,12 +158,12 @@ declare module 'stripe' {
             description?: string;
 
             /**
-             * The skip button text
+             * Custom text for the skip button. Maximum 14 characters.
              */
             skip_button?: string;
 
             /**
-             * The submit button text
+             * Custom text for the submit button. Maximum 30 characters.
              */
             submit_button?: string;
 
@@ -188,7 +188,7 @@ declare module 'stripe' {
               id: string;
 
               /**
-               * The style of the button which will be shown for this choice
+               * The style of the button which will be shown for this choice. Can be `primary` or `secondary`.
                */
               style?: Choice.Style;
 
@@ -205,17 +205,17 @@ declare module 'stripe' {
 
           interface Toggle {
             /**
-             * The default value of the toggle
+             * The default value of the toggle. Can be `enabled` or `disabled`.
              */
             default_value?: Toggle.DefaultValue;
 
             /**
-             * The description which will be displayed for the toggle
+             * The description which will be displayed for the toggle. Maximum 50 characters. At least one of title or description must be provided.
              */
             description?: string;
 
             /**
-             * The title which will be displayed for the toggle
+             * The title which will be displayed for the toggle. Maximum 50 characters. At least one of title or description must be provided.
              */
             title?: string;
           }
@@ -236,12 +236,12 @@ declare module 'stripe' {
 
       interface ReaderCollectPaymentMethodParams {
         /**
-         * PaymentIntent ID.
+         * The ID of the PaymentIntent to collect a payment method for.
          */
         payment_intent: string;
 
         /**
-         * Configuration overrides.
+         * Configuration overrides for this collection, such as tipping, surcharging, and customer cancellation settings.
          */
         collect_config?: ReaderCollectPaymentMethodParams.CollectConfig;
 
@@ -288,12 +288,12 @@ declare module 'stripe' {
 
       interface ReaderConfirmPaymentIntentParams {
         /**
-         * PaymentIntent ID.
+         * The ID of the PaymentIntent to confirm.
          */
         payment_intent: string;
 
         /**
-         * Configuration overrides.
+         * Configuration overrides for this confirmation, such as surcharge settings and return URL.
          */
         confirm_config?: ReaderConfirmPaymentIntentParams.ConfirmConfig;
 
@@ -314,7 +314,7 @@ declare module 'stripe' {
 
       interface ReaderProcessPaymentIntentParams {
         /**
-         * PaymentIntent ID
+         * The ID of the PaymentIntent to process on the reader.
          */
         payment_intent: string;
 
@@ -324,7 +324,7 @@ declare module 'stripe' {
         expand?: Array<string>;
 
         /**
-         * Configuration overrides
+         * Configuration overrides for this transaction, such as tipping and customer cancellation settings.
          */
         process_config?: ReaderProcessPaymentIntentParams.ProcessConfig;
       }
@@ -376,7 +376,7 @@ declare module 'stripe' {
         allow_redisplay: ReaderProcessSetupIntentParams.AllowRedisplay;
 
         /**
-         * SetupIntent ID
+         * The ID of the SetupIntent to process on the reader.
          */
         setup_intent: string;
 
@@ -386,7 +386,7 @@ declare module 'stripe' {
         expand?: Array<string>;
 
         /**
-         * Configuration overrides
+         * Configuration overrides for this setup, such as MOTO and customer cancellation settings.
          */
         process_config?: ReaderProcessSetupIntentParams.ProcessConfig;
       }
@@ -434,7 +434,7 @@ declare module 'stripe' {
         refund_application_fee?: boolean;
 
         /**
-         * Configuration overrides
+         * Configuration overrides for this refund, such as customer cancellation settings.
          */
         refund_payment_config?: ReaderRefundPaymentParams.RefundPaymentConfig;
 
@@ -455,12 +455,12 @@ declare module 'stripe' {
 
       interface ReaderSetReaderDisplayParams {
         /**
-         * Type
+         * Type of information to display. Only `cart` is currently supported.
          */
         type: 'cart';
 
         /**
-         * Cart
+         * Cart details to display on the reader screen, including line items, amounts, and currency.
          */
         cart?: ReaderSetReaderDisplayParams.Cart;
 
@@ -478,17 +478,17 @@ declare module 'stripe' {
           currency: string;
 
           /**
-           * Array of line items that were purchased.
+           * Array of line items to display.
            */
           line_items: Array<Cart.LineItem>;
 
           /**
-           * The amount of tax in cents.
+           * The amount of tax in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
            */
           tax?: number;
 
           /**
-           * Total balance of cart due in cents.
+           * Total balance of cart due in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
            */
           total: number;
         }
@@ -496,7 +496,7 @@ declare module 'stripe' {
         namespace Cart {
           interface LineItem {
             /**
-             * The price of the item in cents.
+             * The price of the item in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
              */
             amount: number;
 
@@ -579,7 +579,7 @@ declare module 'stripe' {
         ): Promise<Stripe.Response<Stripe.Terminal.DeletedReader>>;
 
         /**
-         * Cancels the current reader action.
+         * Cancels the current reader action. See [Programmatic Cancellation](https://docs.stripe.com/docs/terminal/payments/collect-card-payment?terminal-sdk-platform=server-driven#programmatic-cancellation) for more details.
          */
         cancelAction(
           id: string,
@@ -592,7 +592,7 @@ declare module 'stripe' {
         ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
 
         /**
-         * Initiates an input collection flow on a Reader.
+         * Initiates an [input collection flow](https://docs.stripe.com/docs/terminal/features/collect-inputs) on a Reader to display input forms and collect information from your customers.
          */
         collectInputs(
           id: string,
@@ -601,7 +601,7 @@ declare module 'stripe' {
         ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
 
         /**
-         * Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
+         * Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation. See [Collecting a Payment method](https://docs.stripe.com/docs/terminal/payments/collect-card-payment?terminal-sdk-platform=server-driven&process=inspect#collect-a-paymentmethod) for more details.
          */
         collectPaymentMethod(
           id: string,
@@ -610,7 +610,7 @@ declare module 'stripe' {
         ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
 
         /**
-         * Finalizes a payment on a Reader.
+         * Finalizes a payment on a Reader. See [Confirming a Payment](https://docs.stripe.com/docs/terminal/payments/collect-card-payment?terminal-sdk-platform=server-driven&process=inspect#confirm-the-paymentintent) for more details.
          */
         confirmPaymentIntent(
           id: string,
@@ -619,7 +619,7 @@ declare module 'stripe' {
         ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
 
         /**
-         * Initiates a payment flow on a Reader.
+         * Initiates a payment flow on a Reader. See [process the payment](https://docs.stripe.com/docs/terminal/payments/collect-card-payment?terminal-sdk-platform=server-driven&process=immediately#process-payment) for more details.
          */
         processPaymentIntent(
           id: string,
@@ -628,7 +628,7 @@ declare module 'stripe' {
         ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
 
         /**
-         * Initiates a setup intent flow on a Reader.
+         * Initiates a SetupIntent flow on a Reader. See [Save directly without charging](https://docs.stripe.com/docs/terminal/features/saving-payment-details/save-directly) for more details.
          */
         processSetupIntent(
           id: string,
@@ -637,7 +637,7 @@ declare module 'stripe' {
         ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
 
         /**
-         * Initiates a refund on a Reader
+         * Initiates an in-person refund on a Reader. See [Refund an Interac Payment](https://docs.stripe.com/docs/terminal/payments/regional?integration-country=CA#refund-an-interac-payment) for more details.
          */
         refundPayment(
           id: string,
@@ -650,7 +650,7 @@ declare module 'stripe' {
         ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
 
         /**
-         * Sets reader display to show cart details.
+         * Sets the reader display to show [cart details](https://docs.stripe.com/docs/terminal/features/display).
          */
         setReaderDisplay(
           id: string,