Class: MergeATSClient::Candidate

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ats_client/models/candidate.rb

Overview

# The Candidate Object ### Description The ‘Candidate` object is used to represent profile information about a given Candidate. Because it is specific to a Candidate, this information stays constant across applications. ### Usage Example Fetch from the `LIST Candidates` endpoint and filter by `ID` to show all candidates.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Candidate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/merge_ats_client/models/candidate.rb', line 160

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'locations')
    if (value = attributes[:'locations']).is_a?(Array)
      self.locations = 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?(:'email_addresses')
    if (value = attributes[:'email_addresses']).is_a?(Array)
      self.email_addresses = value
    end
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#applications ⇒ Object

Array of ‘Application` object IDs.



64
65
66
 
# File 'lib/merge_ats_client/models/candidate.rb', line 64

def applications
  @applications
end

#attachments ⇒ Object

Array of ‘Attachment` object IDs.



67
68
69
 
# File 'lib/merge_ats_client/models/candidate.rb', line 67

def attachments
  @attachments
end

#can_email ⇒ Object

Whether or not the candidate can be emailed.



49
50
51
 
# File 'lib/merge_ats_client/models/candidate.rb', line 49

def can_email
  @can_email
end

#company ⇒ Object

The candidate’s current company.



31
32
33
 
# File 'lib/merge_ats_client/models/candidate.rb', line 31

def company
  @company
end

#email_addresses ⇒ Object

Returns the value of attribute email_addresses.



56
57
58
 
# File 'lib/merge_ats_client/models/candidate.rb', line 56

def email_addresses
  @email_addresses
end

#field_mappings ⇒ Object

Returns the value of attribute field_mappings.



74
75
76
 
# File 'lib/merge_ats_client/models/candidate.rb', line 74

def field_mappings
  @field_mappings
end

#first_name ⇒ Object

The candidate’s first name.



25
26
27
 
# File 'lib/merge_ats_client/models/candidate.rb', line 25

def first_name
  @first_name
end

#id ⇒ Object

Returns the value of attribute id.



19
20
21
 
# File 'lib/merge_ats_client/models/candidate.rb', line 19

def id
  @id
end

#is_private ⇒ Object

Whether or not the candidate is private.



46
47
48
 
# File 'lib/merge_ats_client/models/candidate.rb', line 46

def is_private
  @is_private
end

#last_interaction_at ⇒ Object

When the most recent interaction with the candidate occurred.



43
44
45
 
# File 'lib/merge_ats_client/models/candidate.rb', line 43

def last_interaction_at
  @last_interaction_at
end

#last_name ⇒ Object

The candidate’s last name.



28
29
30
 
# File 'lib/merge_ats_client/models/candidate.rb', line 28

def last_name
  @last_name
end

#locations ⇒ Object

The candidate’s locations.



52
53
54
 
# File 'lib/merge_ats_client/models/candidate.rb', line 52

def locations
  @locations
end

#modified_at ⇒ Object

This is the datetime that this object was last updated by Merge



72
73
74
 
# File 'lib/merge_ats_client/models/candidate.rb', line 72

def modified_at
  @modified_at
end

#phone_numbers ⇒ Object

Returns the value of attribute phone_numbers.



54
55
56
 
# File 'lib/merge_ats_client/models/candidate.rb', line 54

def phone_numbers
  @phone_numbers
end

#remote_created_at ⇒ Object

When the third party’s candidate was created.



37
38
39
 
# File 'lib/merge_ats_client/models/candidate.rb', line 37

def remote_created_at
  @remote_created_at
end

#remote_data ⇒ Object

Returns the value of attribute remote_data.



76
77
78
 
# File 'lib/merge_ats_client/models/candidate.rb', line 76

def remote_data
  @remote_data
end

#remote_id ⇒ Object

The third-party API ID of the matching object.



22
23
24
 
# File 'lib/merge_ats_client/models/candidate.rb', line 22

def remote_id
  @remote_id
end

#remote_updated_at ⇒ Object

When the third party’s candidate was updated.



40
41
42
 
# File 'lib/merge_ats_client/models/candidate.rb', line 40

def remote_updated_at
  @remote_updated_at
end

#remote_was_deleted ⇒ Object

Returns the value of attribute remote_was_deleted.



69
70
71
 
# File 'lib/merge_ats_client/models/candidate.rb', line 69

def remote_was_deleted
  @remote_was_deleted
end

#tags ⇒ Object

Array of ‘Tag` names as strings.



61
62
63
 
# File 'lib/merge_ats_client/models/candidate.rb', line 61

def tags
  @tags
end

#title ⇒ Object

The candidate’s current title.



34
35
36
 
# File 'lib/merge_ats_client/models/candidate.rb', line 34

def title
  @title
end

#urls ⇒ Object

Returns the value of attribute urls.



58
59
60
 
# File 'lib/merge_ats_client/models/candidate.rb', line 58

def urls
  @urls
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



107
108
109
 
# File 'lib/merge_ats_client/models/candidate.rb', line 107

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/merge_ats_client/models/candidate.rb', line 79

def self.attribute_map
  {
    :'id' => :'id',
    :'remote_id' => :'remote_id',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'company' => :'company',
    :'title' => :'title',
    :'remote_created_at' => :'remote_created_at',
    :'remote_updated_at' => :'remote_updated_at',
    :'last_interaction_at' => :'last_interaction_at',
    :'is_private' => :'is_private',
    :'can_email' => :'can_email',
    :'locations' => :'locations',
    :'phone_numbers' => :'phone_numbers',
    :'email_addresses' => :'email_addresses',
    :'urls' => :'urls',
    :'tags' => :'tags',
    :'applications' => :'applications',
    :'attachments' => :'attachments',
    :'remote_was_deleted' => :'remote_was_deleted',
    :'modified_at' => :'modified_at',
    :'field_mappings' => :'field_mappings',
    :'remote_data' => :'remote_data'
  }
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



337
338
339
 
# File 'lib/merge_ats_client/models/candidate.rb', line 337

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/merge_ats_client/models/candidate.rb', line 140

def self.openapi_nullable
  Set.new([
    :'remote_id',
    :'first_name',
    :'last_name',
    :'company',
    :'title',
    :'remote_created_at',
    :'remote_updated_at',
    :'last_interaction_at',
    :'is_private',
    :'can_email',
    :'locations',
    :'field_mappings',
    :'remote_data'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/merge_ats_client/models/candidate.rb', line 112

def self.openapi_types
  {
    :'id' => :'String',
    :'remote_id' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'company' => :'String',
    :'title' => :'String',
    :'remote_created_at' => :'Time',
    :'remote_updated_at' => :'Time',
    :'last_interaction_at' => :'Time',
    :'is_private' => :'Boolean',
    :'can_email' => :'Boolean',
    :'locations' => :'Array<String>',
    :'phone_numbers' => :'Array<PhoneNumber>',
    :'email_addresses' => :'Array<EmailAddress>',
    :'urls' => :'Array<Url>',
    :'tags' => :'Array<String>',
    :'applications' => :'Array<String>',
    :'attachments' => :'Array<String>',
    :'remote_was_deleted' => :'Boolean',
    :'modified_at' => :'Time',
    :'field_mappings' => :'Hash<String, Object>',
    :'remote_data' => :'Array<RemoteData>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/merge_ats_client/models/candidate.rb', line 295

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      remote_id == o.remote_id &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      company == o.company &&
      title == o.title &&
      remote_created_at == o.remote_created_at &&
      remote_updated_at == o.remote_updated_at &&
      last_interaction_at == o.last_interaction_at &&
      is_private == o.is_private &&
      can_email == o.can_email &&
      locations == o.locations &&
      phone_numbers == o.phone_numbers &&
      email_addresses == o.email_addresses &&
      urls == o.urls &&
      tags == o.tags &&
      applications == o.applications &&
      attachments == o.attachments &&
      remote_was_deleted == o.remote_was_deleted &&
      modified_at == o.modified_at &&
      field_mappings == o.field_mappings &&
      remote_data == o.remote_data
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



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/merge_ats_client/models/candidate.rb', line 367

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 = MergeATSClient.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



438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/merge_ats_client/models/candidate.rb', line 438

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



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/merge_ats_client/models/candidate.rb', line 344

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


324
325
326
 
# File 'lib/merge_ats_client/models/candidate.rb', line 324

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



330
331
332
 
# File 'lib/merge_ats_client/models/candidate.rb', line 330

def hash
  [id, remote_id, first_name, last_name, company, title, remote_created_at, remote_updated_at, last_interaction_at, is_private, can_email, locations, phone_numbers, email_addresses, urls, tags, applications, attachments, remote_was_deleted, modified_at, field_mappings, remote_data].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



282
283
284
285
 
# File 'lib/merge_ats_client/models/candidate.rb', line 282

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



414
415
416
 
# File 'lib/merge_ats_client/models/candidate.rb', line 414

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



420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/merge_ats_client/models/candidate.rb', line 420

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



408
409
410
 
# File 'lib/merge_ats_client/models/candidate.rb', line 408

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



289
290
291
 
# File 'lib/merge_ats_client/models/candidate.rb', line 289

def valid?
  true
end