stripe 19.3.0 → 19.4.0.pre.alpha.2

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

@@ -0,0 +1,69 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # Use the OutboundSetupIntent API to create and setup usable payout methods.
+      class OutboundSetupIntent < APIResource
+        OBJECT_NAME = "v2.money_management.outbound_setup_intent"
+        def self.object_name
+          "v2.money_management.outbound_setup_intent"
+        end
+
+        class NextAction < ::Stripe::StripeObject
+          class ConfirmationOfPayee < ::Stripe::StripeObject
+            # The type of the credential.
+            attr_reader :object
+            # The Confirmation of Payee status.
+            attr_reader :status
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Confirmation of Payee details.
+          attr_reader :confirmation_of_payee
+          # The type of next action.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = { confirmation_of_payee: ConfirmationOfPayee }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Created timestamp.
+        attr_reader :created
+        # ID of the outbound setup intent.
+        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
+        # Specifies which actions needs to be taken next to continue setup of the credential.
+        attr_reader :next_action
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # Use the PayoutMethods API to list and interact with PayoutMethod objects.
+        attr_reader :payout_method
+        # Closed Enum. Status of the outbound setup intent.
+        attr_reader :status
+        # The intended money movement flow this payout method should be set up for, specified in params.
+        attr_reader :usage_intent
+
+        def self.inner_class_types
+          @inner_class_types = { next_action: NextAction }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,239 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # OutboundTransfer represents a single money movement from one FinancialAccount you own to a payout method you also own.
+      class OutboundTransfer < APIResource
+        OBJECT_NAME = "v2.money_management.outbound_transfer"
+        def self.object_name
+          "v2.money_management.outbound_transfer"
+        end
+
+        class DeliveryOptions < ::Stripe::StripeObject
+          # Open Enum. Method for bank account.
+          attr_reader :bank_account
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class From < ::Stripe::StripeObject
+          # The monetary amount debited from the sender, only set on responses.
+          attr_reader :debited
+          # The FinancialAccount that funds were pulled from.
+          attr_reader :financial_account
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        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 Processing < ::Stripe::StripeObject
+            # Open Enum. The `processing` 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
+          # The `failed` status reason.
+          attr_reader :failed
+          # The `processing` status details.
+          attr_reader :processing
+          # The `returned` status reason.
+          attr_reader :returned
+
+          def self.inner_class_types
+            @inner_class_types = { failed: Failed, processing: Processing, returned: Returned }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class StatusTransitions < ::Stripe::StripeObject
+          # Timestamp describing when an OutboundTransfer changed status to `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
+          # Timestamp describing when an OutboundTransfer changed status to `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 an OutboundTransfer changed status to `posted`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+          attr_reader :posted_at
+          # Timestamp describing when an OutboundTransfer 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
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class To < ::Stripe::StripeObject
+          class PayoutMethodOptions < ::Stripe::StripeObject
+            class BankAccount < ::Stripe::StripeObject
+              # The preferred networks to use for this OutboundTransfer.
+              attr_reader :preferred_networks
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # Options for bank account payout methods.
+            attr_reader :bank_account
+
+            def self.inner_class_types
+              @inner_class_types = { bank_account: BankAccount }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The monetary amount being credited to the destination.
+          attr_reader :credited
+          # The payout method which the OutboundTransfer uses to send payout.
+          attr_reader :payout_method
+          # Payout method options for the OutboundTransfer.
+          attr_reader :payout_method_options
+
+          def self.inner_class_types
+            @inner_class_types = { payout_method_options: PayoutMethodOptions }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class TraceId < ::Stripe::StripeObject
+          # Possible values are `pending`, `supported`, and `unsupported`. Initially set to `pending`, it changes to
+          # `supported` when the recipient bank provides a trace ID, or `unsupported` if the recipient bank doesn't support it.
+          # Note that this status may not align with the OutboundPayment or OutboundTransfer status and can remain `pending`
+          # even after the payment or transfer is posted.
+          attr_reader :status
+          # The trace ID value if `trace_id.status` is `supported`, otherwise empty.
+          attr_reader :value
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The "presentment amount" for the OutboundTransfer.
+        attr_reader :amount
+        # Returns true if the OutboundTransfer can be canceled, and false otherwise.
+        attr_reader :cancelable
+        # Time at which the OutboundTransfer 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
+        # Delivery options to be used to send the OutboundTransfer.
+        attr_reader :delivery_options
+        # An arbitrary string attached to the OutboundTransfer. Often useful for displaying to users.
+        attr_reader :description
+        # The date when funds are expected to arrive in the payout method. This field is not set if the payout method is in a `failed`, `canceled`, or `returned` state.
+        # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+        attr_reader :expected_arrival_date
+        # The FinancialAccount that funds were pulled from.
+        attr_reader :from
+        # Unique identifier for the OutboundTransfer.
+        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
+        # Set of key-value pairs 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
+        # 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 OutboundTransfer. The receipt link remains active for 60 days from the OutboundTransfer creation date. After this period, the link will expire and the receipt url value will be null.
+        attr_reader :receipt_url
+        # The recipient verification id for this OutboundTransfer. Only required for countries with regulatory mandates to verify recipient names before OutboundTransfer creation.
+        attr_reader :recipient_verification
+        # The description that appears on the receiving end for an OutboundTransfer (for example, bank statement for external bank transfer). It will default to `STRIPE` if not set on the account settings.
+        attr_reader :statement_descriptor
+        # Closed Enum. Current status of the OutboundTransfer: `processing`, `failed`, `posted`, `returned`, `canceled`.
+        # An OutboundTransfer is `processing` if it has been created and is processing.
+        # The status changes to `posted` once the OutboundTransfer has been "confirmed" and funds have left the account, or to `failed` or `canceled`.
+        # If an OutboundTransfer fails to arrive at its payout method, its status will change to `returned`.
+        attr_reader :status
+        # Status details for an OutboundTransfer in a `processing`, `failed`, or `returned` state.
+        attr_reader :status_details
+        # Hash containing timestamps of when the object transitioned to a particular status.
+        attr_reader :status_transitions
+        # To which payout method the OutboundTransfer was sent.
+        attr_reader :to
+        # A unique identifier that can be used to track this OutboundTransfer with recipient bank. Banks might call this a "reference number" or something similar.
+        attr_reader :trace_id
+
+        def self.inner_class_types
+          @inner_class_types = {
+            delivery_options: DeliveryOptions,
+            from: From,
+            status_details: StatusDetails,
+            status_transitions: StatusTransitions,
+            to: To,
+            trace_id: TraceId,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,245 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # PayoutIntent represents an intent to send funds from a Financial Account to a payout method.
+      class PayoutIntent < APIResource
+        OBJECT_NAME = "v2.money_management.payout_intent"
+        def self.object_name
+          "v2.money_management.payout_intent"
+        end
+
+        class From < ::Stripe::StripeObject
+          # The currency of the financial account.
+          attr_reader :currency
+          # The FinancialAccount that funds are pulled from.
+          attr_reader :financial_account
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class LatestPayout < ::Stripe::StripeObject
+          # The ID of the OutboundPayment, if applicable.
+          attr_reader :outbound_payment
+          # The ID of the OutboundTransfer, if applicable.
+          attr_reader :outbound_transfer
+          # The type of payout.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class NextAction < ::Stripe::StripeObject
+          class HandleFailure < ::Stripe::StripeObject
+            # Open Enum. The reason for the failure.
+            attr_reader :failure_reason
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Details about a failure that requires user action. Populated when type is handle_failure.
+          attr_reader :handle_failure
+          # Open Enum. The type of next action required.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = { handle_failure: HandleFailure }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class RecipientNotification < ::Stripe::StripeObject
+          # Closed Enum. Configuration option to enable or disable notifications to recipients.
+          # Do not send notifications when setting is NONE. Default to account setting when setting is CONFIGURED or not set.
+          attr_reader :setting
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class ScheduleOptions < ::Stripe::StripeObject
+          # The date when the payout should be executed, in YYYY-MM-DD format.
+          attr_reader :execute_on
+
+          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 PayoutIntent changed status to `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
+          # Timestamp describing when a PayoutIntent changed status to `posted`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+          attr_reader :posted_at
+          # Timestamp describing when a PayoutIntent changed status to `processing`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+          attr_reader :processing_at
+          # Timestamp describing when a PayoutIntent changed status to `requires_action`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+          attr_reader :requires_action_at
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class To < ::Stripe::StripeObject
+          class PayoutMethodOptions < ::Stripe::StripeObject
+            class BankAccount < ::Stripe::StripeObject
+              class PreferredNetworkOptions < ::Stripe::StripeObject
+                class Ach < ::Stripe::StripeObject
+                  # Open Enum. ACH submission timing.
+                  attr_reader :submission
+                  # The transaction purpose for this ACH payment.
+                  attr_reader :transaction_purpose
+
+                  def self.inner_class_types
+                    @inner_class_types = {}
+                  end
+
+                  def self.field_remappings
+                    @field_remappings = {}
+                  end
+                end
+                # ACH-specific network options.
+                attr_reader :ach
+
+                def self.inner_class_types
+                  @inner_class_types = { ach: Ach }
+                end
+
+                def self.field_remappings
+                  @field_remappings = {}
+                end
+              end
+              # Per-network configuration options.
+              attr_reader :preferred_network_options
+              # The preferred networks to use for this PayoutIntent.
+              attr_reader :preferred_networks
+
+              def self.inner_class_types
+                @inner_class_types = { preferred_network_options: PreferredNetworkOptions }
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # Options for bank account payout methods.
+            attr_reader :bank_account
+
+            def self.inner_class_types
+              @inner_class_types = { bank_account: BankAccount }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The currency to send to the recipient.
+          attr_reader :currency
+          # The payout method ID. Optional for OutboundPayment if recipient has default payment method. Required for OutboundTransfer.
+          attr_reader :payout_method
+          # Payout method options for the PayoutIntent.
+          attr_reader :payout_method_options
+          # The recipient ID. Only relevant for OutboundPayment.
+          attr_reader :recipient
+
+          def self.inner_class_types
+            @inner_class_types = { payout_method_options: PayoutMethodOptions }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The monetary amount to be sent.
+        attr_reader :amount
+        # Time at which the PayoutIntent 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
+        # An arbitrary string attached to the PayoutIntent. Often useful for displaying to users.
+        attr_reader :description
+        # The FinancialAccount that funds are pulled from.
+        attr_reader :from
+        # Unique identifier for the PayoutIntent.
+        attr_reader :id
+        # Details about the latest payout associated with this PayoutIntent.
+        attr_reader :latest_payout
+        # 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 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
+        # Next action required for a PayoutIntent in the requires_action state. Populated when status is requires_action.
+        attr_reader :next_action
+        # 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 OutboundPayment notification settings for recipient. Only applicable to OutboundPayment.
+        attr_reader :recipient_notification
+        # Scheduling options for the payout. If this is nil, we assume immediate execution.
+        attr_reader :schedule_options
+        # The description that appears on the receiving end for the payout (for example, on a bank statement).
+        attr_reader :statement_descriptor
+        # Open Enum. Current status of the PayoutIntent: `pending`, `processing`, `posted`, `canceled`, `requires_action`.
+        attr_reader :status
+        # Hash containing timestamps of when transitioned to a particular status.
+        attr_reader :status_transitions
+        # To which payout method the payout is sent.
+        attr_reader :to
+
+        def self.inner_class_types
+          @inner_class_types = {
+            from: From,
+            latest_payout: LatestPayout,
+            next_action: NextAction,
+            recipient_notification: RecipientNotification,
+            schedule_options: ScheduleOptions,
+            status_transitions: StatusTransitions,
+            to: To,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end