stripe 13.4.1 → 17.0.1

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

@@ -22,6 +22,363 @@ module Stripe
         "identity.verification_report"
       end
 
+      class Document < 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
+
+        class Error < Stripe::StripeObject
+          # A short machine-readable string giving the reason for the verification failure.
+          attr_reader :code
+          # A human-readable message giving the reason for the failure. These messages can be shown to your users.
+          attr_reader :reason
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class ExpirationDate < 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
+
+        class IssuedDate < 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
+        # Address as it appears in the document.
+        attr_reader :address
+        # 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.
+        attr_reader :files
+        # First name as it appears in the document.
+        attr_reader :first_name
+        # Issued date of the document.
+        attr_reader :issued_date
+        # Issuing country of the document.
+        attr_reader :issuing_country
+        # Last name as it appears in the document.
+        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
+
+        def self.inner_class_types
+          @inner_class_types = {
+            address: Address,
+            dob: Dob,
+            error: Error,
+            expiration_date: ExpirationDate,
+            issued_date: IssuedDate,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Email < Stripe::StripeObject
+        class Error < Stripe::StripeObject
+          # A short machine-readable string giving the reason for the verification failure.
+          attr_reader :code
+          # A human-readable message giving the reason for the failure. These messages can be shown to your users.
+          attr_reader :reason
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Email to be verified.
+        attr_reader :email
+        # Details on the verification error. Present when status is `unverified`.
+        attr_reader :error
+        # Status of this `email` check.
+        attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = { error: Error }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class IdNumber < Stripe::StripeObject
+        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
+
+        class Error < Stripe::StripeObject
+          # A short machine-readable string giving the reason for the verification failure.
+          attr_reader :code
+          # A human-readable message giving the reason for the failure. These messages can be shown to your users.
+          attr_reader :reason
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Date of birth.
+        attr_reader :dob
+        # Details on the verification error. Present when status is `unverified`.
+        attr_reader :error
+        # First name.
+        attr_reader :first_name
+        # ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present.
+        attr_reader :id_number
+        # Type of ID number.
+        attr_reader :id_number_type
+        # Last name.
+        attr_reader :last_name
+        # Status of this `id_number` check.
+        attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = { dob: Dob, error: Error }
+        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 IdNumber < Stripe::StripeObject
+          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 id_number
+        attr_reader :id_number
+
+        def self.inner_class_types
+          @inner_class_types = { document: Document, id_number: IdNumber }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Phone < Stripe::StripeObject
+        class Error < Stripe::StripeObject
+          # A short machine-readable string giving the reason for the verification failure.
+          attr_reader :code
+          # A human-readable message giving the reason for the failure. These messages can be shown to your users.
+          attr_reader :reason
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Details on the verification error. Present when status is `unverified`.
+        attr_reader :error
+        # Phone to be verified.
+        attr_reader :phone
+        # Status of this `phone` check.
+        attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = { error: Error }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Selfie < Stripe::StripeObject
+        class Error < Stripe::StripeObject
+          # A short machine-readable string giving the reason for the verification failure.
+          attr_reader :code
+          # A human-readable message giving the reason for the failure. These messages can be shown to your users.
+          attr_reader :reason
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @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.
+        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.
+        attr_reader :selfie
+        # Status of this `selfie` check.
+        attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = { error: Error }
+        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
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Result from a document check
+      attr_reader :document
+      # Result from a email check
+      attr_reader :email
+      # Unique identifier for the object.
+      attr_reader :id
+      # Result from an id_number check
+      attr_reader :id_number
+      # 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
+      # Attribute for field options
+      attr_reader :options
+      # Result from a phone check
+      attr_reader :phone
+      # Result from a selfie check
+      attr_reader :selfie
+      # Type of report.
+      attr_reader :type
+      # The configuration token of a verification flow from the dashboard.
+      attr_reader :verification_flow
+      # ID of the VerificationSession that created this report.
+      attr_reader :verification_session
+
       # List all verification reports.
       def self.list(params = {}, opts = {})
         request_stripe_object(
@@ -31,6 +388,21 @@ module Stripe
           opts: opts
         )
       end
+
+      def self.inner_class_types
+        @inner_class_types = {
+          document: Document,
+          email: Email,
+          id_number: IdNumber,
+          options: Options,
+          phone: Phone,
+          selfie: Selfie,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end