trulioo_sdk 1.0.3

data/lib/trulioo_sdk/models/address.rb

@@ -0,0 +1,356 @@
+=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 Address
+    # Flat/Unit/Apartment number of address
+    attr_accessor :unit_number
+
+    # House / Civic / Building number of address
+    attr_accessor :building_number
+
+    # Name of building
+    attr_accessor :building_name
+
+    # Street name
+    attr_accessor :street_name
+
+    # Street type of address (Typically St, Rd etc)
+    attr_accessor :street_type
+
+    # City
+    attr_accessor :city
+
+    # Suburb / Subdivision / Municipality
+    attr_accessor :suburb
+
+    # State or province of address. US sources expect 2 characters. Australian sources expect 2 or 3 characters.
+    attr_accessor :state_province_code
+
+    # ZIP Code or Postal Code
+    attr_accessor :postal_code
+
+    # Address1
+    attr_accessor :address1
+
+    # Address Type
+    attr_accessor :address_type
+
+    # State Province
+    attr_accessor :state_province
+
+    attr_accessor :country
+
+    attr_accessor :country_code
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'unit_number' => :'UnitNumber',
+        :'building_number' => :'BuildingNumber',
+        :'building_name' => :'BuildingName',
+        :'street_name' => :'StreetName',
+        :'street_type' => :'StreetType',
+        :'city' => :'City',
+        :'suburb' => :'Suburb',
+        :'state_province_code' => :'StateProvinceCode',
+        :'postal_code' => :'PostalCode',
+        :'address1' => :'Address1',
+        :'address_type' => :'AddressType',
+        :'state_province' => :'StateProvince',
+        :'country' => :'Country',
+        :'country_code' => :'CountryCode'
+      }
+    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
+      {
+        :'unit_number' => :'String',
+        :'building_number' => :'String',
+        :'building_name' => :'String',
+        :'street_name' => :'String',
+        :'street_type' => :'String',
+        :'city' => :'String',
+        :'suburb' => :'String',
+        :'state_province_code' => :'String',
+        :'postal_code' => :'String',
+        :'address1' => :'String',
+        :'address_type' => :'String',
+        :'state_province' => :'String',
+        :'country' => :'String',
+        :'country_code' => :'String'
+      }
+    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::Address` 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::Address`. 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?(:'unit_number')
+        self.unit_number = attributes[:'unit_number']
+      end
+
+      if attributes.key?(:'building_number')
+        self.building_number = attributes[:'building_number']
+      end
+
+      if attributes.key?(:'building_name')
+        self.building_name = attributes[:'building_name']
+      end
+
+      if attributes.key?(:'street_name')
+        self.street_name = attributes[:'street_name']
+      end
+
+      if attributes.key?(:'street_type')
+        self.street_type = attributes[:'street_type']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'suburb')
+        self.suburb = attributes[:'suburb']
+      end
+
+      if attributes.key?(:'state_province_code')
+        self.state_province_code = attributes[:'state_province_code']
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end
+
+      if attributes.key?(:'address1')
+        self.address1 = attributes[:'address1']
+      end
+
+      if attributes.key?(:'address_type')
+        self.address_type = attributes[:'address_type']
+      end
+
+      if attributes.key?(:'state_province')
+        self.state_province = attributes[:'state_province']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'country_code')
+        self.country_code = attributes[:'country_code']
+      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
+      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?
+      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 &&
+          unit_number == o.unit_number &&
+          building_number == o.building_number &&
+          building_name == o.building_name &&
+          street_name == o.street_name &&
+          street_type == o.street_type &&
+          city == o.city &&
+          suburb == o.suburb &&
+          state_province_code == o.state_province_code &&
+          postal_code == o.postal_code &&
+          address1 == o.address1 &&
+          address_type == o.address_type &&
+          state_province == o.state_province &&
+          country == o.country &&
+          country_code == o.country_code
+    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
+      [unit_number, building_number, building_name, street_name, street_type, city, suburb, state_province_code, postal_code, address1, address_type, state_province, country, country_code].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/appended_field.rb

@@ -0,0 +1,237 @@
+=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
+  # <p>Types of fields you will see here include</p>  <table class=\"help-page-table\">    <thead>      <tr>        <td>          <b>FieldName</b>        </td>        <td>          <b>Data</b>        </td>        <td>          <b>Comments</b>        </td>      </tr>    </thead>    <tbody>      <tr>        <td>WatchlistState</td>        <td>Clear</td>        <td>If the submitted individual did not match any watchlist checks, the appended field data will appear as clear</td>      </tr>      <tr>        <td>WatchlistState</td>        <td>Hit</td>        <td>If the submitted individual triggered a watchlist hit, the watchlistdata field also be included as below:</td>      </tr>      <tr>        <td>WatchlistData</td>        <td>Name|URL\\tName2|URL</td>        <td> Name of the source a pipe (|) the url of the source each source is separated with a tab (\\t )</td>      </tr>      <tr>        <td>CanadaSixMonthResidency</td>        <td>YES</td>        <td>The Canadian Credit Agency provides a flag to indicate that an individual has been at the specified              residence for at least six months.The canadasixmonthresidency field is returned with a value of either YES or NO.</td>      </tr>      <tr>        <td>IsDeceased</td>        <td>False</td>        <td>The IsDeceased field is returned by various datasources to indicate whether the input information was screened against an available death file.              Check with your Trulioo Technical Account Manager to see which datasources support this option.</td>      </tr>      <tr>        <td>IsDeceased</td>        <td>True</td>        <td></td>      </tr>      <tr>        <td>FraudFlag</td>        <td>True</td>        <td></td>      </tr>      <tr>        <td>FraudFlag</td>        <td>False</td>        <td></td>      </tr>    </tbody>  </table>  <p>If you are retrieving transaction with address corrected values you will also see address fields in appended data</p>
+  class AppendedField
+    attr_accessor :field_name
+
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'field_name' => :'FieldName',
+        :'data' => :'Data'
+      }
+    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
+      {
+        :'field_name' => :'String',
+        :'data' => :'Object'
+      }
+    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::AppendedField` 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::AppendedField`. 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?(:'field_name')
+        self.field_name = attributes[:'field_name']
+      end
+
+      if attributes.key?(:'data')
+        self.data = attributes[:'data']
+      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
+      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?
+      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 &&
+          field_name == o.field_name &&
+          data == o.data
+    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
+      [field_name, data].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