stripe 13.3.0 → 13.4.0.pre.beta.2

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

@@ -6,12 +6,272 @@ 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
+        # Type of account holder that this account belongs to.
+        attr_reader :type
+      end
+
+      class Balance < Stripe::StripeObject
+        class Cash < Stripe::StripeObject
+          # The funds available to the account holder. Typically this is the current balance after subtracting any outbound pending transactions and 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 :available
+        end
+
+        class Credit < Stripe::StripeObject
+          # The credit that has been used by the account holder.
+          #
+          # 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 :used
+        end
+        # The time that the external institution calculated this balance. Measured in seconds since the Unix epoch.
+        attr_reader :as_of
+        # Attribute for field cash
+        attr_reader :cash
+        # Attribute for field credit
+        attr_reader :credit
+        # 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
+        # The `type` of the balance. An additional hash is included on the balance with a name matching this value.
+        attr_reader :type
+      end
+
+      class BalanceRefresh < 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 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 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
+        # Time at which the next ownership 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 TransactionRefresh < Stripe::StripeObject
+        # Unique identifier for the object.
+        attr_reader :id
+        # 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 transaction 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 ListParams < Stripe::RequestParams
+        class AccountHolder < Stripe::RequestParams
+          # The ID of the Stripe account whose accounts will be retrieved.
+          attr_accessor :account
+          # The ID of the Stripe customer whose accounts will be retrieved.
+          attr_accessor :customer
+
+          def initialize(account: nil, customer: nil)
+            @account = account
+            @customer = customer
+          end
+        end
+        # If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.
+        attr_accessor :account_holder
+        # 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
+        # If present, only return accounts that were collected as part of the given session.
+        attr_accessor :session
+        # 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(
+          account_holder: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          session: nil,
+          starting_after: nil
+        )
+          @account_holder = account_holder
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @session = session
+          @starting_after = starting_after
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class ListOwnersParams < 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
+        # The ID of the ownership object to fetch owners from.
+        attr_accessor :ownership
+        # 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,
+          ownership: nil,
+          starting_after: nil
+        )
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @ownership = ownership
+          @starting_after = starting_after
+        end
+      end
+
+      class DisconnectParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class RefreshAccountParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The list of account features that you would like to refresh.
+        attr_accessor :features
+
+        def initialize(expand: nil, features: nil)
+          @expand = expand
+          @features = features
+        end
+      end
+
+      class SubscribeParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The list of account features to which you would like to subscribe.
+        attr_accessor :features
+
+        def initialize(expand: nil, features: nil)
+          @expand = expand
+          @features = features
+        end
+      end
+
+      class UnsubscribeParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The list of account features from which you would like to unsubscribe.
+        attr_accessor :features
+
+        def initialize(expand: nil, features: nil)
+          @expand = expand
+          @features = features
+        end
+      end
+      # The account holder that this account belongs to.
+      attr_reader :account_holder
+      # The most recent information about the account's balance.
+      attr_reader :balance
+      # The state of the most recent attempt to refresh the account balance.
+      attr_reader :balance_refresh
+      # The type of the account. Account category is further divided in `subcategory`.
+      attr_reader :category
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # A human-readable name that has been assigned to this account, either by the account holder or by the institution.
+      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 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.
+      attr_reader :last4
+      # 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 most recent information about the account's owners.
+      attr_reader :ownership
+      # The state of the most recent attempt to refresh the account owners.
+      attr_reader :ownership_refresh
+      # The list of permissions granted by this account.
+      attr_reader :permissions
+      # The status of the link to the account.
+      attr_reader :status
+      # If `category` is `cash`, one of:
+      #
+      #  - `checking`
+      #  - `savings`
+      #  - `other`
+      #
+      # If `category` is `credit`, one of:
+      #
+      #  - `mortgage`
+      #  - `line_of_credit`
+      #  - `credit_card`
+      #  - `other`
+      #
+      # If `category` is `investment` or `other`, this will be `other`.
+      attr_reader :subcategory
+      # The list of data refresh subscriptions requested on this account.
+      attr_reader :subscriptions
+      # The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.
+      attr_reader :supported_payment_method_types
+      # The state of the most recent attempt to refresh the account transactions.
+      attr_reader :transaction_refresh
+
       # Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
       def disconnect(params = {}, opts = {})
         request_stripe_object(

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/account_owner.rb

@@ -9,6 +9,23 @@ module Stripe
       def self.object_name
         "financial_connections.account_owner"
       end
+
+      # The email address of the owner.
+      attr_reader :email
+      # Unique identifier for the object.
+      attr_reader :id
+      # The full name of the owner.
+      attr_reader :name
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The ownership object that this owner belongs to.
+      attr_reader :ownership
+      # The raw phone number of the owner.
+      attr_reader :phone
+      # The raw physical address of the owner.
+      attr_reader :raw_address
+      # The timestamp of the refresh that updated this owner.
+      attr_reader :refreshed_at
     end
   end
 end

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

@@ -9,6 +9,15 @@ module Stripe
       def self.object_name
         "financial_connections.account_ownership"
       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
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # A paginated list of owners for this account.
+      attr_reader :owners
     end
   end
 end

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

@@ -0,0 +1,99 @@
+# 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
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+      # 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

@@ -12,6 +12,165 @@ module Stripe
         "financial_connections.session"
       end
 
+      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
+        # Type of account holder that this account belongs to.
+        attr_reader :type
+      end
+
+      class Filters < Stripe::StripeObject
+        # Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.
+        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 RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class CreateParams < Stripe::RequestParams
+        class AccountHolder < Stripe::RequestParams
+          # The ID of the Stripe account whose accounts will be retrieved. Should only be present if `type` is `account`.
+          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
+          # Type of account holder to collect accounts for.
+          attr_accessor :type
+
+          def initialize(account: nil, customer: nil, type: nil)
+            @account = account
+            @customer = customer
+            @type = type
+          end
+        end
+
+        class Filters < Stripe::RequestParams
+          # Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.
+          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, 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.
+        attr_accessor :account_holder
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # Filters to restrict the kinds of accounts to collect.
+        attr_accessor :filters
+        # Settings for configuring Session-specific limits.
+        attr_accessor :limits
+        # Settings for configuring manual entry of account details for this Session.
+        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`.
+        attr_accessor :permissions
+        # List of data features that you would like to retrieve upon account creation.
+        attr_accessor :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_accessor :return_url
+
+        def initialize(
+          account_holder: nil,
+          expand: nil,
+          filters: nil,
+          limits: nil,
+          manual_entry: nil,
+          permissions: nil,
+          prefetch: nil,
+          return_url: nil
+        )
+          @account_holder = account_holder
+          @expand = expand
+          @filters = filters
+          @limits = limits
+          @manual_entry = manual_entry
+          @permissions = permissions
+          @prefetch = prefetch
+          @return_url = return_url
+        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.
+      attr_reader :accounts
+      # A value that will be passed to the client to launch the authentication flow.
+      attr_reader :client_secret
+      # Attribute for field filters
+      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.
+      attr_reader :permissions
+      # Data features requested to be retrieved upon account creation.
+      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 = {})
         request_stripe_object(