stripe 15.3.0 → 15.4.0.pre.beta.1

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

@@ -6,17 +6,22 @@ module Stripe
     # A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.
     class Account < APIResource
       extend Stripe::APIOperations::List
+      extend Stripe::APIOperations::NestedResource
 
       OBJECT_NAME = "financial_connections.account"
       def self.object_name
         "financial_connections.account"
       end
 
+      nested_resource_class_methods :inferred_balance, operations: %i[list]
+
       class AccountHolder < Stripe::StripeObject
         # The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`.
         attr_reader :account
         # ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`.
         attr_reader :customer
+        # Attribute for field customer_account
+        attr_reader :customer_account
         # Type of account holder that this account belongs to.
         attr_reader :type
       end
@@ -64,6 +69,15 @@ module Stripe
         attr_reader :status
       end
 
+      class InferredBalancesRefresh < Stripe::StripeObject
+        # The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
+        attr_reader :last_attempted_at
+        # Time at which the next inferred balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.
+        attr_reader :next_refresh_available_at
+        # The status of the last refresh attempt.
+        attr_reader :status
+      end
+
       class OwnershipRefresh < Stripe::StripeObject
         # The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
         attr_reader :last_attempted_at
@@ -90,10 +104,13 @@ module Stripe
           attr_accessor :account
           # The ID of the Stripe customer whose accounts will be retrieved.
           attr_accessor :customer
+          # The Account ID of the Stripe customer whose accounts will be retrieved.
+          attr_accessor :customer_account
 
-          def initialize(account: nil, customer: nil)
+          def initialize(account: nil, customer: nil, customer_account: nil)
             @account = account
             @customer = customer
+            @customer_account = customer_account
           end
         end
         # If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.
@@ -211,6 +228,10 @@ module Stripe
       attr_reader :display_name
       # Unique identifier for the object.
       attr_reader :id
+      # The state of the most recent attempt to refresh the account's inferred balance history.
+      attr_reader :inferred_balances_refresh
+      # The ID of the Financial Connections Institution this account belongs to. Note that this relationship may sometimes change in rare circumstances (e.g. institution mergers).
+      attr_reader :institution
       # The name of the institution that holds this account.
       attr_reader :institution_name
       # The last 4 digits of the account number. If present, this will be 4 numeric characters.

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

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    # A historical balance for the account on a particular day. It may be sourced from a balance snapshot provided by a financial institution, or inferred using transactions data.
+    class AccountInferredBalance < APIResource
+      OBJECT_NAME = "financial_connections.account_inferred_balance"
+      def self.object_name
+        "financial_connections.account_inferred_balance"
+      end
+
+      # The time for which this balance was calculated, measured in seconds since the Unix epoch. If the balance was computed by Stripe and not provided directly by a financial institution, it will always be 23:59:59 UTC.
+      attr_reader :as_of
+      # The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions.
+      #
+      # Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
+      #
+      # Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
+      attr_reader :current
+      # Unique identifier for the object.
+      attr_reader :id
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    # An institution represents a financial institution to which an end user can connect using the Financial Connections authentication flow.
+    class Institution < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "financial_connections.institution"
+      def self.object_name
+        "financial_connections.institution"
+      end
+
+      class Features < Stripe::StripeObject
+        class Balances < Stripe::StripeObject
+          # Whether the given feature is supported by this institution.
+          attr_reader :supported
+        end
+
+        class Ownership < Stripe::StripeObject
+          # Whether the given feature is supported by this institution.
+          attr_reader :supported
+        end
+
+        class PaymentMethod < Stripe::StripeObject
+          # Whether the given feature is supported by this institution.
+          attr_reader :supported
+        end
+
+        class Transactions < Stripe::StripeObject
+          # Whether the given feature is supported by this institution.
+          attr_reader :supported
+        end
+        # Attribute for field balances
+        attr_reader :balances
+        # Attribute for field ownership
+        attr_reader :ownership
+        # Attribute for field payment_method
+        attr_reader :payment_method
+        # Attribute for field transactions
+        attr_reader :transactions
+      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
+      # The list of countries supported by this institution, formatted as ISO country codes.
+      attr_reader :countries
+      # Attribute for field features
+      attr_reader :features
+      # 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 name of this institution.
+      attr_reader :name
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # A list of routing numbers which are known to correspond to this institution. Due to the many to many relationship between institutions and routing numbers, this list may not be comprehensive and routing numbers may also be shared between institutions.
+      attr_reader :routing_numbers
+      # The status of this institution in the Financial Connections authentication flow.
+      attr_reader :status
+      # A URL corresponding to this institution. This URL is also displayed in the authentication flow to help end users confirm that they are authenticating with the right institution.
+      attr_reader :url
+
+      # Returns a list of Financial Connections Institution objects.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/financial_connections/institutions",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

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

@@ -17,6 +17,8 @@ module Stripe
         attr_reader :account
         # ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`.
         attr_reader :customer
+        # Attribute for field customer_account
+        attr_reader :customer_account
         # Type of account holder that this account belongs to.
         attr_reader :type
       end
@@ -26,6 +28,24 @@ 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
+      end
+
+      class Limits < Stripe::StripeObject
+        # The number of accounts that can be linked in this Session.
+        attr_reader :accounts
+      end
+
+      class ManualEntry < Stripe::StripeObject; end
+
+      class StatusDetails < Stripe::StripeObject
+        class Cancelled < Stripe::StripeObject
+          # The reason for the Session being cancelled.
+          attr_reader :reason
+        end
+        # Attribute for field cancelled
+        attr_reader :cancelled
       end
 
       class CreateParams < Stripe::RequestParams
@@ -34,12 +54,15 @@ module Stripe
           attr_accessor :account
           # The ID of the Stripe customer whose accounts will be retrieved. Should only be present if `type` is `customer`.
           attr_accessor :customer
+          # The ID of the Stripe customer Account whose accounts will be retrieved. Should only be present if `type` is `customer`.
+          attr_accessor :customer_account
           # Type of account holder to collect accounts for.
           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
@@ -49,10 +72,31 @@ module Stripe
           attr_accessor :account_subcategories
           # List of countries from which to collect accounts.
           attr_accessor :countries
+          # Stripe ID of the institution with which the customer should be directed to log in.
+          attr_accessor :institution
 
-          def initialize(account_subcategories: nil, countries: nil)
+          def initialize(account_subcategories: nil, countries: nil, institution: nil)
             @account_subcategories = account_subcategories
             @countries = countries
+            @institution = institution
+          end
+        end
+
+        class Limits < Stripe::RequestParams
+          # The number of accounts that can be linked in this Session.
+          attr_accessor :accounts
+
+          def initialize(accounts: nil)
+            @accounts = accounts
+          end
+        end
+
+        class ManualEntry < Stripe::RequestParams
+          # Whether manual entry will be handled by Stripe during the Session.
+          attr_accessor :mode
+
+          def initialize(mode: nil)
+            @mode = mode
           end
         end
         # The account holder to link accounts for.
@@ -61,6 +105,10 @@ module Stripe
         attr_accessor :expand
         # Filters to restrict the kinds of accounts to collect.
         attr_accessor :filters
+        # Settings for configuring Session-specific limits.
+        attr_accessor :limits
+        # Customize manual entry behavior
+        attr_accessor :manual_entry
         # List of data features that you would like to request access to.
         #
         # Possible values are `balances`, `transactions`, `ownership`, and `payment_method`.
@@ -74,6 +122,8 @@ module Stripe
           account_holder: nil,
           expand: nil,
           filters: nil,
+          limits: nil,
+          manual_entry: nil,
           permissions: nil,
           prefetch: nil,
           return_url: nil
@@ -81,6 +131,8 @@ module Stripe
           @account_holder = account_holder
           @expand = expand
           @filters = filters
+          @limits = limits
+          @manual_entry = manual_entry
           @permissions = permissions
           @prefetch = prefetch
           @return_url = return_url
@@ -96,8 +148,12 @@ module Stripe
       attr_reader :filters
       # Unique identifier for the object.
       attr_reader :id
+      # Attribute for field limits
+      attr_reader :limits
       # 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
+      # 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.
@@ -106,6 +162,10 @@ module Stripe
       attr_reader :prefetch
       # 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
 
       # 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 = {})

data/lib/stripe/resources/fx_quote.rb

@@ -0,0 +1,184 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # The FX Quotes API provides three key functions:
+  # - View current exchange rates: The object shows Stripe's current exchange rate for any given currency pair.
+  # - Extended quotes: The API provides rate quotes valid for a 1-hour period or a 24-hour period, eliminating uncertainty from FX fluctuations.
+  # - View FX fees: The API provides information on the FX fees Stripe will charge on your FX transaction, allowing you to anticipate specific settlement amounts before payment costs.
+  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
+      end
+      # The rate that includes the FX fee rate.
+      attr_reader :exchange_rate
+      # Attribute for field rate_details
+      attr_reader :rate_details
+    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
+      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
+      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
+    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
+  end
+end

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

@@ -170,6 +170,8 @@ module Stripe
         attr_accessor :limit
         # Attribute for param field related_customer
         attr_accessor :related_customer
+        # Attribute for param field related_customer_account
+        attr_accessor :related_customer_account
         # 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
         # Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
@@ -182,6 +184,7 @@ module Stripe
           expand: nil,
           limit: nil,
           related_customer: nil,
+          related_customer_account: nil,
           starting_after: nil,
           status: nil
         )
@@ -191,6 +194,7 @@ module Stripe
           @expand = expand
           @limit = limit
           @related_customer = related_customer
+          @related_customer_account = related_customer_account
           @starting_after = starting_after
           @status = status
         end
@@ -263,6 +267,8 @@ module Stripe
         attr_accessor :provided_details
         # Customer ID
         attr_accessor :related_customer
+        # Token referencing a Customer Account resource.
+        attr_accessor :related_customer_account
         # Tokens referencing a Person resource and it's associated account.
         attr_accessor :related_person
         # The URL that the user will be redirected to upon completing the verification flow.
@@ -279,6 +285,7 @@ module Stripe
           options: nil,
           provided_details: nil,
           related_customer: nil,
+          related_customer_account: nil,
           related_person: nil,
           return_url: nil,
           type: nil,
@@ -290,6 +297,7 @@ module Stripe
           @options = options
           @provided_details = provided_details
           @related_customer = related_customer
+          @related_customer_account = related_customer_account
           @related_person = related_person
           @return_url = return_url
           @type = type
@@ -403,6 +411,8 @@ module Stripe
       attr_reader :redaction
       # Customer ID
       attr_reader :related_customer
+      # Token referencing a Customer Account resource.
+      attr_reader :related_customer_account
       # Attribute for field related_person
       attr_reader :related_person
       # Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).