stripe 18.3.0 → 18.4.0.pre.alpha.1

data/lib/stripe/resources/fr_meal_vouchers_onboarding.rb

@@ -0,0 +1,143 @@
+# 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.
+  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
+    # 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
+    # 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
+    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
+    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
+      # 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
+      # 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`.
@@ -333,6 +335,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`.