checkify 0.1.0

data/lib/checkify/models/sanctions_result.rb

@@ -0,0 +1,339 @@
+=begin
+#Checkify API
+
+#Australian and New Zealand address validation, business lookups, identity checks, and communication validation through a single REST interface.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Checkify
+  class SanctionsResult < ApiModelBase
+    # Source sanctions list
+    attr_accessor :source
+
+    # Source-specific reference number
+    attr_accessor :reference
+
+    # Primary name of the sanctioned individual or entity
+    attr_accessor :name
+
+    attr_accessor :type
+
+    attr_accessor :aliases
+
+    # Confidence score — higher when birth details match
+    attr_accessor :confidence
+
+    attr_accessor :sanctions
+
+    attr_accessor :date_of_birth
+
+    attr_accessor :place_of_birth
+
+    attr_accessor :citizenship
+
+    attr_accessor :committees
+
+    attr_accessor :listing_information
+
+    # Date of last source list update
+    attr_accessor :source_updated_at
+
+    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
+      {
+        :'source' => :'source',
+        :'reference' => :'reference',
+        :'name' => :'name',
+        :'type' => :'type',
+        :'aliases' => :'aliases',
+        :'confidence' => :'confidence',
+        :'sanctions' => :'sanctions',
+        :'date_of_birth' => :'date_of_birth',
+        :'place_of_birth' => :'place_of_birth',
+        :'citizenship' => :'citizenship',
+        :'committees' => :'committees',
+        :'listing_information' => :'listing_information',
+        :'source_updated_at' => :'source_updated_at'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'source' => :'String',
+        :'reference' => :'String',
+        :'name' => :'String',
+        :'type' => :'String',
+        :'aliases' => :'Array<String>',
+        :'confidence' => :'Float',
+        :'sanctions' => :'SanctionsResultSanctions',
+        :'date_of_birth' => :'String',
+        :'place_of_birth' => :'String',
+        :'citizenship' => :'String',
+        :'committees' => :'String',
+        :'listing_information' => :'String',
+        :'source_updated_at' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'date_of_birth',
+        :'place_of_birth',
+        :'citizenship',
+        :'committees',
+        :'listing_information',
+      ])
+    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 `Checkify::SanctionsResult` 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 `Checkify::SanctionsResult`. 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?(:'source')
+        self.source = attributes[:'source']
+      end
+
+      if attributes.key?(:'reference')
+        self.reference = attributes[:'reference']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'aliases')
+        if (value = attributes[:'aliases']).is_a?(Array)
+          self.aliases = value
+        end
+      end
+
+      if attributes.key?(:'confidence')
+        self.confidence = attributes[:'confidence']
+      end
+
+      if attributes.key?(:'sanctions')
+        self.sanctions = attributes[:'sanctions']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'place_of_birth')
+        self.place_of_birth = attributes[:'place_of_birth']
+      end
+
+      if attributes.key?(:'citizenship')
+        self.citizenship = attributes[:'citizenship']
+      end
+
+      if attributes.key?(:'committees')
+        self.committees = attributes[:'committees']
+      end
+
+      if attributes.key?(:'listing_information')
+        self.listing_information = attributes[:'listing_information']
+      end
+
+      if attributes.key?(:'source_updated_at')
+        self.source_updated_at = attributes[:'source_updated_at']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if !@confidence.nil? && @confidence > 1
+        invalid_properties.push('invalid value for "confidence", must be smaller than or equal to 1.')
+      end
+
+      if !@confidence.nil? && @confidence < 0
+        invalid_properties.push('invalid value for "confidence", must be greater 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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      source_validator = EnumAttributeValidator.new('String', ["dfat", "ofac", "eu", "uk", "un", "ca", "nz", "fr", "hk", "wb", "idb"])
+      return false unless source_validator.valid?(@source)
+      type_validator = EnumAttributeValidator.new('String', ["Individual", "Entity", "Vessel"])
+      return false unless type_validator.valid?(@type)
+      return false if !@confidence.nil? && @confidence > 1
+      return false if !@confidence.nil? && @confidence < 0
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] source Object to be assigned
+    def source=(source)
+      validator = EnumAttributeValidator.new('String', ["dfat", "ofac", "eu", "uk", "un", "ca", "nz", "fr", "hk", "wb", "idb"])
+      unless validator.valid?(source)
+        fail ArgumentError, "invalid value for \"source\", must be one of #{validator.allowable_values}."
+      end
+      @source = source
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["Individual", "Entity", "Vessel"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] confidence Value to be assigned
+    def confidence=(confidence)
+      if confidence.nil?
+        fail ArgumentError, 'confidence cannot be nil'
+      end
+
+      if confidence > 1
+        fail ArgumentError, 'invalid value for "confidence", must be smaller than or equal to 1.'
+      end
+
+      if confidence < 0
+        fail ArgumentError, 'invalid value for "confidence", must be greater than or equal to 0.'
+      end
+
+      @confidence = confidence
+    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 &&
+          source == o.source &&
+          reference == o.reference &&
+          name == o.name &&
+          type == o.type &&
+          aliases == o.aliases &&
+          confidence == o.confidence &&
+          sanctions == o.sanctions &&
+          date_of_birth == o.date_of_birth &&
+          place_of_birth == o.place_of_birth &&
+          citizenship == o.citizenship &&
+          committees == o.committees &&
+          listing_information == o.listing_information &&
+          source_updated_at == o.source_updated_at
+    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
+      [source, reference, name, type, aliases, confidence, sanctions, date_of_birth, place_of_birth, citizenship, committees, listing_information, source_updated_at].hash
+    end
+
+    # 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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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)
+        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
+  end
+end

data/lib/checkify/models/sanctions_result_sanctions.rb

@@ -0,0 +1,172 @@
+=begin
+#Checkify API
+
+#Australian and New Zealand address validation, business lookups, identity checks, and communication validation through a single REST interface.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Checkify
+  class SanctionsResultSanctions < ApiModelBase
+    attr_accessor :targeted_financial_sanction
+
+    attr_accessor :travel_ban
+
+    attr_accessor :arms_embargo
+
+    attr_accessor :maritime_restriction
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'targeted_financial_sanction' => :'targeted_financial_sanction',
+        :'travel_ban' => :'travel_ban',
+        :'arms_embargo' => :'arms_embargo',
+        :'maritime_restriction' => :'maritime_restriction'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'targeted_financial_sanction' => :'Boolean',
+        :'travel_ban' => :'Boolean',
+        :'arms_embargo' => :'Boolean',
+        :'maritime_restriction' => :'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 `Checkify::SanctionsResultSanctions` 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 `Checkify::SanctionsResultSanctions`. 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?(:'targeted_financial_sanction')
+        self.targeted_financial_sanction = attributes[:'targeted_financial_sanction']
+      end
+
+      if attributes.key?(:'travel_ban')
+        self.travel_ban = attributes[:'travel_ban']
+      end
+
+      if attributes.key?(:'arms_embargo')
+        self.arms_embargo = attributes[:'arms_embargo']
+      end
+
+      if attributes.key?(:'maritime_restriction')
+        self.maritime_restriction = attributes[:'maritime_restriction']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      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 &&
+          targeted_financial_sanction == o.targeted_financial_sanction &&
+          travel_ban == o.travel_ban &&
+          arms_embargo == o.arms_embargo &&
+          maritime_restriction == o.maritime_restriction
+    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
+      [targeted_financial_sanction, travel_ban, arms_embargo, maritime_restriction].hash
+    end
+
+    # 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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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)
+        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
+  end
+end