stripe 13.5.0 → 14.0.0

data/lib/stripe/resources/topup.rb

@@ -17,6 +17,171 @@ module Stripe
       "topup"
     end
 
+    class ListParams < Stripe::RequestParams
+      class Amount < 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 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
+      # A positive integer representing how much to transfer.
+      attr_accessor :amount
+      # A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
+      attr_accessor :created
+      # 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
+      # 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 top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`.
+      attr_accessor :status
+
+      def initialize(
+        amount: nil,
+        created: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        starting_after: nil,
+        status: nil
+      )
+        @amount = amount
+        @created = created
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+        @status = status
+      end
+    end
+
+    class CreateParams < Stripe::RequestParams
+      # A positive integer representing how much to transfer.
+      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
+      # 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 ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)).
+      attr_accessor :source
+      # Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters.
+      attr_accessor :statement_descriptor
+      # A string that identifies this top-up as part of a group.
+      attr_accessor :transfer_group
+
+      def initialize(
+        amount: nil,
+        currency: nil,
+        description: nil,
+        expand: nil,
+        metadata: nil,
+        source: nil,
+        statement_descriptor: nil,
+        transfer_group: nil
+      )
+        @amount = amount
+        @currency = currency
+        @description = description
+        @expand = expand
+        @metadata = metadata
+        @source = source
+        @statement_descriptor = statement_descriptor
+        @transfer_group = transfer_group
+      end
+    end
+
+    class UpdateParams < Stripe::RequestParams
+      # 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
+      # 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
+
+      def initialize(description: nil, expand: nil, metadata: nil)
+        @description = description
+        @expand = expand
+        @metadata = metadata
+      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
+    # Amount transferred.
+    attr_reader :amount
+    # ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.
+    attr_reader :balance_transaction
+    # 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
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_reader :description
+    # Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.
+    attr_reader :expected_availability_date
+    # Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes).
+    attr_reader :failure_code
+    # Message to user further explaining reason for top-up failure if available.
+    attr_reader :failure_message
+    # 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
+    # The source field is deprecated. It might not always be present in the API response.
+    attr_reader :source
+    # Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.
+    attr_reader :statement_descriptor
+    # The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`.
+    attr_reader :status
+    # A string that identifies this top-up as part of a group.
+    attr_reader :transfer_group
+
     # Cancels a top-up. Only pending top-ups can be canceled.
     def cancel(params = {}, opts = {})
       request_stripe_object(

data/lib/stripe/resources/transfer.rb

@@ -25,6 +25,150 @@ module Stripe
 
     nested_resource_class_methods :reversal, operations: %i[create retrieve update list]
 
+    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 transfers that were created during the given date interval.
+      attr_accessor :created
+      # Only return transfers for the destination specified by this account ID.
+      attr_accessor :destination
+      # 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
+      # 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 transfers with the specified transfer group.
+      attr_accessor :transfer_group
+
+      def initialize(
+        created: nil,
+        destination: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        starting_after: nil,
+        transfer_group: nil
+      )
+        @created = created
+        @destination = destination
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+        @transfer_group = transfer_group
+      end
+    end
+
+    class CreateParams < Stripe::RequestParams
+      # A positive integer in cents (or local equivalent) representing how much to transfer.
+      attr_accessor :amount
+      # Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies).
+      attr_accessor :currency
+      # An arbitrary string attached to the object. Often useful for displaying to users.
+      attr_accessor :description
+      # The ID of a connected Stripe account. <a href="/docs/connect/separate-charges-and-transfers">See the Connect documentation</a> for details.
+      attr_accessor :destination
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # 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
+      # You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-availability) for details.
+      attr_accessor :source_transaction
+      # The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`.
+      attr_accessor :source_type
+      # A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
+      attr_accessor :transfer_group
+
+      def initialize(
+        amount: nil,
+        currency: nil,
+        description: nil,
+        destination: nil,
+        expand: nil,
+        metadata: nil,
+        source_transaction: nil,
+        source_type: nil,
+        transfer_group: nil
+      )
+        @amount = amount
+        @currency = currency
+        @description = description
+        @destination = destination
+        @expand = expand
+        @metadata = metadata
+        @source_transaction = source_transaction
+        @source_type = source_type
+        @transfer_group = transfer_group
+      end
+    end
+
+    class UpdateParams < Stripe::RequestParams
+      # 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
+      # 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
+
+      def initialize(description: nil, expand: nil, metadata: nil)
+        @description = description
+        @expand = expand
+        @metadata = metadata
+      end
+    end
+    # Amount in cents (or local equivalent) to be transferred.
+    attr_reader :amount
+    # Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).
+    attr_reader :amount_reversed
+    # Balance transaction that describes the impact of this transfer on your account balance.
+    attr_reader :balance_transaction
+    # Time that this record of the transfer was first created.
+    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
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_reader :description
+    # ID of the Stripe account the transfer was sent to.
+    attr_reader :destination
+    # If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.
+    attr_reader :destination_payment
+    # 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
+    # A list of reversals that have been applied to the transfer.
+    attr_reader :reversals
+    # Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.
+    attr_reader :reversed
+    # ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.
+    attr_reader :source_transaction
+    # The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`.
+    attr_reader :source_type
+    # A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
+    attr_reader :transfer_group
+
     # To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://stripe.com/docs/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error.
     def self.create(params = {}, opts = {})
       request_stripe_object(method: :post, path: "/v1/transfers", params: params, opts: opts)

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

@@ -13,6 +13,89 @@ module Stripe
         "treasury.credit_reversal"
       end
 
+      class StatusTransitions < Stripe::StripeObject
+        # Timestamp describing when the CreditReversal changed status to `posted`
+        attr_reader :posted_at
+      end
+
+      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
+        # Only return CreditReversals for the ReceivedCredit ID.
+        attr_accessor :received_credit
+        # 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 CreditReversals for a given status.
+        attr_accessor :status
+
+        def initialize(
+          ending_before: nil,
+          expand: nil,
+          financial_account: nil,
+          limit: nil,
+          received_credit: nil,
+          starting_after: nil,
+          status: nil
+        )
+          @ending_before = ending_before
+          @expand = expand
+          @financial_account = financial_account
+          @limit = limit
+          @received_credit = received_credit
+          @starting_after = starting_after
+          @status = status
+        end
+      end
+
+      class CreateParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # 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 ReceivedCredit to reverse.
+        attr_accessor :received_credit
+
+        def initialize(expand: nil, metadata: nil, received_credit: nil)
+          @expand = expand
+          @metadata = metadata
+          @received_credit = received_credit
+        end
+      end
+      # Amount (in cents) transferred.
+      attr_reader :amount
+      # 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
+      # The FinancialAccount to reverse funds 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
+      # The rails used to reverse the funds.
+      attr_reader :network
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The ReceivedCredit being reversed.
+      attr_reader :received_credit
+      # Status of the CreditReversal
+      attr_reader :status
+      # Attribute for field status_transitions
+      attr_reader :status_transitions
+      # The Transaction associated with this object.
+      attr_reader :transaction
+
       # Reverses a ReceivedCredit and creates a CreditReversal object.
       def self.create(params = {}, opts = {})
         request_stripe_object(

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

@@ -13,6 +13,100 @@ module Stripe
         "treasury.debit_reversal"
       end
 
+      class LinkedFlows < Stripe::StripeObject
+        # Set if there is an Issuing dispute associated with the DebitReversal.
+        attr_reader :issuing_dispute
+      end
+
+      class StatusTransitions < Stripe::StripeObject
+        # Timestamp describing when the DebitReversal changed status to `completed`.
+        attr_reader :completed_at
+      end
+
+      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
+        # Only return DebitReversals for the ReceivedDebit ID.
+        attr_accessor :received_debit
+        # Only return DebitReversals for a given resolution.
+        attr_accessor :resolution
+        # 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 DebitReversals for a given status.
+        attr_accessor :status
+
+        def initialize(
+          ending_before: nil,
+          expand: nil,
+          financial_account: nil,
+          limit: nil,
+          received_debit: nil,
+          resolution: nil,
+          starting_after: nil,
+          status: nil
+        )
+          @ending_before = ending_before
+          @expand = expand
+          @financial_account = financial_account
+          @limit = limit
+          @received_debit = received_debit
+          @resolution = resolution
+          @starting_after = starting_after
+          @status = status
+        end
+      end
+
+      class CreateParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # 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 ReceivedDebit to reverse.
+        attr_accessor :received_debit
+
+        def initialize(expand: nil, metadata: nil, received_debit: nil)
+          @expand = expand
+          @metadata = metadata
+          @received_debit = received_debit
+        end
+      end
+      # Amount (in cents) transferred.
+      attr_reader :amount
+      # 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
+      # The FinancialAccount to reverse funds 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
+      # Other flows linked to a DebitReversal.
+      attr_reader :linked_flows
+      # 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
+      # The rails used to reverse the funds.
+      attr_reader :network
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The ReceivedDebit being reversed.
+      attr_reader :received_debit
+      # Status of the DebitReversal
+      attr_reader :status
+      # Attribute for field status_transitions
+      attr_reader :status_transitions
+      # The Transaction associated with this object.
+      attr_reader :transaction
+
       # Reverses a ReceivedDebit and creates a DebitReversal object.
       def self.create(params = {}, opts = {})
         request_stripe_object(