Class: MergeCRMClient::Lead

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_crm_client/models/lead.rb

Overview

# The Lead Object ### Description The ‘Lead` object is used to represent a lead in the remote system. ### Usage Example TODO

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Lead

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/merge_crm_client/models/lead.rb', line 138

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MergeCRMClient::Lead` 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 `MergeCRMClient::Lead`. 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?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'remote_id')
    self.remote_id = attributes[:'remote_id']
  end

  if attributes.key?(:'owner')
    self.owner = attributes[:'owner']
  end

  if attributes.key?(:'lead_source')
    self.lead_source = attributes[:'lead_source']
  end

  if attributes.key?(:'title')
    self.title = attributes[:'title']
  end

  if attributes.key?(:'company')
    self.company = attributes[:'company']
  end

  if attributes.key?(:'first_name')
    self.first_name = attributes[:'first_name']
  end

  if attributes.key?(:'last_name')
    self.last_name = attributes[:'last_name']
  end

  if attributes.key?(:'addresses')
    if (value = attributes[:'addresses']).is_a?(Array)
      self.addresses = value
    end
  end

  if attributes.key?(:'email_addresses')
    if (value = attributes[:'email_addresses']).is_a?(Array)
      self.email_addresses = value
    end
  end

  if attributes.key?(:'phone_numbers')
    if (value = attributes[:'phone_numbers']).is_a?(Array)
      self.phone_numbers = value
    end
  end

  if attributes.key?(:'remote_updated_at')
    self.remote_updated_at = attributes[:'remote_updated_at']
  end

  if attributes.key?(:'remote_created_at')
    self.remote_created_at = attributes[:'remote_created_at']
  end

  if attributes.key?(:'converted_date')
    self.converted_date = attributes[:'converted_date']
  end

  if attributes.key?(:'converted_contact')
    self.converted_contact = attributes[:'converted_contact']
  end

  if attributes.key?(:'converted_account')
    self. = attributes[:'converted_account']
  end

  if attributes.key?(:'remote_data')
    if (value = attributes[:'remote_data']).is_a?(Array)
      self.remote_data = value
    end
  end

  if attributes.key?(:'remote_was_deleted')
    self.remote_was_deleted = attributes[:'remote_was_deleted']
  end
end

Instance Attribute Details

#addresses ⇒ Object

Returns the value of attribute addresses.



41
42
43
 
# File 'lib/merge_crm_client/models/lead.rb', line 41

def addresses
  @addresses
end

#company ⇒ Object

The lead’s company.



33
34
35
 
# File 'lib/merge_crm_client/models/lead.rb', line 33

def company
  @company
end

#converted_account ⇒ Object

Returns the value of attribute converted_account.



58
59
60
 
# File 'lib/merge_crm_client/models/lead.rb', line 58

def 
  @converted_account
end

#converted_contact ⇒ Object

Returns the value of attribute converted_contact.



56
57
58
 
# File 'lib/merge_crm_client/models/lead.rb', line 56

def converted_contact
  @converted_contact
end

#converted_date ⇒ Object

When the lead was converted.



54
55
56
 
# File 'lib/merge_crm_client/models/lead.rb', line 54

def converted_date
  @converted_date
end

#email_addresses ⇒ Object

Returns the value of attribute email_addresses.



43
44
45
 
# File 'lib/merge_crm_client/models/lead.rb', line 43

def email_addresses
  @email_addresses
end

#first_name ⇒ Object

The lead’s first name.



36
37
38
 
# File 'lib/merge_crm_client/models/lead.rb', line 36

def first_name
  @first_name
end

#id ⇒ Object

Returns the value of attribute id.



19
20
21
 
# File 'lib/merge_crm_client/models/lead.rb', line 19

def id
  @id
end

#last_name ⇒ Object

The lead’s last name.



39
40
41
 
# File 'lib/merge_crm_client/models/lead.rb', line 39

def last_name
  @last_name
end

#lead_source ⇒ Object

The lead’s source.



27
28
29
 
# File 'lib/merge_crm_client/models/lead.rb', line 27

def lead_source
  @lead_source
end

#owner ⇒ Object

Returns the value of attribute owner.



24
25
26
 
# File 'lib/merge_crm_client/models/lead.rb', line 24

def owner
  @owner
end

#phone_numbers ⇒ Object

Returns the value of attribute phone_numbers.



45
46
47
 
# File 'lib/merge_crm_client/models/lead.rb', line 45

def phone_numbers
  @phone_numbers
end

#remote_created_at ⇒ Object

When the third party’s lead was created.



51
52
53
 
# File 'lib/merge_crm_client/models/lead.rb', line 51

def remote_created_at
  @remote_created_at
end

#remote_data ⇒ Object

Returns the value of attribute remote_data.



60
61
62
 
# File 'lib/merge_crm_client/models/lead.rb', line 60

def remote_data
  @remote_data
end

#remote_id ⇒ Object

The third-party API ID of the matching object.



22
23
24
 
# File 'lib/merge_crm_client/models/lead.rb', line 22

def remote_id
  @remote_id
end

#remote_updated_at ⇒ Object

When the third party’s lead was updated.



48
49
50
 
# File 'lib/merge_crm_client/models/lead.rb', line 48

def remote_updated_at
  @remote_updated_at
end

#remote_was_deleted ⇒ Object

Returns the value of attribute remote_was_deleted.



62
63
64
 
# File 'lib/merge_crm_client/models/lead.rb', line 62

def remote_was_deleted
  @remote_was_deleted
end

#title ⇒ Object

The lead’s title.



30
31
32
 
# File 'lib/merge_crm_client/models/lead.rb', line 30

def title
  @title
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/merge_crm_client/models/lead.rb', line 89

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/merge_crm_client/models/lead.rb', line 65

def self.attribute_map
  {
    :'id' => :'id',
    :'remote_id' => :'remote_id',
    :'owner' => :'owner',
    :'lead_source' => :'lead_source',
    :'title' => :'title',
    :'company' => :'company',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'addresses' => :'addresses',
    :'email_addresses' => :'email_addresses',
    :'phone_numbers' => :'phone_numbers',
    :'remote_updated_at' => :'remote_updated_at',
    :'remote_created_at' => :'remote_created_at',
    :'converted_date' => :'converted_date',
    :'converted_contact' => :'converted_contact',
    :'converted_account' => :'converted_account',
    :'remote_data' => :'remote_data',
    :'remote_was_deleted' => :'remote_was_deleted'
  }
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



285
286
287
 
# File 'lib/merge_crm_client/models/lead.rb', line 285

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/merge_crm_client/models/lead.rb', line 118

def self.openapi_nullable
  Set.new([
    :'remote_id',
    :'owner',
    :'lead_source',
    :'title',
    :'company',
    :'first_name',
    :'last_name',
    :'remote_updated_at',
    :'remote_created_at',
    :'converted_date',
    :'converted_contact',
    :'converted_account',
    :'remote_data',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/merge_crm_client/models/lead.rb', line 94

def self.openapi_types
  {
    :'id' => :'String',
    :'remote_id' => :'String',
    :'owner' => :'String',
    :'lead_source' => :'String',
    :'title' => :'String',
    :'company' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'addresses' => :'Array<Address>',
    :'email_addresses' => :'Array<EmailAddress>',
    :'phone_numbers' => :'Array<PhoneNumber>',
    :'remote_updated_at' => :'Time',
    :'remote_created_at' => :'Time',
    :'converted_date' => :'Time',
    :'converted_contact' => :'String',
    :'converted_account' => :'String',
    :'remote_data' => :'Array<RemoteData>',
    :'remote_was_deleted' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/merge_crm_client/models/lead.rb', line 247

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      remote_id == o.remote_id &&
      owner == o.owner &&
      lead_source == o.lead_source &&
      title == o.title &&
      company == o.company &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      addresses == o.addresses &&
      email_addresses == o.email_addresses &&
      phone_numbers == o.phone_numbers &&
      remote_updated_at == o.remote_updated_at &&
      remote_created_at == o.remote_created_at &&
      converted_date == o.converted_date &&
      converted_contact == o.converted_contact &&
       == o. &&
      remote_data == o.remote_data &&
      remote_was_deleted == o.remote_was_deleted
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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/merge_crm_client/models/lead.rb', line 315

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value
  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 = MergeCRMClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/merge_crm_client/models/lead.rb', line 386

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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/merge_crm_client/models/lead.rb', line 292

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


272
273
274
 
# File 'lib/merge_crm_client/models/lead.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



278
279
280
 
# File 'lib/merge_crm_client/models/lead.rb', line 278

def hash
  [id, remote_id, owner, lead_source, title, company, first_name, last_name, addresses, email_addresses, phone_numbers, remote_updated_at, remote_created_at, converted_date, converted_contact, , remote_data, remote_was_deleted].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



234
235
236
237
 
# File 'lib/merge_crm_client/models/lead.rb', line 234

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



362
363
364
 
# File 'lib/merge_crm_client/models/lead.rb', line 362

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



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/merge_crm_client/models/lead.rb', line 368

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



356
357
358
 
# File 'lib/merge_crm_client/models/lead.rb', line 356

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



241
242
243
 
# File 'lib/merge_crm_client/models/lead.rb', line 241

def valid?
  true
end