stripe 17.0.0 → 17.1.0.pre.beta.1

data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb

@@ -0,0 +1,114 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      module Vault
+        # Use the GBBankAccounts API to create and manage GB bank account objects
+        class GbBankAccount < APIResource
+          OBJECT_NAME = "v2.core.vault.gb_bank_account"
+          def self.object_name
+            "v2.core.vault.gb_bank_account"
+          end
+
+          class ConfirmationOfPayee < Stripe::StripeObject
+            class Result < Stripe::StripeObject
+              class Matched < Stripe::StripeObject
+                # The business type given by the bank for this account, in case of a MATCH or PARTIAL_MATCH.
+                # Closed enum.
+                attr_reader :business_type
+                # The name given by the bank for this account, in case of a MATCH or PARTIAL_MATCH.
+                attr_reader :name
+
+                def self.inner_class_types
+                  @inner_class_types = {}
+                end
+
+                def self.field_remappings
+                  @field_remappings = {}
+                end
+              end
+
+              class Provided < Stripe::StripeObject
+                # The provided or Legal Entity business type to match against the CoP service. Closed enum.
+                attr_reader :business_type
+                # The provided or Legal Entity name to match against the CoP service.
+                attr_reader :name
+
+                def self.inner_class_types
+                  @inner_class_types = {}
+                end
+
+                def self.field_remappings
+                  @field_remappings = {}
+                end
+              end
+              # When the CoP result was created.
+              attr_reader :created
+              # Whether or not the information of the bank account matches what you have provided. Closed enum.
+              attr_reader :match_result
+              # The fields that CoP service matched against. Only has value if MATCH or PARTIAL_MATCH, empty otherwise.
+              attr_reader :matched
+              # Human-readable message describing the match result.
+              attr_reader :message
+              # The fields that are matched against what the network has on file.
+              attr_reader :provided
+
+              def self.inner_class_types
+                @inner_class_types = { matched: Matched, provided: Provided }
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The result of the Confirmation of Payee check, once the check has been initiated. Closed enum.
+            attr_reader :result
+            # The current state of Confirmation of Payee on this bank account. Closed enum.
+            attr_reader :status
+
+            def self.inner_class_types
+              @inner_class_types = { result: Result }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Whether this bank account object was archived. Bank account objects can be archived through
+          # the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects
+          # cannot be used as outbound destinations and will not appear in the outbound destination list.
+          attr_reader :archived
+          # Closed Enum. The type of the bank account (checking or savings).
+          attr_reader :bank_account_type
+          # The name of the bank.
+          attr_reader :bank_name
+          # Information around the status of Confirmation of Payee matching done on this bank account.
+          # Confirmation of Payee is a name matching service that must be done before making OutboundPayments in the UK.
+          attr_reader :confirmation_of_payee
+          # Creation time.
+          attr_reader :created
+          # The ID of the GBBankAccount object.
+          attr_reader :id
+          # The last 4 digits of the account number or IBAN.
+          attr_reader :last4
+          # String representing the object's type. Objects of the same type share the same value of the object field.
+          attr_reader :object
+          # The Sort Code of the bank account.
+          attr_reader :sort_code
+          # 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
+
+          def self.inner_class_types
+            @inner_class_types = { confirmation_of_payee: ConfirmationOfPayee }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/core/vault/us_bank_account.rb

@@ -0,0 +1,47 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      module Vault
+        # Use the USBankAccounts API to create and manage US bank accounts objects that you can use to receive funds. Note that these are not interchangeable with v1 Tokens.
+        class UsBankAccount < APIResource
+          OBJECT_NAME = "v2.core.vault.us_bank_account"
+          def self.object_name
+            "v2.core.vault.us_bank_account"
+          end
+
+          # Whether this USBankAccount object was archived.
+          attr_reader :archived
+          # Closed Enum. The type of bank account (checking or savings).
+          attr_reader :bank_account_type
+          # The name of the bank this bank account belongs to. This field is populated automatically by Stripe based on the routing number.
+          attr_reader :bank_name
+          # Creation time of the object.
+          attr_reader :created
+          # The fedwire routing number of the bank account.
+          attr_reader :fedwire_routing_number
+          # The ID of the USBankAccount object.
+          attr_reader :id
+          # The last 4 digits of the account number.
+          attr_reader :last4
+          # String representing the object's type. Objects of the same type share the same value of the object field.
+          attr_reader :object
+          # The ACH routing number of the bank account.
+          attr_reader :routing_number
+          # 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
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/financial_address_credit_simulation.rb

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    class FinancialAddressCreditSimulation < APIResource
+      OBJECT_NAME = "financial_address_credit_simulation"
+      def self.object_name
+        "financial_address_credit_simulation"
+      end
+
+      # String representing the object's type. Objects of the same type share the same value of the object field.
+      attr_reader :object
+      # The status of the request, signifying whether a simulated credit was initiated.
+      attr_reader :status
+      # 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
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    class FinancialAddressGeneratedMicrodeposits < APIResource
+      OBJECT_NAME = "financial_address_generated_microdeposits"
+      def self.object_name
+        "financial_address_generated_microdeposits"
+      end
+
+      # The amounts of the microdeposits that were generated.
+      attr_reader :amounts
+      # String representing the object's type. Objects of the same type share the same value of the object field.
+      attr_reader :object
+      # Closed Enum. The status of the request.
+      attr_reader :status
+      # 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
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/money_management/adjustment.rb

@@ -0,0 +1,67 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # Adjustments represent Stripe-initiated credits or debits to a user balance. They might be used to amend balances due to technical or operational error.
+      class Adjustment < APIResource
+        OBJECT_NAME = "v2.money_management.adjustment"
+        def self.object_name
+          "v2.money_management.adjustment"
+        end
+
+        class AdjustedFlow < Stripe::StripeObject
+          # Closed Enum. If applicable, the type of flow linked to this Adjustment. The field matching this value will contain the ID of the flow.
+          attr_reader :type
+          # If applicable, the ID of the Adjustment linked to this Adjustment.
+          attr_reader :adjustment
+          # If applicable, the ID of the InboundTransfer linked to this Adjustment.
+          attr_reader :inbound_transfer
+          # If applicable, the ID of the OutboundPayment linked to this Adjustment.
+          attr_reader :outbound_payment
+          # If applicable, the ID of the OutboundTransfer linked to this Adjustment.
+          attr_reader :outbound_transfer
+          # If applicable, the ID of the ReceivedCredit linked to this Adjustment.
+          attr_reader :received_credit
+          # If applicable, the ID of the ReceivedDebit linked to this Adjustment.
+          attr_reader :received_debit
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # If applicable, contains information about the original flow linked to this Adjustment.
+        attr_reader :adjusted_flow
+        # The amount of the Adjustment.
+        attr_reader :amount
+        # Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+        attr_reader :created
+        # Description of the Adjustment and what it was used for.
+        attr_reader :description
+        # The FinancialAccount that this adjustment is for.
+        attr_reader :financial_account
+        # Unique identifier for the object.
+        attr_reader :id
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # A link to the Stripe-hosted receipt that is provided when money movement is considered regulated under Stripe’s money transmission licenses. The receipt link remains active for 60 days from the Adjustment creation date. After this period, the link will expire and the receipt url value will be null.
+        attr_reader :receipt_url
+        # 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
+
+        def self.inner_class_types
+          @inner_class_types = { adjusted_flow: AdjustedFlow }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/money_management/financial_account.rb

@@ -0,0 +1,140 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # A FinancialAccount represents a balance and can be used as the source or destination for the money management (`/v2/money_management`) APIs.
+      class FinancialAccount < APIResource
+        OBJECT_NAME = "v2.money_management.financial_account"
+        def self.object_name
+          "v2.money_management.financial_account"
+        end
+
+        class Balance < Stripe::StripeObject
+          # Balance that can be used for money movement.
+          attr_reader :available
+          # Balance of inbound funds that will later transition to the `available` balance.
+          attr_reader :inbound_pending
+          # Balance of funds that are being used for a pending outbound money movement.
+          attr_reader :outbound_pending
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Other < Stripe::StripeObject
+          # The type of the FinancialAccount, represented as a string. Upgrade your API version to see the type reflected in `financial_account.type`.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class StatusDetails < Stripe::StripeObject
+          class Closed < Stripe::StripeObject
+            class ForwardingSettings < Stripe::StripeObject
+              # The address to send forwarded payments to.
+              attr_reader :payment_method
+              # The address to send forwarded payouts to.
+              attr_reader :payout_method
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # Attribute for field forwarding_settings
+            attr_reader :forwarding_settings
+            # Attribute for field reason
+            attr_reader :reason
+
+            def self.inner_class_types
+              @inner_class_types = { forwarding_settings: ForwardingSettings }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Attribute for field closed
+          attr_reader :closed
+
+          def self.inner_class_types
+            @inner_class_types = { closed: Closed }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Storage < Stripe::StripeObject
+          # The currencies that this FinancialAccount can hold.
+          attr_reader :holds_currencies
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Multi-currency balance of this FinancialAccount, split by availability state. Each balance is represented as a hash where the key is the three-letter ISO currency code, in lowercase, and the value is the amount for that currency.
+        attr_reader :balance
+        # Open Enum. Two-letter country code that represents the country where the LegalEntity associated with the FinancialAccount is based in.
+        attr_reader :country
+        # Time at which the object was created.
+        attr_reader :created
+        # A descriptive name for the FinancialAccount, up to 50 characters long. This name will be used in the Stripe Dashboard and embedded components.
+        attr_reader :display_name
+        # Unique identifier for the object.
+        attr_reader :id
+        # Metadata associated with the FinancialAccount.
+        attr_reader :metadata
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # If this is a `other` FinancialAccount, this hash indicates what the actual type is. Upgrade your API version to see it reflected in `type`.
+        attr_reader :other
+        # Closed Enum. An enum representing the status of the FinancialAccount. This indicates whether or not the FinancialAccount can be used for any money movement flows.
+        attr_reader :status
+        # Attribute for field status_details
+        attr_reader :status_details
+        # If this is a `storage` FinancialAccount, this hash includes details specific to `storage` FinancialAccounts.
+        attr_reader :storage
+        # Type of the FinancialAccount. An additional hash is included on the FinancialAccount with a name matching this value.
+        # It contains additional information specific to the FinancialAccount type.
+        attr_reader :type
+        # 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
+
+        def self.inner_class_types
+          @inner_class_types = {
+            balance: Balance,
+            other: Other,
+            status_details: StatusDetails,
+            storage: Storage,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/money_management/financial_address.rb

@@ -0,0 +1,132 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # A FinancialAddress contains information needed to transfer money to a Financial Account. A Financial Account can have more than one Financial Address.
+      class FinancialAddress < APIResource
+        OBJECT_NAME = "v2.money_management.financial_address"
+        def self.object_name
+          "v2.money_management.financial_address"
+        end
+
+        class Credentials < Stripe::StripeObject
+          class GbBankAccount < Stripe::StripeObject
+            # The account holder name to be used during bank transference.
+            attr_reader :account_holder_name
+            # The account number of the UK Bank Account.
+            attr_reader :account_number
+            # The last four digits of the UK Bank Account number. This will always be returned.
+            # To view the full account number when retrieving or listing FinancialAddresses, use the `include` request parameter.
+            attr_reader :last4
+            # The sort code of the UK Bank Account.
+            attr_reader :sort_code
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class SepaBankAccount < Stripe::StripeObject
+            # The account holder name to be used during bank transfers.
+            attr_reader :account_holder_name
+            # The name of the Bank.
+            attr_reader :bank_name
+            # The BIC of the SEPA Bank Account.
+            attr_reader :bic
+            # The originating country of the SEPA Bank account.
+            attr_reader :country
+            # The IBAN of the SEPA Bank Account.
+            attr_reader :iban
+            # The last four digits of the SEPA Bank Account number. This will always be returned.
+            # To view the full account number when retrieving or listing FinancialAddresses, use the `include` request parameter.
+            attr_reader :last4
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class UsBankAccount < Stripe::StripeObject
+            # The account number of the US Bank Account.
+            attr_reader :account_number
+            # The name of the Bank.
+            attr_reader :bank_name
+            # The last four digits of the US Bank Account number. This will always be returned.
+            # To view the full account number when retrieving or listing FinancialAddresses, use the `include` request parameter.
+            attr_reader :last4
+            # The routing number of the US Bank Account.
+            attr_reader :routing_number
+            # The swift code of the bank or financial institution.
+            attr_reader :swift_code
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Open Enum. The type of Credentials that are provisioned for the FinancialAddress.
+          attr_reader :type
+          # The credentials of the UK Bank Account for the FinancialAddress. This contains unique banking details such as the sort code, account number, etc. of a UK bank account.
+          attr_reader :gb_bank_account
+          # The credentials of the SEPA Bank Account for the FinancialAddress. This contains unique banking details such as the IBAN, BIC, etc. of a SEPA bank account.
+          attr_reader :sepa_bank_account
+          # The credentials of the US Bank Account for the FinancialAddress. This contains unique banking details such as the routing number, account number, etc. of a US bank account.
+          attr_reader :us_bank_account
+
+          def self.inner_class_types
+            @inner_class_types = {
+              gb_bank_account: GbBankAccount,
+              sepa_bank_account: SepaBankAccount,
+              us_bank_account: UsBankAccount,
+            }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The creation timestamp of the FinancialAddress.
+        attr_reader :created
+        # Object indicates the type of credentials that have been allocated and attached to the FinancialAddress.
+        # It contains all necessary banking details with which to perform money movements with the FinancialAddress.
+        # This field is only available for FinancialAddresses with an active status.
+        attr_reader :credentials
+        # Open Enum. The currency the FinancialAddress supports.
+        attr_reader :currency
+        # A ID of the FinancialAccount this FinancialAddress corresponds to.
+        attr_reader :financial_account
+        # The ID of a FinancialAddress.
+        attr_reader :id
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # Open Enum. The currency the FinancialAddress settles into the FinancialAccount.
+        attr_reader :settlement_currency
+        # Closed Enum. An enum representing the status of the FinancialAddress. This indicates whether or not the FinancialAddress can be used for any money movement flows.
+        attr_reader :status
+        # 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
+
+        def self.inner_class_types
+          @inner_class_types = { credentials: Credentials }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end