trinsic_api 2.3.0.pre.alpha2 → 3.0.0

data/lib/trinsic_api/models/{bangladesh_nid_input.rb → belgium_id_card_provider_output.rb}

@@ -14,30 +14,27 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  class BangladeshNidInput
-    # The user's Bangladesh National ID number.
-    attr_accessor :national_id_number
+  # Exposed properties for the `a-be-id-login` Provider which do not directly map to the normalized IdentityData model.
+  class BelgiumIdCardProviderOutput
+    # The first name of the verified individual
+    attr_accessor :first_name
 
-    # The user's date of birth, in `YYYY-MM-DD` format
-    attr_accessor :date_of_birth
-
-    # The user's full name
-    attr_accessor :name
+    # The last name of the verified individual
+    attr_accessor :last_name
 
-    # The raw bytes of the photo file collected from the user.
-    attr_accessor :photo_byes
+    # The date of birth of the verified individual
+    attr_accessor :date_of_birth
 
-    # The MIME Type of the file contained in `PhotoByes`.              Must be one of `image/jpeg`, or `image/png`.
-    attr_accessor :photo_image_mime_type
+    # The Belgian National Register Number (\"Rijksregisternummer\") of the verified individual.              This is an 11-digit number in the format YYMMDDXXXCC, where: - YYMMDD represents the individual's date of birth (year, month, day). - XXX is a sequential birth number, odd for males and even for females. - CC is a checksum, calculated with the equation: 97 - (YYMMDDXXX mod 97)              For births in the year 2000 or later, the digit '2' is prepended to the first 9 digits during checksum calculation.
+    attr_accessor :national_register_number
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'national_id_number' => :'nationalIdNumber',
+        :'first_name' => :'firstName',
+        :'last_name' => :'lastName',
         :'date_of_birth' => :'dateOfBirth',
-        :'name' => :'name',
-        :'photo_byes' => :'photoByes',
-        :'photo_image_mime_type' => :'photoImageMimeType'
+        :'national_register_number' => :'nationalRegisterNumber'
       }
     end
 
@@ -54,19 +51,16 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'national_id_number' => :'String',
+        :'first_name' => :'String',
+        :'last_name' => :'String',
         :'date_of_birth' => :'Date',
-        :'name' => :'String',
-        :'photo_byes' => :'String',
-        :'photo_image_mime_type' => :'String'
+        :'national_register_number' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'photo_byes',
-        :'photo_image_mime_type'
       ])
     end
 
@@ -74,22 +68,28 @@ module TrinsicApi
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::BangladeshNidInput` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::BelgiumIdCardProviderOutput` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!acceptable_attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::BangladeshNidInput`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::BelgiumIdCardProviderOutput`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'national_id_number')
-        self.national_id_number = attributes[:'national_id_number']
+      if attributes.key?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      else
+        self.first_name = nil
+      end
+
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_name']
       else
-        self.national_id_number = nil
+        self.last_name = nil
       end
 
       if attributes.key?(:'date_of_birth')
@@ -98,18 +98,10 @@ module TrinsicApi
         self.date_of_birth = nil
       end
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
+      if attributes.key?(:'national_register_number')
+        self.national_register_number = attributes[:'national_register_number']
       else
-        self.name = nil
-      end
-
-      if attributes.key?(:'photo_byes')
-        self.photo_byes = attributes[:'photo_byes']
-      end
-
-      if attributes.key?(:'photo_image_mime_type')
-        self.photo_image_mime_type = attributes[:'photo_image_mime_type']
+        self.national_register_number = nil
       end
     end
 
@@ -118,32 +110,20 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @national_id_number.nil?
-        invalid_properties.push('invalid value for "national_id_number", national_id_number cannot be nil.')
-      end
-
-      if @national_id_number.to_s.length > 17
-        invalid_properties.push('invalid value for "national_id_number", the character length must be smaller than or equal to 17.')
+      if @first_name.nil?
+        invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
       end
 
-      if @national_id_number.to_s.length < 10
-        invalid_properties.push('invalid value for "national_id_number", the character length must be great than or equal to 10.')
+      if @last_name.nil?
+        invalid_properties.push('invalid value for "last_name", last_name cannot be nil.')
       end
 
       if @date_of_birth.nil?
         invalid_properties.push('invalid value for "date_of_birth", date_of_birth cannot be nil.')
       end
 
-      if @name.nil?
-        invalid_properties.push('invalid value for "name", name cannot be nil.')
-      end
-
-      if @name.to_s.length > 80
-        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 80.')
-      end
-
-      if @name.to_s.length < 1
-        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
+      if @national_register_number.nil?
+        invalid_properties.push('invalid value for "national_register_number", national_register_number cannot be nil.')
       end
 
       invalid_properties
@@ -153,32 +133,31 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @national_id_number.nil?
-      return false if @national_id_number.to_s.length > 17
-      return false if @national_id_number.to_s.length < 10
+      return false if @first_name.nil?
+      return false if @last_name.nil?
       return false if @date_of_birth.nil?
-      return false if @name.nil?
-      return false if @name.to_s.length > 80
-      return false if @name.to_s.length < 1
+      return false if @national_register_number.nil?
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] national_id_number Value to be assigned
-    def national_id_number=(national_id_number)
-      if national_id_number.nil?
-        fail ArgumentError, 'national_id_number cannot be nil'
+    # @param [Object] first_name Value to be assigned
+    def first_name=(first_name)
+      if first_name.nil?
+        fail ArgumentError, 'first_name cannot be nil'
       end
 
-      if national_id_number.to_s.length > 17
-        fail ArgumentError, 'invalid value for "national_id_number", the character length must be smaller than or equal to 17.'
-      end
+      @first_name = first_name
+    end
 
-      if national_id_number.to_s.length < 10
-        fail ArgumentError, 'invalid value for "national_id_number", the character length must be great than or equal to 10.'
+    # Custom attribute writer method with validation
+    # @param [Object] last_name Value to be assigned
+    def last_name=(last_name)
+      if last_name.nil?
+        fail ArgumentError, 'last_name cannot be nil'
       end
 
-      @national_id_number = national_id_number
+      @last_name = last_name
     end
 
     # Custom attribute writer method with validation
@@ -192,21 +171,13 @@ module TrinsicApi
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] name Value to be assigned
-    def name=(name)
-      if name.nil?
-        fail ArgumentError, 'name cannot be nil'
-      end
-
-      if name.to_s.length > 80
-        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 80.'
-      end
-
-      if name.to_s.length < 1
-        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+    # @param [Object] national_register_number Value to be assigned
+    def national_register_number=(national_register_number)
+      if national_register_number.nil?
+        fail ArgumentError, 'national_register_number cannot be nil'
       end
 
-      @name = name
+      @national_register_number = national_register_number
     end
 
     # Checks equality by comparing each attribute.
@@ -214,11 +185,10 @@ module TrinsicApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          national_id_number == o.national_id_number &&
+          first_name == o.first_name &&
+          last_name == o.last_name &&
           date_of_birth == o.date_of_birth &&
-          name == o.name &&
-          photo_byes == o.photo_byes &&
-          photo_image_mime_type == o.photo_image_mime_type
+          national_register_number == o.national_register_number
     end
 
     # @see the `==` method
@@ -230,7 +200,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [national_id_number, date_of_birth, name, photo_byes, photo_image_mime_type].hash
+      [first_name, last_name, date_of_birth, national_register_number].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/{contract_identifier_field.rb → contract_attachment.rb}

@@ -14,17 +14,14 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  # Information about an identifier a Provider returns in verification results.
-  class ContractIdentifierField
-    # The scope of the identifier as it appears in verification results.
-    attr_accessor :scope
+  # Information about an attachment that a Provider may return in verification results.
+  class ContractAttachment
+    # The type of the attachment as it appears in verification results.              Possible values: - \"selfie\" - \"document_front\" - \"document_back\" - \"document_portrait\" - \"document_signature\" - \"document_scan_report\"              Additional attachment types may be defined for specific Providers.
+    attr_accessor :type
 
-    # Indicates when this field will be present in verification results.
+    # Indicates when this attachment will be present in verification results.
     attr_accessor :outputted
 
-    # A human-readable description of the identifier, written by Trinsic.
-    attr_accessor :description
-
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -50,9 +47,8 @@ module TrinsicApi
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'scope' => :'scope',
-        :'outputted' => :'outputted',
-        :'description' => :'description'
+        :'type' => :'type',
+        :'outputted' => :'outputted'
       }
     end
 
@@ -69,9 +65,8 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'scope' => :'String',
-        :'outputted' => :'FieldAvailability',
-        :'description' => :'String'
+        :'type' => :'String',
+        :'outputted' => :'AttributeAvailability'
       }
     end
 
@@ -85,22 +80,22 @@ module TrinsicApi
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::ContractIdentifierField` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::ContractAttachment` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!acceptable_attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::ContractIdentifierField`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::ContractAttachment`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'scope')
-        self.scope = attributes[:'scope']
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
       else
-        self.scope = nil
+        self.type = nil
       end
 
       if attributes.key?(:'outputted')
@@ -108,12 +103,6 @@ module TrinsicApi
       else
         self.outputted = nil
       end
-
-      if attributes.key?(:'description')
-        self.description = attributes[:'description']
-      else
-        self.description = nil
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -121,18 +110,14 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @scope.nil?
-        invalid_properties.push('invalid value for "scope", scope cannot be nil.')
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
 
       if @outputted.nil?
         invalid_properties.push('invalid value for "outputted", outputted cannot be nil.')
       end
 
-      if @description.nil?
-        invalid_properties.push('invalid value for "description", description cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -140,20 +125,19 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @scope.nil?
+      return false if @type.nil?
       return false if @outputted.nil?
-      return false if @description.nil?
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] scope Value to be assigned
-    def scope=(scope)
-      if scope.nil?
-        fail ArgumentError, 'scope cannot be nil'
+    # @param [Object] type Value to be assigned
+    def type=(type)
+      if type.nil?
+        fail ArgumentError, 'type cannot be nil'
       end
 
-      @scope = scope
+      @type = type
     end
 
     # Custom attribute writer method with validation
@@ -166,24 +150,13 @@ module TrinsicApi
       @outputted = outputted
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] description Value to be assigned
-    def description=(description)
-      if description.nil?
-        fail ArgumentError, 'description cannot be nil'
-      end
-
-      @description = description
-    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 &&
-          scope == o.scope &&
-          outputted == o.outputted &&
-          description == o.description
+          type == o.type &&
+          outputted == o.outputted
     end
 
     # @see the `==` method
@@ -195,7 +168,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [scope, outputted, description].hash
+      [type, outputted].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/{contract_field.rb → contract_attribute.rb}

@@ -14,15 +14,12 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  # Information about a field that a Provider will return in verification results.
-  class ContractField
-    # The name of the field as it appears in verification results.
-    attr_accessor :name
-
-    # The scope of the field as it appears in verification results.
+  # Information about an attribute that a Provider may return in verification results.
+  class ContractAttribute
+    # The scope of the attribute as it appears in verification results.
     attr_accessor :scope
 
-    # Indicates when this field will be present in verification results.
+    # Indicates when this attribute will be present in verification results.
     attr_accessor :outputted
 
     class EnumAttributeValidator
@@ -50,7 +47,6 @@ module TrinsicApi
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'name' => :'name',
         :'scope' => :'scope',
         :'outputted' => :'outputted'
       }
@@ -69,9 +65,8 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'name' => :'String',
         :'scope' => :'String',
-        :'outputted' => :'FieldAvailability'
+        :'outputted' => :'AttributeAvailability'
       }
     end
 
@@ -85,24 +80,18 @@ module TrinsicApi
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::ContractField` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::ContractAttribute` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!acceptable_attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::ContractField`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::ContractAttribute`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
-      else
-        self.name = nil
-      end
-
       if attributes.key?(:'scope')
         self.scope = attributes[:'scope']
       else
@@ -121,10 +110,6 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @name.nil?
-        invalid_properties.push('invalid value for "name", name cannot be nil.')
-      end
-
       if @scope.nil?
         invalid_properties.push('invalid value for "scope", scope cannot be nil.')
       end
@@ -140,22 +125,11 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @name.nil?
       return false if @scope.nil?
       return false if @outputted.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] name Value to be assigned
-    def name=(name)
-      if name.nil?
-        fail ArgumentError, 'name cannot be nil'
-      end
-
-      @name = name
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] scope Value to be assigned
     def scope=(scope)
@@ -181,7 +155,6 @@ module TrinsicApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          name == o.name &&
           scope == o.scope &&
           outputted == o.outputted
     end
@@ -195,7 +168,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, scope, outputted].hash
+      [scope, outputted].hash
     end
 
     # Builds the object from hash