stripe 5.55.0 → 18.2.0.pre.beta.1

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

@@ -3,29 +3,366 @@
 
 module Stripe
   module FinancialConnections
+    # 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 that this account belongs to. Only available when `account_holder.type` is `account`.
+        attr_reader :account
+        # The ID for an Account representing a customer that this account belongs to. Only available when `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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class AccountNumber < ::Stripe::StripeObject
+        # When the account number is expected to expire, if applicable.
+        attr_reader :expected_expiry_date
+        # The type of account number associated with the account.
+        attr_reader :identifier_type
+        # Whether the account number is currently active and usable for transactions.
+        attr_reader :status
+        # The payment networks that the account number can be used for.
+        attr_reader :supported_networks
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      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
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        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
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        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
+
+        def self.inner_class_types
+          @inner_class_types = { cash: Cash, credit: Credit }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      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
 
-      custom_method :disconnect, http_verb: :post
-      custom_method :refresh, http_verb: :post
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
 
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The account holder that this account belongs to.
+      attr_reader :account_holder
+      # Details about the account numbers.
+      attr_reader :account_numbers
+      # 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 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.
+      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://docs.stripe.com/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(
           method: :post,
-          path: resource_url + "/disconnect",
+          path: format("/v1/financial_connections/accounts/%<account>s/disconnect", { account: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
       end
 
-      def refresh(params = {}, opts = {})
+      # 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 self.disconnect(account, params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: resource_url + "/refresh",
+          path: format("/v1/financial_connections/accounts/%<account>s/disconnect", { account: CGI.escape(account) }),
           params: params,
           opts: opts
         )
       end
+
+      # Returns a list of Financial Connections Account objects.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/financial_connections/accounts",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Lists all owners for a given Account
+      def list_owners(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: format("/v1/financial_connections/accounts/%<account>s/owners", { account: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Lists all owners for a given Account
+      def self.list_owners(account, params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: format("/v1/financial_connections/accounts/%<account>s/owners", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Refreshes the data associated with a Financial Connections Account.
+      def refresh_account(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/refresh", { account: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Refreshes the data associated with a Financial Connections Account.
+      def self.refresh_account(account, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/refresh", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Subscribes to periodic refreshes of data associated with a Financial Connections Account. When the account status is active, data is typically refreshed once a day.
+      def subscribe(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/subscribe", { account: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Subscribes to periodic refreshes of data associated with a Financial Connections Account. When the account status is active, data is typically refreshed once a day.
+      def self.subscribe(account, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/subscribe", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.
+      def unsubscribe(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/unsubscribe", { account: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.
+      def self.unsubscribe(account, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/unsubscribe", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = {
+          account_holder: AccountHolder,
+          account_numbers: AccountNumber,
+          balance: Balance,
+          balance_refresh: BalanceRefresh,
+          inferred_balances_refresh: InferredBalancesRefresh,
+          ownership_refresh: OwnershipRefresh,
+          transaction_refresh: TransactionRefresh,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

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

@@ -0,0 +1,35 @@
+# 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
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

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

@@ -3,8 +3,37 @@
 
 module Stripe
   module FinancialConnections
+    # Describes an owner of an account.
     class AccountOwner < StripeObject
       OBJECT_NAME = "financial_connections.account_owner"
+      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
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

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

@@ -3,8 +3,29 @@
 
 module Stripe
   module FinancialConnections
+    # Describes a snapshot of the owners of an account at a particular point in time.
     class AccountOwnership < StripeObject
       OBJECT_NAME = "financial_connections.account_ownership"
+      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
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

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

@@ -0,0 +1,127 @@
+# 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
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Ownership < ::Stripe::StripeObject
+          # Whether the given feature is supported by this institution.
+          attr_reader :supported
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class PaymentMethod < ::Stripe::StripeObject
+          # Whether the given feature is supported by this institution.
+          attr_reader :supported
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Transactions < ::Stripe::StripeObject
+          # Whether the given feature is supported by this institution.
+          attr_reader :supported
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        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
+
+        def self.inner_class_types
+          @inner_class_types = {
+            balances: Balances,
+            ownership: Ownership,
+            payment_method: PaymentMethod,
+            transactions: Transactions,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        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
+
+      def self.inner_class_types
+        @inner_class_types = { features: Features }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end