stripe 13.5.0.pre.beta.1 → 13.5.0

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

@@ -17,501 +17,6 @@ module Stripe
         "treasury.outbound_payment"
       end
 
-      class DestinationPaymentMethodDetails < Stripe::StripeObject
-        class BillingDetails < Stripe::StripeObject
-          class Address < Stripe::StripeObject
-            # City, district, suburb, town, or village.
-            attr_reader :city
-            # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
-            attr_reader :country
-            # Address line 1 (e.g., street, PO Box, or company name).
-            attr_reader :line1
-            # Address line 2 (e.g., apartment, suite, unit, or building).
-            attr_reader :line2
-            # ZIP or postal code.
-            attr_reader :postal_code
-            # State, county, province, or region.
-            attr_reader :state
-          end
-          # Attribute for field address
-          attr_reader :address
-          # Email address.
-          attr_reader :email
-          # Full name.
-          attr_reader :name
-        end
-
-        class FinancialAccount < Stripe::StripeObject
-          # Token of the FinancialAccount.
-          attr_reader :id
-          # The rails used to send funds.
-          attr_reader :network
-        end
-
-        class UsBankAccount < Stripe::StripeObject
-          # Account holder type: individual or company.
-          attr_reader :account_holder_type
-          # Account type: checkings or savings. Defaults to checking if omitted.
-          attr_reader :account_type
-          # Name of the bank associated with the bank account.
-          attr_reader :bank_name
-          # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
-          attr_reader :fingerprint
-          # Last four digits of the bank account number.
-          attr_reader :last4
-          # ID of the mandate used to make this payment.
-          attr_reader :mandate
-          # The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
-          attr_reader :network
-          # Routing number of the bank account.
-          attr_reader :routing_number
-        end
-        # Attribute for field billing_details
-        attr_reader :billing_details
-        # Attribute for field financial_account
-        attr_reader :financial_account
-        # The type of the payment method used in the OutboundPayment.
-        attr_reader :type
-        # Attribute for field us_bank_account
-        attr_reader :us_bank_account
-      end
-
-      class EndUserDetails < Stripe::StripeObject
-        # IP address of the user initiating the OutboundPayment. Set if `present` is set to `true`. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked.
-        attr_reader :ip_address
-        # `true` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`.
-        attr_reader :present
-      end
-
-      class ReturnedDetails < Stripe::StripeObject
-        # Reason for the return.
-        attr_reader :code
-        # The Transaction associated with this object.
-        attr_reader :transaction
-      end
-
-      class StatusTransitions < Stripe::StripeObject
-        # Timestamp describing when an OutboundPayment changed status to `canceled`.
-        attr_reader :canceled_at
-        # Timestamp describing when an OutboundPayment changed status to `failed`.
-        attr_reader :failed_at
-        # Timestamp describing when an OutboundPayment changed status to `posted`.
-        attr_reader :posted_at
-        # Timestamp describing when an OutboundPayment changed status to `returned`.
-        attr_reader :returned_at
-      end
-
-      class TrackingDetails < Stripe::StripeObject
-        class Ach < Stripe::StripeObject
-          # ACH trace ID of the OutboundPayment for payments sent over the `ach` network.
-          attr_reader :trace_id
-        end
-
-        class UsDomesticWire < Stripe::StripeObject
-          # CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the `us_domestic_wire` network.
-          attr_reader :chips
-          # IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.
-          attr_reader :imad
-          # OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.
-          attr_reader :omad
-        end
-        # Attribute for field ach
-        attr_reader :ach
-        # The US bank account network used to send funds.
-        attr_reader :type
-        # Attribute for field us_domestic_wire
-        attr_reader :us_domestic_wire
-      end
-
-      class ListParams < Stripe::RequestParams
-        class Created < Stripe::RequestParams
-          # Minimum value to filter by (exclusive)
-          attr_accessor :gt
-          # Minimum value to filter by (inclusive)
-          attr_accessor :gte
-          # Maximum value to filter by (exclusive)
-          attr_accessor :lt
-          # Maximum value to filter by (inclusive)
-          attr_accessor :lte
-
-          def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
-            @gt = gt
-            @gte = gte
-            @lt = lt
-            @lte = lte
-          end
-        end
-        # Only return OutboundPayments that were created during the given date interval.
-        attr_accessor :created
-        # Only return OutboundPayments sent to this customer.
-        attr_accessor :customer
-        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
-        attr_accessor :ending_before
-        # Specifies which fields in the response should be expanded.
-        attr_accessor :expand
-        # Returns objects associated with this FinancialAccount.
-        attr_accessor :financial_account
-        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
-        attr_accessor :limit
-        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
-        attr_accessor :starting_after
-        # Only return OutboundPayments that have the given status: `processing`, `failed`, `posted`, `returned`, or `canceled`.
-        attr_accessor :status
-
-        def initialize(
-          created: nil,
-          customer: nil,
-          ending_before: nil,
-          expand: nil,
-          financial_account: nil,
-          limit: nil,
-          starting_after: nil,
-          status: nil
-        )
-          @created = created
-          @customer = customer
-          @ending_before = ending_before
-          @expand = expand
-          @financial_account = financial_account
-          @limit = limit
-          @starting_after = starting_after
-          @status = status
-        end
-      end
-
-      class CreateParams < Stripe::RequestParams
-        class DestinationPaymentMethodData < Stripe::RequestParams
-          class BillingDetails < Stripe::RequestParams
-            class Address < Stripe::RequestParams
-              # City, district, suburb, town, or village.
-              attr_accessor :city
-              # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
-              attr_accessor :country
-              # Address line 1 (e.g., street, PO Box, or company name).
-              attr_accessor :line1
-              # Address line 2 (e.g., apartment, suite, unit, or building).
-              attr_accessor :line2
-              # ZIP or postal code.
-              attr_accessor :postal_code
-              # State, county, province, or region.
-              attr_accessor :state
-
-              def initialize(
-                city: nil,
-                country: nil,
-                line1: nil,
-                line2: nil,
-                postal_code: nil,
-                state: nil
-              )
-                @city = city
-                @country = country
-                @line1 = line1
-                @line2 = line2
-                @postal_code = postal_code
-                @state = state
-              end
-            end
-            # Billing address.
-            attr_accessor :address
-            # Email address.
-            attr_accessor :email
-            # Full name.
-            attr_accessor :name
-            # Billing phone number (including extension).
-            attr_accessor :phone
-
-            def initialize(address: nil, email: nil, name: nil, phone: nil)
-              @address = address
-              @email = email
-              @name = name
-              @phone = phone
-            end
-          end
-
-          class UsBankAccount < Stripe::RequestParams
-            # Account holder type: individual or company.
-            attr_accessor :account_holder_type
-            # Account number of the bank account.
-            attr_accessor :account_number
-            # Account type: checkings or savings. Defaults to checking if omitted.
-            attr_accessor :account_type
-            # The ID of a Financial Connections Account to use as a payment method.
-            attr_accessor :financial_connections_account
-            # Routing number of the bank account.
-            attr_accessor :routing_number
-
-            def initialize(
-              account_holder_type: nil,
-              account_number: nil,
-              account_type: nil,
-              financial_connections_account: nil,
-              routing_number: nil
-            )
-              @account_holder_type = account_holder_type
-              @account_number = account_number
-              @account_type = account_type
-              @financial_connections_account = financial_connections_account
-              @routing_number = routing_number
-            end
-          end
-          # Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
-          attr_accessor :billing_details
-          # Required if type is set to `financial_account`. The FinancialAccount ID to send funds to.
-          attr_accessor :financial_account
-          # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
-          attr_accessor :metadata
-          # The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
-          attr_accessor :type
-          # Required hash if type is set to `us_bank_account`.
-          attr_accessor :us_bank_account
-
-          def initialize(
-            billing_details: nil,
-            financial_account: nil,
-            metadata: nil,
-            type: nil,
-            us_bank_account: nil
-          )
-            @billing_details = billing_details
-            @financial_account = financial_account
-            @metadata = metadata
-            @type = type
-            @us_bank_account = us_bank_account
-          end
-        end
-
-        class DestinationPaymentMethodOptions < Stripe::RequestParams
-          class UsBankAccount < Stripe::RequestParams
-            # Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
-            attr_accessor :network
-
-            def initialize(network: nil)
-              @network = network
-            end
-          end
-          # Optional fields for `us_bank_account`.
-          attr_accessor :us_bank_account
-
-          def initialize(us_bank_account: nil)
-            @us_bank_account = us_bank_account
-          end
-        end
-
-        class EndUserDetails < Stripe::RequestParams
-          # IP address of the user initiating the OutboundPayment. Must be supplied if `present` is set to `true`.
-          attr_accessor :ip_address
-          # `True` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`.
-          attr_accessor :present
-
-          def initialize(ip_address: nil, present: nil)
-            @ip_address = ip_address
-            @present = present
-          end
-        end
-        # Amount (in cents) to be transferred.
-        attr_accessor :amount
-        # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
-        attr_accessor :currency
-        # ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the `destination_payment_method` passed in.
-        attr_accessor :customer
-        # An arbitrary string attached to the object. Often useful for displaying to users.
-        attr_accessor :description
-        # The PaymentMethod to use as the payment instrument for the OutboundPayment. Exclusive with `destination_payment_method_data`.
-        attr_accessor :destination_payment_method
-        # Hash used to generate the PaymentMethod to be used for this OutboundPayment. Exclusive with `destination_payment_method`.
-        attr_accessor :destination_payment_method_data
-        # Payment method-specific configuration for this OutboundPayment.
-        attr_accessor :destination_payment_method_options
-        # End user details.
-        attr_accessor :end_user_details
-        # Specifies which fields in the response should be expanded.
-        attr_accessor :expand
-        # The FinancialAccount to pull funds from.
-        attr_accessor :financial_account
-        # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
-        attr_accessor :metadata
-        # The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `us_domestic_wire` payments, or 500 characters for `stripe` network transfers. The default value is "payment".
-        attr_accessor :statement_descriptor
-
-        def initialize(
-          amount: nil,
-          currency: nil,
-          customer: nil,
-          description: nil,
-          destination_payment_method: nil,
-          destination_payment_method_data: nil,
-          destination_payment_method_options: nil,
-          end_user_details: nil,
-          expand: nil,
-          financial_account: nil,
-          metadata: nil,
-          statement_descriptor: nil
-        )
-          @amount = amount
-          @currency = currency
-          @customer = customer
-          @description = description
-          @destination_payment_method = destination_payment_method
-          @destination_payment_method_data = destination_payment_method_data
-          @destination_payment_method_options = destination_payment_method_options
-          @end_user_details = end_user_details
-          @expand = expand
-          @financial_account = financial_account
-          @metadata = metadata
-          @statement_descriptor = statement_descriptor
-        end
-      end
-
-      class RetrieveParams < Stripe::RequestParams
-        # Specifies which fields in the response should be expanded.
-        attr_accessor :expand
-
-        def initialize(expand: nil)
-          @expand = expand
-        end
-      end
-
-      class CancelParams < Stripe::RequestParams
-        # Specifies which fields in the response should be expanded.
-        attr_accessor :expand
-
-        def initialize(expand: nil)
-          @expand = expand
-        end
-      end
-
-      class UpdateParams < Stripe::RequestParams
-        class TrackingDetails < Stripe::RequestParams
-          class Ach < Stripe::RequestParams
-            # ACH trace ID for funds sent over the `ach` network.
-            attr_accessor :trace_id
-
-            def initialize(trace_id: nil)
-              @trace_id = trace_id
-            end
-          end
-
-          class UsDomesticWire < Stripe::RequestParams
-            # CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.
-            attr_accessor :chips
-            # IMAD for funds sent over the `us_domestic_wire` network.
-            attr_accessor :imad
-            # OMAD for funds sent over the `us_domestic_wire` network.
-            attr_accessor :omad
-
-            def initialize(chips: nil, imad: nil, omad: nil)
-              @chips = chips
-              @imad = imad
-              @omad = omad
-            end
-          end
-          # ACH network tracking details.
-          attr_accessor :ach
-          # The US bank account network used to send funds.
-          attr_accessor :type
-          # US domestic wire network tracking details.
-          attr_accessor :us_domestic_wire
-
-          def initialize(ach: nil, type: nil, us_domestic_wire: nil)
-            @ach = ach
-            @type = type
-            @us_domestic_wire = us_domestic_wire
-          end
-        end
-        # Specifies which fields in the response should be expanded.
-        attr_accessor :expand
-        # Details about network-specific tracking information.
-        attr_accessor :tracking_details
-
-        def initialize(expand: nil, tracking_details: nil)
-          @expand = expand
-          @tracking_details = tracking_details
-        end
-      end
-
-      class FailParams < Stripe::RequestParams
-        # Specifies which fields in the response should be expanded.
-        attr_accessor :expand
-
-        def initialize(expand: nil)
-          @expand = expand
-        end
-      end
-
-      class PostParams < Stripe::RequestParams
-        # Specifies which fields in the response should be expanded.
-        attr_accessor :expand
-
-        def initialize(expand: nil)
-          @expand = expand
-        end
-      end
-
-      class ReturnOutboundPaymentParams < Stripe::RequestParams
-        class ReturnedDetails < Stripe::RequestParams
-          # The return code to be set on the OutboundPayment object.
-          attr_accessor :code
-
-          def initialize(code: nil)
-            @code = code
-          end
-        end
-        # Specifies which fields in the response should be expanded.
-        attr_accessor :expand
-        # Optional hash to set the return code.
-        attr_accessor :returned_details
-
-        def initialize(expand: nil, returned_details: nil)
-          @expand = expand
-          @returned_details = returned_details
-        end
-      end
-      # Amount (in cents) transferred.
-      attr_reader :amount
-      # Returns `true` if the object can be canceled, and `false` otherwise.
-      attr_reader :cancelable
-      # Time at which the object was created. Measured in seconds since the Unix epoch.
-      attr_reader :created
-      # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
-      attr_reader :currency
-      # ID of the [customer](https://stripe.com/docs/api/customers) to whom an OutboundPayment is sent.
-      attr_reader :customer
-      # An arbitrary string attached to the object. Often useful for displaying to users.
-      attr_reader :description
-      # The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`.
-      attr_reader :destination_payment_method
-      # Details about the PaymentMethod for an OutboundPayment.
-      attr_reader :destination_payment_method_details
-      # Details about the end user.
-      attr_reader :end_user_details
-      # The date when funds are expected to arrive in the destination account.
-      attr_reader :expected_arrival_date
-      # The FinancialAccount that funds were pulled from.
-      attr_reader :financial_account
-      # A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
-      attr_reader :hosted_regulatory_receipt_url
-      # 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
-      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
-      attr_reader :metadata
-      # String representing the object's type. Objects of the same type share the same value.
-      attr_reader :object
-      # Details about a returned OutboundPayment. Only set when the status is `returned`.
-      attr_reader :returned_details
-      # The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).
-      attr_reader :statement_descriptor
-      # Current status of the OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`. An OutboundPayment is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundPayment has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundPayment fails to arrive at its destination, its status will change to `returned`.
-      attr_reader :status
-      # Attribute for field status_transitions
-      attr_reader :status_transitions
-      # Details about network-specific tracking information if available.
-      attr_reader :tracking_details
-      # The Transaction associated with this object.
-      attr_reader :transaction
-
       # Cancel an OutboundPayment.
       def cancel(params = {}, opts = {})
         request_stripe_object(