stripe 13.4.0 → 13.5.0.pre.beta.1

data/lib/stripe/services/treasury/outbound_payment_service.rb

@@ -4,6 +4,264 @@
 module Stripe
   module Treasury
     class OutboundPaymentService < StripeService
+      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
+
       # Cancel an OutboundPayment.
       def cancel(id, params = {}, opts = {})
         request(

data/lib/stripe/services/treasury/outbound_transfer_service.rb

@@ -4,6 +4,154 @@
 module Stripe
   module Treasury
     class OutboundTransferService < StripeService
+      class ListParams < 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 OutboundTransfers that have the given status: `processing`, `canceled`, `failed`, `posted`, or `returned`.
+        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
+
+      class CreateParams < Stripe::RequestParams
+        class DestinationPaymentMethodData < Stripe::RequestParams
+          # Required if type is set to `financial_account`. The FinancialAccount ID to send funds to.
+          attr_accessor :financial_account
+          # The type of the destination.
+          attr_accessor :type
+
+          def initialize(financial_account: nil, type: nil)
+            @financial_account = financial_account
+            @type = type
+          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 NetworkDetails < Stripe::RequestParams
+          class Ach < Stripe::RequestParams
+            # Addenda record data associated with this OutboundTransfer.
+            attr_accessor :addenda
+
+            def initialize(addenda: nil)
+              @addenda = addenda
+            end
+          end
+          # Optional fields for `ach`.
+          attr_accessor :ach
+          # The type of flow that originated the OutboundTransfer.
+          attr_accessor :type
+
+          def initialize(ach: nil, type: nil)
+            @ach = ach
+            @type = type
+          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
+        # 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 OutboundTransfer.
+        attr_accessor :destination_payment_method
+        # Hash used to generate the PaymentMethod to be used for this OutboundTransfer. Exclusive with `destination_payment_method`.
+        attr_accessor :destination_payment_method_data
+        # Hash describing payment method configuration details.
+        attr_accessor :destination_payment_method_options
+        # 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
+        # Details about the network used for the OutboundTransfer.
+        attr_accessor :network_details
+        # Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is "transfer".
+        attr_accessor :statement_descriptor
+
+        def initialize(
+          amount: nil,
+          currency: nil,
+          description: nil,
+          destination_payment_method: nil,
+          destination_payment_method_data: nil,
+          destination_payment_method_options: nil,
+          expand: nil,
+          financial_account: nil,
+          metadata: nil,
+          network_details: nil,
+          statement_descriptor: nil
+        )
+          @amount = amount
+          @currency = currency
+          @description = description
+          @destination_payment_method = destination_payment_method
+          @destination_payment_method_data = destination_payment_method_data
+          @destination_payment_method_options = destination_payment_method_options
+          @expand = expand
+          @financial_account = financial_account
+          @metadata = metadata
+          @network_details = network_details
+          @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
+
       # An OutboundTransfer can be canceled if the funds have not yet been paid out.
       def cancel(outbound_transfer, params = {}, opts = {})
         request(

data/lib/stripe/services/treasury/received_credit_service.rb

@@ -4,6 +4,58 @@
 module Stripe
   module Treasury
     class ReceivedCreditService < StripeService
+      class ListParams < Stripe::RequestParams
+        class LinkedFlows < Stripe::RequestParams
+          # The source flow type.
+          attr_accessor :source_flow_type
+
+          def initialize(source_flow_type: nil)
+            @source_flow_type = source_flow_type
+          end
+        end
+        # 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
+        # The FinancialAccount that received the funds.
+        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
+        # Only return ReceivedCredits described by the flow.
+        attr_accessor :linked_flows
+        # 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 ReceivedCredits that have the given status: `succeeded` or `failed`.
+        attr_accessor :status
+
+        def initialize(
+          ending_before: nil,
+          expand: nil,
+          financial_account: nil,
+          limit: nil,
+          linked_flows: nil,
+          starting_after: nil,
+          status: nil
+        )
+          @ending_before = ending_before
+          @expand = expand
+          @financial_account = financial_account
+          @limit = limit
+          @linked_flows = linked_flows
+          @starting_after = starting_after
+          @status = status
+        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
+
       # Returns a list of ReceivedCredits.
       def list(params = {}, opts = {})
         request(

data/lib/stripe/services/treasury/received_debit_service.rb

@@ -4,6 +4,46 @@
 module Stripe
   module Treasury
     class ReceivedDebitService < StripeService
+      class ListParams < 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
+        # The FinancialAccount that funds were pulled from.
+        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 ReceivedDebits that have the given status: `succeeded` or `failed`.
+        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
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
       # Returns a list of ReceivedDebits.
       def list(params = {}, opts = {})
         request(

data/lib/stripe/services/treasury/transaction_entry_service.rb

@@ -4,6 +4,93 @@
 module Stripe
   module Treasury
     class TransactionEntryService < StripeService
+      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
+
+        class EffectiveAt < 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 TransactionEntries that were created during the given date interval.
+        attr_accessor :created
+        # Attribute for param field effective_at
+        attr_accessor :effective_at
+        # 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
+        # The results are in reverse chronological order by `created` or `effective_at`. The default is `created`.
+        attr_accessor :order_by
+        # 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 TransactionEntries associated with this Transaction.
+        attr_accessor :transaction
+
+        def initialize(
+          created: nil,
+          effective_at: nil,
+          ending_before: nil,
+          expand: nil,
+          financial_account: nil,
+          limit: nil,
+          order_by: nil,
+          starting_after: nil,
+          transaction: nil
+        )
+          @created = created
+          @effective_at = effective_at
+          @ending_before = ending_before
+          @expand = expand
+          @financial_account = financial_account
+          @limit = limit
+          @order_by = order_by
+          @starting_after = starting_after
+          @transaction = transaction
+        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
+
       # Retrieves a list of TransactionEntry objects.
       def list(params = {}, opts = {})
         request(