stripe 15.5.0 → 15.6.0.pre.alpha.2

data/lib/stripe/resources/fx_quote.rb

@@ -0,0 +1,234 @@
+# 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
+
+    class ListParams < Stripe::RequestParams
+      # 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
+      # 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
+
+      def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+      end
+    end
+
+    class CreateParams < Stripe::RequestParams
+      class Usage < Stripe::RequestParams
+        class Payment < Stripe::RequestParams
+          # 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_accessor :destination
+          # The Stripe account ID that these funds are intended for.
+          #
+          # This field should match the account ID that would be used in the PaymentIntent’s on_behalf_of field.
+          attr_accessor :on_behalf_of
+
+          def initialize(destination: nil, on_behalf_of: nil)
+            @destination = destination
+            @on_behalf_of = on_behalf_of
+          end
+        end
+
+        class Transfer < Stripe::RequestParams
+          # 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_accessor :destination
+
+          def initialize(destination: nil)
+            @destination = destination
+          end
+        end
+        # The payment transaction details that are intended for the FX Quote.
+        attr_accessor :payment
+        # The transfer transaction details that are intended for the FX Quote.
+        attr_accessor :transfer
+        # Which transaction the FX Quote will be used for
+        #
+        # Can be “payment” | “transfer”
+        attr_accessor :type
+
+        def initialize(payment: nil, transfer: nil, type: nil)
+          @payment = payment
+          @transfer = transfer
+          @type = type
+        end
+      end
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A list of three letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be [supported currencies](https://stripe.com/docs/currencies).
+      attr_accessor :from_currencies
+      # The duration that you wish the quote to be locked for. The quote will be usable for the duration specified. The default is `none`. The maximum is 1 day.
+      attr_accessor :lock_duration
+      # 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).
+      attr_accessor :to_currency
+      # The usage specific information for the quote.
+      attr_accessor :usage
+
+      def initialize(
+        expand: nil,
+        from_currencies: nil,
+        lock_duration: nil,
+        to_currency: nil,
+        usage: nil
+      )
+        @expand = expand
+        @from_currencies = from_currencies
+        @lock_duration = lock_duration
+        @to_currency = to_currency
+        @usage = usage
+      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/verification_report.rb

@@ -36,6 +36,14 @@ module Stripe
           attr_reader :postal_code
           # State, county, province, or region.
           attr_reader :state
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
         end
 
         class Dob < Stripe::StripeObject
@@ -45,6 +53,14 @@ module Stripe
           attr_reader :month
           # The four-digit year.
           attr_reader :year
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
         end
 
         class Error < Stripe::StripeObject
@@ -52,6 +68,14 @@ module Stripe
           attr_reader :code
           # A human-readable message giving the reason for the failure. These messages can be shown to your users.
           attr_reader :reason
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
         end
 
         class ExpirationDate < Stripe::StripeObject
@@ -61,6 +85,14 @@ module Stripe
           attr_reader :month
           # The four-digit year.
           attr_reader :year
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
         end
 
         class IssuedDate < Stripe::StripeObject
@@ -70,6 +102,14 @@ module Stripe
           attr_reader :month
           # The four-digit year.
           attr_reader :year
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
         end
         # Address as it appears in the document.
         attr_reader :address
@@ -101,6 +141,20 @@ module Stripe
         attr_reader :unparsed_place_of_birth
         # Sex as it appears in the document.
         attr_reader :unparsed_sex
+
+        def self.inner_class_types
+          @inner_class_types = {
+            address: Address,
+            dob: Dob,
+            error: Error,
+            expiration_date: ExpirationDate,
+            issued_date: IssuedDate,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
       end
 
       class Email < Stripe::StripeObject
@@ -109,6 +163,14 @@ module Stripe
           attr_reader :code
           # A human-readable message giving the reason for the failure. These messages can be shown to your users.
           attr_reader :reason
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
         end
         # Email to be verified.
         attr_reader :email
@@ -116,6 +178,14 @@ module Stripe
         attr_reader :error
         # Status of this `email` check.
         attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = { error: Error }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
       end
 
       class IdNumber < Stripe::StripeObject
@@ -126,6 +196,14 @@ module Stripe
           attr_reader :month
           # The four-digit year.
           attr_reader :year
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
         end
 
         class Error < Stripe::StripeObject
@@ -133,6 +211,14 @@ module Stripe
           attr_reader :code
           # A human-readable message giving the reason for the failure. These messages can be shown to your users.
           attr_reader :reason
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
         end
         # Date of birth.
         attr_reader :dob
@@ -148,6 +234,14 @@ module Stripe
         attr_reader :last_name
         # Status of this `id_number` check.
         attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = { dob: Dob, error: Error }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
       end
 
       class Options < Stripe::StripeObject
@@ -160,13 +254,37 @@ module Stripe
           attr_reader :require_live_capture
           # Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).
           attr_reader :require_matching_selfie
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
         end
 
-        class IdNumber < Stripe::StripeObject; end
+        class IdNumber < Stripe::StripeObject
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
         # Attribute for field document
         attr_reader :document
         # Attribute for field id_number
         attr_reader :id_number
+
+        def self.inner_class_types
+          @inner_class_types = { document: Document, id_number: IdNumber }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
       end
 
       class Phone < Stripe::StripeObject
@@ -175,6 +293,14 @@ module Stripe
           attr_reader :code
           # A human-readable message giving the reason for the failure. These messages can be shown to your users.
           attr_reader :reason
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
         end
         # Details on the verification error. Present when status is `unverified`.
         attr_reader :error
@@ -182,6 +308,14 @@ module Stripe
         attr_reader :phone
         # Status of this `phone` check.
         attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = { error: Error }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
       end
 
       class Selfie < Stripe::StripeObject
@@ -190,6 +324,14 @@ module Stripe
           attr_reader :code
           # A human-readable message giving the reason for the failure. These messages can be shown to your users.
           attr_reader :reason
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
         end
         # ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check.
         attr_reader :document
@@ -199,6 +341,14 @@ module Stripe
         attr_reader :selfie
         # Status of this `selfie` check.
         attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = { error: Error }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
       end
 
       class ListParams < Stripe::RequestParams
@@ -294,6 +444,21 @@ module Stripe
           opts: opts
         )
       end
+
+      def self.inner_class_types
+        @inner_class_types = {
+          document: Document,
+          email: Email,
+          id_number: IdNumber,
+          options: Options,
+          phone: Phone,
+          selfie: Selfie,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end