stripe 15.0.0 → 15.1.0.pre.beta.2

data/rbi/stripe/resources/treasury/debit_reversal.rbi

@@ -1,131 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-# typed: true
-module Stripe
-  module Treasury
-    # You can reverse some [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.
-    class DebitReversal < APIResource
-      class LinkedFlows < Stripe::StripeObject
-        # Set if there is an Issuing dispute associated with the DebitReversal.
-        sig { returns(T.nilable(String)) }
-        attr_reader :issuing_dispute
-      end
-      class StatusTransitions < Stripe::StripeObject
-        # Timestamp describing when the DebitReversal changed status to `completed`.
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :completed_at
-      end
-      # Amount (in cents) transferred.
-      sig { returns(Integer) }
-      attr_reader :amount
-      # Time at which the object was created. Measured in seconds since the Unix epoch.
-      sig { returns(Integer) }
-      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).
-      sig { returns(String) }
-      attr_reader :currency
-      # The FinancialAccount to reverse funds from.
-      sig { returns(T.nilable(String)) }
-      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.
-      sig { returns(T.nilable(String)) }
-      attr_reader :hosted_regulatory_receipt_url
-      # Unique identifier for the object.
-      sig { returns(String) }
-      attr_reader :id
-      # Other flows linked to a DebitReversal.
-      sig { returns(T.nilable(LinkedFlows)) }
-      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.
-      sig { returns(T::Boolean) }
-      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.
-      sig { returns(T::Hash[String, String]) }
-      attr_reader :metadata
-      # The rails used to reverse the funds.
-      sig { returns(String) }
-      attr_reader :network
-      # String representing the object's type. Objects of the same type share the same value.
-      sig { returns(String) }
-      attr_reader :object
-      # The ReceivedDebit being reversed.
-      sig { returns(String) }
-      attr_reader :received_debit
-      # Status of the DebitReversal
-      sig { returns(String) }
-      attr_reader :status
-      # Attribute for field status_transitions
-      sig { returns(StatusTransitions) }
-      attr_reader :status_transitions
-      # The Transaction associated with this object.
-      sig { returns(T.nilable(T.any(String, Stripe::Treasury::Transaction))) }
-      attr_reader :transaction
-      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.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :ending_before
-        # Specifies which fields in the response should be expanded.
-        sig { returns(T.nilable(T::Array[String])) }
-        attr_accessor :expand
-        # Returns objects associated with this FinancialAccount.
-        sig { returns(String) }
-        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.
-        sig { returns(T.nilable(Integer)) }
-        attr_accessor :limit
-        # Only return DebitReversals for the ReceivedDebit ID.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :received_debit
-        # Only return DebitReversals for a given resolution.
-        sig { returns(T.nilable(String)) }
-        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.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :starting_after
-        # Only return DebitReversals for a given status.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :status
-        sig {
-          params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), financial_account: String, limit: T.nilable(Integer), received_debit: T.nilable(String), resolution: T.nilable(String), starting_after: T.nilable(String), status: T.nilable(String)).void
-         }
-        def initialize(
-          ending_before: nil,
-          expand: nil,
-          financial_account: nil,
-          limit: nil,
-          received_debit: nil,
-          resolution: nil,
-          starting_after: nil,
-          status: nil
-        ); end
-      end
-      class CreateParams < Stripe::RequestParams
-        # Specifies which fields in the response should be expanded.
-        sig { returns(T.nilable(T::Array[String])) }
-        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`.
-        sig { returns(T.nilable(T::Hash[String, String])) }
-        attr_accessor :metadata
-        # The ReceivedDebit to reverse.
-        sig { returns(String) }
-        attr_accessor :received_debit
-        sig {
-          params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), received_debit: String).void
-         }
-        def initialize(expand: nil, metadata: nil, received_debit: nil); end
-      end
-      # Reverses a ReceivedDebit and creates a DebitReversal object.
-      sig {
-        params(params: T.any(::Stripe::Treasury::DebitReversal::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Treasury::DebitReversal)
-       }
-      def self.create(params = {}, opts = {}); end
-
-      # Returns a list of DebitReversals.
-      sig {
-        params(params: T.any(::Stripe::Treasury::DebitReversal::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
-       }
-      def self.list(params = {}, opts = {}); end
-    end
-  end
-end