stripe 13.4.1 → 17.0.1

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.
     #
@@ -24,9 +24,273 @@ module Stripe
         "identity.verification_session"
       end
 
-      # A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work).
+      class LastError < Stripe::StripeObject
+        # A short machine-readable string giving the reason for the verification or user-session failure.
+        attr_reader :code
+        # A message that explains the reason for verification or user-session failure.
+        attr_reader :reason
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Options < Stripe::StripeObject
+        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.
+          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).
+          attr_reader :require_matching_selfie
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Email < Stripe::StripeObject
+          # Request one time password verification of `provided_details.email`.
+          attr_reader :require_verification
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class IdNumber < Stripe::StripeObject
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Matching < Stripe::StripeObject
+          # Strictness of the DOB matching policy to apply.
+          attr_reader :dob
+          # Strictness of the name matching policy to apply.
+          attr_reader :name
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Phone < Stripe::StripeObject
+          # Request one time password verification of `provided_details.phone`.
+          attr_reader :require_verification
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field document
+        attr_reader :document
+        # Attribute for field email
+        attr_reader :email
+        # Attribute for field id_number
+        attr_reader :id_number
+        # Attribute for field matching
+        attr_reader :matching
+        # Attribute for field phone
+        attr_reader :phone
+
+        def self.inner_class_types
+          @inner_class_types = {
+            document: Document,
+            email: Email,
+            id_number: IdNumber,
+            matching: Matching,
+            phone: Phone,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class ProvidedDetails < Stripe::StripeObject
+        # Email of user being verified
+        attr_reader :email
+        # Phone number of user being verified
+        attr_reader :phone
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Redaction < Stripe::StripeObject
+        # Indicates whether this object and its related objects have been redacted or not.
+        attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class RelatedPerson < Stripe::StripeObject
+        # Token referencing the associated Account of the related Person resource.
+        attr_reader :account
+        # Token referencing the related Person resource.
+        attr_reader :person
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class VerifiedOutputs < Stripe::StripeObject
+        class Address < Stripe::StripeObject
+          # City, district, suburb, town, or village.
+          attr_reader :city
+          # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+          attr_reader :country
+          # Address line 1, such as the street, PO Box, or company name.
+          attr_reader :line1
+          # Address line 2, such as the apartment, suite, unit, or building.
+          attr_reader :line2
+          # ZIP or postal code.
+          attr_reader :postal_code
+          # State, county, province, or region.
+          attr_reader :state
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Dob < Stripe::StripeObject
+          # Numerical day between 1 and 31.
+          attr_reader :day
+          # Numerical month between 1 and 12.
+          attr_reader :month
+          # The four-digit year.
+          attr_reader :year
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The user's verified address.
+        attr_reader :address
+        # The user’s verified date of birth.
+        attr_reader :dob
+        # The user's verified email address
+        attr_reader :email
+        # The user's verified first name.
+        attr_reader :first_name
+        # The user's verified id number.
+        attr_reader :id_number
+        # The user's verified id number type.
+        attr_reader :id_number_type
+        # The user's verified last name.
+        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
+
+        def self.inner_class_types
+          @inner_class_types = { address: Address, dob: Dob }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      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.
+      attr_reader :client_secret
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Unique identifier for the object.
+      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)
+      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.
+      attr_reader :metadata
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # A set of options for the session’s verification checks.
+      attr_reader :options
+      # Details provided about the user being verified. These details may be shown to the user.
+      attr_reader :provided_details
+      # Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.
+      attr_reader :redaction
+      # Customer ID
+      attr_reader :related_customer
+      # 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).
+      attr_reader :status
+      # The type of [verification check](https://stripe.com/docs/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.
+      attr_reader :url
+      # The configuration token of a verification flow from the dashboard.
+      attr_reader :verification_flow
+      # The user’s verified data.
+      attr_reader :verified_outputs
+
+      # 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,
@@ -36,9 +300,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,
@@ -54,7 +318,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,
@@ -79,7 +343,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
@@ -92,7 +356,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,
@@ -107,7 +371,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
@@ -120,7 +384,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,
@@ -142,6 +406,21 @@ module Stripe
           opts: opts
         )
       end
+
+      def self.inner_class_types
+        @inner_class_types = {
+          last_error: LastError,
+          options: Options,
+          provided_details: ProvidedDetails,
+          redaction: Redaction,
+          related_person: RelatedPerson,
+          verified_outputs: VerifiedOutputs,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end