stripe 13.4.1 → 17.0.1

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

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class OutboundPaymentPostParams < 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_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class OutboundPaymentRetrieveParams < 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_return_outbound_payment_params.rb

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

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

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

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

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class OutboundTransferCancelParams < 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_transfer_create_params.rb

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

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

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class OutboundTransferFailParams < 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_transfer_list_params.rb

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

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

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class OutboundTransferPostParams < 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_transfer_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class OutboundTransferRetrieveParams < 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_transfer_return_outbound_transfer_params.rb

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class OutboundTransferReturnOutboundTransferParams < Stripe::RequestParams
+      class ReturnedDetails < Stripe::RequestParams
+        # Reason for the return.
+        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 returned OutboundTransfer.
+      attr_accessor :returned_details
+
+      def initialize(expand: nil, returned_details: nil)
+        @expand = expand
+        @returned_details = returned_details
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,66 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class ReceivedCreditCreateParams < Stripe::RequestParams
+      class InitiatingPaymentMethodDetails < Stripe::RequestParams
+        class UsBankAccount < Stripe::RequestParams
+          # The bank account holder's name.
+          attr_accessor :account_holder_name
+          # The bank account number.
+          attr_accessor :account_number
+          # The bank account's routing number.
+          attr_accessor :routing_number
+
+          def initialize(account_holder_name: nil, account_number: nil, routing_number: nil)
+            @account_holder_name = account_holder_name
+            @account_number = account_number
+            @routing_number = routing_number
+          end
+        end
+        # The source type.
+        attr_accessor :type
+        # Optional fields for `us_bank_account`.
+        attr_accessor :us_bank_account
+
+        def initialize(type: nil, us_bank_account: nil)
+          @type = type
+          @us_bank_account = us_bank_account
+        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
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # The FinancialAccount to send funds to.
+      attr_accessor :financial_account
+      # Initiating payment method details for the object.
+      attr_accessor :initiating_payment_method_details
+      # 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(
+        amount: nil,
+        currency: nil,
+        description: nil,
+        expand: nil,
+        financial_account: nil,
+        initiating_payment_method_details: nil,
+        network: nil
+      )
+        @amount = amount
+        @currency = currency
+        @description = description
+        @expand = expand
+        @financial_account = financial_account
+        @initiating_payment_method_details = initiating_payment_method_details
+        @network = network
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class ReceivedCreditRetrieveParams < 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/received_debit_create_params.rb

@@ -0,0 +1,66 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class ReceivedDebitCreateParams < Stripe::RequestParams
+      class InitiatingPaymentMethodDetails < Stripe::RequestParams
+        class UsBankAccount < Stripe::RequestParams
+          # The bank account holder's name.
+          attr_accessor :account_holder_name
+          # The bank account number.
+          attr_accessor :account_number
+          # The bank account's routing number.
+          attr_accessor :routing_number
+
+          def initialize(account_holder_name: nil, account_number: nil, routing_number: nil)
+            @account_holder_name = account_holder_name
+            @account_number = account_number
+            @routing_number = routing_number
+          end
+        end
+        # The source type.
+        attr_accessor :type
+        # Optional fields for `us_bank_account`.
+        attr_accessor :us_bank_account
+
+        def initialize(type: nil, us_bank_account: nil)
+          @type = type
+          @us_bank_account = us_bank_account
+        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
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # The FinancialAccount to pull funds from.
+      attr_accessor :financial_account
+      # Initiating payment method details for the object.
+      attr_accessor :initiating_payment_method_details
+      # 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(
+        amount: nil,
+        currency: nil,
+        description: nil,
+        expand: nil,
+        financial_account: nil,
+        initiating_payment_method_details: nil,
+        network: nil
+      )
+        @amount = amount
+        @currency = currency
+        @description = description
+        @expand = expand
+        @financial_account = financial_account
+        @initiating_payment_method_details = initiating_payment_method_details
+        @network = network
+      end
+    end
+  end
+end

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

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

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

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