Class: MergeATSClient::CandidateRequest

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

Overview

# The Candidate Object ### Description The ‘Candidate` object is used to represent a Candidate for various positions. ### 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 = {}) ⇒ CandidateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 158

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

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

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

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

Instance Attribute Details

#applications ⇒ Object

Array of ‘Application` object IDs.



62
63
64
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 62

def applications
  @applications
end

#attachments ⇒ Object

Array of ‘Attachment` object IDs.



65
66
67
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 65

def attachments
  @attachments
end

#can_email ⇒ Object

Whether or not the candidate can be emailed.



47
48
49
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 47

def can_email
  @can_email
end

#company ⇒ Object

The candidate’s current company.



29
30
31
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 29

def company
  @company
end

#custom_fields ⇒ Object

Custom fields configured for a given model.



68
69
70
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 68

def custom_fields
  @custom_fields
end

#email_addresses ⇒ Object

Returns the value of attribute email_addresses.



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

def email_addresses
  @email_addresses
end

#first_name ⇒ Object

The candidate’s first name.



23
24
25
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 23

def first_name
  @first_name
end

#integration_params ⇒ Object

Returns the value of attribute integration_params.



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

def integration_params
  @integration_params
end

#is_private ⇒ Object

Whether or not the candidate is private.



44
45
46
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 44

def is_private
  @is_private
end

#last_interaction_at ⇒ Object

When the most recent candidate interaction occurred.



41
42
43
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 41

def last_interaction_at
  @last_interaction_at
end

#last_name ⇒ Object

The candidate’s last name.



26
27
28
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 26

def last_name
  @last_name
end

#linked_account_params ⇒ Object

Returns the value of attribute linked_account_params.



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

def 
  @linked_account_params
end

#locations ⇒ Object

The candidate’s locations.



50
51
52
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 50

def locations
  @locations
end

#phone_numbers ⇒ Object

Returns the value of attribute phone_numbers.



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

def phone_numbers
  @phone_numbers
end

#remote_created_at ⇒ Object

When the third party’s candidate was created.



35
36
37
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 35

def remote_created_at
  @remote_created_at
end

#remote_id ⇒ Object

The third-party API ID of the matching object.



20
21
22
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 20

def remote_id
  @remote_id
end

#remote_template_id ⇒ Object

Returns the value of attribute remote_template_id.



70
71
72
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 70

def remote_template_id
  @remote_template_id
end

#remote_updated_at ⇒ Object

When the third party’s candidate was updated.



38
39
40
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 38

def remote_updated_at
  @remote_updated_at
end

#tags ⇒ Object

Array of ‘Tag` names as strings.



59
60
61
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 59

def tags
  @tags
end

#title ⇒ Object

The candidate’s current title.



32
33
34
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 32

def title
  @title
end

#urls ⇒ Object

Returns the value of attribute urls.



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

def urls
  @urls
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



104
105
106
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 104

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'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',
    :'custom_fields' => :'custom_fields',
    :'remote_template_id' => :'remote_template_id',
    :'integration_params' => :'integration_params',
    :'linked_account_params' => :'linked_account_params'
  }
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



347
348
349
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 347

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 136

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',
    :'custom_fields',
    :'remote_template_id',
    :'integration_params',
    :'linked_account_params'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 109

def self.openapi_types
  {
    :'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<PhoneNumberRequest>',
    :'email_addresses' => :'Array<EmailAddressRequest>',
    :'urls' => :'Array<UrlRequest>',
    :'tags' => :'Array<String>',
    :'applications' => :'Array<String>',
    :'attachments' => :'Array<String>',
    :'custom_fields' => :'Hash<String, AnyType>',
    :'remote_template_id' => :'String',
    :'integration_params' => :'Hash<String, AnyType>',
    :'linked_account_params' => :'Hash<String, AnyType>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 306

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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 &&
      custom_fields == o.custom_fields &&
      remote_template_id == o.remote_template_id &&
      integration_params == o.integration_params &&
       == o.
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



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
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 377

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



448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 448

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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 354

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


334
335
336
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 334

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



340
341
342
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 340

def hash
  [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, custom_fields, remote_template_id, integration_params, ].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



278
279
280
281
282
283
284
285
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 278

def list_invalid_properties
  invalid_properties = Array.new
  if !@remote_template_id.nil? && @remote_template_id.to_s.length < 1
    invalid_properties.push('invalid value for "remote_template_id", the character length must be great than or equal to 1.')
  end

  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



424
425
426
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 424

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



430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 430

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



418
419
420
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 418

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
292
 
# File 'lib/merge_ats_client/models/candidate_request.rb', line 289

def valid?
  return false if !@remote_template_id.nil? && @remote_template_id.to_s.length < 1
  true
end