stripe 5.55.0 → 18.2.0.pre.beta.1

data/lib/stripe/params/treasury/financial_account_update_params.rb

@@ -0,0 +1,223 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class FinancialAccountUpdateParams < ::Stripe::RequestParams
+      class Features < ::Stripe::RequestParams
+        class CardIssuing < ::Stripe::RequestParams
+          # Whether the FinancialAccount should have the Feature.
+          attr_accessor :requested
+
+          def initialize(requested: nil)
+            @requested = requested
+          end
+        end
+
+        class DepositInsurance < ::Stripe::RequestParams
+          # Whether the FinancialAccount should have the Feature.
+          attr_accessor :requested
+
+          def initialize(requested: nil)
+            @requested = requested
+          end
+        end
+
+        class FinancialAddresses < ::Stripe::RequestParams
+          class Aba < ::Stripe::RequestParams
+            # Requested bank partner
+            attr_accessor :bank
+            # Whether the FinancialAccount should have the Feature.
+            attr_accessor :requested
+
+            def initialize(bank: nil, requested: nil)
+              @bank = bank
+              @requested = requested
+            end
+          end
+          # Adds an ABA FinancialAddress to the FinancialAccount.
+          attr_accessor :aba
+
+          def initialize(aba: nil)
+            @aba = aba
+          end
+        end
+
+        class InboundTransfers < ::Stripe::RequestParams
+          class Ach < ::Stripe::RequestParams
+            # Whether the FinancialAccount should have the Feature.
+            attr_accessor :requested
+
+            def initialize(requested: nil)
+              @requested = requested
+            end
+          end
+          # Enables ACH Debits via the InboundTransfers API.
+          attr_accessor :ach
+
+          def initialize(ach: nil)
+            @ach = ach
+          end
+        end
+
+        class IntraStripeFlows < ::Stripe::RequestParams
+          # Whether the FinancialAccount should have the Feature.
+          attr_accessor :requested
+
+          def initialize(requested: nil)
+            @requested = requested
+          end
+        end
+
+        class OutboundPayments < ::Stripe::RequestParams
+          class Ach < ::Stripe::RequestParams
+            # Whether the FinancialAccount should have the Feature.
+            attr_accessor :requested
+
+            def initialize(requested: nil)
+              @requested = requested
+            end
+          end
+
+          class UsDomesticWire < ::Stripe::RequestParams
+            # Whether the FinancialAccount should have the Feature.
+            attr_accessor :requested
+
+            def initialize(requested: nil)
+              @requested = requested
+            end
+          end
+          # Enables ACH transfers via the OutboundPayments API.
+          attr_accessor :ach
+          # Enables US domestic wire transfers via the OutboundPayments API.
+          attr_accessor :us_domestic_wire
+
+          def initialize(ach: nil, us_domestic_wire: nil)
+            @ach = ach
+            @us_domestic_wire = us_domestic_wire
+          end
+        end
+
+        class OutboundTransfers < ::Stripe::RequestParams
+          class Ach < ::Stripe::RequestParams
+            # Whether the FinancialAccount should have the Feature.
+            attr_accessor :requested
+
+            def initialize(requested: nil)
+              @requested = requested
+            end
+          end
+
+          class UsDomesticWire < ::Stripe::RequestParams
+            # Whether the FinancialAccount should have the Feature.
+            attr_accessor :requested
+
+            def initialize(requested: nil)
+              @requested = requested
+            end
+          end
+          # Enables ACH transfers via the OutboundTransfers API.
+          attr_accessor :ach
+          # Enables US domestic wire transfers via the OutboundTransfers API.
+          attr_accessor :us_domestic_wire
+
+          def initialize(ach: nil, us_domestic_wire: nil)
+            @ach = ach
+            @us_domestic_wire = us_domestic_wire
+          end
+        end
+        # Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.
+        attr_accessor :card_issuing
+        # Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.
+        attr_accessor :deposit_insurance
+        # Contains Features that add FinancialAddresses to the FinancialAccount.
+        attr_accessor :financial_addresses
+        # Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.
+        attr_accessor :inbound_transfers
+        # Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).
+        attr_accessor :intra_stripe_flows
+        # Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.
+        attr_accessor :outbound_payments
+        # Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.
+        attr_accessor :outbound_transfers
+
+        def initialize(
+          card_issuing: nil,
+          deposit_insurance: nil,
+          financial_addresses: nil,
+          inbound_transfers: nil,
+          intra_stripe_flows: nil,
+          outbound_payments: nil,
+          outbound_transfers: nil
+        )
+          @card_issuing = card_issuing
+          @deposit_insurance = deposit_insurance
+          @financial_addresses = financial_addresses
+          @inbound_transfers = inbound_transfers
+          @intra_stripe_flows = intra_stripe_flows
+          @outbound_payments = outbound_payments
+          @outbound_transfers = outbound_transfers
+        end
+      end
+
+      class ForwardingSettings < ::Stripe::RequestParams
+        # The financial_account id
+        attr_accessor :financial_account
+        # The payment_method or bank account id. This needs to be a verified bank account.
+        attr_accessor :payment_method
+        # The type of the bank account provided. This can be either "financial_account" or "payment_method"
+        attr_accessor :type
+
+        def initialize(financial_account: nil, payment_method: nil, type: nil)
+          @financial_account = financial_account
+          @payment_method = payment_method
+          @type = type
+        end
+      end
+
+      class PlatformRestrictions < ::Stripe::RequestParams
+        # Restricts all inbound money movement.
+        attr_accessor :inbound_flows
+        # Restricts all outbound money movement.
+        attr_accessor :outbound_flows
+
+        def initialize(inbound_flows: nil, outbound_flows: nil)
+          @inbound_flows = inbound_flows
+          @outbound_flows = outbound_flows
+        end
+      end
+      # The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
+      attr_accessor :display_name
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # Encodes whether a FinancialAccount has access to a particular feature, with a status enum and associated `status_details`. Stripe or the platform may control features via the requested field.
+      attr_accessor :features
+      # A different bank account where funds can be deposited/debited in order to get the closing FA's balance to $0
+      attr_accessor :forwarding_settings
+      # Set of [key-value pairs](https://docs.stripe.com/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 nickname for the FinancialAccount.
+      attr_accessor :nickname
+      # The set of functionalities that the platform can restrict on the FinancialAccount.
+      attr_accessor :platform_restrictions
+
+      def initialize(
+        display_name: nil,
+        expand: nil,
+        features: nil,
+        forwarding_settings: nil,
+        metadata: nil,
+        nickname: nil,
+        platform_restrictions: nil
+      )
+        @display_name = display_name
+        @expand = expand
+        @features = features
+        @forwarding_settings = forwarding_settings
+        @metadata = metadata
+        @nickname = nickname
+        @platform_restrictions = platform_restrictions
+      end
+    end
+  end
+end

data/lib/stripe/params/treasury/inbound_transfer_cancel_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class InboundTransferCancelParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/treasury/inbound_transfer_create_params.rb

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class InboundTransferCreateParams < ::Stripe::RequestParams
+      # 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
+      # An arbitrary string attached to the object. Often useful for displaying to users.
+      attr_accessor :description
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # The FinancialAccount to send funds to.
+      attr_accessor :financial_account
+      # Set of [key-value pairs](https://docs.stripe.com/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 origin payment method to be debited for the InboundTransfer.
+      attr_accessor :origin_payment_method
+      # The complete description that appears on your customers' statements. Maximum 10 characters. Can only include -#.$&*, spaces, and alphanumeric characters.
+      attr_accessor :statement_descriptor
+
+      def initialize(
+        amount: nil,
+        currency: nil,
+        description: nil,
+        expand: nil,
+        financial_account: nil,
+        metadata: nil,
+        origin_payment_method: nil,
+        statement_descriptor: nil
+      )
+        @amount = amount
+        @currency = currency
+        @description = description
+        @expand = expand
+        @financial_account = financial_account
+        @metadata = metadata
+        @origin_payment_method = origin_payment_method
+        @statement_descriptor = statement_descriptor
+      end
+    end
+  end
+end

data/lib/stripe/params/treasury/inbound_transfer_fail_params.rb

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class InboundTransferFailParams < ::Stripe::RequestParams
+      class FailureDetails < ::Stripe::RequestParams
+        # Reason for the failure.
+        attr_accessor :code
+
+        def initialize(code: nil)
+          @code = code
+        end
+      end
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # Details about a failed InboundTransfer.
+      attr_accessor :failure_details
+
+      def initialize(expand: nil, failure_details: nil)
+        @expand = expand
+        @failure_details = failure_details
+      end
+    end
+  end
+end

data/lib/stripe/params/treasury/inbound_transfer_list_params.rb

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class InboundTransferListParams < ::Stripe::RequestParams
+      # 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 InboundTransfers that have the given status: `processing`, `succeeded`, `failed` or `canceled`.
+      attr_accessor :status
+
+      def initialize(
+        ending_before: nil,
+        expand: nil,
+        financial_account: nil,
+        limit: nil,
+        starting_after: nil,
+        status: nil
+      )
+        @ending_before = ending_before
+        @expand = expand
+        @financial_account = financial_account
+        @limit = limit
+        @starting_after = starting_after
+        @status = status
+      end
+    end
+  end
+end

data/lib/stripe/params/treasury/inbound_transfer_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class InboundTransferRetrieveParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/treasury/inbound_transfer_return_inbound_transfer_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class InboundTransferReturnInboundTransferParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/treasury/inbound_transfer_succeed_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class InboundTransferSucceedParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/treasury/outbound_payment_cancel_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class OutboundPaymentCancelParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/treasury/outbound_payment_create_params.rb

@@ -0,0 +1,190 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class OutboundPaymentCreateParams < ::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, such as the street, PO Box, or company name.
+            attr_accessor :line1
+            # Address line 2, such as the apartment, suite, unit, or building.
+            attr_accessor :line2
+            # ZIP or postal code.
+            attr_accessor :postal_code
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
+            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://docs.stripe.com/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://docs.stripe.com/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://docs.stripe.com/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. Can only include -#.$&*, spaces, and alphanumeric characters. 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
+  end
+end

data/lib/stripe/params/treasury/outbound_payment_fail_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class OutboundPaymentFailParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/treasury/outbound_payment_list_params.rb

@@ -0,0 +1,62 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class OutboundPaymentListParams < ::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
+  end
+end