yousign_client 1.0.0

data/lib/yousign_client/models/check_document_identities_input.rb

@@ -0,0 +1,222 @@
+=begin
+#Yousign API Swagger
+
+#For your information, the Yousign API documentation is available at https://dev.yousign.com/
+
+OpenAPI spec version: 2.1
+Contact: support@yousign.fr
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'date'
+
+module YousignClient
+  class CheckDocumentIdentitiesInput
+    # Content in base 64 of the document to check
+    attr_accessor :file
+
+    # List of firstnames to check on document
+    attr_accessor :first_names
+
+    # Birth name to check on document
+    attr_accessor :birth_name
+
+    # Birth date to check on document
+    attr_accessor :birth_date
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'file' => :'file',
+        :'first_names' => :'firstNames',
+        :'birth_name' => :'birthName',
+        :'birth_date' => :'birthDate'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'file' => :'String',
+        :'first_names' => :'Array<String>',
+        :'birth_name' => :'String',
+        :'birth_date' => :'Date'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'file')
+        self.file = attributes[:'file']
+      end
+
+      if attributes.has_key?(:'firstNames')
+        if (value = attributes[:'firstNames']).is_a?(Array)
+          self.first_names = value
+        end
+      end
+
+      if attributes.has_key?(:'birthName')
+        self.birth_name = attributes[:'birthName']
+      end
+
+      if attributes.has_key?(:'birthDate')
+        self.birth_date = attributes[:'birthDate']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @file.nil?
+        invalid_properties.push('invalid value for "file", file cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @file.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          file == o.file &&
+          first_names == o.first_names &&
+          birth_name == o.birth_name &&
+          birth_date == o.birth_date
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [file, first_names, birth_name, birth_date].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = YousignClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/yousign_client/models/check_document_identities_output.rb

@@ -0,0 +1,440 @@
+=begin
+#Yousign API Swagger
+
+#For your information, the Yousign API documentation is available at https://dev.yousign.com/
+
+OpenAPI spec version: 2.1
+Contact: support@yousign.fr
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'date'
+
+module YousignClient
+  class CheckDocumentIdentitiesOutput
+    # Id of the object
+    attr_accessor :id
+
+    # Created date of the object
+    attr_accessor :created_at
+
+    # Updated date of the object
+    attr_accessor :updated_at
+
+    # List of firstnames to check on document
+    attr_accessor :first_names
+
+    # Birth name to check on document
+    attr_accessor :birth_name
+
+    # Birth date to check on document
+    attr_accessor :birth_date
+
+    # workspace creator of the object
+    attr_accessor :workspace
+
+    # Creator of the object
+    attr_accessor :creator
+
+    # Type of document
+    attr_accessor :document_type
+
+    # Extracted firstnames on the document
+    attr_accessor :extracted_first_names
+
+    # Extracted birth name on the document
+    attr_accessor :extracted_birth_name
+
+    # Extracted birth date on the document
+    attr_accessor :extracted_birth_date
+
+    # Extracted gender on the document
+    attr_accessor :extracted_gender
+
+    # Extracted issuance date on the document
+    attr_accessor :extracted_issuance_date
+
+    # Extracted expiration date on the document
+    attr_accessor :extracted_expiration_date
+
+    # Extracted MRZ on the document
+    attr_accessor :extracted_mrz
+
+    # Defines if one firstname sent in the input is valid
+    attr_accessor :first_name_valid
+
+    # Defines if birth name sent in the input is valid
+    attr_accessor :birth_name_valid
+
+    # Defines if MRZ sent in the input is valid
+    attr_accessor :mrz_valid
+
+    # Defines if the document is expired
+    attr_accessor :expired
+
+    # Defines if the document is valid
+    attr_accessor :valid
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt',
+        :'first_names' => :'firstNames',
+        :'birth_name' => :'birthName',
+        :'birth_date' => :'birthDate',
+        :'workspace' => :'workspace',
+        :'creator' => :'creator',
+        :'document_type' => :'documentType',
+        :'extracted_first_names' => :'extractedFirstNames',
+        :'extracted_birth_name' => :'extractedBirthName',
+        :'extracted_birth_date' => :'extractedBirthDate',
+        :'extracted_gender' => :'extractedGender',
+        :'extracted_issuance_date' => :'extractedIssuanceDate',
+        :'extracted_expiration_date' => :'extractedExpirationDate',
+        :'extracted_mrz' => :'extractedMrz',
+        :'first_name_valid' => :'firstNameValid',
+        :'birth_name_valid' => :'birthNameValid',
+        :'mrz_valid' => :'mrzValid',
+        :'expired' => :'expired',
+        :'valid' => :'valid'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'String',
+        :'created_at' => :'DateTime',
+        :'updated_at' => :'DateTime',
+        :'first_names' => :'Array<String>',
+        :'birth_name' => :'String',
+        :'birth_date' => :'Date',
+        :'workspace' => :'String',
+        :'creator' => :'String',
+        :'document_type' => :'String',
+        :'extracted_first_names' => :'Array<String>',
+        :'extracted_birth_name' => :'String',
+        :'extracted_birth_date' => :'Date',
+        :'extracted_gender' => :'String',
+        :'extracted_issuance_date' => :'Date',
+        :'extracted_expiration_date' => :'Date',
+        :'extracted_mrz' => :'Array<String>',
+        :'first_name_valid' => :'BOOLEAN',
+        :'birth_name_valid' => :'BOOLEAN',
+        :'mrz_valid' => :'BOOLEAN',
+        :'expired' => :'BOOLEAN',
+        :'valid' => :'BOOLEAN'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'createdAt')
+        self.created_at = attributes[:'createdAt']
+      end
+
+      if attributes.has_key?(:'updatedAt')
+        self.updated_at = attributes[:'updatedAt']
+      end
+
+      if attributes.has_key?(:'firstNames')
+        if (value = attributes[:'firstNames']).is_a?(Array)
+          self.first_names = value
+        end
+      end
+
+      if attributes.has_key?(:'birthName')
+        self.birth_name = attributes[:'birthName']
+      end
+
+      if attributes.has_key?(:'birthDate')
+        self.birth_date = attributes[:'birthDate']
+      end
+
+      if attributes.has_key?(:'workspace')
+        self.workspace = attributes[:'workspace']
+      end
+
+      if attributes.has_key?(:'creator')
+        self.creator = attributes[:'creator']
+      end
+
+      if attributes.has_key?(:'documentType')
+        self.document_type = attributes[:'documentType']
+      end
+
+      if attributes.has_key?(:'extractedFirstNames')
+        if (value = attributes[:'extractedFirstNames']).is_a?(Array)
+          self.extracted_first_names = value
+        end
+      end
+
+      if attributes.has_key?(:'extractedBirthName')
+        self.extracted_birth_name = attributes[:'extractedBirthName']
+      end
+
+      if attributes.has_key?(:'extractedBirthDate')
+        self.extracted_birth_date = attributes[:'extractedBirthDate']
+      end
+
+      if attributes.has_key?(:'extractedGender')
+        self.extracted_gender = attributes[:'extractedGender']
+      end
+
+      if attributes.has_key?(:'extractedIssuanceDate')
+        self.extracted_issuance_date = attributes[:'extractedIssuanceDate']
+      end
+
+      if attributes.has_key?(:'extractedExpirationDate')
+        self.extracted_expiration_date = attributes[:'extractedExpirationDate']
+      end
+
+      if attributes.has_key?(:'extractedMrz')
+        if (value = attributes[:'extractedMrz']).is_a?(Array)
+          self.extracted_mrz = value
+        end
+      end
+
+      if attributes.has_key?(:'firstNameValid')
+        self.first_name_valid = attributes[:'firstNameValid']
+      end
+
+      if attributes.has_key?(:'birthNameValid')
+        self.birth_name_valid = attributes[:'birthNameValid']
+      end
+
+      if attributes.has_key?(:'mrzValid')
+        self.mrz_valid = attributes[:'mrzValid']
+      end
+
+      if attributes.has_key?(:'expired')
+        self.expired = attributes[:'expired']
+      end
+
+      if attributes.has_key?(:'valid')
+        self.valid = attributes[:'valid']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if !@id.nil? && @id !~ Regexp.new(/^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/)
+        invalid_properties.push('invalid value for "id", must conform to the pattern /^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if !@id.nil? && @id !~ Regexp.new(/^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/)
+      document_type_validator = EnumAttributeValidator.new('String', ['ID_CARD', 'PASSPORT'])
+      return false unless document_type_validator.valid?(@document_type)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if !id.nil? && id !~ Regexp.new(/^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/)
+        fail ArgumentError, 'invalid value for "id", must conform to the pattern /^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/.'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] document_type Object to be assigned
+    def document_type=(document_type)
+      validator = EnumAttributeValidator.new('String', ['ID_CARD', 'PASSPORT'])
+      unless validator.valid?(document_type)
+        fail ArgumentError, 'invalid value for "document_type", must be one of #{validator.allowable_values}.'
+      end
+      @document_type = document_type
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
+          first_names == o.first_names &&
+          birth_name == o.birth_name &&
+          birth_date == o.birth_date &&
+          workspace == o.workspace &&
+          creator == o.creator &&
+          document_type == o.document_type &&
+          extracted_first_names == o.extracted_first_names &&
+          extracted_birth_name == o.extracted_birth_name &&
+          extracted_birth_date == o.extracted_birth_date &&
+          extracted_gender == o.extracted_gender &&
+          extracted_issuance_date == o.extracted_issuance_date &&
+          extracted_expiration_date == o.extracted_expiration_date &&
+          extracted_mrz == o.extracted_mrz &&
+          first_name_valid == o.first_name_valid &&
+          birth_name_valid == o.birth_name_valid &&
+          mrz_valid == o.mrz_valid &&
+          expired == o.expired &&
+          valid == o.valid
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [id, created_at, updated_at, first_names, birth_name, birth_date, workspace, creator, document_type, extracted_first_names, extracted_birth_name, extracted_birth_date, extracted_gender, extracted_issuance_date, extracted_expiration_date, extracted_mrz, first_name_valid, birth_name_valid, mrz_valid, expired, valid].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = YousignClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end