Class: MergeATSClient::Application

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

Overview

# The Application Object ### Description The Application Object is used to represent a candidate’s journey through a particular Job’s recruiting process. If a Candidate applies for multiple Jobs, there will be a separate Application for each Job if the third-party integration allows it. ### Usage Example Fetch from the ‘LIST Applications` endpoint and filter by `ID` to show all applications.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Application

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

  if attributes.key?(:'reject_reason')
    self.reject_reason = attributes[:'reject_reason']
  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

#applied_atObject

When the application was submitted.



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

def applied_at
  @applied_at
end

#candidateObject

The candidate applying.



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

def candidate
  @candidate
end

#credited_toObject

The user credited for this application.



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

def credited_to
  @credited_to
end

#current_stageObject

The application’s current stage.



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

def current_stage
  @current_stage
end

#field_mappingsObject

Returns the value of attribute field_mappings.



53
54
55
# File 'lib/merge_ats_client/models/application.rb', line 53

def field_mappings
  @field_mappings
end

#idObject

Returns the value of attribute id.



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

def id
  @id
end

#jobObject

The job being applied for.



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

def job
  @job
end

#modified_atObject

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



51
52
53
# File 'lib/merge_ats_client/models/application.rb', line 51

def modified_at
  @modified_at
end

#reject_reasonObject

The application’s reason for rejection.



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

def reject_reason
  @reject_reason
end

#rejected_atObject

When the application was rejected.



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

def rejected_at
  @rejected_at
end

#remote_dataObject

Returns the value of attribute remote_data.



55
56
57
# File 'lib/merge_ats_client/models/application.rb', line 55

def remote_data
  @remote_data
end

#remote_idObject

The third-party API ID of the matching object.



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

def remote_id
  @remote_id
end

#remote_was_deletedObject

Returns the value of attribute remote_was_deleted.



48
49
50
# File 'lib/merge_ats_client/models/application.rb', line 48

def remote_was_deleted
  @remote_was_deleted
end

#sourceObject

The application’s source.



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

def source
  @source
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



78
79
80
# File 'lib/merge_ats_client/models/application.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/merge_ats_client/models/application.rb', line 58

def self.attribute_map
  {
    :'id' => :'id',
    :'remote_id' => :'remote_id',
    :'candidate' => :'candidate',
    :'job' => :'job',
    :'applied_at' => :'applied_at',
    :'rejected_at' => :'rejected_at',
    :'source' => :'source',
    :'credited_to' => :'credited_to',
    :'current_stage' => :'current_stage',
    :'reject_reason' => :'reject_reason',
    :'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



244
245
246
# File 'lib/merge_ats_client/models/application.rb', line 244

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

.openapi_nullableObject

List of attributes with nullable: true



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/merge_ats_client/models/application.rb', line 103

def self.openapi_nullable
  Set.new([
    :'remote_id',
    :'candidate',
    :'job',
    :'applied_at',
    :'rejected_at',
    :'source',
    :'credited_to',
    :'current_stage',
    :'reject_reason',
    :'field_mappings',
    :'remote_data'
  ])
end

.openapi_typesObject

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/merge_ats_client/models/application.rb', line 83

def self.openapi_types
  {
    :'id' => :'String',
    :'remote_id' => :'String',
    :'candidate' => :'String',
    :'job' => :'String',
    :'applied_at' => :'Time',
    :'rejected_at' => :'Time',
    :'source' => :'String',
    :'credited_to' => :'String',
    :'current_stage' => :'String',
    :'reject_reason' => :'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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
# File 'lib/merge_ats_client/models/application.rb', line 210

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      remote_id == o.remote_id &&
      candidate == o.candidate &&
      job == o.job &&
      applied_at == o.applied_at &&
      rejected_at == o.rejected_at &&
      source == o.source &&
      credited_to == o.credited_to &&
      current_stage == o.current_stage &&
      reject_reason == o.reject_reason &&
      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



274
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/merge_ats_client/models/application.rb', line 274

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



345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'lib/merge_ats_client/models/application.rb', line 345

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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
# File 'lib/merge_ats_client/models/application.rb', line 251

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


231
232
233
# File 'lib/merge_ats_client/models/application.rb', line 231

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



237
238
239
# File 'lib/merge_ats_client/models/application.rb', line 237

def hash
  [id, remote_id, candidate, job, applied_at, rejected_at, source, credited_to, current_stage, reject_reason, remote_was_deleted, modified_at, field_mappings, remote_data].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



197
198
199
200
# File 'lib/merge_ats_client/models/application.rb', line 197

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

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/merge_ats_client/models/application.rb', line 321

def to_body
  to_hash
end

#to_hashHash

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
336
337
338
339
# File 'lib/merge_ats_client/models/application.rb', line 327

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



315
316
317
# File 'lib/merge_ats_client/models/application.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



204
205
206
# File 'lib/merge_ats_client/models/application.rb', line 204

def valid?
  true
end