stripe 13.4.0.pre.beta.1 → 13.4.0.pre.beta.2

data/lib/stripe/resources/treasury/financial_account.rb

@@ -18,10 +18,8 @@ module Stripe
       class Balance < Stripe::StripeObject
         # Funds the user can spend right now.
         attr_reader :cash
-
         # Funds not spendable yet, but will become available at a later time.
         attr_reader :inbound_pending
-
         # Funds in the account, but not spendable because they are being held for pending outbound flows.
         attr_reader :outbound_pending
       end
@@ -30,25 +28,19 @@ module Stripe
         class Aba < Stripe::StripeObject
           # The name of the person or business that owns the bank account.
           attr_reader :account_holder_name
-
           # The account number.
           attr_reader :account_number
-
           # The last four characters of the account number.
           attr_reader :account_number_last4
-
           # Name of the bank.
           attr_reader :bank_name
-
           # Routing number for the account.
           attr_reader :routing_number
         end
         # ABA Records contain U.S. bank account details per the ABA format.
         attr_reader :aba
-
         # The list of networks that the address supports
         attr_reader :supported_networks
-
         # The type of financial address
         attr_reader :type
       end
@@ -56,7 +48,6 @@ module Stripe
       class PlatformRestrictions < Stripe::StripeObject
         # Restricts all inbound money movement.
         attr_reader :inbound_flows
-
         # Restricts all outbound money movement.
         attr_reader :outbound_flows
       end
@@ -74,13 +65,10 @@ module Stripe
         class Created < Stripe::RequestParams
           # Minimum value to filter by (exclusive)
           attr_accessor :gt
-
           # Minimum value to filter by (inclusive)
           attr_accessor :gte
-
           # Maximum value to filter by (exclusive)
           attr_accessor :lt
-
           # Maximum value to filter by (inclusive)
           attr_accessor :lte
 
@@ -93,16 +81,12 @@ module Stripe
         end
         # Only return FinancialAccounts that were created during the given date interval.
         attr_accessor :created
-
         # An object ID cursor for use in pagination.
         attr_accessor :ending_before
-
         # Specifies which fields in the response should be expanded.
         attr_accessor :expand
-
         # A limit ranging from 1 to 100 (defaults to 10).
         attr_accessor :limit
-
         # An object ID cursor for use in pagination.
         attr_accessor :starting_after
 
@@ -145,7 +129,6 @@ module Stripe
             class Aba < Stripe::RequestParams
               # Requested bank partner
               attr_accessor :bank
-
               # Whether the FinancialAccount should have the Feature.
               attr_accessor :requested
 
@@ -208,7 +191,6 @@ module Stripe
             end
             # Enables ACH transfers via the OutboundPayments API.
             attr_accessor :ach
-
             # Enables US domestic wire transfers via the OutboundPayments API.
             attr_accessor :us_domestic_wire
 
@@ -238,7 +220,6 @@ module Stripe
             end
             # Enables ACH transfers via the OutboundTransfers API.
             attr_accessor :ach
-
             # Enables US domestic wire transfers via the OutboundTransfers API.
             attr_accessor :us_domestic_wire
 
@@ -249,22 +230,16 @@ module Stripe
           end
           # Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.
           attr_accessor :card_issuing
-
           # Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.
           attr_accessor :deposit_insurance
-
           # Contains Features that add FinancialAddresses to the FinancialAccount.
           attr_accessor :financial_addresses
-
           # Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.
           attr_accessor :inbound_transfers
-
           # Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).
           attr_accessor :intra_stripe_flows
-
           # Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.
           attr_accessor :outbound_payments
-
           # Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.
           attr_accessor :outbound_transfers
 
@@ -290,7 +265,6 @@ module Stripe
         class PlatformRestrictions < Stripe::RequestParams
           # Restricts all inbound money movement.
           attr_accessor :inbound_flows
-
           # Restricts all outbound money movement.
           attr_accessor :outbound_flows
 
@@ -301,19 +275,16 @@ module Stripe
         end
         # The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
         attr_accessor :display_name
-
         # Specifies which fields in the response should be expanded.
         attr_accessor :expand
-
         # Encodes whether a FinancialAccount has access to a particular feature. Stripe or the platform can control features via the requested field.
         attr_accessor :features
-
         # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
         attr_accessor :metadata
-
+        # The nickname for the FinancialAccount.
+        attr_accessor :nickname
         # The set of functionalities that the platform can restrict on the FinancialAccount.
         attr_accessor :platform_restrictions
-
         # The currencies the FinancialAccount can hold a balance in.
         attr_accessor :supported_currencies
 
@@ -322,6 +293,7 @@ module Stripe
           expand: nil,
           features: nil,
           metadata: nil,
+          nickname: nil,
           platform_restrictions: nil,
           supported_currencies: nil
         )
@@ -329,6 +301,7 @@ module Stripe
           @expand = expand
           @features = features
           @metadata = metadata
+          @nickname = nickname
           @platform_restrictions = platform_restrictions
           @supported_currencies = supported_currencies
         end
@@ -367,7 +340,6 @@ module Stripe
             class Aba < Stripe::RequestParams
               # Requested bank partner
               attr_accessor :bank
-
               # Whether the FinancialAccount should have the Feature.
               attr_accessor :requested
 
@@ -430,7 +402,6 @@ module Stripe
             end
             # Enables ACH transfers via the OutboundPayments API.
             attr_accessor :ach
-
             # Enables US domestic wire transfers via the OutboundPayments API.
             attr_accessor :us_domestic_wire
 
@@ -460,7 +431,6 @@ module Stripe
             end
             # Enables ACH transfers via the OutboundTransfers API.
             attr_accessor :ach
-
             # Enables US domestic wire transfers via the OutboundTransfers API.
             attr_accessor :us_domestic_wire
 
@@ -471,22 +441,16 @@ module Stripe
           end
           # Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.
           attr_accessor :card_issuing
-
           # Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.
           attr_accessor :deposit_insurance
-
           # Contains Features that add FinancialAddresses to the FinancialAccount.
           attr_accessor :financial_addresses
-
           # Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.
           attr_accessor :inbound_transfers
-
           # Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).
           attr_accessor :intra_stripe_flows
-
           # Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.
           attr_accessor :outbound_payments
-
           # Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.
           attr_accessor :outbound_transfers
 
@@ -509,10 +473,24 @@ module Stripe
           end
         end
 
+        class ForwardingSettings < Stripe::RequestParams
+          # The financial_account id
+          attr_accessor :financial_account
+          # The payment_method or bank account id. This needs to be a verified bank account.
+          attr_accessor :payment_method
+          # The type of the bank account provided. This can be either "financial_account" or "payment_method"
+          attr_accessor :type
+
+          def initialize(financial_account: nil, payment_method: nil, type: nil)
+            @financial_account = financial_account
+            @payment_method = payment_method
+            @type = type
+          end
+        end
+
         class PlatformRestrictions < Stripe::RequestParams
           # Restricts all inbound money movement.
           attr_accessor :inbound_flows
-
           # Restricts all outbound money movement.
           attr_accessor :outbound_flows
 
@@ -523,16 +501,16 @@ module Stripe
         end
         # The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
         attr_accessor :display_name
-
         # Specifies which fields in the response should be expanded.
         attr_accessor :expand
-
         # Encodes whether a FinancialAccount has access to a particular feature, with a status enum and associated `status_details`. Stripe or the platform may control features via the requested field.
         attr_accessor :features
-
+        # A different bank account where funds can be deposited/debited in order to get the closing FA's balance to $0
+        attr_accessor :forwarding_settings
         # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
         attr_accessor :metadata
-
+        # The nickname for the FinancialAccount.
+        attr_accessor :nickname
         # The set of functionalities that the platform can restrict on the FinancialAccount.
         attr_accessor :platform_restrictions
 
@@ -540,13 +518,17 @@ module Stripe
           display_name: nil,
           expand: nil,
           features: nil,
+          forwarding_settings: nil,
           metadata: nil,
+          nickname: nil,
           platform_restrictions: nil
         )
           @display_name = display_name
           @expand = expand
           @features = features
+          @forwarding_settings = forwarding_settings
           @metadata = metadata
+          @nickname = nickname
           @platform_restrictions = platform_restrictions
         end
       end
@@ -583,7 +565,6 @@ module Stripe
           class Aba < Stripe::RequestParams
             # Requested bank partner
             attr_accessor :bank
-
             # Whether the FinancialAccount should have the Feature.
             attr_accessor :requested
 
@@ -646,7 +627,6 @@ module Stripe
           end
           # Enables ACH transfers via the OutboundPayments API.
           attr_accessor :ach
-
           # Enables US domestic wire transfers via the OutboundPayments API.
           attr_accessor :us_domestic_wire
 
@@ -676,7 +656,6 @@ module Stripe
           end
           # Enables ACH transfers via the OutboundTransfers API.
           attr_accessor :ach
-
           # Enables US domestic wire transfers via the OutboundTransfers API.
           attr_accessor :us_domestic_wire
 
@@ -687,25 +666,18 @@ module Stripe
         end
         # Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.
         attr_accessor :card_issuing
-
         # Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.
         attr_accessor :deposit_insurance
-
         # Specifies which fields in the response should be expanded.
         attr_accessor :expand
-
         # Contains Features that add FinancialAddresses to the FinancialAccount.
         attr_accessor :financial_addresses
-
         # Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.
         attr_accessor :inbound_transfers
-
         # Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).
         attr_accessor :intra_stripe_flows
-
         # Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.
         attr_accessor :outbound_payments
-
         # Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.
         attr_accessor :outbound_transfers
 
@@ -729,58 +701,92 @@ module Stripe
           @outbound_transfers = outbound_transfers
         end
       end
+
+      class CloseParams < Stripe::RequestParams
+        class ForwardingSettings < Stripe::RequestParams
+          # The financial_account id
+          attr_accessor :financial_account
+          # The payment_method or bank account id. This needs to be a verified bank account.
+          attr_accessor :payment_method
+          # The type of the bank account provided. This can be either "financial_account" or "payment_method"
+          attr_accessor :type
+
+          def initialize(financial_account: nil, payment_method: nil, type: nil)
+            @financial_account = financial_account
+            @payment_method = payment_method
+            @type = type
+          end
+        end
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A different bank account where funds can be deposited/debited in order to get the closing FA's balance to $0
+        attr_accessor :forwarding_settings
+
+        def initialize(expand: nil, forwarding_settings: nil)
+          @expand = expand
+          @forwarding_settings = forwarding_settings
+        end
+      end
       # The array of paths to active Features in the Features hash.
       attr_reader :active_features
-
       # Balance information for the FinancialAccount
       attr_reader :balance
-
       # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
       attr_reader :country
-
       # Time at which the object was created. Measured in seconds since the Unix epoch.
       attr_reader :created
-
       # The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
       attr_reader :display_name
-
       # Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.
       # Stripe or the platform can control Features via the requested field.
       attr_reader :features
-
       # The set of credentials that resolve to a FinancialAccount.
       attr_reader :financial_addresses
-
       # Unique identifier for the object.
       attr_reader :id
-
+      # Attribute for field is_default
+      attr_reader :is_default
       # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
       attr_reader :livemode
-
       # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
       attr_reader :metadata
-
+      # The nickname for the FinancialAccount.
+      attr_reader :nickname
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
-
       # The array of paths to pending Features in the Features hash.
       attr_reader :pending_features
-
       # The set of functionalities that the platform can restrict on the FinancialAccount.
       attr_reader :platform_restrictions
-
       # The array of paths to restricted Features in the Features hash.
       attr_reader :restricted_features
-
       # Status of this FinancialAccount.
       attr_reader :status
-
       # Attribute for field status_details
       attr_reader :status_details
-
       # The currencies the FinancialAccount can hold a balance in. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
       attr_reader :supported_currencies
 
+      # Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.
+      def close(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/treasury/financial_accounts/%<financial_account>s/close", { financial_account: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.
+      def self.close(financial_account, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/treasury/financial_accounts/%<financial_account>s/close", { financial_account: CGI.escape(financial_account) }),
+          params: params,
+          opts: opts
+        )
+      end
+
       # Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.
       def self.create(params = {}, opts = {})
         request_stripe_object(

data/lib/stripe/resources/treasury/financial_account_features.rb

@@ -15,19 +15,15 @@ module Stripe
         class StatusDetail < Stripe::StripeObject
           # Represents the reason why the status is `pending` or `restricted`.
           attr_reader :code
-
           # Represents what the user should do, if anything, to activate the Feature.
           attr_reader :resolution
-
           # The `platform_restrictions` that are restricting this Feature.
           attr_reader :restriction
         end
         # Whether the FinancialAccount should have the Feature.
         attr_reader :requested
-
         # Whether the Feature is operational.
         attr_reader :status
-
         # Additional details; includes at least one entry when the status is not `active`.
         attr_reader :status_details
       end
@@ -36,19 +32,15 @@ module Stripe
         class StatusDetail < Stripe::StripeObject
           # Represents the reason why the status is `pending` or `restricted`.
           attr_reader :code
-
           # Represents what the user should do, if anything, to activate the Feature.
           attr_reader :resolution
-
           # The `platform_restrictions` that are restricting this Feature.
           attr_reader :restriction
         end
         # Whether the FinancialAccount should have the Feature.
         attr_reader :requested
-
         # Whether the Feature is operational.
         attr_reader :status
-
         # Additional details; includes at least one entry when the status is not `active`.
         attr_reader :status_details
       end
@@ -58,22 +50,17 @@ module Stripe
           class StatusDetail < Stripe::StripeObject
             # Represents the reason why the status is `pending` or `restricted`.
             attr_reader :code
-
             # Represents what the user should do, if anything, to activate the Feature.
             attr_reader :resolution
-
             # The `platform_restrictions` that are restricting this Feature.
             attr_reader :restriction
           end
           # Requested bank partner for this Financial Account
           attr_reader :bank
-
           # Whether the FinancialAccount should have the Feature.
           attr_reader :requested
-
           # Whether the Feature is operational.
           attr_reader :status
-
           # Additional details; includes at least one entry when the status is not `active`.
           attr_reader :status_details
         end
@@ -86,19 +73,15 @@ module Stripe
           class StatusDetail < Stripe::StripeObject
             # Represents the reason why the status is `pending` or `restricted`.
             attr_reader :code
-
             # Represents what the user should do, if anything, to activate the Feature.
             attr_reader :resolution
-
             # The `platform_restrictions` that are restricting this Feature.
             attr_reader :restriction
           end
           # Whether the FinancialAccount should have the Feature.
           attr_reader :requested
-
           # Whether the Feature is operational.
           attr_reader :status
-
           # Additional details; includes at least one entry when the status is not `active`.
           attr_reader :status_details
         end
@@ -110,19 +93,15 @@ module Stripe
         class StatusDetail < Stripe::StripeObject
           # Represents the reason why the status is `pending` or `restricted`.
           attr_reader :code
-
           # Represents what the user should do, if anything, to activate the Feature.
           attr_reader :resolution
-
           # The `platform_restrictions` that are restricting this Feature.
           attr_reader :restriction
         end
         # Whether the FinancialAccount should have the Feature.
         attr_reader :requested
-
         # Whether the Feature is operational.
         attr_reader :status
-
         # Additional details; includes at least one entry when the status is not `active`.
         attr_reader :status_details
       end
@@ -132,19 +111,15 @@ module Stripe
           class StatusDetail < Stripe::StripeObject
             # Represents the reason why the status is `pending` or `restricted`.
             attr_reader :code
-
             # Represents what the user should do, if anything, to activate the Feature.
             attr_reader :resolution
-
             # The `platform_restrictions` that are restricting this Feature.
             attr_reader :restriction
           end
           # Whether the FinancialAccount should have the Feature.
           attr_reader :requested
-
           # Whether the Feature is operational.
           attr_reader :status
-
           # Additional details; includes at least one entry when the status is not `active`.
           attr_reader :status_details
         end
@@ -153,25 +128,20 @@ module Stripe
           class StatusDetail < Stripe::StripeObject
             # Represents the reason why the status is `pending` or `restricted`.
             attr_reader :code
-
             # Represents what the user should do, if anything, to activate the Feature.
             attr_reader :resolution
-
             # The `platform_restrictions` that are restricting this Feature.
             attr_reader :restriction
           end
           # Whether the FinancialAccount should have the Feature.
           attr_reader :requested
-
           # Whether the Feature is operational.
           attr_reader :status
-
           # Additional details; includes at least one entry when the status is not `active`.
           attr_reader :status_details
         end
         # Toggle settings for enabling/disabling an outbound ACH specific feature
         attr_reader :ach
-
         # Toggle settings for enabling/disabling a feature
         attr_reader :us_domestic_wire
       end
@@ -181,19 +151,15 @@ module Stripe
           class StatusDetail < Stripe::StripeObject
             # Represents the reason why the status is `pending` or `restricted`.
             attr_reader :code
-
             # Represents what the user should do, if anything, to activate the Feature.
             attr_reader :resolution
-
             # The `platform_restrictions` that are restricting this Feature.
             attr_reader :restriction
           end
           # Whether the FinancialAccount should have the Feature.
           attr_reader :requested
-
           # Whether the Feature is operational.
           attr_reader :status
-
           # Additional details; includes at least one entry when the status is not `active`.
           attr_reader :status_details
         end
@@ -202,49 +168,37 @@ module Stripe
           class StatusDetail < Stripe::StripeObject
             # Represents the reason why the status is `pending` or `restricted`.
             attr_reader :code
-
             # Represents what the user should do, if anything, to activate the Feature.
             attr_reader :resolution
-
             # The `platform_restrictions` that are restricting this Feature.
             attr_reader :restriction
           end
           # Whether the FinancialAccount should have the Feature.
           attr_reader :requested
-
           # Whether the Feature is operational.
           attr_reader :status
-
           # Additional details; includes at least one entry when the status is not `active`.
           attr_reader :status_details
         end
         # Toggle settings for enabling/disabling an outbound ACH specific feature
         attr_reader :ach
-
         # Toggle settings for enabling/disabling a feature
         attr_reader :us_domestic_wire
       end
       # Toggle settings for enabling/disabling a feature
       attr_reader :card_issuing
-
       # Toggle settings for enabling/disabling a feature
       attr_reader :deposit_insurance
-
       # Settings related to Financial Addresses features on a Financial Account
       attr_reader :financial_addresses
-
       # InboundTransfers contains inbound transfers features for a FinancialAccount.
       attr_reader :inbound_transfers
-
       # Toggle settings for enabling/disabling a feature
       attr_reader :intra_stripe_flows
-
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
-
       # Settings related to Outbound Payments features on a Financial Account
       attr_reader :outbound_payments
-
       # OutboundTransfers contains outbound transfers features for a FinancialAccount.
       attr_reader :outbound_transfers
     end