checkify 0.1.0

data/lib/checkify/models/suburb_details.rb

@@ -0,0 +1,207 @@
+=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 SuburbDetails < ApiModelBase
+    attr_accessor :city
+
+    # 4-digit postcode (null for NZ)
+    attr_accessor :postcode
+
+    # State abbreviation — AU only
+    attr_accessor :state
+
+    # Full state name — AU only
+    attr_accessor :state_full
+
+    # Region/city — NZ only
+    attr_accessor :region
+
+    attr_accessor :country
+
+    attr_accessor :country_full
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'city' => :'city',
+        :'postcode' => :'postcode',
+        :'state' => :'state',
+        :'state_full' => :'stateFull',
+        :'region' => :'region',
+        :'country' => :'country',
+        :'country_full' => :'countryFull'
+      }
+    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
+      {
+        :'city' => :'String',
+        :'postcode' => :'String',
+        :'state' => :'String',
+        :'state_full' => :'String',
+        :'region' => :'String',
+        :'country' => :'String',
+        :'country_full' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'postcode',
+        :'state',
+        :'state_full',
+        :'region',
+      ])
+    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::SuburbDetails` 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::SuburbDetails`. 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?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'postcode')
+        self.postcode = attributes[:'postcode']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'state_full')
+        self.state_full = attributes[:'state_full']
+      end
+
+      if attributes.key?(:'region')
+        self.region = attributes[:'region']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'country_full')
+        self.country_full = attributes[:'country_full']
+      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 &&
+          city == o.city &&
+          postcode == o.postcode &&
+          state == o.state &&
+          state_full == o.state_full &&
+          region == o.region &&
+          country == o.country &&
+          country_full == o.country_full
+    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
+      [city, postcode, state, state_full, region, country, country_full].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/tfn_response.rb

@@ -0,0 +1,174 @@
+=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 TfnResponse < ApiModelBase
+    # Normalised digits only
+    attr_accessor :tfn
+
+    # Grouped with spaces
+    attr_accessor :tfn_formatted
+
+    attr_accessor :valid
+
+    attr_accessor :notice
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'tfn' => :'tfn',
+        :'tfn_formatted' => :'tfnFormatted',
+        :'valid' => :'valid',
+        :'notice' => :'notice'
+      }
+    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
+      {
+        :'tfn' => :'String',
+        :'tfn_formatted' => :'String',
+        :'valid' => :'Boolean',
+        :'notice' => :'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 `Checkify::TfnResponse` 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::TfnResponse`. 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?(:'tfn')
+        self.tfn = attributes[:'tfn']
+      end
+
+      if attributes.key?(:'tfn_formatted')
+        self.tfn_formatted = attributes[:'tfn_formatted']
+      end
+
+      if attributes.key?(:'valid')
+        self.valid = attributes[:'valid']
+      end
+
+      if attributes.key?(:'notice')
+        self.notice = attributes[:'notice']
+      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 &&
+          tfn == o.tfn &&
+          tfn_formatted == o.tfn_formatted &&
+          valid == o.valid &&
+          notice == o.notice
+    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
+      [tfn, tfn_formatted, valid, notice].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/version.rb

@@ -0,0 +1,15 @@
+=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
+
+module Checkify
+  VERSION = '0.1.0'
+end

data/lib/checkify.rb

@@ -0,0 +1,78 @@
+=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
+
+# Common files
+require 'checkify/api_client'
+require 'checkify/api_error'
+require 'checkify/api_model_base'
+require 'checkify/version'
+require 'checkify/configuration'
+require 'checkify/client'
+
+# Models
+require 'checkify/models/abn_address'
+require 'checkify/models/abn_response'
+require 'checkify/models/abn_response_abn_details'
+require 'checkify/models/account'
+require 'checkify/models/acn_address'
+require 'checkify/models/acn_response'
+require 'checkify/models/acn_response_abn_details'
+require 'checkify/models/acn_response_acn_details'
+require 'checkify/models/address_details'
+require 'checkify/models/asic_document'
+require 'checkify/models/asic_document_contents_inner'
+require 'checkify/models/bulk_create_request'
+require 'checkify/models/bulk_create_request_items'
+require 'checkify/models/bulk_job'
+require 'checkify/models/business_activity'
+require 'checkify/models/business_activity_response'
+require 'checkify/models/director_id_response'
+require 'checkify/models/email_response'
+require 'checkify/models/email_response_dns'
+require 'checkify/models/email_response_format'
+require 'checkify/models/error'
+require 'checkify/models/former_name'
+require 'checkify/models/name_availability'
+require 'checkify/models/phone_response'
+require 'checkify/models/postcode_result'
+require 'checkify/models/reverse_result'
+require 'checkify/models/sanctions_response'
+require 'checkify/models/sanctions_result'
+require 'checkify/models/sanctions_result_sanctions'
+require 'checkify/models/suburb_details'
+require 'checkify/models/tfn_response'
+
+# APIs
+require 'checkify/api/account_api'
+require 'checkify/api/address_api'
+require 'checkify/api/batch_api'
+require 'checkify/api/business_api'
+require 'checkify/api/communication_api'
+require 'checkify/api/identity_api'
+
+module Checkify
+  class << self
+    # Customize default settings for the SDK using block.
+    #   Checkify.configure do |config|
+    #     config.access_token = ENV.fetch("CHECKIFY_API_KEY")
+    #     config.timeout = 30
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end