stripe 15.1.0 → 15.2.0.pre.beta.1

data/lib/stripe/services/tax/form_service.rb

@@ -0,0 +1,100 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    class FormService < StripeService
+      class ListParams < Stripe::RequestParams
+        class Payee < Stripe::RequestParams
+          # The ID of the Stripe account whose forms will be retrieved.
+          attr_accessor :account
+          # The external reference to the payee whose forms will be retrieved.
+          attr_accessor :external_reference
+          # Specifies the payee type. Either `account` or `external_reference`.
+          attr_accessor :type
+
+          def initialize(account: nil, external_reference: nil, type: nil)
+            @account = account
+            @external_reference = external_reference
+            @type = type
+          end
+        end
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # The payee whose volume is represented on the tax form.
+        attr_accessor :payee
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        attr_accessor :starting_after
+        # An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future tax form types. If your integration expects only one type of tax form in the response, make sure to provide a type value in the request.
+        attr_accessor :type
+
+        def initialize(
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          payee: nil,
+          starting_after: nil,
+          type: nil
+        )
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @payee = payee
+          @starting_after = starting_after
+          @type = type
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class PdfParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      # Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.
+      def list(params = {}, opts = {})
+        request(method: :get, path: "/v1/tax/forms", params: params, opts: opts, base_address: :api)
+      end
+
+      # Download the PDF for a tax form.
+      def pdf(id, params = {}, opts = {}, &read_body_chunk_block)
+        opts = { api_base: APIRequestor.active_requestor.config.uploads_base }.merge(opts)
+        request_stream(
+          method: :get,
+          path: format("/v1/tax/forms/%<id>s/pdf", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :files,
+          &read_body_chunk_block
+        )
+      end
+
+      # Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/tax/forms/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/tax_id_service.rb

@@ -21,12 +21,15 @@ module Stripe
         attr_accessor :account
         # Customer the tax ID belongs to. Required when `type=customer`
         attr_accessor :customer
+        # v2 Account the tax ID belongs to. Can be used in place of `customer` when `type=customer`
+        attr_accessor :customer_account
         # Type of owner referenced.
         attr_accessor :type
 
-        def initialize(account: nil, customer: nil, type: nil)
+        def initialize(account: nil, customer: nil, customer_account: nil, type: nil)
           @account = account
           @customer = customer
+          @customer_account = customer_account
           @type = type
         end
       end
@@ -56,12 +59,15 @@ module Stripe
         attr_accessor :account
         # Customer the tax ID belongs to. Required when `type=customer`
         attr_accessor :customer
+        # v2 Account the tax ID belongs to. Can be used in place of `customer` when `type=customer`
+        attr_accessor :customer_account
         # Type of owner referenced.
         attr_accessor :type
 
-        def initialize(account: nil, customer: nil, type: nil)
+        def initialize(account: nil, customer: nil, customer_account: nil, type: nil)
           @account = account
           @customer = customer
+          @customer_account = customer_account
           @type = type
         end
       end

data/lib/stripe/services/tax_service.rb

@@ -3,11 +3,13 @@
 
 module Stripe
   class TaxService < StripeService
-    attr_reader :calculations, :registrations, :settings, :transactions
+    attr_reader :associations, :calculations, :forms, :registrations, :settings, :transactions
 
     def initialize(requestor)
       super
+      @associations = Stripe::Tax::AssociationService.new(@requestor)
       @calculations = Stripe::Tax::CalculationService.new(@requestor)
+      @forms = Stripe::Tax::FormService.new(@requestor)
       @registrations = Stripe::Tax::RegistrationService.new(@requestor)
       @settings = Stripe::Tax::SettingsService.new(@requestor)
       @transactions = Stripe::Tax::TransactionService.new(@requestor)

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

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class ReaderCollectedDataService < StripeService
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      # Retrieve data collected using Reader hardware.
+      def retrieve(reader_collected_data, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/terminal/reader_collected_data/%<reader_collected_data>s", { reader_collected_data: CGI.escape(reader_collected_data) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

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

@@ -106,6 +106,153 @@ 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
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # PaymentIntent ID
+        attr_accessor :payment_intent
+
+        def initialize(expand: nil, payment_intent: nil)
+          @expand = expand
+          @payment_intent = payment_intent
+        end
+      end
+
       class ProcessPaymentIntentParams < Stripe::RequestParams
         class ProcessConfig < Stripe::RequestParams
           class Tipping < Stripe::RequestParams
@@ -281,6 +428,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

@@ -3,7 +3,7 @@
 
 module Stripe
   class TerminalService < StripeService
-    attr_reader :configurations, :connection_tokens, :locations, :readers
+    attr_reader :configurations, :connection_tokens, :locations, :readers, :reader_collected_data
 
     def initialize(requestor)
       super
@@ -11,6 +11,7 @@ module Stripe
       @connection_tokens = Stripe::Terminal::ConnectionTokenService.new(@requestor)
       @locations = Stripe::Terminal::LocationService.new(@requestor)
       @readers = Stripe::Terminal::ReaderService.new(@requestor)
+      @reader_collected_data = Stripe::Terminal::ReaderCollectedDataService.new(@requestor)
     end
   end
 end

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

@@ -159,9 +159,21 @@ module Stripe
           class Giropay < Stripe::RequestParams
           end
 
+          class Gopay < Stripe::RequestParams
+          end
+
           class Grabpay < Stripe::RequestParams
           end
 
+          class IdBankTransfer < Stripe::RequestParams
+            # Bank where the account is held.
+            attr_accessor :bank
+
+            def initialize(bank: nil)
+              @bank = bank
+            end
+          end
+
           class Ideal < Stripe::RequestParams
             # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
             attr_accessor :bank
@@ -209,6 +221,9 @@ module Stripe
           class Link < Stripe::RequestParams
           end
 
+          class MbWay < Stripe::RequestParams
+          end
+
           class Mobilepay < Stripe::RequestParams
           end
 
@@ -279,12 +294,30 @@ module Stripe
           class Paypal < Stripe::RequestParams
           end
 
+          class Payto < Stripe::RequestParams
+            # The account number for the bank account.
+            attr_accessor :account_number
+            # Bank-State-Branch number of the bank account.
+            attr_accessor :bsb_number
+            # The PayID alias for the bank account.
+            attr_accessor :pay_id
+
+            def initialize(account_number: nil, bsb_number: nil, pay_id: nil)
+              @account_number = account_number
+              @bsb_number = bsb_number
+              @pay_id = pay_id
+            end
+          end
+
           class Pix < Stripe::RequestParams
           end
 
           class Promptpay < Stripe::RequestParams
           end
 
+          class Qris < 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.
             attr_accessor :session
@@ -294,6 +327,29 @@ module Stripe
             end
           end
 
+          class Rechnung < Stripe::RequestParams
+            class Dob < Stripe::RequestParams
+              # The day of birth, between 1 and 31.
+              attr_accessor :day
+              # The month of birth, between 1 and 12.
+              attr_accessor :month
+              # The four-digit year of birth.
+              attr_accessor :year
+
+              def initialize(day: nil, month: nil, year: nil)
+                @day = day
+                @month = month
+                @year = year
+              end
+            end
+            # Customer's date of birth
+            attr_accessor :dob
+
+            def initialize(dob: nil)
+              @dob = dob
+            end
+          end
+
           class RevolutPay < Stripe::RequestParams
           end
 
@@ -312,6 +368,9 @@ module Stripe
             end
           end
 
+          class Shopeepay < Stripe::RequestParams
+          end
+
           class Sofort < Stripe::RequestParams
             # Two-letter ISO code representing the country the bank account is located in.
             attr_accessor :country
@@ -321,6 +380,18 @@ module Stripe
             end
           end
 
+          class StripeBalance < Stripe::RequestParams
+            # The connected account ID whose Stripe balance to use as the source of payment
+            attr_accessor :account
+            # The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
+            attr_accessor :source_type
+
+            def initialize(account: nil, source_type: nil)
+              @account = account
+              @source_type = source_type
+            end
+          end
+
           class Swish < Stripe::RequestParams
           end
 
@@ -397,8 +468,12 @@ module Stripe
           attr_accessor :fpx
           # If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
           attr_accessor :giropay
+          # If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
+          attr_accessor :gopay
           # If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
           attr_accessor :grabpay
+          # If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
+          attr_accessor :id_bank_transfer
           # If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
           attr_accessor :ideal
           # If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
@@ -413,6 +488,8 @@ module Stripe
           attr_accessor :kr_card
           # If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
           attr_accessor :link
+          # If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
+          attr_accessor :mb_way
           # 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
           # If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
@@ -435,12 +512,18 @@ module Stripe
           attr_accessor :paynow
           # If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
           attr_accessor :paypal
+          # If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
+          attr_accessor :payto
           # If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
           attr_accessor :pix
           # If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
           attr_accessor :promptpay
+          # If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
+          attr_accessor :qris
           # 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 `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
+          attr_accessor :rechnung
           # 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.
@@ -449,8 +532,12 @@ module Stripe
           attr_accessor :satispay
           # If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
           attr_accessor :sepa_debit
+          # If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
+          attr_accessor :shopeepay
           # If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
           attr_accessor :sofort
+          # This hash contains details about the Stripe balance payment method.
+          attr_accessor :stripe_balance
           # If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
           attr_accessor :swish
           # If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
@@ -484,7 +571,9 @@ module Stripe
             eps: nil,
             fpx: nil,
             giropay: nil,
+            gopay: nil,
             grabpay: nil,
+            id_bank_transfer: nil,
             ideal: nil,
             interac_present: nil,
             kakao_pay: nil,
@@ -492,6 +581,7 @@ module Stripe
             konbini: nil,
             kr_card: nil,
             link: nil,
+            mb_way: nil,
             metadata: nil,
             mobilepay: nil,
             multibanco: nil,
@@ -503,14 +593,19 @@ module Stripe
             payco: nil,
             paynow: nil,
             paypal: nil,
+            payto: nil,
             pix: nil,
             promptpay: nil,
+            qris: nil,
             radar_options: nil,
+            rechnung: nil,
             revolut_pay: nil,
             samsung_pay: nil,
             satispay: nil,
             sepa_debit: nil,
+            shopeepay: nil,
             sofort: nil,
+            stripe_balance: nil,
             swish: nil,
             twint: nil,
             type: nil,
@@ -537,7 +632,9 @@ module Stripe
             @eps = eps
             @fpx = fpx
             @giropay = giropay
+            @gopay = gopay
             @grabpay = grabpay
+            @id_bank_transfer = id_bank_transfer
             @ideal = ideal
             @interac_present = interac_present
             @kakao_pay = kakao_pay
@@ -545,6 +642,7 @@ module Stripe
             @konbini = konbini
             @kr_card = kr_card
             @link = link
+            @mb_way = mb_way
             @metadata = metadata
             @mobilepay = mobilepay
             @multibanco = multibanco
@@ -556,14 +654,19 @@ module Stripe
             @payco = payco
             @paynow = paynow
             @paypal = paypal
+            @payto = payto
             @pix = pix
             @promptpay = promptpay
+            @qris = qris
             @radar_options = radar_options
+            @rechnung = rechnung
             @revolut_pay = revolut_pay
             @samsung_pay = samsung_pay
             @satispay = satispay
             @sepa_debit = sepa_debit
+            @shopeepay = shopeepay
             @sofort = sofort
+            @stripe_balance = stripe_balance
             @swish = swish
             @twint = twint
             @type = type

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