stripe 19.2.0 → 19.3.0.pre.alpha.2

data/lib/stripe/resources/financial_connections/session.rb

@@ -36,6 +36,8 @@ module Stripe
         attr_reader :account_subcategories
         # List of countries from which to filter accounts.
         attr_reader :countries
+        # Stripe ID of the institution with which the customer should be directed to log in.
+        attr_reader :institution
 
         def self.inner_class_types
           @inner_class_types = {}
@@ -45,6 +47,101 @@ module Stripe
           @field_remappings = {}
         end
       end
+
+      class Hosted < ::Stripe::StripeObject
+        # How the user enters the hosted flow. You can only use the values `email` and `url` if you provide `relink_options`.
+        attr_reader :delivery_method
+        # The URL to redirect your customer back to after they link their accounts or cancel this Session. This parameter is required if `ui_mode` is `hosted`.
+        attr_reader :return_url
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Limits < ::Stripe::StripeObject
+        # The number of accounts that can be linked in this Session.
+        attr_reader :accounts
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class ManualEntry < ::Stripe::StripeObject
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class RelinkOptions < ::Stripe::StripeObject
+        # Requires the end user to repair this specific account during the authentication flow instead of connecting a different one.
+        attr_reader :account
+        # The authorization to relink in the Session.
+        attr_reader :authorization
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class RelinkResult < ::Stripe::StripeObject
+        # The account relinked in the Session. Only present if `relink_options[account]` is set and relink is successful.
+        attr_reader :account
+        # The authorization relinked in the Session. Only present if relink is successful.
+        attr_reader :authorization
+        # Reason for why relink failed. One of `no_authorization`, `no_account`, or `other`.
+        attr_reader :failure_reason
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class StatusDetails < ::Stripe::StripeObject
+        class Cancelled < ::Stripe::StripeObject
+          # The reason for the Session being cancelled.
+          attr_reader :reason
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field cancelled
+        attr_reader :cancelled
+
+        def self.inner_class_types
+          @inner_class_types = { cancelled: Cancelled }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
       # The account holder for whom accounts are collected in this session.
       attr_reader :account_holder
       # The accounts that were collected as part of this Session.
@@ -53,18 +150,36 @@ module Stripe
       attr_reader :client_secret
       # Attribute for field filters
       attr_reader :filters
+      # Settings for the Hosted UI mode.
+      attr_reader :hosted
       # Unique identifier for the object.
       attr_reader :id
+      # Attribute for field limits
+      attr_reader :limits
       # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
       attr_reader :livemode
+      # Attribute for field manual_entry
+      attr_reader :manual_entry
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
       # Permissions requested for accounts collected during this session.
       attr_reader :permissions
       # Data features requested to be retrieved upon account creation.
       attr_reader :prefetch
+      # Attribute for field relink_options
+      attr_reader :relink_options
+      # Attribute for field relink_result
+      attr_reader :relink_result
       # For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
       attr_reader :return_url
+      # The current state of the session.
+      attr_reader :status
+      # Attribute for field status_details
+      attr_reader :status_details
+      # The UI mode for this session.
+      attr_reader :ui_mode
+      # The hosted URL for this Session. Redirect customers to this URL to take them to the hosted authentication flow. This value is only present when the Session is active and the `ui_mode` is `hosted`.
+      attr_reader :url
 
       # To launch the Financial Connections authorization flow, create a Session. The session's client_secret can be used to launch the flow using Stripe.js.
       def self.create(params = {}, opts = {})
@@ -77,7 +192,16 @@ module Stripe
       end
 
       def self.inner_class_types
-        @inner_class_types = { account_holder: AccountHolder, filters: Filters }
+        @inner_class_types = {
+          account_holder: AccountHolder,
+          filters: Filters,
+          hosted: Hosted,
+          limits: Limits,
+          manual_entry: ManualEntry,
+          relink_options: RelinkOptions,
+          relink_result: RelinkResult,
+          status_details: StatusDetails,
+        }
       end
 
       def self.field_remappings

data/lib/stripe/resources/fr_meal_vouchers_onboarding.rb

@@ -0,0 +1,153 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # The `French Meal Vouchers Onboarding` resource encapsulates the onboarding status and other related information
+  # for a single restaurant (SIRET number) in the context of the French Meal Vouchers program.
+  #
+  # To onboard a restaurant for the French Meal Vouchers program, you create a `French Meal Vouchers Onboarding` object.
+  # You can retrieve individual objects, list all such objects, or update objects to correct the postal code of the restaurant.
+  # We identify `French Meal Vouchers Onboarding` objects with a unique, random ID.
+  #
+  # Related guide: [Set up a restaurant for titres-restaurant payments](https://docs.stripe.com/payments/meal-vouchers/fr-meal-vouchers/set-up-restaurant)
+  class FrMealVouchersOnboarding < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "fr_meal_vouchers_onboarding"
+    def self.object_name
+      "fr_meal_vouchers_onboarding"
+    end
+
+    class Providers < ::Stripe::StripeObject
+      class Conecs < ::Stripe::StripeObject
+        class Issuers < ::Stripe::StripeObject
+          # Issuers are available to this restaurant via Conecs, will be blank if the onboarding to Conecs is not complete or unsuccessful
+          attr_reader :available
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Requirements < ::Stripe::StripeObject
+          class Error < ::Stripe::StripeObject
+            # The code for the type of error.
+            attr_reader :code
+            # An informative message that provides additional details about the error.
+            attr_reader :message
+            # The specific onboarding requirement field (in the requirements hash) that needs to be resolved.
+            attr_reader :requirement
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Information any errors that are preventing the onboarding to Conecs from being completed.
+          attr_reader :errors
+          # Fields that need to be provided to complete the onboarding to Conecs.
+          attr_reader :past_due
+
+          def self.inner_class_types
+            @inner_class_types = { errors: Error }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # This represents information which issuers are available to this restaurant via Conecs
+        attr_reader :issuers
+        # This represents information about outstanding requirements for this restaurant to onboard to Conecs
+        attr_reader :requirements
+        # Status of the restaurant's onboarding to Conecs
+        attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = { issuers: Issuers, requirements: Requirements }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # This represents the onboarding state of the restaurant on Conecs.
+      attr_reader :conecs
+
+      def self.inner_class_types
+        @inner_class_types = { conecs: Conecs }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # Unique identifier for the object.
+    attr_reader :id
+    # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+    attr_reader :livemode
+    # Set of [key-value pairs](https://docs.stripe.com/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
+    # Name of the restaurant.
+    attr_reader :name
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Postal code of the restaurant.
+    attr_reader :postal_code
+    # This represents the onboarding state of the restaurant on different providers.
+    attr_reader :providers
+    # SIRET number associated with the restaurant.
+    attr_reader :siret
+
+    # Creates a French Meal Vouchers Onboarding object that represents a restaurant's onboarding status and starts the onboarding process.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: "/v1/fr_meal_vouchers_onboardings",
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Lists French Meal Vouchers Onboarding objects. The objects are returned in sorted order, with the most recently created objects appearing first.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: "/v1/fr_meal_vouchers_onboardings",
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Updates the details of a restaurant's French Meal Vouchers Onboarding object by
+    # setting the values of the parameters passed. Any parameters not provided are left unchanged.
+    # After you update the object, the onboarding process automatically restarts.
+    #
+    # You can only update French Meal Vouchers Onboarding objects with the postal_code field requirement in past_due.
+    def self.update(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/fr_meal_vouchers_onboardings/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.inner_class_types
+      @inner_class_types = { providers: Providers }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end

data/lib/stripe/resources/fx_quote.rb

@@ -0,0 +1,147 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # The FX Quotes API provides three functions:
+  # - View Stripe's current exchange rate for any given currency pair.
+  # - Extend quoted rates for a 1-hour period or a 24-hour period, minimizing uncertainty from FX fluctuations.
+  # - Preview the FX fees Stripe will charge on your FX transaction, allowing you to anticipate specific settlement amounts before payment costs.
+  #
+  # [View the docs](https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api)
+  class FxQuote < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "fx_quote"
+    def self.object_name
+      "fx_quote"
+    end
+
+    class Rates < ::Stripe::StripeObject
+      class RateDetails < ::Stripe::StripeObject
+        # The rate for the currency pair.
+        attr_reader :base_rate
+        # The fee for locking the conversion rates.
+        attr_reader :duration_premium
+        # The FX fee for the currency pair.
+        attr_reader :fx_fee_rate
+        # A reference rate for the currency pair provided by the reference rate provider.
+        attr_reader :reference_rate
+        # The reference rate provider.
+        attr_reader :reference_rate_provider
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The rate that includes the FX fee rate.
+      attr_reader :exchange_rate
+      # Attribute for field rate_details
+      attr_reader :rate_details
+
+      def self.inner_class_types
+        @inner_class_types = { rate_details: RateDetails }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Usage < ::Stripe::StripeObject
+      class Payment < ::Stripe::StripeObject
+        # The Stripe account ID that the funds will be transferred to.
+        #
+        # This field should match the account ID that would be used in the PaymentIntent’s transfer_data[destination] field.
+        attr_reader :destination
+        # The Stripe account ID that these funds are intended for.
+        #
+        # This field must match the account ID that would be used in the PaymentIntent’s on_behalf_of field.
+        attr_reader :on_behalf_of
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Transfer < ::Stripe::StripeObject
+        # The Stripe account ID that the funds will be transferred to.
+        #
+        # This field should match the account ID that would be used in the Transfer’s destination field.
+        attr_reader :destination
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The details required to use an FX Quote for a payment
+      attr_reader :payment
+      # The details required to use an FX Quote for a transfer
+      attr_reader :transfer
+      # The transaction type for which the FX Quote will be used.
+      #
+      # Can be 'payment' or 'transfer'.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = { payment: Payment, transfer: Transfer }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # Time at which the quote was created, measured in seconds since the Unix epoch.
+    attr_reader :created
+    # Unique identifier for the object.
+    attr_reader :id
+    # The duration the exchange rate quote remains valid from creation time. Allowed values are none, hour, and day. Note that for the test mode API available in alpha, you can request an extended quote, but it won't be usable for any transactions.
+    attr_reader :lock_duration
+    # Time at which the quote will expire, measured in seconds since the Unix epoch.
+    #
+    # If lock_duration is set to ‘none’ this field will be set to null.
+    attr_reader :lock_expires_at
+    # Lock status of the quote. Transitions from active to expired once past the lock_expires_at timestamp.
+    #
+    # Can return value none, active, or expired.
+    attr_reader :lock_status
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Information about the rates.
+    attr_reader :rates
+    # The currency to convert into, typically this is the currency that you want to settle to your Stripe balance. Three-letter ISO currency code, in lowercase. Must be a supported currency.
+    attr_reader :to_currency
+    # Attribute for field usage
+    attr_reader :usage
+
+    # Creates an FX Quote object
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/fx_quotes", params: params, opts: opts)
+    end
+
+    # Returns a list of FX quotes that have been issued. The FX quotes are returned in sorted order, with the most recent FX quotes appearing first.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/fx_quotes", params: params, opts: opts)
+    end
+
+    def self.inner_class_types
+      @inner_class_types = { rates: Rates, usage: Usage }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end

data/lib/stripe/resources/identity/blocklist_entry.rb

@@ -0,0 +1,116 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    # A BlocklistEntry represents an entry in our identity verification blocklist.
+    # It helps prevent fraudulent users from repeatedly attempting verification with similar information.
+    # When you create a BlocklistEntry, we store data from a specified VerificationReport,
+    # such as document details or facial biometrics.
+    # This allows us to compare future verification attempts against these entries.
+    # If a match is found, we categorize the new verification as unverified.
+    #
+    # To learn more, see [Identity Verification Blocklist](https://docs.stripe.com/identity/review-tools#block-list)
+    class BlocklistEntry < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "identity.blocklist_entry"
+      def self.object_name
+        "identity.blocklist_entry"
+      end
+
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Time at which you disabled the BlocklistEntry. Measured in seconds since the Unix epoch.
+      attr_reader :disabled_at
+      # Time at which the BlocklistEntry expires. Measured in seconds since the Unix epoch.
+      attr_reader :expires_at
+      # Unique identifier for the object.
+      attr_reader :id
+      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The current status of the BlocklistEntry.
+      attr_reader :status
+      # The type of BlocklistEntry.
+      attr_reader :type
+      # The verification report the BlocklistEntry was created from.
+      attr_reader :verification_report
+      # The verification session the BlocklistEntry was created from.
+      attr_reader :verification_session
+
+      # Creates a BlocklistEntry object from a verification report.
+      #
+      # A blocklist entry prevents future identity verifications that match the same identity information.
+      # You can create blocklist entries from verification reports that contain document extracted data
+      # or a selfie.
+      #
+      # Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#add-a-blocklist-entry)
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/identity/blocklist_entries",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Disables a BlocklistEntry object.
+      #
+      # After a BlocklistEntry is disabled, it will no longer block future verifications that match
+      # the same information. This action is irreversible. To re-enable it, a new BlocklistEntry
+      # must be created using the same verification report.
+      #
+      # Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#disable-a-blocklist-entry)
+      def disable(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/identity/blocklist_entries/%<id>s/disable", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Disables a BlocklistEntry object.
+      #
+      # After a BlocklistEntry is disabled, it will no longer block future verifications that match
+      # the same information. This action is irreversible. To re-enable it, a new BlocklistEntry
+      # must be created using the same verification report.
+      #
+      # Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#disable-a-blocklist-entry)
+      def self.disable(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/identity/blocklist_entries/%<id>s/disable", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of BlocklistEntry objects associated with your account.
+      #
+      # The blocklist entries are returned sorted by creation date, with the most recently created
+      # entries appearing first.
+      #
+      # Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#block-list)
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/identity/blocklist_entries",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/identity/verification_report.rb

@@ -113,6 +113,8 @@ module Stripe
         end
         # Address as it appears in the document.
         attr_reader :address
+        # If document was not verified due to extracted data being on the blocklist, this is the token of the BlocklistEntry that blocked it
+        attr_reader :blocked_by_entry
         # Date of birth as it appears in the document.
         attr_reader :dob
         # Details on the verification error. Present when status is `unverified`.
@@ -158,6 +160,23 @@ module Stripe
       end
 
       class Email < ::Stripe::StripeObject
+        class Details < ::Stripe::StripeObject
+          # Number of days from the time when the email domain was first observed to the time of verification.
+          attr_reader :days_since_domain_creation
+          # Number of days from the time when the email address was first observed to the time of verification.
+          attr_reader :days_since_ownership_started
+          # Two-letter ISO 3166-1 alpha-2 country code of the email domain's country.
+          attr_reader :domain_country
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
         class Error < ::Stripe::StripeObject
           # A short machine-readable string giving the reason for the verification failure.
           attr_reader :code
@@ -172,6 +191,8 @@ module Stripe
             @field_remappings = {}
           end
         end
+        # Additional email verification details
+        attr_reader :details
         # Email to be verified.
         attr_reader :email
         # Details on the verification error. Present when status is `unverified`.
@@ -180,7 +201,7 @@ module Stripe
         attr_reader :status
 
         def self.inner_class_types
-          @inner_class_types = { error: Error }
+          @inner_class_types = { details: Details, error: Error }
         end
 
         def self.field_remappings
@@ -333,6 +354,8 @@ module Stripe
             @field_remappings = {}
           end
         end
+        # If selfie was not verified due to being on the blocklist, this is the token of the BlocklistEntry that blocked it
+        attr_reader :blocked_by_entry
         # ID of the [File](https://docs.stripe.com/api/files) holding the image of the identity document used in this check.
         attr_reader :document
         # Details on the verification error. Present when status is `unverified`.