stripe 13.4.0.pre.beta.1 → 13.4.0.pre.beta.3

data/rbi/stripe/resources/setup_attempt.rbi

@@ -17,32 +17,25 @@ module Stripe
         # Bank code of bank associated with the bank account.
         sig { returns(T.nilable(String)) }
         attr_reader :bank_code
-
         # Name of the bank associated with the bank account.
         sig { returns(T.nilable(String)) }
         attr_reader :bank_name
-
         # Bank Identifier Code of the bank associated with the bank account.
         sig { returns(T.nilable(String)) }
         attr_reader :bic
-
         # The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
         sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
         attr_reader :generated_sepa_debit
-
         # The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
         sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
         attr_reader :generated_sepa_debit_mandate
-
         # Last four characters of the IBAN.
         sig { returns(T.nilable(String)) }
         attr_reader :iban_last4
-
         # Preferred language of the Bancontact authorization page that the customer is redirected to.
         # Can be one of `en`, `de`, `fr`, or `nl`
         sig { returns(T.nilable(String)) }
         attr_reader :preferred_language
-
         # Owner's verified full name. Values are verified or provided by Bancontact directly
         # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
         sig { returns(T.nilable(String)) }
@@ -54,11 +47,9 @@ module Stripe
           # If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
           sig { returns(T.nilable(String)) }
           attr_reader :address_line1_check
-
           # If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
           sig { returns(T.nilable(String)) }
           attr_reader :address_postal_code_check
-
           # If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
           sig { returns(T.nilable(String)) }
           attr_reader :cvc_check
@@ -68,26 +59,21 @@ module Stripe
           # the issuing bank.
           sig { returns(T.nilable(String)) }
           attr_reader :authentication_flow
-
           # The Electronic Commerce Indicator (ECI). A protocol-level field
           # indicating what degree of authentication was performed.
           sig { returns(T.nilable(String)) }
           attr_reader :electronic_commerce_indicator
-
           # Indicates the outcome of 3D Secure authentication.
           sig { returns(T.nilable(String)) }
           attr_reader :result
-
           # Additional information about why 3D Secure succeeded or failed based
           # on the `result`.
           sig { returns(T.nilable(String)) }
           attr_reader :result_reason
-
           # The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID
           # (dsTransId) for this payment.
           sig { returns(T.nilable(String)) }
           attr_reader :transaction_id
-
           # The version of 3D Secure that was used.
           sig { returns(T.nilable(String)) }
           attr_reader :version
@@ -98,11 +84,9 @@ module Stripe
           # Attribute for field apple_pay
           sig { returns(ApplePay) }
           attr_reader :apple_pay
-
           # Attribute for field google_pay
           sig { returns(GooglePay) }
           attr_reader :google_pay
-
           # The type of the card wallet, one of `apple_pay`, `google_pay`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.
           sig { returns(String) }
           attr_reader :type
@@ -110,57 +94,44 @@ module Stripe
         # Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
         sig { returns(T.nilable(String)) }
         attr_reader :brand
-
         # Check results by Card networks on Card address and CVC at the time of authorization
         sig { returns(T.nilable(Checks)) }
         attr_reader :checks
-
         # Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
         sig { returns(T.nilable(String)) }
         attr_reader :country
-
         # A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
         sig { returns(T.nilable(String)) }
         attr_reader :description
-
         # Two-digit number representing the card's expiration month.
         sig { returns(T.nilable(Integer)) }
         attr_reader :exp_month
-
         # Four-digit number representing the card's expiration year.
         sig { returns(T.nilable(Integer)) }
         attr_reader :exp_year
-
         # Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
         #
         # *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
         sig { returns(T.nilable(String)) }
         attr_reader :fingerprint
-
         # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
         sig { returns(T.nilable(String)) }
         attr_reader :funding
-
         # Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
         sig { returns(T.nilable(String)) }
         attr_reader :iin
-
         # The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
         sig { returns(T.nilable(String)) }
         attr_reader :issuer
-
         # The last four digits of the card.
         sig { returns(T.nilable(String)) }
         attr_reader :last4
-
         # Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
         sig { returns(T.nilable(String)) }
         attr_reader :network
-
         # Populated if this authorization used 3D Secure authentication.
         sig { returns(T.nilable(ThreeDSecure)) }
         attr_reader :three_d_secure
-
         # If this Card is part of a card wallet, this contains the details of the card wallet.
         sig { returns(T.nilable(Wallet)) }
         attr_reader :wallet
@@ -170,7 +141,6 @@ module Stripe
           # Time at which the payment was collected while offline
           sig { returns(T.nilable(Integer)) }
           attr_reader :stored_at
-
           # The method used to process this payment method offline. Only deferred is allowed.
           sig { returns(T.nilable(String)) }
           attr_reader :type
@@ -178,7 +148,6 @@ module Stripe
         # The ID of the Card PaymentMethod which was generated by this SetupAttempt.
         sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
         attr_reader :generated_card
-
         # Details about payments collected offline.
         sig { returns(T.nilable(Offline)) }
         attr_reader :offline
@@ -188,15 +157,12 @@ module Stripe
         # Bank where the account is located.
         sig { returns(T.nilable(String)) }
         attr_reader :bank
-
         # Local bank code of the bank.
         sig { returns(T.nilable(String)) }
         attr_reader :bank_code
-
         # Name of the bank associated with the bank account.
         sig { returns(T.nilable(String)) }
         attr_reader :bank_name
-
         # Merchant name and billing details name, for the customer to check for the correct merchant when performing the bank transfer.
         sig { returns(T.nilable(String)) }
         attr_reader :display_name
@@ -205,23 +171,18 @@ module Stripe
         # The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
         sig { returns(T.nilable(String)) }
         attr_reader :bank
-
         # The Bank Identifier Code of the customer's bank.
         sig { returns(T.nilable(String)) }
         attr_reader :bic
-
         # The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
         sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
         attr_reader :generated_sepa_debit
-
         # The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
         sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
         attr_reader :generated_sepa_debit_mandate
-
         # Last four characters of the IBAN.
         sig { returns(T.nilable(String)) }
         attr_reader :iban_last4
-
         # Owner's verified full name. Values are verified or provided by iDEAL directly
         # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
         sig { returns(T.nilable(String)) }
@@ -239,32 +200,25 @@ module Stripe
         # Bank code of bank associated with the bank account.
         sig { returns(T.nilable(String)) }
         attr_reader :bank_code
-
         # Name of the bank associated with the bank account.
         sig { returns(T.nilable(String)) }
         attr_reader :bank_name
-
         # Bank Identifier Code of the bank associated with the bank account.
         sig { returns(T.nilable(String)) }
         attr_reader :bic
-
         # The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
         sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
         attr_reader :generated_sepa_debit
-
         # The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
         sig { returns(T.nilable(T.any(String, Stripe::Mandate))) }
         attr_reader :generated_sepa_debit_mandate
-
         # Last four characters of the IBAN.
         sig { returns(T.nilable(String)) }
         attr_reader :iban_last4
-
         # Preferred language of the Sofort authorization page that the customer is redirected to.
         # Can be one of `en`, `de`, `fr`, or `nl`
         sig { returns(T.nilable(String)) }
         attr_reader :preferred_language
-
         # Owner's verified full name. Values are verified or provided by Sofort directly
         # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
         sig { returns(T.nilable(String)) }
@@ -274,124 +228,98 @@ module Stripe
       # Attribute for field acss_debit
       sig { returns(AcssDebit) }
       attr_reader :acss_debit
-
       # Attribute for field amazon_pay
       sig { returns(AmazonPay) }
       attr_reader :amazon_pay
-
       # Attribute for field au_becs_debit
       sig { returns(AuBecsDebit) }
       attr_reader :au_becs_debit
-
       # Attribute for field bacs_debit
       sig { returns(BacsDebit) }
       attr_reader :bacs_debit
-
       # Attribute for field bancontact
       sig { returns(Bancontact) }
       attr_reader :bancontact
-
       # Attribute for field boleto
       sig { returns(Boleto) }
       attr_reader :boleto
-
       # Attribute for field card
       sig { returns(Card) }
       attr_reader :card
-
       # Attribute for field card_present
       sig { returns(CardPresent) }
       attr_reader :card_present
-
       # Attribute for field cashapp
       sig { returns(Cashapp) }
       attr_reader :cashapp
-
       # Attribute for field id_bank_transfer
       sig { returns(IdBankTransfer) }
       attr_reader :id_bank_transfer
-
       # Attribute for field ideal
       sig { returns(Ideal) }
       attr_reader :ideal
-
       # Attribute for field kakao_pay
       sig { returns(KakaoPay) }
       attr_reader :kakao_pay
-
       # Attribute for field klarna
       sig { returns(Klarna) }
       attr_reader :klarna
-
       # Attribute for field kr_card
       sig { returns(KrCard) }
       attr_reader :kr_card
-
       # Attribute for field link
       sig { returns(Link) }
       attr_reader :link
-
       # Attribute for field paypal
       sig { returns(Paypal) }
       attr_reader :paypal
-
       # Attribute for field payto
       sig { returns(Payto) }
       attr_reader :payto
-
       # Attribute for field revolut_pay
       sig { returns(RevolutPay) }
       attr_reader :revolut_pay
-
       # Attribute for field sepa_debit
       sig { returns(SepaDebit) }
       attr_reader :sepa_debit
-
       # Attribute for field sofort
       sig { returns(Sofort) }
       attr_reader :sofort
-
       # The type of the payment method used in the SetupIntent (e.g., `card`). An additional hash is included on `payment_method_details` with a name matching this value. It contains confirmation-specific information for the payment method.
       sig { returns(String) }
       attr_reader :type
-
       # Attribute for field us_bank_account
       sig { returns(UsBankAccount) }
       attr_reader :us_bank_account
     end
     class SetupError < Stripe::StripeObject
+      # For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one.
+      sig { returns(String) }
+      attr_reader :advice_code
       # For card errors, the ID of the failed charge.
       sig { returns(String) }
       attr_reader :charge
-
       # For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.
       sig { returns(String) }
       attr_reader :code
-
       # For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.
       sig { returns(String) }
       attr_reader :decline_code
-
       # A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.
       sig { returns(String) }
       attr_reader :doc_url
-
       # A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
       sig { returns(String) }
       attr_reader :message
-
       # For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
       sig { returns(String) }
       attr_reader :network_advice_code
-
       # For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.
       sig { returns(String) }
       attr_reader :network_decline_code
-
       # If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
       sig { returns(String) }
       attr_reader :param
-
       # A PaymentIntent guides you through the process of collecting a payment from your customer.
       # We recommend that you create exactly one PaymentIntent for each order or
       # customer session in your system. You can reference the PaymentIntent later to
@@ -405,7 +333,6 @@ module Stripe
       # Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)
       sig { returns(Stripe::PaymentIntent) }
       attr_reader :payment_intent
-
       # PaymentMethod objects represent your customer's payment instruments.
       # You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to
       # Customer objects to store instrument details for future payments.
@@ -413,15 +340,12 @@ module Stripe
       # Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
       sig { returns(Stripe::PaymentMethod) }
       attr_reader :payment_method
-
       # If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
       sig { returns(String) }
       attr_reader :payment_method_type
-
       # A URL to the request log entry in your dashboard.
       sig { returns(String) }
       attr_reader :request_log_url
-
       # A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
       # For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
       # Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.
@@ -445,11 +369,9 @@ module Stripe
       # Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)
       sig { returns(Stripe::SetupIntent) }
       attr_reader :setup_intent
-
       # Attribute for field source
       sig { returns(T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source)) }
       attr_reader :source
-
       # The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`
       sig { returns(String) }
       attr_reader :type
@@ -457,85 +379,66 @@ module Stripe
     # The value of [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation.
     sig { returns(T.nilable(T.any(String, Stripe::Application))) }
     attr_reader :application
-
     # If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
     #
     # It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
     sig { returns(T::Boolean) }
     attr_reader :attach_to_self
-
     # Time at which the object was created. Measured in seconds since the Unix epoch.
     sig { returns(Integer) }
     attr_reader :created
-
     # The value of [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation.
     sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
     attr_reader :customer
-
     # Indicates the directions of money movement for which this payment method is intended to be used.
     #
     # Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.
     sig { returns(T.nilable(T::Array[String])) }
     attr_reader :flow_directions
-
     # Unique identifier for the object.
     sig { returns(String) }
     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.
     sig { returns(T::Boolean) }
     attr_reader :livemode
-
     # String representing the object's type. Objects of the same type share the same value.
     sig { returns(String) }
     attr_reader :object
-
     # The value of [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation.
     sig { returns(T.nilable(T.any(String, Stripe::Account))) }
     attr_reader :on_behalf_of
-
     # ID of the payment method used with this SetupAttempt.
     sig { returns(T.any(String, Stripe::PaymentMethod)) }
     attr_reader :payment_method
-
     # Attribute for field payment_method_details
     sig { returns(PaymentMethodDetails) }
     attr_reader :payment_method_details
-
     # The error encountered during this attempt to confirm the SetupIntent, if any.
     sig { returns(T.nilable(SetupError)) }
     attr_reader :setup_error
-
     # ID of the SetupIntent that this attempt belongs to.
     sig { returns(T.any(String, Stripe::SetupIntent)) }
     attr_reader :setup_intent
-
     # Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`.
     sig { returns(String) }
     attr_reader :status
-
     # The value of [usage](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_session`.
     sig { returns(String) }
     attr_reader :usage
-
     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
@@ -544,28 +447,22 @@ module Stripe
       # dictionary with a number of different query options.
       sig { returns(T.any(::Stripe::SetupAttempt::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 SetupAttempts created by the SetupIntent specified by
       # this ID.
       sig { returns(String) }
       attr_accessor :setup_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(created: T.any(::Stripe::SetupAttempt::ListParams::Created, Integer), ending_before: String, expand: T::Array[String], limit: Integer, setup_intent: String, starting_after: String).void
        }