stripe 19.2.0 → 19.3.0.pre.alpha.2

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
+        # 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
+        # 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
+
+        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,177 @@
+# 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 Counterparty < ::Stripe::StripeObject
+          # Name of the counterparty.
+          attr_reader :name
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Flow < ::Stripe::StripeObject
+          # If applicable, the ID of the Adjustment that created this Transaction.
+          attr_reader :adjustment
+          # If applicable, the ID of the Application Fee that created this Transaction.
+          attr_reader :application_fee
+          # If applicable, the ID of the Application Fee Refund that created this Transaction.
+          attr_reader :application_fee_refund
+          # If applicable, the ID of the Charge that created this Transaction.
+          attr_reader :charge
+          # 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 DebitDispute that created this Transaction.
+          attr_reader :debit_dispute
+          # If applicable, the ID of the Dispute that created this Transaction.
+          attr_reader :dispute
+          # 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 Payout that created this Transaction.
+          attr_reader :payout
+          # 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
+          # If applicable, the ID of the Refund that created this Transaction.
+          attr_reader :refund
+          # If applicable, the ID of the Reserve Hold that created this Transaction.
+          attr_reader :reserve_hold
+          # If applicable, the ID of the Reserve Release that created this Transaction.
+          attr_reader :reserve_release
+          # If applicable, the ID of the Topup that created this Transaction.
+          attr_reader :topup
+          # If applicable, the ID of the Transfer that created this Transaction.
+          attr_reader :transfer
+          # If applicable, the ID of the Transfer Reversal that created this Transaction.
+          attr_reader :transfer_reversal
+          # If applicable, the ID of the Treasury CreditReversal that created this Transaction.
+          attr_reader :treasury_credit_reversal
+          # If applicable, the ID of the Treasury DebitReversal that created this Transaction.
+          attr_reader :treasury_debit_reversal
+          # If applicable, the ID of the Treasury InboundTransfer that created this Transaction.
+          attr_reader :treasury_inbound_transfer
+          # If applicable, the ID of the Treasury IssuingAuthorization that created this Transaction.
+          attr_reader :treasury_issuing_authorization
+          # If applicable, the ID of the Treasury OutboundPayment that created this Transaction.
+          attr_reader :treasury_outbound_payment
+          # If applicable, the ID of the Treasury OutboundTransfer that created this Transaction.
+          attr_reader :treasury_outbound_transfer
+          # If applicable, the ID of the Treasury ReceivedCredit that created this Transaction.
+          attr_reader :treasury_received_credit
+          # If applicable, the ID of the Treasury ReceivedDebit that created this Transaction.
+          attr_reader :treasury_received_debit
+          # 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
+
+          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
+        # Counterparty to this Transaction.
+        attr_reader :counterparty
+        # 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 this Transaction. When applicable, the description is copied from the Flow object at the time
+        # of transaction creation.
+        attr_reader :description
+        # 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
+        # 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 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
+        # The v1 Treasury transaction associated with this transaction.
+        attr_reader :treasury_transaction
+
+        def self.inner_class_types
+          @inner_class_types = {
+            balance_impact: BalanceImpact,
+            counterparty: Counterparty,
+            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,147 @@
+# 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
+            # If applicable, the ID of the Adjustment that created this Transaction.
+            attr_reader :adjustment
+            # If applicable, the ID of the Application Fee that created this Transaction.
+            attr_reader :application_fee
+            # If applicable, the ID of the Application Fee Refund that created this Transaction.
+            attr_reader :application_fee_refund
+            # If applicable, the ID of the Charge that created this Transaction.
+            attr_reader :charge
+            # 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 DebitDispute that created this Transaction.
+            attr_reader :debit_dispute
+            # If applicable, the ID of the Dispute that created this Transaction.
+            attr_reader :dispute
+            # 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 Payout that created this Transaction.
+            attr_reader :payout
+            # 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
+            # If applicable, the ID of the Refund that created this Transaction.
+            attr_reader :refund
+            # If applicable, the ID of the Reserve Hold that created this Transaction.
+            attr_reader :reserve_hold
+            # If applicable, the ID of the Reserve Release that created this Transaction.
+            attr_reader :reserve_release
+            # If applicable, the ID of the Topup that created this Transaction.
+            attr_reader :topup
+            # If applicable, the ID of the Transfer that created this Transaction.
+            attr_reader :transfer
+            # If applicable, the ID of the Transfer Reversal that created this Transaction.
+            attr_reader :transfer_reversal
+            # If applicable, the ID of the Treasury CreditReversal that created this Transaction.
+            attr_reader :treasury_credit_reversal
+            # If applicable, the ID of the Treasury DebitReversal that created this Transaction.
+            attr_reader :treasury_debit_reversal
+            # If applicable, the ID of the Treasury InboundTransfer that created this Transaction.
+            attr_reader :treasury_inbound_transfer
+            # If applicable, the ID of the Treasury IssuingAuthorization that created this Transaction.
+            attr_reader :treasury_issuing_authorization
+            # If applicable, the ID of the Treasury OutboundPayment that created this Transaction.
+            attr_reader :treasury_outbound_payment
+            # If applicable, the ID of the Treasury OutboundTransfer that created this Transaction.
+            attr_reader :treasury_outbound_transfer
+            # If applicable, the ID of the Treasury ReceivedCredit that created this Transaction.
+            attr_reader :treasury_received_credit
+            # If applicable, the ID of the Treasury ReceivedDebit that created this Transaction.
+            attr_reader :treasury_received_debit
+            # 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
+
+            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
+        # 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 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
+        # The v1 Treasury transaction entry associated with this transaction entry.
+        attr_reader :treasury_transaction_entry
+
+        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

data/lib/stripe/resources/v2/network/business_profile.rb

@@ -0,0 +1,84 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Network
+      # The Stripe business profile represents a business' public identity on the Stripe network.
+      class BusinessProfile < APIResource
+        OBJECT_NAME = "v2.network.business_profile"
+        def self.object_name
+          "v2.network.business_profile"
+        end
+
+        class Branding < ::Stripe::StripeObject
+          class Icon < ::Stripe::StripeObject
+            # The URL of the image in its original size.
+            attr_reader :original
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class Logo < ::Stripe::StripeObject
+            # The URL of the image in its original size.
+            attr_reader :original
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # URL of the icon for the business. The image will be square and at least 128px x 128px.
+          attr_reader :icon
+          # URL of the logo for the business. The image will be at least 128px x 128px.
+          attr_reader :logo
+          # A CSS hex color value representing the primary branding color for this business.
+          attr_reader :primary_color
+          # A CSS hex color value representing the secondary branding color for this business.
+          attr_reader :secondary_color
+
+          def self.inner_class_types
+            @inner_class_types = { icon: Icon, logo: Logo }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Branding data for the business.
+        attr_reader :branding
+        # The description of the business.
+        attr_reader :description
+        # The display name of the Stripe business profile.
+        attr_reader :display_name
+        # The ID of the Stripe business profile; also known as the Network ID. This is the ID used to identify the business on the Stripe network.
+        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
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # The URL of the business.
+        attr_reader :url
+        # The username of the Stripe business profile.
+        attr_reader :username
+
+        def self.inner_class_types
+          @inner_class_types = { branding: Branding }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/orchestrated_commerce/agreement.rb

@@ -0,0 +1,93 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module OrchestratedCommerce
+      # An Orchestrated Commerce Agreement represents a mutual agreement between a seller and an orchestrator/agent on the Stripe network.
+      class Agreement < APIResource
+        OBJECT_NAME = "v2.orchestrated_commerce.agreement"
+        def self.object_name
+          "v2.orchestrated_commerce.agreement"
+        end
+
+        class OrchestratorDetails < ::Stripe::StripeObject
+          # The name of the orchestrator. This can be the name of the agent or the name of the business.
+          attr_reader :name
+          # The Network ID of the orchestrator.
+          attr_reader :network_business_profile
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class SellerDetails < ::Stripe::StripeObject
+          # The Network ID of the seller.
+          attr_reader :network_business_profile
+
+          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 orchestrator confirmed the agreement.
+          attr_reader :orchestrator_confirmed_at
+          # The time at which the seller confirmed the agreement.
+          attr_reader :seller_confirmed_at
+          # The time at which the agreement was terminated.
+          attr_reader :terminated_at
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The time at which the agreement was created.
+        attr_reader :created
+        # The unique identifier for the agreement.
+        attr_reader :id
+        # The party that initiated the agreement.
+        attr_reader :initiated_by
+        # 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 of the object field.
+        attr_reader :object
+        # Details about the orchestrator.
+        attr_reader :orchestrator_details
+        # Details about the seller.
+        attr_reader :seller_details
+        # The current status of the agreement.
+        attr_reader :status
+        # Timestamps of key status transitions for the agreement.
+        attr_reader :status_transitions
+        # The party that terminated the agreement, if applicable.
+        attr_reader :terminated_by
+
+        def self.inner_class_types
+          @inner_class_types = {
+            orchestrator_details: OrchestratorDetails,
+            seller_details: SellerDetails,
+            status_transitions: StatusTransitions,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end