stripe 15.1.0 → 15.2.0

data/rbi/stripe/resources/confirmation_token.rbi

@@ -1104,21 +1104,11 @@ module Stripe
            }
           def initialize(account_number: nil, institution_number: nil, transit_number: nil); end
         end
-        class Affirm < Stripe::RequestParams
-
-        end
-        class AfterpayClearpay < Stripe::RequestParams
-
-        end
-        class Alipay < Stripe::RequestParams
-
-        end
-        class Alma < Stripe::RequestParams
-
-        end
-        class AmazonPay < Stripe::RequestParams
-
-        end
+        class Affirm < Stripe::RequestParams; end
+        class AfterpayClearpay < Stripe::RequestParams; end
+        class Alipay < Stripe::RequestParams; end
+        class Alma < Stripe::RequestParams; end
+        class AmazonPay < Stripe::RequestParams; end
         class AuBecsDebit < Stripe::RequestParams
           # The account number for the bank account.
           sig { returns(String) }
@@ -1139,12 +1129,8 @@ module Stripe
           sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void }
           def initialize(account_number: nil, sort_code: nil); end
         end
-        class Bancontact < Stripe::RequestParams
-
-        end
-        class Billie < Stripe::RequestParams
-
-        end
+        class Bancontact < Stripe::RequestParams; end
+        class Billie < Stripe::RequestParams; end
         class BillingDetails < Stripe::RequestParams
           class Address < Stripe::RequestParams
             # City, district, suburb, town, or village.
@@ -1199,9 +1185,7 @@ module Stripe
            }
           def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end
         end
-        class Blik < Stripe::RequestParams
-
-        end
+        class Blik < Stripe::RequestParams; end
         class Boleto < Stripe::RequestParams
           # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
           sig { returns(String) }
@@ -1209,12 +1193,8 @@ module Stripe
           sig { params(tax_id: String).void }
           def initialize(tax_id: nil); end
         end
-        class Cashapp < Stripe::RequestParams
-
-        end
-        class CustomerBalance < Stripe::RequestParams
-
-        end
+        class Cashapp < Stripe::RequestParams; end
+        class CustomerBalance < Stripe::RequestParams; end
         class Eps < Stripe::RequestParams
           # The customer's bank.
           sig { returns(T.nilable(String)) }
@@ -1232,12 +1212,8 @@ module Stripe
           sig { params(account_holder_type: T.nilable(String), bank: String).void }
           def initialize(account_holder_type: nil, bank: nil); end
         end
-        class Giropay < Stripe::RequestParams
-
-        end
-        class Grabpay < Stripe::RequestParams
-
-        end
+        class Giropay < Stripe::RequestParams; end
+        class Grabpay < Stripe::RequestParams; end
         class Ideal < Stripe::RequestParams
           # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
           sig { returns(T.nilable(String)) }
@@ -1245,12 +1221,8 @@ module Stripe
           sig { params(bank: T.nilable(String)).void }
           def initialize(bank: nil); end
         end
-        class InteracPresent < Stripe::RequestParams
-
-        end
-        class KakaoPay < Stripe::RequestParams
-
-        end
+        class InteracPresent < Stripe::RequestParams; end
+        class KakaoPay < Stripe::RequestParams; end
         class Klarna < Stripe::RequestParams
           class Dob < Stripe::RequestParams
             # The day of birth, between 1 and 31.
@@ -1275,21 +1247,11 @@ module Stripe
            }
           def initialize(dob: nil); end
         end
-        class Konbini < Stripe::RequestParams
-
-        end
-        class KrCard < Stripe::RequestParams
-
-        end
-        class Link < Stripe::RequestParams
-
-        end
-        class Mobilepay < Stripe::RequestParams
-
-        end
-        class Multibanco < Stripe::RequestParams
-
-        end
+        class Konbini < Stripe::RequestParams; end
+        class KrCard < Stripe::RequestParams; end
+        class Link < Stripe::RequestParams; end
+        class Mobilepay < Stripe::RequestParams; end
+        class Multibanco < Stripe::RequestParams; end
         class NaverPay < Stripe::RequestParams
           # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
           sig { returns(T.nilable(String)) }
@@ -1328,9 +1290,7 @@ module Stripe
             suffix: nil
           ); end
         end
-        class Oxxo < Stripe::RequestParams
-
-        end
+        class Oxxo < Stripe::RequestParams; end
         class P24 < Stripe::RequestParams
           # The customer's bank.
           sig { returns(T.nilable(String)) }
@@ -1338,24 +1298,12 @@ module Stripe
           sig { params(bank: T.nilable(String)).void }
           def initialize(bank: nil); end
         end
-        class PayByBank < Stripe::RequestParams
-
-        end
-        class Payco < Stripe::RequestParams
-
-        end
-        class Paynow < Stripe::RequestParams
-
-        end
-        class Paypal < Stripe::RequestParams
-
-        end
-        class Pix < Stripe::RequestParams
-
-        end
-        class Promptpay < Stripe::RequestParams
-
-        end
+        class PayByBank < Stripe::RequestParams; end
+        class Payco < Stripe::RequestParams; end
+        class Paynow < Stripe::RequestParams; end
+        class Paypal < Stripe::RequestParams; end
+        class Pix < Stripe::RequestParams; end
+        class Promptpay < Stripe::RequestParams; end
         class RadarOptions < Stripe::RequestParams
           # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
           sig { returns(T.nilable(String)) }
@@ -1363,15 +1311,9 @@ module Stripe
           sig { params(session: T.nilable(String)).void }
           def initialize(session: nil); end
         end
-        class RevolutPay < Stripe::RequestParams
-
-        end
-        class SamsungPay < Stripe::RequestParams
-
-        end
-        class Satispay < Stripe::RequestParams
-
-        end
+        class RevolutPay < Stripe::RequestParams; end
+        class SamsungPay < Stripe::RequestParams; end
+        class Satispay < Stripe::RequestParams; end
         class SepaDebit < Stripe::RequestParams
           # IBAN of the bank account.
           sig { returns(String) }
@@ -1386,12 +1328,8 @@ module Stripe
           sig { params(country: String).void }
           def initialize(country: nil); end
         end
-        class Swish < Stripe::RequestParams
-
-        end
-        class Twint < Stripe::RequestParams
-
-        end
+        class Swish < Stripe::RequestParams; end
+        class Twint < Stripe::RequestParams; end
         class UsBankAccount < Stripe::RequestParams
           # Account holder type: individual or company.
           sig { returns(T.nilable(String)) }
@@ -1419,12 +1357,8 @@ module Stripe
             routing_number: nil
           ); end
         end
-        class WechatPay < Stripe::RequestParams
-
-        end
-        class Zip < Stripe::RequestParams
-
-        end
+        class WechatPay < Stripe::RequestParams; end
+        class Zip < Stripe::RequestParams; end
         # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
         sig {
           returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::AcssDebit))

data/rbi/stripe/resources/country_spec.rbi

@@ -8,7 +8,7 @@ module Stripe
   # Country Specs API makes these rules available to your integration.
   #
   # You can also view the information from this API call as [an online
-  # guide](https://stripe.com/docs/connect/required-verification-information).
+  # guide](https://docs.stripe.com/docs/connect/required-verification-information).
   class CountrySpec < APIResource
     class VerificationFields < Stripe::StripeObject
       class Company < Stripe::StripeObject

data/rbi/stripe/resources/coupon.rbi

@@ -71,9 +71,7 @@ module Stripe
     # Always true for a deleted object
     sig { returns(T::Boolean) }
     attr_reader :deleted
-    class DeleteParams < Stripe::RequestParams
-
-    end
+    class DeleteParams < Stripe::RequestParams; end
     class UpdateParams < Stripe::RequestParams
       class CurrencyOptions < Stripe::RequestParams
         # A positive integer representing the amount to subtract from an invoice total.

data/rbi/stripe/resources/credit_note.rbi

@@ -152,6 +152,12 @@ module Stripe
     # The link to download the PDF of the credit note.
     sig { returns(String) }
     attr_reader :pdf
+    # The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof.
+    sig { returns(Integer) }
+    attr_reader :post_payment_amount
+    # The amount of the credit note by which the invoice's `amount_remaining` and `amount_due` were reduced.
+    sig { returns(Integer) }
+    attr_reader :pre_payment_amount
     # The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
     sig { returns(T::Array[PretaxCreditAmount]) }
     attr_reader :pretax_credit_amounts
@@ -689,20 +695,19 @@ module Stripe
       sig { params(expand: T.nilable(T::Array[String])).void }
       def initialize(expand: nil); end
     end
-    # Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces
-    # its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result
-    # in any combination of the following:
+    # Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice's amount_remaining (and amount_due), but not below zero.
+    # This amount is indicated by the credit note's pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:
     #
     #
-    # Refund: create a new refund (using refund_amount) or link an existing refund (using refund).
+    # Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
     # Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
     # Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
     #
     #
-    # For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.
+    # The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.
     #
-    # You may issue multiple credit notes for an invoice. Each credit note will increment the invoice's pre_payment_credit_notes_amount
-    # or post_payment_credit_notes_amount depending on its status at the time of credit note creation.
+    # You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount,
+    # post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation.
     sig {
       params(params: T.any(::Stripe::CreditNote::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
      }
@@ -732,13 +737,13 @@ module Stripe
      }
     def self.update(id, params = {}, opts = {}); end
 
-    # Marks a credit note as void. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).
+    # Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding).
     sig {
       params(params: T.any(::Stripe::CreditNote::VoidCreditNoteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
      }
     def void_credit_note(params = {}, opts = {}); end
 
-    # Marks a credit note as void. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).
+    # Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding).
     sig {
       params(id: String, params: T.any(::Stripe::CreditNote::VoidCreditNoteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
      }

data/rbi/stripe/resources/customer.rbi

@@ -210,9 +210,7 @@ module Stripe
     # Always true for a deleted object
     sig { returns(T::Boolean) }
     attr_reader :deleted
-    class DeleteParams < Stripe::RequestParams
-
-    end
+    class DeleteParams < Stripe::RequestParams; end
     class UpdateParams < Stripe::RequestParams
       class Address < Stripe::RequestParams
         # City, district, suburb, town, or village.
@@ -459,9 +457,7 @@ module Stripe
         validate: nil
       ); end
     end
-    class DeleteDiscountParams < Stripe::RequestParams
-
-    end
+    class DeleteDiscountParams < Stripe::RequestParams; end
     class ListParams < Stripe::RequestParams
       class Created < Stripe::RequestParams
         # Minimum value to filter by (exclusive)

data/rbi/stripe/resources/customer_session.rbi

@@ -6,9 +6,9 @@ module Stripe
   # A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access
   # control over a Customer.
   #
-  # Related guides: [Customer Session with the Payment Element](https://stripe.com/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods),
-  # [Customer Session with the Pricing Table](https://stripe.com/payments/checkout/pricing-table#customer-session),
-  # [Customer Session with the Buy Button](https://stripe.com/payment-links/buy-button#pass-an-existing-customer).
+  # Related guides: [Customer Session with the Payment Element](https://docs.stripe.com/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods),
+  # [Customer Session with the Pricing Table](https://docs.stripe.com/payments/checkout/pricing-table#customer-session),
+  # [Customer Session with the Buy Button](https://docs.stripe.com/payment-links/buy-button#pass-an-existing-customer).
   class CustomerSession < APIResource
     class Components < Stripe::StripeObject
       class BuyButton < Stripe::StripeObject

data/rbi/stripe/resources/dispute.rbi

@@ -340,7 +340,7 @@ module Stripe
     # Attribute for field payment_method_details
     sig { returns(PaymentMethodDetails) }
     attr_reader :payment_method_details
-    # Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories).
+    # Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `noncompliant`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories).
     sig { returns(String) }
     attr_reader :reason
     # Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, or `lost`.
@@ -752,7 +752,7 @@ module Stripe
 
     # When you get a dispute, contacting your customer is always the best first step. If that doesn't work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your [dashboard](https://dashboard.stripe.com/disputes), but if you prefer, you can use the API to submit evidence programmatically.
     #
-    # Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our [guide to dispute types](https://stripe.com/docs/disputes/categories).
+    # Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our [guide to dispute types](https://docs.stripe.com/docs/disputes/categories).
     sig {
       params(dispute: String, params: T.any(::Stripe::Dispute::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Dispute)
      }

data/rbi/stripe/resources/event.rbi

@@ -56,7 +56,7 @@ module Stripe
     # The Stripe API version used to render `data`. This property is populated only for events on or after October 31, 2014.
     sig { returns(T.nilable(String)) }
     attr_reader :api_version
-    # Attribute for field context
+    # Authentication context needed to fetch the event or related object.
     sig { returns(String) }
     attr_reader :context
     # Time at which the object was created. Measured in seconds since the Unix epoch.

data/rbi/stripe/resources/file.rbi

@@ -7,7 +7,7 @@ module Stripe
   # files with the [create file](https://stripe.com/docs/api#create_file) request
   # (for example, when uploading dispute evidence). Stripe also
   # creates files independently (for example, the results of a [Sigma scheduled
-  # query](https://stripe.com/docs/api#scheduled_queries)).
+  # query](https://docs.stripe.com/api#scheduled_queries)).
   #
   # Related guide: [File upload guide](https://stripe.com/docs/file-upload)
   class File < APIResource

data/rbi/stripe/resources/identity/verification_report.rbi

@@ -108,12 +108,21 @@ module Stripe
         # Document ID number.
         sig { returns(T.nilable(String)) }
         attr_reader :number
+        # Sex of the person in the document.
+        sig { returns(T.nilable(String)) }
+        attr_reader :sex
         # Status of this `document` check.
         sig { returns(String) }
         attr_reader :status
         # Type of the document.
         sig { returns(T.nilable(String)) }
         attr_reader :type
+        # Place of birth as it appears in the document.
+        sig { returns(T.nilable(String)) }
+        attr_reader :unparsed_place_of_birth
+        # Sex as it appears in the document.
+        sig { returns(T.nilable(String)) }
+        attr_reader :unparsed_sex
       end
       class Email < Stripe::StripeObject
         class Error < Stripe::StripeObject

data/rbi/stripe/resources/identity/verification_session.rbi

@@ -6,11 +6,11 @@ module Stripe
   module Identity
     # A VerificationSession guides you through the process of collecting and verifying the identities
     # of your users. It contains details about the type of verification, such as what [verification
-    # check](https://stripe.com/docs/identity/verification-checks) to perform. Only create one VerificationSession for
+    # check](https://docs.stripe.com/docs/identity/verification-checks) to perform. Only create one VerificationSession for
     # each verification in your system.
     #
     # A VerificationSession transitions through [multiple
-    # statuses](https://stripe.com/docs/identity/how-sessions-work) throughout its lifetime as it progresses through
+    # statuses](https://docs.stripe.com/docs/identity/how-sessions-work) throughout its lifetime as it progresses through
     # the verification flow. The VerificationSession contains the user's verified data after
     # verification checks are complete.
     #
@@ -132,6 +132,15 @@ module Stripe
         # The user's verified phone number
         sig { returns(T.nilable(String)) }
         attr_reader :phone
+        # The user's verified sex.
+        sig { returns(T.nilable(String)) }
+        attr_reader :sex
+        # The user's verified place of birth as it appears in the document.
+        sig { returns(T.nilable(String)) }
+        attr_reader :unparsed_place_of_birth
+        # The user's verified sex as it appears in the document.
+        sig { returns(T.nilable(String)) }
+        attr_reader :unparsed_sex
       end
       # A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
       sig { returns(T.nilable(String)) }
@@ -422,17 +431,17 @@ module Stripe
         sig { params(expand: T.nilable(T::Array[String])).void }
         def initialize(expand: nil); end
       end
-      # A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work).
+      # A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work).
       #
-      # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://stripe.com/docs/identity/verification-sessions#cancel).
+      # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel).
       sig {
         params(params: T.any(::Stripe::Identity::VerificationSession::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
        }
       def cancel(params = {}, opts = {}); end
 
-      # A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work).
+      # A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work).
       #
-      # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://stripe.com/docs/identity/verification-sessions#cancel).
+      # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel).
       sig {
         params(session: String, params: T.any(::Stripe::Identity::VerificationSession::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
        }
@@ -444,7 +453,7 @@ module Stripe
       #
       # If your API key is in test mode, verification checks won't actually process, though everything else will occur as if in live mode.
       #
-      # Related guide: [Verify your users' identity documents](https://stripe.com/docs/identity/verify-identity-documents)
+      # Related guide: [Verify your users' identity documents](https://docs.stripe.com/docs/identity/verify-identity-documents)
       sig {
         params(params: T.any(::Stripe::Identity::VerificationSession::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
        }
@@ -461,7 +470,7 @@ module Stripe
       # request logs, etc.
       #
       # A VerificationSession object can be redacted when it is in requires_input or verified
-      # [status](https://stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
+      # [status](https://docs.stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
       # state will automatically cancel it.
       #
       # The redaction process may take up to four days. When the redaction process is in progress, the
@@ -474,7 +483,7 @@ module Stripe
       # placeholder. The metadata field will also be erased. Redacted objects cannot be updated or
       # used for any purpose.
       #
-      # [Learn more](https://stripe.com/docs/identity/verification-sessions#redact).
+      # [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#redact).
       sig {
         params(params: T.any(::Stripe::Identity::VerificationSession::RedactParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
        }
@@ -485,7 +494,7 @@ module Stripe
       # request logs, etc.
       #
       # A VerificationSession object can be redacted when it is in requires_input or verified
-      # [status](https://stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
+      # [status](https://docs.stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
       # state will automatically cancel it.
       #
       # The redaction process may take up to four days. When the redaction process is in progress, the
@@ -498,7 +507,7 @@ module Stripe
       # placeholder. The metadata field will also be erased. Redacted objects cannot be updated or
       # used for any purpose.
       #
-      # [Learn more](https://stripe.com/docs/identity/verification-sessions#redact).
+      # [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#redact).
       sig {
         params(session: String, params: T.any(::Stripe::Identity::VerificationSession::RedactParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
        }