stripe 15.0.0 → 15.3.0

data/lib/stripe/services/terminal/reader_service.rb

@@ -4,8 +4,7 @@
 module Stripe
   module Terminal
     class ReaderService < StripeService
-      class DeleteParams < Stripe::RequestParams
-      end
+      class DeleteParams < Stripe::RequestParams; end
 
       class RetrieveParams < Stripe::RequestParams
         # Specifies which fields in the response should be expanded.
@@ -106,6 +105,164 @@ module Stripe
         end
       end
 
+      class CollectInputsParams < Stripe::RequestParams
+        class Input < Stripe::RequestParams
+          class CustomText < Stripe::RequestParams
+            # The description which will be displayed when collecting this input
+            attr_accessor :description
+            # The skip button text
+            attr_accessor :skip_button
+            # The submit button text
+            attr_accessor :submit_button
+            # The title which will be displayed when collecting this input
+            attr_accessor :title
+
+            def initialize(description: nil, skip_button: nil, submit_button: nil, title: nil)
+              @description = description
+              @skip_button = skip_button
+              @submit_button = submit_button
+              @title = title
+            end
+          end
+
+          class Selection < Stripe::RequestParams
+            class Choice < Stripe::RequestParams
+              # The unique identifier for this choice
+              attr_accessor :id
+              # The style of the button which will be shown for this choice
+              attr_accessor :style
+              # The text which will be shown on the button for this choice
+              attr_accessor :text
+
+              def initialize(id: nil, style: nil, text: nil)
+                @id = id
+                @style = style
+                @text = text
+              end
+            end
+            # List of choices for the `selection` input
+            attr_accessor :choices
+
+            def initialize(choices: nil)
+              @choices = choices
+            end
+          end
+
+          class Toggle < Stripe::RequestParams
+            # The default value of the toggle
+            attr_accessor :default_value
+            # The description which will be displayed for the toggle
+            attr_accessor :description
+            # The title which will be displayed for the toggle
+            attr_accessor :title
+
+            def initialize(default_value: nil, description: nil, title: nil)
+              @default_value = default_value
+              @description = description
+              @title = title
+            end
+          end
+          # Customize the text which will be displayed while collecting this input
+          attr_accessor :custom_text
+          # Indicate that this input is required, disabling the skip button
+          attr_accessor :required
+          # Options for the `selection` input
+          attr_accessor :selection
+          # List of toggles to be displayed and customization for the toggles
+          attr_accessor :toggles
+          # The type of input to collect
+          attr_accessor :type
+
+          def initialize(custom_text: nil, required: nil, selection: nil, toggles: nil, type: nil)
+            @custom_text = custom_text
+            @required = required
+            @selection = selection
+            @toggles = toggles
+            @type = type
+          end
+        end
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # List of inputs to be collected using the Reader
+        attr_accessor :inputs
+        # 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`.
+        attr_accessor :metadata
+
+        def initialize(expand: nil, inputs: nil, metadata: nil)
+          @expand = expand
+          @inputs = inputs
+          @metadata = metadata
+        end
+      end
+
+      class CollectPaymentMethodParams < Stripe::RequestParams
+        class CollectConfig < Stripe::RequestParams
+          class Tipping < Stripe::RequestParams
+            # 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).
+            attr_accessor :amount_eligible
+
+            def initialize(amount_eligible: nil)
+              @amount_eligible = amount_eligible
+            end
+          end
+          # 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.
+          attr_accessor :allow_redisplay
+          # Enables cancel button on transaction screens.
+          attr_accessor :enable_customer_cancellation
+          # Override showing a tipping selection screen on this transaction.
+          attr_accessor :skip_tipping
+          # Tipping configuration for this transaction.
+          attr_accessor :tipping
+
+          def initialize(
+            allow_redisplay: nil,
+            enable_customer_cancellation: nil,
+            skip_tipping: nil,
+            tipping: nil
+          )
+            @allow_redisplay = allow_redisplay
+            @enable_customer_cancellation = enable_customer_cancellation
+            @skip_tipping = skip_tipping
+            @tipping = tipping
+          end
+        end
+        # Configuration overrides.
+        attr_accessor :collect_config
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # PaymentIntent ID.
+        attr_accessor :payment_intent
+
+        def initialize(collect_config: nil, expand: nil, payment_intent: nil)
+          @collect_config = collect_config
+          @expand = expand
+          @payment_intent = payment_intent
+        end
+      end
+
+      class ConfirmPaymentIntentParams < Stripe::RequestParams
+        class ConfirmConfig < Stripe::RequestParams
+          # The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
+          attr_accessor :return_url
+
+          def initialize(return_url: nil)
+            @return_url = return_url
+          end
+        end
+        # Configuration overrides.
+        attr_accessor :confirm_config
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # PaymentIntent ID.
+        attr_accessor :payment_intent
+
+        def initialize(confirm_config: nil, expand: nil, payment_intent: nil)
+          @confirm_config = confirm_config
+          @expand = expand
+          @payment_intent = payment_intent
+        end
+      end
+
       class ProcessPaymentIntentParams < Stripe::RequestParams
         class ProcessConfig < Stripe::RequestParams
           class Tipping < Stripe::RequestParams
@@ -120,6 +277,8 @@ module Stripe
           attr_accessor :allow_redisplay
           # Enables cancel button on transaction screens.
           attr_accessor :enable_customer_cancellation
+          # The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
+          attr_accessor :return_url
           # Override showing a tipping selection screen on this transaction.
           attr_accessor :skip_tipping
           # Tipping configuration for this transaction.
@@ -128,11 +287,13 @@ module Stripe
           def initialize(
             allow_redisplay: nil,
             enable_customer_cancellation: nil,
+            return_url: nil,
             skip_tipping: nil,
             tipping: nil
           )
             @allow_redisplay = allow_redisplay
             @enable_customer_cancellation = enable_customer_cancellation
+            @return_url = return_url
             @skip_tipping = skip_tipping
             @tipping = tipping
           end
@@ -281,6 +442,39 @@ module Stripe
         )
       end
 
+      # Initiates an input collection flow on a Reader.
+      def collect_inputs(reader, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/collect_inputs", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
+      def collect_payment_method(reader, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/collect_payment_method", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Finalizes a payment on a Reader.
+      def confirm_payment_intent(reader, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/confirm_payment_intent", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
       # Creates a new Reader object.
       def create(params = {}, opts = {})
         request(

data/lib/stripe/services/terminal_service.rb

@@ -6,7 +6,7 @@ module Stripe
     attr_reader :configurations, :connection_tokens, :locations, :readers
 
     def initialize(requestor)
-      super(requestor)
+      super
       @configurations = Stripe::Terminal::ConfigurationService.new(@requestor)
       @connection_tokens = Stripe::Terminal::ConnectionTokenService.new(@requestor)
       @locations = Stripe::Terminal::LocationService.new(@requestor)

data/lib/stripe/services/test_helpers/confirmation_token_service.rb

@@ -21,20 +21,11 @@ module Stripe
             end
           end
 
-          class Affirm < Stripe::RequestParams
-          end
-
-          class AfterpayClearpay < Stripe::RequestParams
-          end
-
-          class Alipay < Stripe::RequestParams
-          end
-
-          class Alma < Stripe::RequestParams
-          end
-
-          class AmazonPay < Stripe::RequestParams
-          end
+          class Affirm < Stripe::RequestParams; end
+          class AfterpayClearpay < Stripe::RequestParams; end
+          class Alipay < Stripe::RequestParams; end
+          class Alma < Stripe::RequestParams; end
+          class AmazonPay < Stripe::RequestParams; end
 
           class AuBecsDebit < Stripe::RequestParams
             # The account number for the bank account.
@@ -60,11 +51,8 @@ module Stripe
             end
           end
 
-          class Bancontact < Stripe::RequestParams
-          end
-
-          class Billie < Stripe::RequestParams
-          end
+          class Bancontact < Stripe::RequestParams; end
+          class Billie < Stripe::RequestParams; end
 
           class BillingDetails < Stripe::RequestParams
             class Address < Stripe::RequestParams
@@ -105,17 +93,19 @@ module Stripe
             attr_accessor :name
             # Billing phone number (including extension).
             attr_accessor :phone
+            # Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
+            attr_accessor :tax_id
 
-            def initialize(address: nil, email: nil, name: nil, phone: nil)
+            def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil)
               @address = address
               @email = email
               @name = name
               @phone = phone
+              @tax_id = tax_id
             end
           end
 
-          class Blik < Stripe::RequestParams
-          end
+          class Blik < Stripe::RequestParams; end
 
           class Boleto < Stripe::RequestParams
             # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
@@ -126,11 +116,9 @@ module Stripe
             end
           end
 
-          class Cashapp < Stripe::RequestParams
-          end
-
-          class CustomerBalance < Stripe::RequestParams
-          end
+          class Cashapp < Stripe::RequestParams; end
+          class Crypto < Stripe::RequestParams; end
+          class CustomerBalance < Stripe::RequestParams; end
 
           class Eps < Stripe::RequestParams
             # The customer's bank.
@@ -153,11 +141,8 @@ module Stripe
             end
           end
 
-          class Giropay < Stripe::RequestParams
-          end
-
-          class Grabpay < Stripe::RequestParams
-          end
+          class Giropay < Stripe::RequestParams; end
+          class Grabpay < Stripe::RequestParams; end
 
           class Ideal < Stripe::RequestParams
             # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
@@ -168,11 +153,8 @@ module Stripe
             end
           end
 
-          class InteracPresent < Stripe::RequestParams
-          end
-
-          class KakaoPay < Stripe::RequestParams
-          end
+          class InteracPresent < Stripe::RequestParams; end
+          class KakaoPay < Stripe::RequestParams; end
 
           class Klarna < Stripe::RequestParams
             class Dob < Stripe::RequestParams
@@ -197,20 +179,11 @@ module Stripe
             end
           end
 
-          class Konbini < Stripe::RequestParams
-          end
-
-          class KrCard < Stripe::RequestParams
-          end
-
-          class Link < Stripe::RequestParams
-          end
-
-          class Mobilepay < Stripe::RequestParams
-          end
-
-          class Multibanco < Stripe::RequestParams
-          end
+          class Konbini < Stripe::RequestParams; end
+          class KrCard < Stripe::RequestParams; end
+          class Link < Stripe::RequestParams; end
+          class Mobilepay < Stripe::RequestParams; end
+          class Multibanco < Stripe::RequestParams; end
 
           class NaverPay < Stripe::RequestParams
             # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
@@ -252,8 +225,7 @@ module Stripe
             end
           end
 
-          class Oxxo < Stripe::RequestParams
-          end
+          class Oxxo < Stripe::RequestParams; end
 
           class P24 < Stripe::RequestParams
             # The customer's bank.
@@ -264,23 +236,12 @@ module Stripe
             end
           end
 
-          class PayByBank < Stripe::RequestParams
-          end
-
-          class Payco < Stripe::RequestParams
-          end
-
-          class Paynow < Stripe::RequestParams
-          end
-
-          class Paypal < Stripe::RequestParams
-          end
-
-          class Pix < Stripe::RequestParams
-          end
-
-          class Promptpay < Stripe::RequestParams
-          end
+          class PayByBank < Stripe::RequestParams; end
+          class Payco < Stripe::RequestParams; end
+          class Paynow < Stripe::RequestParams; end
+          class Paypal < Stripe::RequestParams; end
+          class Pix < Stripe::RequestParams; end
+          class Promptpay < Stripe::RequestParams; end
 
           class RadarOptions < Stripe::RequestParams
             # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
@@ -291,14 +252,9 @@ module Stripe
             end
           end
 
-          class RevolutPay < Stripe::RequestParams
-          end
-
-          class SamsungPay < Stripe::RequestParams
-          end
-
-          class Satispay < Stripe::RequestParams
-          end
+          class RevolutPay < Stripe::RequestParams; end
+          class SamsungPay < Stripe::RequestParams; end
+          class Satispay < Stripe::RequestParams; end
 
           class SepaDebit < Stripe::RequestParams
             # IBAN of the bank account.
@@ -318,11 +274,8 @@ module Stripe
             end
           end
 
-          class Swish < Stripe::RequestParams
-          end
-
-          class Twint < Stripe::RequestParams
-          end
+          class Swish < Stripe::RequestParams; end
+          class Twint < Stripe::RequestParams; end
 
           class UsBankAccount < Stripe::RequestParams
             # Account holder type: individual or company.
@@ -351,11 +304,8 @@ module Stripe
             end
           end
 
-          class WechatPay < Stripe::RequestParams
-          end
-
-          class Zip < Stripe::RequestParams
-          end
+          class WechatPay < Stripe::RequestParams; end
+          class Zip < Stripe::RequestParams; end
           # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
           attr_accessor :acss_debit
           # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
@@ -376,7 +326,7 @@ module Stripe
           attr_accessor :bacs_debit
           # If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
           attr_accessor :bancontact
-          # If this is a `billie` PaymentMethod, this hash contains details about the billie payment method.
+          # If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
           attr_accessor :billie
           # Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
           attr_accessor :billing_details
@@ -386,6 +336,8 @@ module Stripe
           attr_accessor :boleto
           # If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
           attr_accessor :cashapp
+          # If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
+          attr_accessor :crypto
           # If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
           attr_accessor :customer_balance
           # If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
@@ -438,11 +390,11 @@ module Stripe
           attr_accessor :promptpay
           # Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
           attr_accessor :radar_options
-          # If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
+          # If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
           attr_accessor :revolut_pay
           # If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
           attr_accessor :samsung_pay
-          # If this is a `satispay` PaymentMethod, this hash contains details about the satispay payment method.
+          # If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
           attr_accessor :satispay
           # If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
           attr_accessor :sepa_debit
@@ -477,6 +429,7 @@ module Stripe
             blik: nil,
             boleto: nil,
             cashapp: nil,
+            crypto: nil,
             customer_balance: nil,
             eps: nil,
             fpx: nil,
@@ -530,6 +483,7 @@ module Stripe
             @blik = blik
             @boleto = boleto
             @cashapp = cashapp
+            @crypto = crypto
             @customer_balance = customer_balance
             @eps = eps
             @fpx = fpx
@@ -570,6 +524,47 @@ module Stripe
           end
         end
 
+        class PaymentMethodOptions < Stripe::RequestParams
+          class Card < Stripe::RequestParams
+            class Installments < Stripe::RequestParams
+              class Plan < Stripe::RequestParams
+                # For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
+                attr_accessor :count
+                # For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
+                # One of `month`.
+                attr_accessor :interval
+                # Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.
+                attr_accessor :type
+
+                def initialize(count: nil, interval: nil, type: nil)
+                  @count = count
+                  @interval = interval
+                  @type = type
+                end
+              end
+              # The selected installment plan to use for this payment attempt.
+              # This parameter can only be provided during confirmation.
+              attr_accessor :plan
+
+              def initialize(plan: nil)
+                @plan = plan
+              end
+            end
+            # Installment configuration for payments confirmed using this ConfirmationToken.
+            attr_accessor :installments
+
+            def initialize(installments: nil)
+              @installments = installments
+            end
+          end
+          # Configuration for any card payments confirmed using this ConfirmationToken.
+          attr_accessor :card
+
+          def initialize(card: nil)
+            @card = card
+          end
+        end
+
         class Shipping < Stripe::RequestParams
           class Address < Stripe::RequestParams
             # City, district, suburb, town, or village.
@@ -620,6 +615,8 @@ module Stripe
         attr_accessor :payment_method
         # If provided, this hash will be used to create a PaymentMethod.
         attr_accessor :payment_method_data
+        # Payment-method-specific configuration for this ConfirmationToken.
+        attr_accessor :payment_method_options
         # Return URL used to confirm the Intent.
         attr_accessor :return_url
         # Indicates that you intend to make future payments with this ConfirmationToken's payment method.
@@ -633,6 +630,7 @@ module Stripe
           expand: nil,
           payment_method: nil,
           payment_method_data: nil,
+          payment_method_options: nil,
           return_url: nil,
           setup_future_usage: nil,
           shipping: nil
@@ -640,6 +638,7 @@ module Stripe
           @expand = expand
           @payment_method = payment_method
           @payment_method_data = payment_method_data
+          @payment_method_options = payment_method_options
           @return_url = return_url
           @setup_future_usage = setup_future_usage
           @shipping = shipping

data/lib/stripe/services/test_helpers/issuing_service.rb

@@ -7,7 +7,7 @@ module Stripe
       attr_reader :authorizations, :cards, :personalization_designs, :transactions
 
       def initialize(requestor)
-        super(requestor)
+        super
         @authorizations = Stripe::TestHelpers::Issuing::AuthorizationService.new(@requestor)
         @cards = Stripe::TestHelpers::Issuing::CardService.new(@requestor)
         @personalization_designs = Stripe::TestHelpers::Issuing::PersonalizationDesignService

data/lib/stripe/services/test_helpers/terminal/reader_service.rb

@@ -49,6 +49,27 @@ module Stripe
           end
         end
 
+        class SucceedInputCollectionParams < Stripe::RequestParams
+          # Specifies which fields in the response should be expanded.
+          attr_accessor :expand
+          # This parameter defines the skip behavior for input collection.
+          attr_accessor :skip_non_required_inputs
+
+          def initialize(expand: nil, skip_non_required_inputs: nil)
+            @expand = expand
+            @skip_non_required_inputs = skip_non_required_inputs
+          end
+        end
+
+        class TimeoutInputCollectionParams < Stripe::RequestParams
+          # Specifies which fields in the response should be expanded.
+          attr_accessor :expand
+
+          def initialize(expand: nil)
+            @expand = expand
+          end
+        end
+
         # Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.
         def present_payment_method(reader, params = {}, opts = {})
           request(
@@ -59,6 +80,28 @@ module Stripe
             base_address: :api
           )
         end
+
+        # Use this endpoint to trigger a successful input collection on a simulated reader.
+        def succeed_input_collection(reader, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/terminal/readers/%<reader>s/succeed_input_collection", { reader: CGI.escape(reader) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Use this endpoint to complete an input collection with a timeout error on a simulated reader.
+        def timeout_input_collection(reader, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/terminal/readers/%<reader>s/timeout_input_collection", { reader: CGI.escape(reader) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
       end
     end
   end

data/lib/stripe/services/test_helpers/terminal_service.rb

@@ -7,7 +7,7 @@ module Stripe
       attr_reader :readers
 
       def initialize(requestor)
-        super(requestor)
+        super
         @readers = Stripe::TestHelpers::Terminal::ReaderService.new(@requestor)
       end
     end

data/lib/stripe/services/test_helpers/test_clock_service.rb

@@ -4,8 +4,7 @@
 module Stripe
   module TestHelpers
     class TestClockService < StripeService
-      class DeleteParams < Stripe::RequestParams
-      end
+      class DeleteParams < Stripe::RequestParams; end
 
       class RetrieveParams < Stripe::RequestParams
         # Specifies which fields in the response should be expanded.

data/lib/stripe/services/test_helpers/treasury_service.rb

@@ -7,7 +7,7 @@ module Stripe
       attr_reader :inbound_transfers, :outbound_payments, :outbound_transfers, :received_credits, :received_debits
 
       def initialize(requestor)
-        super(requestor)
+        super
         @inbound_transfers = Stripe::TestHelpers::Treasury::InboundTransferService.new(@requestor)
         @outbound_payments = Stripe::TestHelpers::Treasury::OutboundPaymentService.new(@requestor)
         @outbound_transfers = Stripe::TestHelpers::Treasury::OutboundTransferService.new(@requestor)

data/lib/stripe/services/test_helpers_service.rb

@@ -6,7 +6,7 @@ module Stripe
     attr_reader :confirmation_tokens, :customers, :issuing, :refunds, :terminal, :test_clocks, :treasury
 
     def initialize(requestor)
-      super(requestor)
+      super
       @confirmation_tokens = Stripe::TestHelpers::ConfirmationTokenService.new(@requestor)
       @customers = Stripe::TestHelpers::CustomerService.new(@requestor)
       @issuing = Stripe::TestHelpers::IssuingService.new(@requestor)