stripe 17.0.0 → 17.1.0.pre.alpha.1

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

@@ -0,0 +1,228 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # Use ReceivedCredits API to retrieve information on when, where, and how funds are sent into your FinancialAccount.
+      class ReceivedCredit < APIResource
+        OBJECT_NAME = "v2.money_management.received_credit"
+        def self.object_name
+          "v2.money_management.received_credit"
+        end
+
+        class StatusDetails < ::Stripe::StripeObject
+          class Failed < ::Stripe::StripeObject
+            # Open Enum. The `failed` status reason.
+            attr_reader :reason
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class Returned < ::Stripe::StripeObject
+            # Open Enum. The `returned` status reason.
+            attr_reader :reason
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Hash that provides additional information regarding the reason behind a `failed` ReceivedCredit status. It is only present when the ReceivedCredit status is `failed`.
+          attr_reader :failed
+          # Hash that provides additional information regarding the reason behind a `returned` ReceivedCredit status. It is only present when the ReceivedCredit status is `returned`.
+          attr_reader :returned
+
+          def self.inner_class_types
+            @inner_class_types = { failed: Failed, returned: Returned }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class StatusTransitions < ::Stripe::StripeObject
+          # Timestamp describing when the ReceivedCredit was marked as `failed`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+          attr_reader :failed_at
+          # Timestamp describing when the ReceivedCredit changed status to `returned`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+          attr_reader :returned_at
+          # Timestamp describing when the ReceivedCredit was marked as `succeeded`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+          attr_reader :succeeded_at
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class BalanceTransfer < ::Stripe::StripeObject
+          # The ID of the account that owns the source object originated the ReceivedCredit.
+          attr_reader :from_account
+          # Open Enum. The type of Stripe Money Movement that originated the ReceivedCredit.
+          attr_reader :type
+          # The ID of the outbound payment object that originated the ReceivedCredit.
+          attr_reader :outbound_payment
+          # The ID of the outbound transfer object that originated the ReceivedCredit.
+          attr_reader :outbound_transfer
+          # The ID of the payout object that originated the ReceivedCredit.
+          attr_reader :payout_v1
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class BankTransfer < ::Stripe::StripeObject
+          class GbBankAccount < ::Stripe::StripeObject
+            # The bank name the transfer was received from.
+            attr_reader :account_holder_name
+            # The bank name the transfer was received from.
+            attr_reader :bank_name
+            # The last 4 digits of the account number that originated the transfer.
+            attr_reader :last4
+            # Open Enum. The money transmission network used to send funds for this ReceivedCredit.
+            attr_reader :network
+            # The sort code of the account that originated the transfer.
+            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 of the bank account the transfer was received from.
+            attr_reader :account_holder_name
+            # The bank name the transfer was received from.
+            attr_reader :bank_name
+            # The BIC of the SEPA account.
+            attr_reader :bic
+            # The origination country of the bank transfer.
+            attr_reader :country
+            # The IBAN that originated the transfer.
+            attr_reader :iban
+            # The money transmission network used to send funds for this ReceivedCredit.
+            attr_reader :network
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class UsBankAccount < ::Stripe::StripeObject
+            # The bank name the transfer was received from.
+            attr_reader :bank_name
+            # The last 4 digits of the account number that originated the transfer.
+            attr_reader :last4
+            # Open Enum. The money transmission network used to send funds for this ReceivedCredit.
+            attr_reader :network
+            # The routing number of the account that originated the transfer.
+            attr_reader :routing_number
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Financial Address on which funds for ReceivedCredit were received.
+          attr_reader :financial_address
+          # Open Enum. Indicates the origin of source from which external funds originated from.
+          attr_reader :origin_type
+          # Freeform string set by originator of the external ReceivedCredit.
+          attr_reader :statement_descriptor
+          # Hash containing the transaction bank details. Present if `origin_type` field value is `gb_bank_account`.
+          attr_reader :gb_bank_account
+          # Hash containing the transaction bank details. Present if `origin_type` field value is `sepa_bank_account`.
+          attr_reader :sepa_bank_account
+          # Hash containing the transaction bank details. Present if `origin_type` field value is `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 amount and currency of the ReceivedCredit.
+        attr_reader :amount
+        # Time at which the ReceivedCredit 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
+        # Freeform string set by originator of the ReceivedCredit.
+        attr_reader :description
+        # Financial Account ID on which funds for ReceivedCredit were received.
+        attr_reader :financial_account
+        # Unique identifier for the ReceivedCredit.
+        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 hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.
+        attr_reader :receipt_url
+        # Open Enum. The status of the ReceivedCredit.
+        attr_reader :status
+        # This hash contains detailed information that elaborates on the specific status of the ReceivedCredit. e.g the reason behind a failure if the status is marked as `failed`.
+        attr_reader :status_details
+        # Hash containing timestamps of when the object transitioned to a particular status.
+        attr_reader :status_transitions
+        # Open Enum. The type of flow that caused the ReceivedCredit.
+        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
+        # This object stores details about the originating Stripe transaction that resulted in the ReceivedCredit. Present if `type` field value is `balance_transfer`.
+        attr_reader :balance_transfer
+        # This object stores details about the originating banking transaction that resulted in the ReceivedCredit. Present if `type` field value is `bank_transfer`.
+        attr_reader :bank_transfer
+
+        def self.inner_class_types
+          @inner_class_types = {
+            status_details: StatusDetails,
+            status_transitions: StatusTransitions,
+            balance_transfer: BalanceTransfer,
+            bank_transfer: BankTransfer,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,138 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # ReceivedDebit resource
+      class ReceivedDebit < APIResource
+        OBJECT_NAME = "v2.money_management.received_debit"
+        def self.object_name
+          "v2.money_management.received_debit"
+        end
+
+        class StatusDetails < ::Stripe::StripeObject
+          class Failed < ::Stripe::StripeObject
+            # Open Enum. The reason for the failure of the ReceivedDebit.
+            attr_reader :reason
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Information that elaborates on the `failed` status of a ReceivedDebit.
+          # It is only present when the ReceivedDebit status is `failed`.
+          attr_reader :failed
+
+          def self.inner_class_types
+            @inner_class_types = { failed: Failed }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class StatusTransitions < ::Stripe::StripeObject
+          # The time when the ReceivedDebit was marked as `canceled`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: `2022-09-18T13:22:18.123Z`.
+          attr_reader :canceled_at
+          # The time when the ReceivedDebit was marked as `failed`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: `2022-09-18T13:22:18.123Z`.
+          attr_reader :failed_at
+          # The time when the ReceivedDebit was marked as `succeeded`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: `2022-09-18T13:22:18.123Z`.
+          attr_reader :succeeded_at
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class BankTransfer < ::Stripe::StripeObject
+          class UsBankAccount < ::Stripe::StripeObject
+            # The name of the bank the debit originated from.
+            attr_reader :bank_name
+            # Open Enum. The bank network the debit was originated on.
+            attr_reader :network
+            # The routing number of the bank that originated the debit.
+            attr_reader :routing_number
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The Financial Address that was debited.
+          attr_reader :financial_address
+          # Open Enum. Indicates the origin type through which this debit was initiated.
+          attr_reader :origin_type
+          # Open Enum. The type of the payment method used to originate the debit.
+          attr_reader :payment_method_type
+          # The statement descriptor set by the originator of the debit.
+          attr_reader :statement_descriptor
+          # The payment method used to originate the debit.
+          attr_reader :us_bank_account
+
+          def self.inner_class_types
+            @inner_class_types = { us_bank_account: UsBankAccount }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Amount and currency of the ReceivedDebit.
+        attr_reader :amount
+        # The time at which the ReceivedDebit 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
+        # Freeform string sent by the originator of the ReceivedDebit.
+        attr_reader :description
+        # Financial Account on which funds for ReceivedDebit were debited.
+        attr_reader :financial_account
+        # Unique identifier for the ReceivedDebit.
+        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 for this ReceivedDebit.
+        attr_reader :receipt_url
+        # Open Enum. The status of the ReceivedDebit.
+        attr_reader :status
+        # Detailed information about the status of the ReceivedDebit.
+        attr_reader :status_details
+        # The time at which the ReceivedDebit transitioned to a particular status.
+        attr_reader :status_transitions
+        # Open Enum. The type of the ReceivedDebit.
+        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
+        # This object stores details about the originating banking transaction that resulted in the ReceivedDebit. Present if `type` field value is `bank_transfer`.
+        attr_reader :bank_transfer
+
+        def self.inner_class_types
+          @inner_class_types = {
+            status_details: StatusDetails,
+            status_transitions: StatusTransitions,
+            bank_transfer: BankTransfer,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # RecipientVerification represents a verification of recipient you intend to send funds to.
+      class RecipientVerification < APIResource
+        OBJECT_NAME = "v2.money_management.recipient_verification"
+        def self.object_name
+          "v2.money_management.recipient_verification"
+        end
+
+        class MatchResultDetails < ::Stripe::StripeObject
+          # The account name associated with the bank account as provided by the VoP provider, only present if there is a match or close match.
+          attr_reader :matched_name
+          # A message describing the match result.
+          attr_reader :message
+          # The name associated with the provided recipient.
+          attr_reader :provided_name
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class StatusTransitions < ::Stripe::StripeObject
+          # Timestamp describing when a RecipientVerification changed status to `acknowledged`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+          attr_reader :acknowledged_at
+          # Timestamp describing when a RecipientVerification changed status to `consumed`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+          attr_reader :consumed_at
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The OBP/OBT ID that consumed this verification, present if one is successfully created.
+        attr_reader :consumed_by
+        # Time at which the RecipientVerification 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
+        # Time at which the RecipientVerification expires, 5 minutes after the creation.
+        # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+        attr_reader :expires_at
+        # The ID of the RecipientVerification.
+        attr_reader :id
+        # Closed Enum. Match level of the RecipientVerification: `match`, `close_match`, `no_match`, `unavailable`.
+        attr_reader :match_result
+        # Details for the match result.
+        attr_reader :match_result_details
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # Closed Enum. Current status of the RecipientVerification: `verified`, `consumed`, `expired`, `awaiting_acknowledgement`, `acknowledged`.
+        attr_reader :status
+        # Hash containing timestamps of when the object transitioned to a particular status.
+        attr_reader :status_transitions
+        # 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 = {
+            match_result_details: MatchResultDetails,
+            status_transitions: StatusTransitions,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,116 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # Use Transactions to view changes to your FinancialAccount balance over time. Every flow that moves money, such as OutboundPayments or ReceivedCredits, will have one or more Transactions that describes how the flow impacted your balance. Note that while the FinancialAccount balance will always be up to date, be aware that Transactions and TransactionEntries are created shortly after to reflect changes.
+      class Transaction < APIResource
+        OBJECT_NAME = "v2.money_management.transaction"
+        def self.object_name
+          "v2.money_management.transaction"
+        end
+
+        class BalanceImpact < ::Stripe::StripeObject
+          # Impact to the available balance.
+          attr_reader :available
+          # Impact to the inbound_pending balance.
+          attr_reader :inbound_pending
+          # Impact to the outbound_pending balance.
+          attr_reader :outbound_pending
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Flow < ::Stripe::StripeObject
+          # Open Enum. Type of the flow that created the Transaction. The field matching this value will contain the ID of the flow.
+          attr_reader :type
+          # If applicable, the ID of the Adjustment that created this Transaction.
+          attr_reader :adjustment
+          # In the future, this will be the ID of the currency conversion that created this Transaction. For now, this field is always null.
+          attr_reader :currency_conversion
+          # If applicable, the ID of the FeeTransaction that created this Transaction.
+          attr_reader :fee_transaction
+          # If applicable, the ID of the InboundTransfer that created this Transaction.
+          attr_reader :inbound_transfer
+          # If applicable, the ID of the OutboundPayment that created this Transaction.
+          attr_reader :outbound_payment
+          # If applicable, the ID of the OutboundTransfer that created this Transaction.
+          attr_reader :outbound_transfer
+          # If applicable, the ID of the ReceivedCredit that created this Transaction.
+          attr_reader :received_credit
+          # If applicable, the ID of the ReceivedDebit that created this Transaction.
+          attr_reader :received_debit
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class StatusTransitions < ::Stripe::StripeObject
+          # The time at which the Transaction became posted. Only present if status == posted.
+          attr_reader :posted_at
+          # The time at which the Transaction became void. Only present if status == void.
+          attr_reader :void_at
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The amount of the Transaction.
+        attr_reader :amount
+        # The delta to the FinancialAccount's balance. The balance_impact for the Transaction is equal to sum of its
+        # TransactionEntries that have `effective_at`s in the past.
+        attr_reader :balance_impact
+        # Open Enum. A descriptive category used to classify the Transaction.
+        attr_reader :category
+        # 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
+        # Indicates the FinancialAccount affected by this Transaction.
+        attr_reader :financial_account
+        # Details about the Flow object that created the Transaction.
+        attr_reader :flow
+        # 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
+        # Closed Enum. Current status of the Transaction.
+        # A Transaction is `pending` if either `balance_impact.inbound_pending` or `balance_impact.outbound_pending` is non-zero.
+        # A Transaction is `posted` if only `balance_impact.available` is non-zero.
+        # A Transaction is `void` if there is no balance impact.
+        # `posted` and `void` are terminal states, and no additional entries will be added to the Transaction.
+        attr_reader :status
+        # Timestamps for when the Transaction transitioned to a particular status.
+        attr_reader :status_transitions
+        # 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_impact: BalanceImpact,
+            flow: Flow,
+            status_transitions: StatusTransitions,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,105 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # TransactionEntries represent individual money movements across different states within a Transaction.
+      class TransactionEntry < APIResource
+        OBJECT_NAME = "v2.money_management.transaction_entry"
+        def self.object_name
+          "v2.money_management.transaction_entry"
+        end
+
+        class BalanceImpact < ::Stripe::StripeObject
+          # Impact to the available balance.
+          attr_reader :available
+          # Impact to the inbound_pending balance.
+          attr_reader :inbound_pending
+          # Impact to the outbound_pending balance.
+          attr_reader :outbound_pending
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class TransactionDetails < ::Stripe::StripeObject
+          class Flow < ::Stripe::StripeObject
+            # Open Enum. Type of the flow that created the Transaction. The field matching this value will contain the ID of the flow.
+            attr_reader :type
+            # If applicable, the ID of the Adjustment that created this Transaction.
+            attr_reader :adjustment
+            # In the future, this will be the ID of the currency conversion that created this Transaction. For now, this field is always null.
+            attr_reader :currency_conversion
+            # If applicable, the ID of the FeeTransaction that created this Transaction.
+            attr_reader :fee_transaction
+            # If applicable, the ID of the InboundTransfer that created this Transaction.
+            attr_reader :inbound_transfer
+            # If applicable, the ID of the OutboundPayment that created this Transaction.
+            attr_reader :outbound_payment
+            # If applicable, the ID of the OutboundTransfer that created this Transaction.
+            attr_reader :outbound_transfer
+            # If applicable, the ID of the ReceivedCredit that created this Transaction.
+            attr_reader :received_credit
+            # If applicable, the ID of the ReceivedDebit that created this Transaction.
+            attr_reader :received_debit
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Closed Enum for now, and will be turned into an Open Enum soon. A descriptive category used to classify the Transaction.
+          attr_reader :category
+          # Indicates the FinancialAccount affected by this Transaction.
+          attr_reader :financial_account
+          # Details about the Flow object that created the Transaction.
+          attr_reader :flow
+
+          def self.inner_class_types
+            @inner_class_types = { flow: Flow }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The delta to the FinancialAccount's balance.
+        attr_reader :balance_impact
+        # Time at which the object was created.
+        attr_reader :created
+        # Time at which the entry impacted (or will impact if it's in the future) the FinancialAccount balance.
+        attr_reader :effective_at
+        # 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
+        # The Transaction that this TransactionEntry belongs to.
+        attr_reader :transaction
+        # Details copied from the transaction that this TransactionEntry belongs to.
+        attr_reader :transaction_details
+        # 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_impact: BalanceImpact,
+            transaction_details: TransactionDetails,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end