stripe 18.1.0.pre.beta.1 → 18.2.0.pre.alpha.1

data/lib/stripe/resources/funding_instructions.rb

@@ -2,11 +2,11 @@
 # frozen_string_literal: true
 
 module Stripe
-  # Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) that is
+  # Each customer has a [`balance`](https://docs.stripe.com/api/customers/object#customer_object-balance) that is
   # automatically applied to future invoices and payments using the `customer_balance` payment method.
   # Customers can fund this balance by initiating a bank transfer to any account in the
   # `financial_addresses` field.
-  # Related guide: [Customer balance funding instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions)
+  # Related guide: [Customer balance funding instructions](https://docs.stripe.com/payments/customer-balance/funding-instructions)
   class FundingInstructions < APIResource
     OBJECT_NAME = "funding_instructions"
     def self.object_name
@@ -27,7 +27,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
 
             def self.inner_class_types
@@ -50,7 +50,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
 
             def self.inner_class_types
@@ -100,7 +100,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
 
             def self.inner_class_types
@@ -123,7 +123,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
 
             def self.inner_class_types
@@ -171,7 +171,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
 
             def self.inner_class_types
@@ -194,7 +194,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
 
             def self.inner_class_types
@@ -240,7 +240,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
 
             def self.inner_class_types
@@ -263,7 +263,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
 
             def self.inner_class_types
@@ -311,7 +311,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
 
             def self.inner_class_types
@@ -334,7 +334,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
 
             def self.inner_class_types
@@ -384,7 +384,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
 
             def self.inner_class_types
@@ -407,7 +407,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
 
             def self.inner_class_types

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

@@ -0,0 +1,116 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    # A BlocklistEntry represents an entry in our identity verification blocklist.
+    # It helps prevent fraudulent users from repeatedly attempting verification with similar information.
+    # When you create a BlocklistEntry, we store data from a specified VerificationReport,
+    # such as document details or facial biometrics.
+    # This allows us to compare future verification attempts against these entries.
+    # If a match is found, we categorize the new verification as unverified.
+    #
+    # To learn more, see [Identity Verification Blocklist](https://docs.stripe.com/identity/review-tools#block-list)
+    class BlocklistEntry < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "identity.blocklist_entry"
+      def self.object_name
+        "identity.blocklist_entry"
+      end
+
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Time at which you disabled the BlocklistEntry. Measured in seconds since the Unix epoch.
+      attr_reader :disabled_at
+      # Time at which the BlocklistEntry expires. Measured in seconds since the Unix epoch.
+      attr_reader :expires_at
+      # Unique identifier for the object.
+      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.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The current status of the BlocklistEntry.
+      attr_reader :status
+      # The type of BlocklistEntry.
+      attr_reader :type
+      # The verification report the BlocklistEntry was created from.
+      attr_reader :verification_report
+      # The verification session the BlocklistEntry was created from.
+      attr_reader :verification_session
+
+      # Creates a BlocklistEntry object from a verification report.
+      #
+      # A blocklist entry prevents future identity verifications that match the same identity information.
+      # You can create blocklist entries from verification reports that contain document extracted data
+      # or a selfie.
+      #
+      # Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#add-a-blocklist-entry)
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/identity/blocklist_entries",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Disables a BlocklistEntry object.
+      #
+      # After a BlocklistEntry is disabled, it will no longer block future verifications that match
+      # the same information. This action is irreversible. To re-enable it, a new BlocklistEntry
+      # must be created using the same verification report.
+      #
+      # Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#disable-a-blocklist-entry)
+      def disable(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/identity/blocklist_entries/%<id>s/disable", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Disables a BlocklistEntry object.
+      #
+      # After a BlocklistEntry is disabled, it will no longer block future verifications that match
+      # the same information. This action is irreversible. To re-enable it, a new BlocklistEntry
+      # must be created using the same verification report.
+      #
+      # Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#disable-a-blocklist-entry)
+      def self.disable(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/identity/blocklist_entries/%<id>s/disable", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of BlocklistEntry objects associated with your account.
+      #
+      # The blocklist entries are returned sorted by creation date, with the most recently created
+      # entries appearing first.
+      #
+      # Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#block-list)
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/identity/blocklist_entries",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

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

@@ -9,11 +9,11 @@ module Stripe
     # appropriate sub-resource: `document`, `id_number`, `selfie`.
     #
     # Each VerificationReport contains a copy of any data collected by the user as well as
-    # reference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files)
+    # reference IDs which can be used to access collected images through the [FileUpload](https://docs.stripe.com/api/files)
     # API. To configure and create VerificationReports, use the
-    # [VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.
+    # [VerificationSession](https://docs.stripe.com/api/identity/verification_sessions) API.
     #
-    # Related guide: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results).
+    # Related guide: [Accessing verification results](https://docs.stripe.com/identity/verification-sessions#results).
     class VerificationReport < APIResource
       extend Stripe::APIOperations::List
 
@@ -34,7 +34,7 @@ module Stripe
           attr_reader :line2
           # ZIP or postal code.
           attr_reader :postal_code
-          # State, county, province, or region.
+          # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
           attr_reader :state
 
           def self.inner_class_types
@@ -113,13 +113,15 @@ module Stripe
         end
         # Address as it appears in the document.
         attr_reader :address
+        # If document was not verified due to extracted data being on the blocklist, this is the token of the BlocklistEntry that blocked it
+        attr_reader :blocked_by_entry
         # Date of birth as it appears in the document.
         attr_reader :dob
         # Details on the verification error. Present when status is `unverified`.
         attr_reader :error
         # Expiration date of the document.
         attr_reader :expiration_date
-        # Array of [File](https://stripe.com/docs/api/files) ids containing images for this document.
+        # Array of [File](https://docs.stripe.com/api/files) ids containing images for this document.
         attr_reader :files
         # First name as it appears in the document.
         attr_reader :first_name
@@ -248,11 +250,11 @@ module Stripe
         class Document < ::Stripe::StripeObject
           # Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
           attr_reader :allowed_types
-          # Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
+          # Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
           attr_reader :require_id_number
           # Disable image uploads, identity document images have to be captured using the device’s camera.
           attr_reader :require_live_capture
-          # Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).
+          # Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://docs.stripe.com/identity/selfie).
           attr_reader :require_matching_selfie
 
           def self.inner_class_types
@@ -333,11 +335,13 @@ module Stripe
             @field_remappings = {}
           end
         end
-        # ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check.
+        # If selfie was not verified due to being on the blocklist, this is the token of the BlocklistEntry that blocked it
+        attr_reader :blocked_by_entry
+        # ID of the [File](https://docs.stripe.com/api/files) holding the image of the identity document used in this check.
         attr_reader :document
         # Details on the verification error. Present when status is `unverified`.
         attr_reader :error
-        # ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check.
+        # ID of the [File](https://docs.stripe.com/api/files) holding the image of the selfie used in this check.
         attr_reader :selfie
         # Status of this `selfie` check.
         attr_reader :status

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

@@ -13,7 +13,7 @@ module Stripe
     # the verification flow. The VerificationSession contains the user's verified data after
     # verification checks are complete.
     #
-    # Related guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions)
+    # Related guide: [The Verification Sessions API](https://docs.stripe.com/identity/verification-sessions)
     class VerificationSession < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List
@@ -43,11 +43,11 @@ module Stripe
         class Document < ::Stripe::StripeObject
           # Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
           attr_reader :allowed_types
-          # Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
+          # Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
           attr_reader :require_id_number
           # Disable image uploads, identity document images have to be captured using the device’s camera.
           attr_reader :require_live_capture
-          # Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).
+          # Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://docs.stripe.com/identity/selfie).
           attr_reader :require_matching_selfie
 
           def self.inner_class_types
@@ -190,7 +190,7 @@ module Stripe
           attr_reader :line2
           # ZIP or postal code.
           attr_reader :postal_code
-          # State, county, province, or region.
+          # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
           attr_reader :state
 
           def self.inner_class_types
@@ -251,7 +251,7 @@ module Stripe
       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.
       attr_reader :client_reference_id
-      # The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more.
+      # The short-lived client secret used by Stripe.js to [show a verification modal](https://docs.stripe.com/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://docs.stripe.com/identity/verification-sessions#client-secret) to learn more.
       attr_reader :client_secret
       # Time at which the object was created. Measured in seconds since the Unix epoch.
       attr_reader :created
@@ -259,11 +259,11 @@ module Stripe
       attr_reader :id
       # If present, this property tells you the last error encountered when processing the verification.
       attr_reader :last_error
-      # ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results)
+      # ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://docs.stripe.com/identity/verification-sessions#results)
       attr_reader :last_verification_report
       # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
       attr_reader :livemode
-      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+      # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
       attr_reader :metadata
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
@@ -275,15 +275,15 @@ module Stripe
       attr_reader :redaction
       # Customer ID
       attr_reader :related_customer
-      # Token referencing a Customer Account resource.
+      # The ID of the Account representing a customer.
       attr_reader :related_customer_account
       # Attribute for field related_person
       attr_reader :related_person
-      # Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
+      # Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work).
       attr_reader :status
-      # The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.
+      # The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed.
       attr_reader :type
-      # The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe.
+      # The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://docs.stripe.com/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe.
       attr_reader :url
       # The configuration token of a verification flow from the dashboard.
       attr_reader :verification_flow