stripe 18.1.0 → 18.2.0-beta.1

package/types/Terminal/Readers.d.ts

@@ -97,6 +97,21 @@ declare module 'stripe' {
 
       namespace Reader {
         interface Action {
+          /**
+           * Represents a reader action to collect customer inputs
+           */
+          collect_inputs?: Action.CollectInputs;
+
+          /**
+           * Represents a reader action to collect a payment method
+           */
+          collect_payment_method?: Action.CollectPaymentMethod;
+
+          /**
+           * Represents a reader action to confirm a payment
+           */
+          confirm_payment_intent?: Action.ConfirmPaymentIntent;
+
           /**
            * Failure code, only set if status is `failed`.
            */
@@ -139,7 +154,284 @@ declare module 'stripe' {
         }
 
         namespace Action {
+          interface CollectInputs {
+            /**
+             * List of inputs to be collected.
+             */
+            inputs: Array<CollectInputs.Input>;
+
+            /**
+             * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+             */
+            metadata: Stripe.Metadata | null;
+          }
+
+          namespace CollectInputs {
+            interface Input {
+              /**
+               * Default text of input being collected.
+               */
+              custom_text: Input.CustomText | null;
+
+              /**
+               * Information about a email being collected using a reader
+               */
+              email?: Input.Email;
+
+              /**
+               * Information about a number being collected using a reader
+               */
+              numeric?: Input.Numeric;
+
+              /**
+               * Information about a phone number being collected using a reader
+               */
+              phone?: Input.Phone;
+
+              /**
+               * Indicate that this input is required, disabling the skip button.
+               */
+              required: boolean | null;
+
+              /**
+               * Information about a selection being collected using a reader
+               */
+              selection?: Input.Selection;
+
+              /**
+               * Information about a signature being collected using a reader
+               */
+              signature?: Input.Signature;
+
+              /**
+               * Indicate that this input was skipped by the user.
+               */
+              skipped?: boolean;
+
+              /**
+               * Information about text being collected using a reader
+               */
+              text?: Input.Text;
+
+              /**
+               * List of toggles being collected. Values are present if collection is complete.
+               */
+              toggles: Array<Input.Toggle> | null;
+
+              /**
+               * Type of input being collected.
+               */
+              type: Input.Type;
+            }
+
+            namespace Input {
+              interface CustomText {
+                /**
+                 * Customize the default description for this input
+                 */
+                description: string | null;
+
+                /**
+                 * Customize the default label for this input's skip button
+                 */
+                skip_button: string | null;
+
+                /**
+                 * Customize the default label for this input's submit button
+                 */
+                submit_button: string | null;
+
+                /**
+                 * Customize the default title for this input
+                 */
+                title: string | null;
+              }
+
+              interface Email {
+                /**
+                 * The collected email address
+                 */
+                value: string | null;
+              }
+
+              interface Numeric {
+                /**
+                 * The collected number
+                 */
+                value: string | null;
+              }
+
+              interface Phone {
+                /**
+                 * The collected phone number
+                 */
+                value: string | null;
+              }
+
+              interface Selection {
+                /**
+                 * List of possible choices to be selected
+                 */
+                choices: Array<Selection.Choice>;
+
+                /**
+                 * The id of the selected choice
+                 */
+                id: string | null;
+
+                /**
+                 * The text of the selected choice
+                 */
+                text: string | null;
+              }
+
+              namespace Selection {
+                interface Choice {
+                  /**
+                   * The id to be selected
+                   */
+                  id: string | null;
+
+                  /**
+                   * The button style for the choice
+                   */
+                  style: Choice.Style | null;
+
+                  /**
+                   * The text to be selected
+                   */
+                  text: string;
+                }
+
+                namespace Choice {
+                  type Style = 'primary' | 'secondary';
+                }
+              }
+
+              interface Signature {
+                /**
+                 * The File ID of a collected signature image
+                 */
+                value: string | null;
+              }
+
+              interface Text {
+                /**
+                 * The collected text value
+                 */
+                value: string | null;
+              }
+
+              interface Toggle {
+                /**
+                 * The toggle's default value
+                 */
+                default_value: Toggle.DefaultValue | null;
+
+                /**
+                 * The toggle's description text
+                 */
+                description: string | null;
+
+                /**
+                 * The toggle's title text
+                 */
+                title: string | null;
+
+                /**
+                 * The toggle's collected value
+                 */
+                value: Toggle.Value | null;
+              }
+
+              namespace Toggle {
+                type DefaultValue = 'disabled' | 'enabled';
+
+                type Value = 'disabled' | 'enabled';
+              }
+
+              type Type =
+                | 'email'
+                | 'numeric'
+                | 'phone'
+                | 'selection'
+                | 'signature'
+                | 'text';
+            }
+          }
+
+          interface CollectPaymentMethod {
+            /**
+             * Account the payment intent belongs to.
+             */
+            account?: string;
+
+            /**
+             * Represents a per-transaction override of a reader configuration
+             */
+            collect_config?: CollectPaymentMethod.CollectConfig;
+
+            /**
+             * Most recent PaymentIntent processed by the reader.
+             */
+            payment_intent: string | Stripe.PaymentIntent;
+
+            /**
+             * PaymentMethod objects represent your customer's payment instruments.
+             * You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to
+             * Customer objects to store instrument details for future payments.
+             *
+             * Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
+             */
+            payment_method?: Stripe.PaymentMethod;
+          }
+
+          namespace CollectPaymentMethod {
+            interface CollectConfig {
+              /**
+               * Enable customer initiated cancellation when processing this payment.
+               */
+              enable_customer_cancellation?: boolean;
+
+              /**
+               * Override showing a tipping selection screen on this transaction.
+               */
+              skip_tipping?: boolean;
+
+              /**
+               * Represents a per-transaction tipping configuration
+               */
+              tipping?: CollectConfig.Tipping;
+            }
+
+            namespace CollectConfig {
+              interface Tipping {
+                /**
+                 * Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).
+                 */
+                amount_eligible?: number;
+              }
+            }
+          }
+
+          interface ConfirmPaymentIntent {
+            /**
+             * Account the payment intent belongs to.
+             */
+            account?: string;
+
+            /**
+             * Most recent PaymentIntent processed by the reader.
+             */
+            payment_intent: string | Stripe.PaymentIntent;
+          }
+
           interface ProcessPaymentIntent {
+            /**
+             * Account the payment intent belongs to.
+             */
+            account?: string;
+
             /**
              * Most recent PaymentIntent processed by the reader.
              */
@@ -206,6 +498,11 @@ declare module 'stripe' {
           }
 
           interface RefundPayment {
+            /**
+             * Account the payment intent belongs to.
+             */
+            account?: string;
+
             /**
              * The amount being refunded.
              */
@@ -321,6 +618,9 @@ declare module 'stripe' {
           type Status = 'failed' | 'in_progress' | 'succeeded';
 
           type Type =
+            | 'collect_inputs'
+            | 'collect_payment_method'
+            | 'confirm_payment_intent'
             | 'process_payment_intent'
             | 'process_setup_intent'
             | 'refund_payment'

package/types/Terminal/ReadersResource.d.ts

@@ -104,6 +104,199 @@ declare module 'stripe' {
         expand?: Array<string>;
       }
 
+      interface ReaderCollectInputsParams {
+        /**
+         * List of inputs to be collected using the Reader
+         */
+        inputs: Array<ReaderCollectInputsParams.Input>;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+         */
+        metadata?: Stripe.MetadataParam;
+      }
+
+      namespace ReaderCollectInputsParams {
+        interface Input {
+          /**
+           * Customize the text which will be displayed while collecting this input
+           */
+          custom_text: Input.CustomText;
+
+          /**
+           * Indicate that this input is required, disabling the skip button
+           */
+          required?: boolean;
+
+          /**
+           * Options for the `selection` input
+           */
+          selection?: Input.Selection;
+
+          /**
+           * List of toggles to be displayed and customization for the toggles
+           */
+          toggles?: Array<Input.Toggle>;
+
+          /**
+           * The type of input to collect
+           */
+          type: Input.Type;
+        }
+
+        namespace Input {
+          interface CustomText {
+            /**
+             * The description which will be displayed when collecting this input
+             */
+            description?: string;
+
+            /**
+             * The skip button text
+             */
+            skip_button?: string;
+
+            /**
+             * The submit button text
+             */
+            submit_button?: string;
+
+            /**
+             * The title which will be displayed when collecting this input
+             */
+            title: string;
+          }
+
+          interface Selection {
+            /**
+             * List of choices for the `selection` input
+             */
+            choices: Array<Selection.Choice>;
+          }
+
+          namespace Selection {
+            interface Choice {
+              /**
+               * The unique identifier for this choice
+               */
+              id: string;
+
+              /**
+               * The style of the button which will be shown for this choice
+               */
+              style?: Choice.Style;
+
+              /**
+               * The text which will be shown on the button for this choice
+               */
+              text: string;
+            }
+
+            namespace Choice {
+              type Style = 'primary' | 'secondary';
+            }
+          }
+
+          interface Toggle {
+            /**
+             * The default value of the toggle
+             */
+            default_value?: Toggle.DefaultValue;
+
+            /**
+             * The description which will be displayed for the toggle
+             */
+            description?: string;
+
+            /**
+             * The title which will be displayed for the toggle
+             */
+            title?: string;
+          }
+
+          namespace Toggle {
+            type DefaultValue = 'disabled' | 'enabled';
+          }
+
+          type Type =
+            | 'email'
+            | 'numeric'
+            | 'phone'
+            | 'selection'
+            | 'signature'
+            | 'text';
+        }
+      }
+
+      interface ReaderCollectPaymentMethodParams {
+        /**
+         * PaymentIntent ID
+         */
+        payment_intent: string;
+
+        /**
+         * Configuration overrides
+         */
+        collect_config?: ReaderCollectPaymentMethodParams.CollectConfig;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      namespace ReaderCollectPaymentMethodParams {
+        interface CollectConfig {
+          /**
+           * This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
+           */
+          allow_redisplay?: CollectConfig.AllowRedisplay;
+
+          /**
+           * Enables cancel button on transaction screens.
+           */
+          enable_customer_cancellation?: boolean;
+
+          /**
+           * Override showing a tipping selection screen on this transaction.
+           */
+          skip_tipping?: boolean;
+
+          /**
+           * Tipping configuration for this transaction.
+           */
+          tipping?: CollectConfig.Tipping;
+        }
+
+        namespace CollectConfig {
+          type AllowRedisplay = 'always' | 'limited' | 'unspecified';
+
+          interface Tipping {
+            /**
+             * Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).
+             */
+            amount_eligible?: number;
+          }
+        }
+      }
+
+      interface ReaderConfirmPaymentIntentParams {
+        /**
+         * PaymentIntent ID
+         */
+        payment_intent: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
       interface ReaderProcessPaymentIntentParams {
         /**
          * PaymentIntent ID
@@ -378,6 +571,33 @@ declare module 'stripe' {
           options?: RequestOptions
         ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
 
+        /**
+         * Initiates an input collection flow on a Reader.
+         */
+        collectInputs(
+          id: string,
+          params: ReaderCollectInputsParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
+
+        /**
+         * Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
+         */
+        collectPaymentMethod(
+          id: string,
+          params: ReaderCollectPaymentMethodParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
+
+        /**
+         * Finalizes a payment on a Reader.
+         */
+        confirmPaymentIntent(
+          id: string,
+          params: ReaderConfirmPaymentIntentParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
+
         /**
          * Initiates a payment flow on a Reader.
          */