stripe 15.1.0 → 15.2.0

data/lib/stripe/resources/balance_transaction.rb

@@ -90,6 +90,8 @@ module Stripe
     attr_reader :amount
     # The date that the transaction's net funds become available in the Stripe balance.
     attr_reader :available_on
+    # The balance that this transaction impacts.
+    attr_reader :balance_type
     # 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).

data/lib/stripe/resources/bank_account.rb

@@ -4,11 +4,11 @@
 module Stripe
   # These bank accounts are payment methods on `Customer` objects.
   #
-  # On the other hand [External Accounts](https://stripe.com/api#external_accounts) are transfer
+  # On the other hand [External Accounts](https://docs.stripe.com/api#external_accounts) are transfer
   # destinations on `Account` objects for connected accounts.
   # They can be bank accounts or debit cards as well, and are documented in the links above.
   #
-  # Related guide: [Bank debits and transfers](https://stripe.com/payments/bank-debits-transfers)
+  # Related guide: [Bank debits and transfers](https://docs.stripe.com/payments/bank-debits-transfers)
   class BankAccount < APIResource
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List

data/lib/stripe/resources/billing_portal/session.rb

@@ -16,7 +16,7 @@ module Stripe
     # Create sessions on-demand when customers intend to manage their subscriptions
     # and billing details.
     #
-    # Related guide: [Customer management](https://stripe.com/customer-management)
+    # Related guide: [Customer management](https://docs.stripe.com/customer-management)
     class Session < APIResource
       extend Stripe::APIOperations::Create
 

data/lib/stripe/resources/capability.rb

@@ -65,7 +65,7 @@ module Stripe
       end
       # Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
       attr_reader :alternatives
-      # Date by which the fields in `currently_due` must be collected to keep the capability enabled for the account. These fields may disable the capability sooner if the next threshold is reached before they are collected.
+      # The date by which all required account information must be both submitted and verified. This includes fields listed in `currently_due` as well as those in `pending_verification`. If any required information is missing or unverified by this date, the account may be disabled. Note that `current_deadline` may change if additional `currently_due` requirements are requested.
       attr_reader :current_deadline
       # Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled.
       attr_reader :currently_due

data/lib/stripe/resources/charge.rb

@@ -157,6 +157,10 @@ module Stripe
       end
 
       class Affirm < Stripe::StripeObject
+        # ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
+        attr_reader :location
+        # ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
+        attr_reader :reader
         # The Affirm transaction ID associated with this payment.
         attr_reader :transaction_id
       end
@@ -978,6 +982,10 @@ module Stripe
       class WechatPay < Stripe::StripeObject
         # Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same.
         attr_reader :fingerprint
+        # ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
+        attr_reader :location
+        # ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
+        attr_reader :reader
         # Transaction ID of this particular WeChat Pay transaction.
         attr_reader :transaction_id
       end
@@ -1636,9 +1644,9 @@ module Stripe
 
     # Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
     #
-    # Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
+    # Uncaptured payments expire a set number of days after they are created ([7 by default](https://docs.stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
     #
-    # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture).
+    # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/capture).
     def capture(params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -1650,9 +1658,9 @@ module Stripe
 
     # Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
     #
-    # Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
+    # Uncaptured payments expire a set number of days after they are created ([7 by default](https://docs.stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
     #
-    # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture).
+    # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/capture).
     def self.capture(charge, params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -1662,7 +1670,7 @@ module Stripe
       )
     end
 
-    # This method is no longer recommended—use the [Payment Intents API](https://stripe.com/docs/api/payment_intents)
+    # This method is no longer recommended—use the [Payment Intents API](https://docs.stripe.com/docs/api/payment_intents)
     # to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge
     # object used to request payment.
     def self.create(params = {}, opts = {})

data/lib/stripe/resources/checkout/session.rb

@@ -677,6 +677,14 @@ module Stripe
         class NaverPay < Stripe::StripeObject
           # Controls when the funds will be captured from the customer's account.
           attr_reader :capture_method
+          # Indicates that you intend to make future payments with this PaymentIntent's payment method.
+          #
+          # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
+          #
+          # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
+          #
+          # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
+          attr_reader :setup_future_usage
         end
 
         class Oxxo < Stripe::StripeObject
@@ -2320,8 +2328,7 @@ module Stripe
             end
           end
 
-          class PayByBank < Stripe::RequestParams
-          end
+          class PayByBank < Stripe::RequestParams; end
 
           class Payco < Stripe::RequestParams
             # Controls when the funds will be captured from the customer's account.
@@ -2717,11 +2724,18 @@ module Stripe
         class SavedPaymentMethodOptions < Stripe::RequestParams
           # Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.
           attr_accessor :allow_redisplay_filters
+          # Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.
+          attr_accessor :payment_method_remove
           # Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
           attr_accessor :payment_method_save
 
-          def initialize(allow_redisplay_filters: nil, payment_method_save: nil)
+          def initialize(
+            allow_redisplay_filters: nil,
+            payment_method_remove: nil,
+            payment_method_save: nil
+          )
             @allow_redisplay_filters = allow_redisplay_filters
+            @payment_method_remove = payment_method_remove
             @payment_method_save = payment_method_save
           end
         end
@@ -3569,7 +3583,7 @@ module Stripe
       # relevant text on the page, such as the submit button. `submit_type` can only be
       # specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
       attr_reader :submit_type
-      # The ID of the subscription for Checkout Sessions in `subscription` mode.
+      # The ID of the [Subscription](https://stripe.com/docs/api/subscriptions) for Checkout Sessions in `subscription` mode.
       attr_reader :subscription
       # The URL the customer will be directed to after the payment or
       # subscription creation is successful.
@@ -3651,6 +3665,8 @@ module Stripe
       end
 
       # Updates a Checkout Session object.
+      #
+      # Related guide: [Dynamically update Checkout](https://docs.stripe.com/payments/checkout/dynamic-updates)
       def self.update(session, params = {}, opts = {})
         request_stripe_object(
           method: :post,

data/lib/stripe/resources/confirmation_token.rb

@@ -825,20 +825,11 @@ module Stripe
           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.
@@ -864,11 +855,8 @@ module Stripe
           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
@@ -921,8 +909,7 @@ module Stripe
           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)
@@ -933,11 +920,8 @@ module Stripe
           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.
@@ -960,11 +944,8 @@ module Stripe
           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.
@@ -975,11 +956,8 @@ module Stripe
           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
@@ -1004,20 +982,11 @@ module Stripe
           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`.
@@ -1059,8 +1028,7 @@ module Stripe
           end
         end
 
-        class Oxxo < Stripe::RequestParams
-        end
+        class Oxxo < Stripe::RequestParams; end
 
         class P24 < Stripe::RequestParams
           # The customer's bank.
@@ -1071,23 +1039,12 @@ module Stripe
           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.
@@ -1098,14 +1055,9 @@ module Stripe
           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.
@@ -1125,11 +1077,8 @@ module Stripe
           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.
@@ -1158,11 +1107,8 @@ module Stripe
           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.
         attr_accessor :acss_debit
         # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.

data/lib/stripe/resources/country_spec.rb

@@ -7,7 +7,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
     extend Stripe::APIOperations::List
 

data/lib/stripe/resources/coupon.rb

@@ -26,8 +26,7 @@ module Stripe
       attr_reader :amount_off
     end
 
-    class DeleteParams < Stripe::RequestParams
-    end
+    class DeleteParams < Stripe::RequestParams; end
 
     class UpdateParams < Stripe::RequestParams
       class CurrencyOptions < Stripe::RequestParams

data/lib/stripe/resources/credit_note.rb

@@ -629,6 +629,10 @@ module Stripe
     attr_reader :out_of_band_amount
     # The link to download the PDF of the credit note.
     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.
+    attr_reader :post_payment_amount
+    # The amount of the credit note by which the invoice's `amount_remaining` and `amount_due` were reduced.
+    attr_reader :pre_payment_amount
     # The pretax credit amounts (ex: discount, credit grants, etc) for all line items.
     attr_reader :pretax_credit_amounts
     # Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
@@ -654,20 +658,19 @@ module Stripe
     # The time that the credit note was voided.
     attr_reader :voided_at
 
-    # 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.
     def self.create(params = {}, opts = {})
       request_stripe_object(method: :post, path: "/v1/credit_notes", params: params, opts: opts)
     end
@@ -707,7 +710,7 @@ module Stripe
       )
     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).
     def void_credit_note(params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -717,7 +720,7 @@ module Stripe
       )
     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).
     def self.void_credit_note(id, params = {}, opts = {})
       request_stripe_object(
         method: :post,

data/lib/stripe/resources/customer.rb

@@ -105,8 +105,7 @@ module Stripe
       attr_reader :location
     end
 
-    class DeleteParams < Stripe::RequestParams
-    end
+    class DeleteParams < Stripe::RequestParams; end
 
     class UpdateParams < Stripe::RequestParams
       class Address < Stripe::RequestParams
@@ -346,8 +345,7 @@ module Stripe
       end
     end
 
-    class DeleteDiscountParams < Stripe::RequestParams
-    end
+    class DeleteDiscountParams < Stripe::RequestParams; end
 
     class ListParams < Stripe::RequestParams
       class Created < Stripe::RequestParams

data/lib/stripe/resources/customer_session.rb

@@ -5,9 +5,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
     extend Stripe::APIOperations::Create
 

data/lib/stripe/resources/dispute.rb

@@ -621,7 +621,7 @@ module Stripe
     attr_reader :payment_intent
     # Attribute for field payment_method_details
     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).
     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`.
     attr_reader :status
@@ -657,7 +657,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).
     def self.update(dispute, params = {}, opts = {})
       request_stripe_object(
         method: :post,

data/lib/stripe/resources/event.rb

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

data/lib/stripe/resources/file.rb

@@ -6,7 +6,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/lib/stripe/resources/identity/verification_report.rb

@@ -91,10 +91,16 @@ module Stripe
         attr_reader :last_name
         # Document ID number.
         attr_reader :number
+        # Sex of the person in the document.
+        attr_reader :sex
         # Status of this `document` check.
         attr_reader :status
         # Type of the document.
         attr_reader :type
+        # Place of birth as it appears in the document.
+        attr_reader :unparsed_place_of_birth
+        # Sex as it appears in the document.
+        attr_reader :unparsed_sex
       end
 
       class Email < Stripe::StripeObject

data/lib/stripe/resources/identity/verification_session.rb

@@ -5,11 +5,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.
     #
@@ -116,6 +116,12 @@ module Stripe
         attr_reader :last_name
         # The user's verified phone number
         attr_reader :phone
+        # The user's verified sex.
+        attr_reader :sex
+        # The user's verified place of birth as it appears in the document.
+        attr_reader :unparsed_place_of_birth
+        # The user's verified sex as it appears in the document.
+        attr_reader :unparsed_sex
       end
 
       class ListParams < Stripe::RequestParams
@@ -376,9 +382,9 @@ module Stripe
       # The user’s verified data.
       attr_reader :verified_outputs
 
-      # 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).
       def cancel(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -388,9 +394,9 @@ module Stripe
         )
       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).
       def self.cancel(session, params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -406,7 +412,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)
       def self.create(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -431,7 +437,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
@@ -444,7 +450,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).
       def redact(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -459,7 +465,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
@@ -472,7 +478,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).
       def self.redact(session, params = {}, opts = {})
         request_stripe_object(
           method: :post,