trulioo_sdk 1.0.3

data/lib/trulioo_sdk/models/business_registration_number.rb

@@ -0,0 +1,410 @@
+=begin
+Trulioo Ruby SDK
+
+Gem version: 1.0.3
+Trulioo OpenAPI version: v1
+Generated by OpenAPI Generator version: 5.0.1
+=end
+
+require 'date'
+require 'time'
+
+module Trulioo
+  class BusinessRegistrationNumber
+    # The name of the business registration number
+    attr_accessor :name
+
+    # Brief description of the business registration number
+    attr_accessor :description
+
+    # Country to which the business registration number applies
+    attr_accessor :country
+
+    # Optional jurisdiction to which the business registration number applies
+    attr_accessor :jurisdiction
+
+    # Whether the business registration number is supported by Trulioo's systems
+    attr_accessor :supported
+
+    # The specified type of this business registration number
+    attr_accessor :type
+
+    # The mask(s) describing this business registration number
+    attr_accessor :masks
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'Name',
+        :'description' => :'Description',
+        :'country' => :'Country',
+        :'jurisdiction' => :'Jurisdiction',
+        :'supported' => :'Supported',
+        :'type' => :'Type',
+        :'masks' => :'Masks'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'description' => :'String',
+        :'country' => :'String',
+        :'jurisdiction' => :'String',
+        :'supported' => :'Boolean',
+        :'type' => :'String',
+        :'masks' => :'Array<BusinessRegistrationNumberMask>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @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 `Trulioo::BusinessRegistrationNumber` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Trulioo::BusinessRegistrationNumber`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'jurisdiction')
+        self.jurisdiction = attributes[:'jurisdiction']
+      end
+
+      if attributes.key?(:'supported')
+        self.supported = attributes[:'supported']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'masks')
+        if (value = attributes[:'masks']).is_a?(Array)
+          self.masks = value
+        end
+      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 !@name.nil? && @name.to_s.length > 512
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 512.')
+      end
+
+      if !@name.nil? && @name.to_s.length < 0
+        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 0.')
+      end
+
+      if !@description.nil? && @description.to_s.length > 512
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 512.')
+      end
+
+      if !@description.nil? && @description.to_s.length < 0
+        invalid_properties.push('invalid value for "description", the character length must be great than or equal to 0.')
+      end
+
+      if !@country.nil? && @country.to_s.length > 512
+        invalid_properties.push('invalid value for "country", the character length must be smaller than or equal to 512.')
+      end
+
+      if !@country.nil? && @country.to_s.length < 0
+        invalid_properties.push('invalid value for "country", the character length must be great than or equal to 0.')
+      end
+
+      if !@jurisdiction.nil? && @jurisdiction.to_s.length > 512
+        invalid_properties.push('invalid value for "jurisdiction", the character length must be smaller than or equal to 512.')
+      end
+
+      if !@jurisdiction.nil? && @jurisdiction.to_s.length < 0
+        invalid_properties.push('invalid value for "jurisdiction", the character length must be great than or equal to 0.')
+      end
+
+      if !@type.nil? && @type.to_s.length > 512
+        invalid_properties.push('invalid value for "type", the character length must be smaller than or equal to 512.')
+      end
+
+      if !@type.nil? && @type.to_s.length < 0
+        invalid_properties.push('invalid value for "type", the character length must be great than or equal to 0.')
+      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 !@name.nil? && @name.to_s.length > 512
+      return false if !@name.nil? && @name.to_s.length < 0
+      return false if !@description.nil? && @description.to_s.length > 512
+      return false if !@description.nil? && @description.to_s.length < 0
+      return false if !@country.nil? && @country.to_s.length > 512
+      return false if !@country.nil? && @country.to_s.length < 0
+      return false if !@jurisdiction.nil? && @jurisdiction.to_s.length > 512
+      return false if !@jurisdiction.nil? && @jurisdiction.to_s.length < 0
+      return false if !@type.nil? && @type.to_s.length > 512
+      return false if !@type.nil? && @type.to_s.length < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if !name.nil? && name.to_s.length > 512
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 512.'
+      end
+
+      if !name.nil? && name.to_s.length < 0
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 0.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if !description.nil? && description.to_s.length > 512
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 512.'
+      end
+
+      if !description.nil? && description.to_s.length < 0
+        fail ArgumentError, 'invalid value for "description", the character length must be great than or equal to 0.'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country Value to be assigned
+    def country=(country)
+      if !country.nil? && country.to_s.length > 512
+        fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 512.'
+      end
+
+      if !country.nil? && country.to_s.length < 0
+        fail ArgumentError, 'invalid value for "country", the character length must be great than or equal to 0.'
+      end
+
+      @country = country
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] jurisdiction Value to be assigned
+    def jurisdiction=(jurisdiction)
+      if !jurisdiction.nil? && jurisdiction.to_s.length > 512
+        fail ArgumentError, 'invalid value for "jurisdiction", the character length must be smaller than or equal to 512.'
+      end
+
+      if !jurisdiction.nil? && jurisdiction.to_s.length < 0
+        fail ArgumentError, 'invalid value for "jurisdiction", the character length must be great than or equal to 0.'
+      end
+
+      @jurisdiction = jurisdiction
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] type Value to be assigned
+    def type=(type)
+      if !type.nil? && type.to_s.length > 512
+        fail ArgumentError, 'invalid value for "type", the character length must be smaller than or equal to 512.'
+      end
+
+      if !type.nil? && type.to_s.length < 0
+        fail ArgumentError, 'invalid value for "type", the character length must be great than or equal to 0.'
+      end
+
+      @type = 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 &&
+          name == o.name &&
+          description == o.description &&
+          country == o.country &&
+          jurisdiction == o.jurisdiction &&
+          supported == o.supported &&
+          type == o.type &&
+          masks == o.masks
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [name, description, country, jurisdiction, supported, type, masks].hash
+    end
+
+    # :nocov:
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+    # :nocov:
+
+    # :nocov:
+    # 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.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      end
+
+      self
+    end
+    # :nocov:
+
+    # :nocov:
+    # 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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = Trulioo.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+    # :nocov:
+
+    # :nocov:
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+    # :nocov:
+
+    # :nocov:
+    # 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
+    # :nocov:
+
+    # :nocov:
+    # 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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+    # :nocov:
+
+    # :nocov:
+    # 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
+    # :nocov:
+  end
+
+end

data/lib/trulioo_sdk/models/business_registration_number_mask.rb

@@ -0,0 +1,272 @@
+=begin
+Trulioo Ruby SDK
+
+Gem version: 1.0.3
+Trulioo OpenAPI version: v1
+Generated by OpenAPI Generator version: 5.0.1
+=end
+
+require 'date'
+require 'time'
+
+module Trulioo
+  class BusinessRegistrationNumberMask
+    # The mask used to validate the format of the business registration number
+    attr_accessor :mask
+
+    # Flag showing whether we can ignore whitespace
+    attr_accessor :ignore_whitespace
+
+    # Flag showing whether we can ignore special character
+    attr_accessor :ignore_special_character
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'mask' => :'Mask',
+        :'ignore_whitespace' => :'IgnoreWhitespace',
+        :'ignore_special_character' => :'IgnoreSpecialCharacter'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'mask' => :'String',
+        :'ignore_whitespace' => :'Boolean',
+        :'ignore_special_character' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @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 `Trulioo::BusinessRegistrationNumberMask` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Trulioo::BusinessRegistrationNumberMask`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'mask')
+        self.mask = attributes[:'mask']
+      end
+
+      if attributes.key?(:'ignore_whitespace')
+        self.ignore_whitespace = attributes[:'ignore_whitespace']
+      end
+
+      if attributes.key?(:'ignore_special_character')
+        self.ignore_special_character = attributes[:'ignore_special_character']
+      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 !@mask.nil? && @mask.to_s.length > 512
+        invalid_properties.push('invalid value for "mask", the character length must be smaller than or equal to 512.')
+      end
+
+      if !@mask.nil? && @mask.to_s.length < 0
+        invalid_properties.push('invalid value for "mask", the character length must be great than or equal to 0.')
+      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 !@mask.nil? && @mask.to_s.length > 512
+      return false if !@mask.nil? && @mask.to_s.length < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mask Value to be assigned
+    def mask=(mask)
+      if !mask.nil? && mask.to_s.length > 512
+        fail ArgumentError, 'invalid value for "mask", the character length must be smaller than or equal to 512.'
+      end
+
+      if !mask.nil? && mask.to_s.length < 0
+        fail ArgumentError, 'invalid value for "mask", the character length must be great than or equal to 0.'
+      end
+
+      @mask = mask
+    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 &&
+          mask == o.mask &&
+          ignore_whitespace == o.ignore_whitespace &&
+          ignore_special_character == o.ignore_special_character
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [mask, ignore_whitespace, ignore_special_character].hash
+    end
+
+    # :nocov:
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+    # :nocov:
+
+    # :nocov:
+    # 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.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      end
+
+      self
+    end
+    # :nocov:
+
+    # :nocov:
+    # 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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = Trulioo.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+    # :nocov:
+
+    # :nocov:
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+    # :nocov:
+
+    # :nocov:
+    # 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
+    # :nocov:
+
+    # :nocov:
+    # 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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+    # :nocov:
+
+    # :nocov:
+    # 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
+    # :nocov:
+  end
+
+end