stripe 13.3.0 → 13.4.0.pre.beta.1

data/rbi/stripe/resources/refund.rbi

@@ -0,0 +1,615 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # Refund objects allow you to refund a previously created charge that isn't
+  # refunded yet. Funds are refunded to the credit or debit card that's
+  # initially charged.
+  #
+  # Related guide: [Refunds](https://stripe.com/docs/refunds)
+  class Refund < APIResource
+    class DestinationDetails < Stripe::StripeObject
+      class Affirm < Stripe::StripeObject; end
+      class AfterpayClearpay < Stripe::StripeObject; end
+      class Alipay < Stripe::StripeObject; end
+      class Alma < Stripe::StripeObject; end
+      class AmazonPay < Stripe::StripeObject; end
+      class AuBankTransfer < Stripe::StripeObject; end
+      class Blik < Stripe::StripeObject
+        # For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.
+        sig { returns(T.nilable(String)) }
+        attr_reader :network_decline_code
+
+        # The reference assigned to the refund.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference
+
+        # Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference_status
+      end
+      class BrBankTransfer < Stripe::StripeObject
+        # The reference assigned to the refund.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference
+
+        # Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference_status
+      end
+      class Card < Stripe::StripeObject
+        # Value of the reference number assigned to the refund.
+        sig { returns(String) }
+        attr_reader :reference
+
+        # Status of the reference number on the refund. This can be `pending`, `available` or `unavailable`.
+        sig { returns(String) }
+        attr_reader :reference_status
+
+        # Type of the reference number assigned to the refund.
+        sig { returns(String) }
+        attr_reader :reference_type
+
+        # The type of refund. This can be `refund`, `reversal`, or `pending`.
+        sig { returns(String) }
+        attr_reader :type
+      end
+      class Cashapp < Stripe::StripeObject; end
+      class CustomerCashBalance < Stripe::StripeObject; end
+      class Eps < Stripe::StripeObject; end
+      class EuBankTransfer < Stripe::StripeObject
+        # The reference assigned to the refund.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference
+
+        # Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference_status
+      end
+      class GbBankTransfer < Stripe::StripeObject
+        # The reference assigned to the refund.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference
+
+        # Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference_status
+      end
+      class Giropay < Stripe::StripeObject; end
+      class Grabpay < Stripe::StripeObject; end
+      class IdBankTransfer < Stripe::StripeObject
+        # The reference assigned to the refund.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference
+
+        # Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference_status
+      end
+      class JpBankTransfer < Stripe::StripeObject
+        # The reference assigned to the refund.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference
+
+        # Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference_status
+      end
+      class Klarna < Stripe::StripeObject; end
+      class Multibanco < Stripe::StripeObject
+        # The reference assigned to the refund.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference
+
+        # Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference_status
+      end
+      class MxBankTransfer < Stripe::StripeObject
+        # The reference assigned to the refund.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference
+
+        # Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference_status
+      end
+      class P24 < Stripe::StripeObject
+        # The reference assigned to the refund.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference
+
+        # Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference_status
+      end
+      class Paynow < Stripe::StripeObject; end
+      class Paypal < Stripe::StripeObject; end
+      class Pix < Stripe::StripeObject; end
+      class Revolut < Stripe::StripeObject; end
+      class Sofort < Stripe::StripeObject; end
+      class Swish < Stripe::StripeObject
+        # For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.
+        sig { returns(T.nilable(String)) }
+        attr_reader :network_decline_code
+
+        # The reference assigned to the refund.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference
+
+        # Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference_status
+      end
+      class ThBankTransfer < Stripe::StripeObject
+        # The reference assigned to the refund.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference
+
+        # Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference_status
+      end
+      class UsBankTransfer < Stripe::StripeObject
+        # The reference assigned to the refund.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference
+
+        # Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference_status
+      end
+      class WechatPay < Stripe::StripeObject; end
+      class Zip < Stripe::StripeObject; end
+      # Attribute for field affirm
+      sig { returns(Affirm) }
+      attr_reader :affirm
+
+      # Attribute for field afterpay_clearpay
+      sig { returns(AfterpayClearpay) }
+      attr_reader :afterpay_clearpay
+
+      # Attribute for field alipay
+      sig { returns(Alipay) }
+      attr_reader :alipay
+
+      # Attribute for field alma
+      sig { returns(Alma) }
+      attr_reader :alma
+
+      # Attribute for field amazon_pay
+      sig { returns(AmazonPay) }
+      attr_reader :amazon_pay
+
+      # Attribute for field au_bank_transfer
+      sig { returns(AuBankTransfer) }
+      attr_reader :au_bank_transfer
+
+      # Attribute for field blik
+      sig { returns(Blik) }
+      attr_reader :blik
+
+      # Attribute for field br_bank_transfer
+      sig { returns(BrBankTransfer) }
+      attr_reader :br_bank_transfer
+
+      # Attribute for field card
+      sig { returns(Card) }
+      attr_reader :card
+
+      # Attribute for field cashapp
+      sig { returns(Cashapp) }
+      attr_reader :cashapp
+
+      # Attribute for field customer_cash_balance
+      sig { returns(CustomerCashBalance) }
+      attr_reader :customer_cash_balance
+
+      # Attribute for field eps
+      sig { returns(Eps) }
+      attr_reader :eps
+
+      # Attribute for field eu_bank_transfer
+      sig { returns(EuBankTransfer) }
+      attr_reader :eu_bank_transfer
+
+      # Attribute for field gb_bank_transfer
+      sig { returns(GbBankTransfer) }
+      attr_reader :gb_bank_transfer
+
+      # Attribute for field giropay
+      sig { returns(Giropay) }
+      attr_reader :giropay
+
+      # Attribute for field grabpay
+      sig { returns(Grabpay) }
+      attr_reader :grabpay
+
+      # Attribute for field id_bank_transfer
+      sig { returns(IdBankTransfer) }
+      attr_reader :id_bank_transfer
+
+      # Attribute for field jp_bank_transfer
+      sig { returns(JpBankTransfer) }
+      attr_reader :jp_bank_transfer
+
+      # Attribute for field klarna
+      sig { returns(Klarna) }
+      attr_reader :klarna
+
+      # Attribute for field multibanco
+      sig { returns(Multibanco) }
+      attr_reader :multibanco
+
+      # Attribute for field mx_bank_transfer
+      sig { returns(MxBankTransfer) }
+      attr_reader :mx_bank_transfer
+
+      # Attribute for field p24
+      sig { returns(P24) }
+      attr_reader :p24
+
+      # Attribute for field paynow
+      sig { returns(Paynow) }
+      attr_reader :paynow
+
+      # Attribute for field paypal
+      sig { returns(Paypal) }
+      attr_reader :paypal
+
+      # Attribute for field pix
+      sig { returns(Pix) }
+      attr_reader :pix
+
+      # Attribute for field revolut
+      sig { returns(Revolut) }
+      attr_reader :revolut
+
+      # Attribute for field sofort
+      sig { returns(Sofort) }
+      attr_reader :sofort
+
+      # Attribute for field swish
+      sig { returns(Swish) }
+      attr_reader :swish
+
+      # Attribute for field th_bank_transfer
+      sig { returns(ThBankTransfer) }
+      attr_reader :th_bank_transfer
+
+      # The type of transaction-specific details of the payment method used in the refund (e.g., `card`). An additional hash is included on `destination_details` with a name matching this value. It contains information specific to the refund transaction.
+      sig { returns(String) }
+      attr_reader :type
+
+      # Attribute for field us_bank_transfer
+      sig { returns(UsBankTransfer) }
+      attr_reader :us_bank_transfer
+
+      # Attribute for field wechat_pay
+      sig { returns(WechatPay) }
+      attr_reader :wechat_pay
+
+      # Attribute for field zip
+      sig { returns(Zip) }
+      attr_reader :zip
+    end
+    class NextAction < Stripe::StripeObject
+      class DisplayDetails < Stripe::StripeObject
+        class EmailSent < Stripe::StripeObject
+          # The timestamp when the email was sent.
+          sig { returns(Integer) }
+          attr_reader :email_sent_at
+
+          # The recipient's email address.
+          sig { returns(String) }
+          attr_reader :email_sent_to
+        end
+        # Attribute for field email_sent
+        sig { returns(EmailSent) }
+        attr_reader :email_sent
+
+        # The expiry timestamp.
+        sig { returns(Integer) }
+        attr_reader :expires_at
+      end
+      # Attribute for field display_details
+      sig { returns(DisplayDetails) }
+      attr_reader :display_details
+
+      # Type of the next action to perform.
+      sig { returns(String) }
+      attr_reader :type
+    end
+    # Amount, in cents (or local equivalent).
+    sig { returns(Integer) }
+    attr_reader :amount
+
+    # Balance transaction that describes the impact on your account balance.
+    sig { returns(T.nilable(T.any(String, Stripe::BalanceTransaction))) }
+    attr_reader :balance_transaction
+
+    # ID of the charge that's refunded.
+    sig { returns(T.nilable(T.any(String, Stripe::Charge))) }
+    attr_reader :charge
+
+    # 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
+
+    # An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only).
+    sig { returns(String) }
+    attr_reader :description
+
+    # Attribute for field destination_details
+    sig { returns(DestinationDetails) }
+    attr_reader :destination_details
+
+    # After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.
+    sig { returns(T.any(String, Stripe::BalanceTransaction)) }
+    attr_reader :failure_balance_transaction
+
+    # Provides the reason for the refund failure. Possible values are: `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request`, or `unknown`.
+    sig { returns(String) }
+    attr_reader :failure_reason
+
+    # Unique identifier for the object.
+    sig { returns(String) }
+    attr_reader :id
+
+    # For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions.
+    sig { returns(String) }
+    attr_reader :instructions_email
+
+    # 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.nilable(T::Hash[String, String])) }
+    attr_reader :metadata
+
+    # Attribute for field next_action
+    sig { returns(NextAction) }
+    attr_reader :next_action
+
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+
+    # ID of the PaymentIntent that's refunded.
+    sig { returns(T.nilable(T.any(String, Stripe::PaymentIntent))) }
+    attr_reader :payment_intent
+
+    # Reason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).
+    sig { returns(T.nilable(String)) }
+    attr_reader :reason
+
+    # This is the transaction number that appears on email receipts sent for this refund.
+    sig { returns(T.nilable(String)) }
+    attr_reader :receipt_number
+
+    # The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account.
+    sig { returns(T.nilable(T.any(String, Stripe::Reversal))) }
+    attr_reader :source_transfer_reversal
+
+    # Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds).
+    sig { returns(T.nilable(String)) }
+    attr_reader :status
+
+    # This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter.
+    sig { returns(T.nilable(T.any(String, Stripe::Reversal))) }
+    attr_reader :transfer_reversal
+
+    class ListParams < Stripe::RequestParams
+      class Created < Stripe::RequestParams
+        # Minimum value to filter by (exclusive)
+        sig { returns(Integer) }
+        attr_accessor :gt
+
+        # Minimum value to filter by (inclusive)
+        sig { returns(Integer) }
+        attr_accessor :gte
+
+        # Maximum value to filter by (exclusive)
+        sig { returns(Integer) }
+        attr_accessor :lt
+
+        # Maximum value to filter by (inclusive)
+        sig { returns(Integer) }
+        attr_accessor :lte
+
+        sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
+        def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
+      end
+      # Only return refunds for the charge specified by this charge ID.
+      sig { returns(String) }
+      attr_accessor :charge
+
+      # Only return refunds that were created during the given date interval.
+      sig { returns(T.any(::Stripe::Refund::ListParams::Created, Integer)) }
+      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.
+      sig { returns(String) }
+      attr_accessor :ending_before
+
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T::Array[String]) }
+      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.
+      sig { returns(Integer) }
+      attr_accessor :limit
+
+      # Only return refunds for the PaymentIntent specified by this ID.
+      sig { returns(String) }
+      attr_accessor :payment_intent
+
+      # 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(String) }
+      attr_accessor :starting_after
+
+      sig {
+        params(charge: String, created: T.any(::Stripe::Refund::ListParams::Created, Integer), ending_before: String, expand: T::Array[String], limit: Integer, payment_intent: String, starting_after: String).void
+       }
+      def initialize(
+        charge: nil,
+        created: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        payment_intent: nil,
+        starting_after: nil
+      ); end
+    end
+    class CreateParams < Stripe::RequestParams
+      # Attribute for param field amount
+      sig { returns(Integer) }
+      attr_accessor :amount
+
+      # The identifier of the charge to refund.
+      sig { returns(String) }
+      attr_accessor :charge
+
+      # 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_accessor :currency
+
+      # Customer whose customer balance to refund from.
+      sig { returns(String) }
+      attr_accessor :customer
+
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T::Array[String]) }
+      attr_accessor :expand
+
+      # For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions.
+      sig { returns(String) }
+      attr_accessor :instructions_email
+
+      # 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
+
+      # Origin of the refund
+      sig { returns(String) }
+      attr_accessor :origin
+
+      # The identifier of the PaymentIntent to refund.
+      sig { returns(String) }
+      attr_accessor :payment_intent
+
+      # String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms.
+      sig { returns(String) }
+      attr_accessor :reason
+
+      # Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.
+      sig { returns(T::Boolean) }
+      attr_accessor :refund_application_fee
+
+      # Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).<br><br>A transfer can be reversed only by the application that created the charge.
+      sig { returns(T::Boolean) }
+      attr_accessor :reverse_transfer
+
+      sig {
+        params(amount: Integer, charge: String, currency: String, customer: String, expand: T::Array[String], instructions_email: String, metadata: T.nilable(T::Hash[String, String]), origin: String, payment_intent: String, reason: String, refund_application_fee: T::Boolean, reverse_transfer: T::Boolean).void
+       }
+      def initialize(
+        amount: nil,
+        charge: nil,
+        currency: nil,
+        customer: nil,
+        expand: nil,
+        instructions_email: nil,
+        metadata: nil,
+        origin: nil,
+        payment_intent: nil,
+        reason: nil,
+        refund_application_fee: nil,
+        reverse_transfer: nil
+      ); end
+    end
+    class RetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T::Array[String]) }
+      attr_accessor :expand
+
+      sig { params(expand: T::Array[String]).void }
+      def initialize(expand: nil); end
+    end
+    class UpdateParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      sig { returns(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
+
+      sig { params(expand: T::Array[String], metadata: T.nilable(T::Hash[String, String])).void }
+      def initialize(expand: nil, metadata: nil); end
+    end
+    class CancelParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T::Array[String]) }
+      attr_accessor :expand
+
+      sig { params(expand: T::Array[String]).void }
+      def initialize(expand: nil); end
+    end
+    class ExpireParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T::Array[String]) }
+      attr_accessor :expand
+
+      sig { params(expand: T::Array[String]).void }
+      def initialize(expand: nil); end
+    end
+    # Cancels a refund with a status of requires_action.
+    #
+    # You can't cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.
+    sig {
+      params(params: T.any(::Stripe::Refund::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Refund)
+     }
+    def cancel(params = {}, opts = {}); end
+
+    # Cancels a refund with a status of requires_action.
+    #
+    # You can't cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.
+    sig {
+      params(refund: String, params: T.any(::Stripe::Refund::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Refund)
+     }
+    def self.cancel(refund, params = {}, opts = {}); end
+
+    # When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
+    #
+    # Creating a new refund will refund a charge that has previously been created but not yet refunded.
+    # Funds will be refunded to the credit or debit card that was originally charged.
+    #
+    # You can optionally refund only part of a charge.
+    # You can do so multiple times, until the entire charge has been refunded.
+    #
+    # Once entirely refunded, a charge can't be refunded again.
+    # This method will raise an error when called on an already-refunded charge,
+    # or when trying to refund more money than is left on a charge.
+    sig {
+      params(params: T.any(::Stripe::Refund::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Refund)
+     }
+    def self.create(params = {}, opts = {}); end
+
+    # Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.
+    sig {
+      params(params: T.any(::Stripe::Refund::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+     }
+    def self.list(params = {}, opts = {}); end
+
+    # Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don't provide remain unchanged.
+    #
+    # This request only accepts metadata as an argument.
+    sig {
+      params(id: String, params: T.any(::Stripe::Refund::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Refund)
+     }
+    def self.update(id, params = {}, opts = {}); end
+  end
+end