stripe 15.0.0 → 15.1.0.pre.beta.2

data/lib/stripe/resources/terminal/reader.rb

@@ -18,6 +18,134 @@ module Stripe
       end
 
       class Action < Stripe::StripeObject
+        class CollectInputs < Stripe::StripeObject
+          class Input < Stripe::StripeObject
+            class CustomText < Stripe::StripeObject
+              # Customize the default description for this input
+              attr_reader :description
+              # Customize the default label for this input's skip button
+              attr_reader :skip_button
+              # Customize the default label for this input's submit button
+              attr_reader :submit_button
+              # Customize the default title for this input
+              attr_reader :title
+            end
+
+            class Email < Stripe::StripeObject
+              # The collected email address
+              attr_reader :value
+            end
+
+            class Numeric < Stripe::StripeObject
+              # The collected number
+              attr_reader :value
+            end
+
+            class Phone < Stripe::StripeObject
+              # The collected phone number
+              attr_reader :value
+            end
+
+            class Selection < Stripe::StripeObject
+              class Choice < Stripe::StripeObject
+                # The id to be selected
+                attr_reader :id
+                # The button style for the choice
+                attr_reader :style
+                # The text to be selected
+                attr_reader :text
+              end
+              # List of possible choices to be selected
+              attr_reader :choices
+              # The id of the selected choice
+              attr_reader :id
+              # The text of the selected choice
+              attr_reader :text
+            end
+
+            class Signature < Stripe::StripeObject
+              # The File ID of a collected signature image
+              attr_reader :value
+            end
+
+            class Text < Stripe::StripeObject
+              # The collected text value
+              attr_reader :value
+            end
+
+            class Toggle < Stripe::StripeObject
+              # The toggle's default value
+              attr_reader :default_value
+              # The toggle's description text
+              attr_reader :description
+              # The toggle's title text
+              attr_reader :title
+              # The toggle's collected value
+              attr_reader :value
+            end
+            # Default text of input being collected.
+            attr_reader :custom_text
+            # Information about a email being collected using a reader
+            attr_reader :email
+            # Information about a number being collected using a reader
+            attr_reader :numeric
+            # Information about a phone number being collected using a reader
+            attr_reader :phone
+            # Indicate that this input is required, disabling the skip button.
+            attr_reader :required
+            # Information about a selection being collected using a reader
+            attr_reader :selection
+            # Information about a signature being collected using a reader
+            attr_reader :signature
+            # Indicate that this input was skipped by the user.
+            attr_reader :skipped
+            # Information about text being collected using a reader
+            attr_reader :text
+            # List of toggles being collected. Values are present if collection is complete.
+            attr_reader :toggles
+            # Type of input being collected.
+            attr_reader :type
+          end
+          # List of inputs to be collected.
+          attr_reader :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.
+          attr_reader :metadata
+        end
+
+        class CollectPaymentMethod < Stripe::StripeObject
+          class CollectConfig < Stripe::StripeObject
+            class Tipping < Stripe::StripeObject
+              # 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_reader :amount_eligible
+            end
+            # Enable customer initiated cancellation when processing this payment.
+            attr_reader :enable_customer_cancellation
+            # Override showing a tipping selection screen on this transaction.
+            attr_reader :skip_tipping
+            # Represents a per-transaction tipping configuration
+            attr_reader :tipping
+          end
+          # Account the payment intent belongs to.
+          attr_reader :account
+          # Represents a per-transaction override of a reader configuration
+          attr_reader :collect_config
+          # Most recent PaymentIntent processed by the reader.
+          attr_reader :payment_intent
+          # 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).
+          attr_reader :payment_method
+        end
+
+        class ConfirmPaymentIntent < Stripe::StripeObject
+          # Account the payment intent belongs to.
+          attr_reader :account
+          # Most recent PaymentIntent processed by the reader.
+          attr_reader :payment_intent
+        end
+
         class ProcessPaymentIntent < Stripe::StripeObject
           class ProcessConfig < Stripe::StripeObject
             class Tipping < Stripe::StripeObject
@@ -31,6 +159,8 @@ module Stripe
             # Represents a per-transaction tipping configuration
             attr_reader :tipping
           end
+          # Account the payment intent belongs to.
+          attr_reader :account
           # Most recent PaymentIntent processed by the reader.
           attr_reader :payment_intent
           # Represents a per-transaction override of a reader configuration
@@ -55,6 +185,8 @@ module Stripe
             # Enable customer initiated cancellation when refunding this payment.
             attr_reader :enable_customer_cancellation
           end
+          # Account the payment intent belongs to.
+          attr_reader :account
           # The amount being refunded.
           attr_reader :amount
           # Charge that is being refunded.
@@ -99,6 +231,12 @@ module Stripe
           # Type of information to be displayed by the reader.
           attr_reader :type
         end
+        # Represents a reader action to collect customer inputs
+        attr_reader :collect_inputs
+        # Represents a reader action to collect a payment method
+        attr_reader :collect_payment_method
+        # Represents a reader action to confirm a payment
+        attr_reader :confirm_payment_intent
         # Failure code, only set if status is `failed`.
         attr_reader :failure_code
         # Detailed failure message, only set if status is `failed`.
@@ -210,6 +348,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
@@ -417,6 +702,27 @@ module Stripe
           @type = type
         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
       # The most recent action performed by the reader.
       attr_reader :action
       # The current software version of the reader.
@@ -464,6 +770,66 @@ module Stripe
         )
       end
 
+      # Initiates an input collection flow on a Reader.
+      def collect_inputs(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/collect_inputs", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Initiates an input collection flow on a Reader.
+      def self.collect_inputs(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/collect_inputs", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
+      def collect_payment_method(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/collect_payment_method", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
+      def self.collect_payment_method(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/collect_payment_method", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Finalizes a payment on a Reader.
+      def confirm_payment_intent(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/confirm_payment_intent", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Finalizes a payment on a Reader.
+      def self.confirm_payment_intent(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/confirm_payment_intent", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
       # Creates a new Reader object.
       def self.create(params = {}, opts = {})
         request_stripe_object(
@@ -623,6 +989,46 @@ module Stripe
             opts: opts
           )
         end
+
+        # Use this endpoint to trigger a successful input collection on a simulated reader.
+        def self.succeed_input_collection(reader, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/terminal/readers/%<reader>s/succeed_input_collection", { reader: CGI.escape(reader) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        # Use this endpoint to trigger a successful input collection on a simulated reader.
+        def succeed_input_collection(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/terminal/readers/%<reader>s/succeed_input_collection", { reader: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        # Use this endpoint to complete an input collection with a timeout error on a simulated reader.
+        def self.timeout_input_collection(reader, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/terminal/readers/%<reader>s/timeout_input_collection", { reader: CGI.escape(reader) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        # Use this endpoint to complete an input collection with a timeout error on a simulated reader.
+        def timeout_input_collection(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/terminal/readers/%<reader>s/timeout_input_collection", { reader: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
       end
     end
   end

data/lib/stripe/resources/terminal/reader_collected_data.rb

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    # Returns data collected by Terminal readers. This data is only stored for 24 hours.
+    class ReaderCollectedData < APIResource
+      OBJECT_NAME = "terminal.reader_collected_data"
+      def self.object_name
+        "terminal.reader_collected_data"
+      end
+
+      class Magstripe < Stripe::StripeObject
+        # The raw magstripe data collected by the reader.
+        attr_reader :data
+      end
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Unique identifier for the object.
+      attr_reader :id
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+      # The magstripe data collected by the reader.
+      attr_reader :magstripe
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The type of data collected by the reader.
+      attr_reader :type
+    end
+  end
+end

data/lib/stripe/resources/token.rb

@@ -164,6 +164,21 @@ module Stripe
             end
           end
 
+          class RegistrationDate < Stripe::RequestParams
+            # The day of registration, between 1 and 31.
+            attr_accessor :day
+            # The month of registration, between 1 and 12.
+            attr_accessor :month
+            # The four-digit year of registration.
+            attr_accessor :year
+
+            def initialize(day: nil, month: nil, year: nil)
+              @day = day
+              @month = month
+              @year = year
+            end
+          end
+
           class Verification < Stripe::RequestParams
             class Document < Stripe::RequestParams
               # The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
@@ -215,6 +230,8 @@ module Stripe
           attr_accessor :ownership_exemption_reason
           # The company's phone number (used for verification).
           attr_accessor :phone
+          # Attribute for param field registration_date
+          attr_accessor :registration_date
           # The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong).
           attr_accessor :registration_number
           # The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.
@@ -245,6 +262,7 @@ module Stripe
             ownership_declaration_shown_and_signed: nil,
             ownership_exemption_reason: nil,
             phone: nil,
+            registration_date: nil,
             registration_number: nil,
             structure: nil,
             tax_id: nil,
@@ -268,6 +286,7 @@ module Stripe
             @ownership_declaration_shown_and_signed = ownership_declaration_shown_and_signed
             @ownership_exemption_reason = ownership_exemption_reason
             @phone = phone
+            @registration_date = registration_date
             @registration_number = registration_number
             @structure = structure
             @tax_id = tax_id
@@ -971,6 +990,44 @@ module Stripe
           end
         end
 
+        class UsCfpbData < Stripe::RequestParams
+          class EthnicityDetails < Stripe::RequestParams
+            # The persons ethnicity
+            attr_accessor :ethnicity
+            # Please specify your origin, when other is selected.
+            attr_accessor :ethnicity_other
+
+            def initialize(ethnicity: nil, ethnicity_other: nil)
+              @ethnicity = ethnicity
+              @ethnicity_other = ethnicity_other
+            end
+          end
+
+          class RaceDetails < Stripe::RequestParams
+            # The persons race.
+            attr_accessor :race
+            # Please specify your race, when other is selected.
+            attr_accessor :race_other
+
+            def initialize(race: nil, race_other: nil)
+              @race = race
+              @race_other = race_other
+            end
+          end
+          # The persons ethnicity details
+          attr_accessor :ethnicity_details
+          # The persons race details
+          attr_accessor :race_details
+          # The persons self-identified gender
+          attr_accessor :self_identified_gender
+
+          def initialize(ethnicity_details: nil, race_details: nil, self_identified_gender: nil)
+            @ethnicity_details = ethnicity_details
+            @race_details = race_details
+            @self_identified_gender = self_identified_gender
+          end
+        end
+
         class Verification < Stripe::RequestParams
           class AdditionalDocument < Stripe::RequestParams
             # The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
@@ -1055,6 +1112,8 @@ module Stripe
         attr_accessor :relationship
         # The last four digits of the person's Social Security number (U.S. only).
         attr_accessor :ssn_last_4
+        # Demographic data related to the person.
+        attr_accessor :us_cfpb_data
         # The person's verification status.
         attr_accessor :verification
 
@@ -1084,6 +1143,7 @@ module Stripe
           registered_address: nil,
           relationship: nil,
           ssn_last_4: nil,
+          us_cfpb_data: nil,
           verification: nil
         )
           @additional_tos_acceptances = additional_tos_acceptances
@@ -1111,6 +1171,7 @@ module Stripe
           @registered_address = registered_address
           @relationship = relationship
           @ssn_last_4 = ssn_last_4
+          @us_cfpb_data = us_cfpb_data
           @verification = verification
         end
       end

data/lib/stripe/resources/transfer.rb

@@ -88,6 +88,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.
@@ -103,6 +105,7 @@ module Stripe
         description: nil,
         destination: nil,
         expand: nil,
+        fx_quote: nil,
         metadata: nil,
         source_transaction: nil,
         source_type: nil,
@@ -113,6 +116,7 @@ module Stripe
         @description = description
         @destination = destination
         @expand = expand
+        @fx_quote = fx_quote
         @metadata = metadata
         @source_transaction = source_transaction
         @source_type = source_type
@@ -150,6 +154,8 @@ module Stripe
     attr_reader :destination
     # If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.
     attr_reader :destination_payment
+    # The FX Quote used for the transfer.
+    attr_reader :fx_quote
     # Unique identifier for the object.
     attr_reader :id
     # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.