stripe 15.4.0 → 15.5.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

@@ -20,12 +20,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
@@ -55,12 +58,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/onboarding_link_service.rb

@@ -0,0 +1,56 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class OnboardingLinkService < StripeService
+      class CreateParams < Stripe::RequestParams
+        class LinkOptions < Stripe::RequestParams
+          class AppleTermsAndConditions < Stripe::RequestParams
+            # Whether the link should also support users relinking their Apple account.
+            attr_accessor :allow_relinking
+            # The business name of the merchant accepting Apple's Terms and Conditions.
+            attr_accessor :merchant_display_name
+
+            def initialize(allow_relinking: nil, merchant_display_name: nil)
+              @allow_relinking = allow_relinking
+              @merchant_display_name = merchant_display_name
+            end
+          end
+          # The options associated with the Apple Terms and Conditions link type.
+          attr_accessor :apple_terms_and_conditions
+
+          def initialize(apple_terms_and_conditions: nil)
+            @apple_terms_and_conditions = apple_terms_and_conditions
+          end
+        end
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # Specific fields needed to generate the desired link type.
+        attr_accessor :link_options
+        # The type of link being generated.
+        attr_accessor :link_type
+        # Stripe account ID to generate the link for.
+        attr_accessor :on_behalf_of
+
+        def initialize(expand: nil, link_options: nil, link_type: nil, on_behalf_of: nil)
+          @expand = expand
+          @link_options = link_options
+          @link_type = link_type
+          @on_behalf_of = on_behalf_of
+        end
+      end
+
+      # Creates a new OnboardingLink object that contains a redirect_url used for onboarding onto Tap to Pay on iPhone.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/terminal/onboarding_links",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

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_service.rb

@@ -3,14 +3,16 @@
 
 module Stripe
   class TerminalService < StripeService
-    attr_reader :configurations, :connection_tokens, :locations, :readers
+    attr_reader :configurations, :connection_tokens, :locations, :onboarding_links, :readers, :reader_collected_data
 
     def initialize(requestor)
       super
       @configurations = Stripe::Terminal::ConfigurationService.new(@requestor)
       @connection_tokens = Stripe::Terminal::ConnectionTokenService.new(@requestor)
       @locations = Stripe::Terminal::LocationService.new(@requestor)
+      @onboarding_links = Stripe::Terminal::OnboardingLinkService.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

@@ -142,8 +142,18 @@ module Stripe
           end
 
           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
@@ -182,6 +192,7 @@ module Stripe
           class Konbini < Stripe::RequestParams; end
           class KrCard < Stripe::RequestParams; end
           class Link < Stripe::RequestParams; end
+          class MbWay < Stripe::RequestParams; end
           class Mobilepay < Stripe::RequestParams; end
           class Multibanco < Stripe::RequestParams; end
 
@@ -240,8 +251,25 @@ module Stripe
           class Payco < Stripe::RequestParams; end
           class Paynow < Stripe::RequestParams; end
           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.
@@ -252,6 +280,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
           class SamsungPay < Stripe::RequestParams; end
           class Satispay < Stripe::RequestParams; end
@@ -265,6 +316,8 @@ 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
@@ -274,6 +327,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
           class Twint < Stripe::RequestParams; end
 
@@ -346,8 +411,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.
@@ -362,6 +431,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.
@@ -384,12 +455,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.
@@ -398,8 +475,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.
@@ -434,7 +515,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,
@@ -442,6 +525,7 @@ module Stripe
             konbini: nil,
             kr_card: nil,
             link: nil,
+            mb_way: nil,
             metadata: nil,
             mobilepay: nil,
             multibanco: nil,
@@ -453,14 +537,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,
@@ -488,7 +577,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
@@ -496,6 +587,7 @@ module Stripe
             @konbini = konbini
             @kr_card = kr_card
             @link = link
+            @mb_way = mb_way
             @metadata = metadata
             @mobilepay = mobilepay
             @multibanco = multibanco
@@ -507,14 +599,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/treasury/received_credit_service.rb

@@ -31,6 +31,26 @@ module Stripe
               @us_bank_account = us_bank_account
             end
           end
+
+          class NetworkDetails < Stripe::RequestParams
+            class Ach < Stripe::RequestParams
+              # ACH Addenda record
+              attr_accessor :addenda
+
+              def initialize(addenda: nil)
+                @addenda = addenda
+              end
+            end
+            # Optional fields for `ach`.
+            attr_accessor :ach
+            # The type of flow that originated the ReceivedCredit.
+            attr_accessor :type
+
+            def initialize(ach: nil, type: nil)
+              @ach = ach
+              @type = type
+            end
+          end
           # Amount (in cents) to be transferred.
           attr_accessor :amount
           # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
@@ -45,6 +65,8 @@ module Stripe
           attr_accessor :initiating_payment_method_details
           # Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
           attr_accessor :network
+          # Details about the network used for the ReceivedCredit.
+          attr_accessor :network_details
 
           def initialize(
             amount: nil,
@@ -53,7 +75,8 @@ module Stripe
             expand: nil,
             financial_account: nil,
             initiating_payment_method_details: nil,
-            network: nil
+            network: nil,
+            network_details: nil
           )
             @amount = amount
             @currency = currency
@@ -62,6 +85,7 @@ module Stripe
             @financial_account = financial_account
             @initiating_payment_method_details = initiating_payment_method_details
             @network = network
+            @network_details = network_details
           end
         end
 

data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb

@@ -31,6 +31,26 @@ module Stripe
               @us_bank_account = us_bank_account
             end
           end
+
+          class NetworkDetails < Stripe::RequestParams
+            class Ach < Stripe::RequestParams
+              # Addenda record data associated with this ReceivedDebit.
+              attr_accessor :addenda
+
+              def initialize(addenda: nil)
+                @addenda = addenda
+              end
+            end
+            # Optional fields for `ach`.
+            attr_accessor :ach
+            # The type of flow that originated the ReceivedDebit.
+            attr_accessor :type
+
+            def initialize(ach: nil, type: nil)
+              @ach = ach
+              @type = type
+            end
+          end
           # Amount (in cents) to be transferred.
           attr_accessor :amount
           # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
@@ -45,6 +65,8 @@ module Stripe
           attr_accessor :initiating_payment_method_details
           # Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
           attr_accessor :network
+          # Details about the network used for the ReceivedDebit.
+          attr_accessor :network_details
 
           def initialize(
             amount: nil,
@@ -53,7 +75,8 @@ module Stripe
             expand: nil,
             financial_account: nil,
             initiating_payment_method_details: nil,
-            network: nil
+            network: nil,
+            network_details: nil
           )
             @amount = amount
             @currency = currency
@@ -62,6 +85,7 @@ module Stripe
             @financial_account = financial_account
             @initiating_payment_method_details = initiating_payment_method_details
             @network = network
+            @network_details = network_details
           end
         end
 

data/lib/stripe/services/transfer_service.rb

@@ -73,6 +73,8 @@ module Stripe
       attr_accessor :destination
       # Specifies which fields in the response should be expanded.
       attr_accessor :expand
+      # The FX rate in the quote is validated and used to convert the transfer amount to the destination currency.
+      attr_accessor :fx_quote
       # 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
       # You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-availability) for details.
@@ -88,6 +90,7 @@ module Stripe
         description: nil,
         destination: nil,
         expand: nil,
+        fx_quote: nil,
         metadata: nil,
         source_transaction: nil,
         source_type: nil,
@@ -98,6 +101,7 @@ module Stripe
         @description = description
         @destination = destination
         @expand = expand
+        @fx_quote = fx_quote
         @metadata = metadata
         @source_transaction = source_transaction
         @source_type = source_type

data/lib/stripe/services/treasury/financial_account_features_service.rb

@@ -25,10 +25,13 @@ module Stripe
 
         class FinancialAddresses < Stripe::RequestParams
           class Aba < Stripe::RequestParams
+            # Requested bank partner
+            attr_accessor :bank
             # Whether the FinancialAccount should have the Feature.
             attr_accessor :requested
 
-            def initialize(requested: nil)
+            def initialize(bank: nil, requested: nil)
+              @bank = bank
               @requested = requested
             end
           end