Class: CloudmersiveValidateApiClient::LeadEnrichmentResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb

Overview

Result of the lead enrichment process

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LeadEnrichmentResponse

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# 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

Instance Attribute Details

#company_city ⇒ Object

City of the address of the company for the lead



49
50
51
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 49

def company_city
  @company_city
end

#company_country ⇒ Object

Country Name of the address of the company for the lead



58
59
60
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 58

def company_country
  @company_country
end

#company_country_code ⇒ Object

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



61
62
63
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 61

def company_country_code
  @company_country_code
end

#company_domain_name ⇒ Object

Domain name / website for the lead



40
41
42
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 40

def company_domain_name
  @company_domain_name
end

#company_house_number ⇒ Object

House number of the address of the company for the lead



43
44
45
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 43

def company_house_number
  @company_house_number
end

#company_name ⇒ Object

Name of the company for the lead



37
38
39
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 37

def company_name
  @company_name
end

#company_postal_code ⇒ Object

Postal Code of the address of the company for the lead



55
56
57
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 55

def company_postal_code
  @company_postal_code
end

#company_state_or_province ⇒ Object

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



52
53
54
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 52

def company_state_or_province
  @company_state_or_province
end

#company_street ⇒ Object

Street name of the address of the company for the lead



46
47
48
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 46

def company_street
  @company_street
end

#company_telephone ⇒ Object

Telephone of the company office for the lead



64
65
66
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 64

def company_telephone
  @company_telephone
end

#company_vat_number ⇒ Object

VAT number of the company for the lead



67
68
69
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 67

def company_vat_number
  @company_vat_number
end

#contact_business_email ⇒ Object

The person’s business email address for the lead



25
26
27
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 25

def contact_business_email
  @contact_business_email
end

#contact_first_name ⇒ Object

The person’s first name for the lead



28
29
30
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 28

def contact_first_name
  @contact_first_name
end

#contact_gender ⇒ Object

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



34
35
36
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 34

def contact_gender
  @contact_gender
end

#contact_last_name ⇒ Object

The person’s last name for the lead



31
32
33
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 31

def contact_last_name
  @contact_last_name
end

#employee_count ⇒ Object

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



70
71
72
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 70

def employee_count
  @employee_count
end

#lead_type ⇒ Object

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)



22
23
24
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 22

def lead_type
  @lead_type
end

#successful ⇒ Object

True if the operation was successful, false otherwise



19
20
21
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 19

def successful
  @successful
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# 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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# 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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


241
242
243
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 241

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



247
248
249
 
# 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 ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



203
204
205
206
 
# 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 ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



321
322
323
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 321

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



327
328
329
330
331
332
333
334
335
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



315
316
317
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 315

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



210
211
212
 
# File 'lib/cloudmersive-validate-api-client/models/lead_enrichment_response.rb', line 210

def valid?
  true
end