class CloudmersiveValidateApiClient::LeadEnrichmentResponse

Result of the lead enrichment process

Attributes

company_city[RW]

City of the address of the company for the lead

company_country[RW]

Country Name of the address of the company for the lead

company_country_code[RW]

Country Code (2-letter ISO 3166-1) of the address of the company for the lead

company_domain_name[RW]

Domain name / website for the lead

company_house_number[RW]

House number of the address of the company for the lead

company_name[RW]

Name of the company for the lead

company_postal_code[RW]

Postal Code of the address of the company for the lead

company_state_or_province[RW]

State or Province of the address of the company for the lead

company_street[RW]

Street name of the address of the company for the lead

company_telephone[RW]

Telephone of the company office for the lead

company_vat_number[RW]

VAT number of the company for the lead

contact_business_email[RW]

The person's business email address for the lead

contact_first_name[RW]

The person's first name for the lead

contact_gender[RW]

Gender for contact name; possible values are Male, Female, and Neutral (can be applied to Male or Female). Requires ContactFirstName.

contact_last_name[RW]

The person's last name for the lead

employee_count[RW]

Count of employees at the company (estimated), if available

lead_type[RW]

The type of the lead; possible types are Junk (a single individual using a disposable/throwaway email address); Individual (a single individual, typically a consumer, not purchasing on behalf of a business); SmallBusiness (a small business, typically with fewer than 100 employees); MediumBusiness (a medium business, larger than 100 employees but fewer than 1000 employees); Enterprise (a large business with greater than 1000 employees); Business (a business customer of unknown size)

successful[RW]

True if the operation was successful, false otherwise

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb, line 73
def self.attribute_map
  {
    :'successful' => :'Successful',
    :'lead_type' => :'LeadType',
    :'contact_business_email' => :'ContactBusinessEmail',
    :'contact_first_name' => :'ContactFirstName',
    :'contact_last_name' => :'ContactLastName',
    :'contact_gender' => :'ContactGender',
    :'company_name' => :'CompanyName',
    :'company_domain_name' => :'CompanyDomainName',
    :'company_house_number' => :'CompanyHouseNumber',
    :'company_street' => :'CompanyStreet',
    :'company_city' => :'CompanyCity',
    :'company_state_or_province' => :'CompanyStateOrProvince',
    :'company_postal_code' => :'CompanyPostalCode',
    :'company_country' => :'CompanyCountry',
    :'company_country_code' => :'CompanyCountryCode',
    :'company_telephone' => :'CompanyTelephone',
    :'company_vat_number' => :'CompanyVATNumber',
    :'employee_count' => :'EmployeeCount'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb, line 122
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'Successful')
    self.successful = attributes[:'Successful']
  end

  if attributes.has_key?(:'LeadType')
    self.lead_type = attributes[:'LeadType']
  end

  if attributes.has_key?(:'ContactBusinessEmail')
    self.contact_business_email = attributes[:'ContactBusinessEmail']
  end

  if attributes.has_key?(:'ContactFirstName')
    self.contact_first_name = attributes[:'ContactFirstName']
  end

  if attributes.has_key?(:'ContactLastName')
    self.contact_last_name = attributes[:'ContactLastName']
  end

  if attributes.has_key?(:'ContactGender')
    self.contact_gender = attributes[:'ContactGender']
  end

  if attributes.has_key?(:'CompanyName')
    self.company_name = attributes[:'CompanyName']
  end

  if attributes.has_key?(:'CompanyDomainName')
    self.company_domain_name = attributes[:'CompanyDomainName']
  end

  if attributes.has_key?(:'CompanyHouseNumber')
    self.company_house_number = attributes[:'CompanyHouseNumber']
  end

  if attributes.has_key?(:'CompanyStreet')
    self.company_street = attributes[:'CompanyStreet']
  end

  if attributes.has_key?(:'CompanyCity')
    self.company_city = attributes[:'CompanyCity']
  end

  if attributes.has_key?(:'CompanyStateOrProvince')
    self.company_state_or_province = attributes[:'CompanyStateOrProvince']
  end

  if attributes.has_key?(:'CompanyPostalCode')
    self.company_postal_code = attributes[:'CompanyPostalCode']
  end

  if attributes.has_key?(:'CompanyCountry')
    self.company_country = attributes[:'CompanyCountry']
  end

  if attributes.has_key?(:'CompanyCountryCode')
    self.company_country_code = attributes[:'CompanyCountryCode']
  end

  if attributes.has_key?(:'CompanyTelephone')
    self.company_telephone = attributes[:'CompanyTelephone']
  end

  if attributes.has_key?(:'CompanyVATNumber')
    self.company_vat_number = attributes[:'CompanyVATNumber']
  end

  if attributes.has_key?(:'EmployeeCount')
    self.employee_count = attributes[:'EmployeeCount']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb, line 97
def self.swagger_types
  {
    :'successful' => :'BOOLEAN',
    :'lead_type' => :'String',
    :'contact_business_email' => :'String',
    :'contact_first_name' => :'String',
    :'contact_last_name' => :'String',
    :'contact_gender' => :'String',
    :'company_name' => :'String',
    :'company_domain_name' => :'String',
    :'company_house_number' => :'String',
    :'company_street' => :'String',
    :'company_city' => :'String',
    :'company_state_or_province' => :'String',
    :'company_postal_code' => :'String',
    :'company_country' => :'String',
    :'company_country_code' => :'String',
    :'company_telephone' => :'String',
    :'company_vat_number' => :'String',
    :'employee_count' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb, line 216
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      successful == o.successful &&
      lead_type == o.lead_type &&
      contact_business_email == o.contact_business_email &&
      contact_first_name == o.contact_first_name &&
      contact_last_name == o.contact_last_name &&
      contact_gender == o.contact_gender &&
      company_name == o.company_name &&
      company_domain_name == o.company_domain_name &&
      company_house_number == o.company_house_number &&
      company_street == o.company_street &&
      company_city == o.company_city &&
      company_state_or_province == o.company_state_or_province &&
      company_postal_code == o.company_postal_code &&
      company_country == o.company_country &&
      company_country_code == o.company_country_code &&
      company_telephone == o.company_telephone &&
      company_vat_number == o.company_vat_number &&
      employee_count == o.employee_count
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb, line 275
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = CloudmersiveValidateApiClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

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

# File lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb, line 341
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
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb, line 254
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb, line 241
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb, line 247
def hash
  [successful, lead_type, contact_business_email, contact_first_name, contact_last_name, contact_gender, company_name, company_domain_name, company_house_number, company_street, company_city, company_state_or_province, company_postal_code, company_country, company_country_code, company_telephone, company_vat_number, employee_count].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb, line 203
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb, line 321
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb, line 327
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb, line 315
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb, line 210
def valid?
  true
end