Class: Merge::Ats::JobInterviewStage

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/ats/types/job_interview_stage.rb

Overview

# The JobInterviewStage Object

### Description
The `JobInterviewStage` object is used to represent a particular recruiting
stage for an `Application`. A given `Application` typically has the
`JobInterviewStage` object represented in the current_stage field.
### Usage Example
Fetch from the `LIST JobInterviewStages` endpoint and view the job interview
stages used by a company.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, job: OMIT, stage_order: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Ats::JobInterviewStage

Parameters:

  • id (String) (defaults to: OMIT)
  • remote_id (String) (defaults to: OMIT) —

    The third-party API ID of the matching object.

  • created_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was created by Merge.

  • modified_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was modified by Merge.

  • name (String) (defaults to: OMIT) —

    Standard stage names are offered by ATS systems but can be modified by users.

  • job (Merge::Ats::JobInterviewStageJob) (defaults to: OMIT) —

    This field is populated only if the stage is specific to a particular job. If the stage is generic, this field will not be populated.

  • stage_order (Integer) (defaults to: OMIT) —

    The stage’s order, with the lowest values ordered first. If the third-party does not return details on the order of stages, this field will not be populated.

  • remote_was_deleted (Boolean) (defaults to: OMIT) —

    Indicates whether or not this object has been deleted in the third party platform.

  • field_mappings (Hash{String => Object}) (defaults to: OMIT)
  • remote_data (Array<Merge::Ats::RemoteData>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/merge_ruby_client/ats/types/job_interview_stage.rb', line 66

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, job: OMIT,
               stage_order: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil)
  @id = id if id != OMIT
  @remote_id = remote_id if remote_id != OMIT
  @created_at = created_at if created_at != OMIT
  @modified_at = modified_at if modified_at != OMIT
  @name = name if name != OMIT
  @job = job if job != OMIT
  @stage_order = stage_order if stage_order != OMIT
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @field_mappings = field_mappings if field_mappings != OMIT
  @remote_data = remote_data if remote_data != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "name": name,
    "job": job,
    "stage_order": stage_order,
    "remote_was_deleted": remote_was_deleted,
    "field_mappings": field_mappings,
    "remote_data": remote_data
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



44
45
46
 
# File 'lib/merge_ruby_client/ats/types/job_interview_stage.rb', line 44

def additional_properties
  @additional_properties
end

#created_at ⇒ DateTime (readonly)

Returns The datetime that this object was created by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was created by Merge.



25
26
27
 
# File 'lib/merge_ruby_client/ats/types/job_interview_stage.rb', line 25

def created_at
  @created_at
end

#field_mappings ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


40
41
42
 
# File 'lib/merge_ruby_client/ats/types/job_interview_stage.rb', line 40

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


21
22
23
 
# File 'lib/merge_ruby_client/ats/types/job_interview_stage.rb', line 21

def id
  @id
end

#job ⇒ Merge::Ats::JobInterviewStageJob (readonly)

Returns This field is populated only if the stage is specific to a particular job. If the stage is generic, this field will not be populated.

Returns:

  • (Merge::Ats::JobInterviewStageJob) —

    This field is populated only if the stage is specific to a particular job. If the stage is generic, this field will not be populated.



32
33
34
 
# File 'lib/merge_ruby_client/ats/types/job_interview_stage.rb', line 32

def job
  @job
end

#modified_at ⇒ DateTime (readonly)

Returns The datetime that this object was modified by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was modified by Merge.



27
28
29
 
# File 'lib/merge_ruby_client/ats/types/job_interview_stage.rb', line 27

def modified_at
  @modified_at
end

#name ⇒ String (readonly)

Returns Standard stage names are offered by ATS systems but can be modified by users.

Returns:

  • (String) —

    Standard stage names are offered by ATS systems but can be modified by users.



29
30
31
 
# File 'lib/merge_ruby_client/ats/types/job_interview_stage.rb', line 29

def name
  @name
end

#remote_data ⇒ Array<Merge::Ats::RemoteData> (readonly)

Returns:



42
43
44
 
# File 'lib/merge_ruby_client/ats/types/job_interview_stage.rb', line 42

def remote_data
  @remote_data
end

#remote_id ⇒ String (readonly)

Returns The third-party API ID of the matching object.

Returns:

  • (String) —

    The third-party API ID of the matching object.



23
24
25
 
# File 'lib/merge_ruby_client/ats/types/job_interview_stage.rb', line 23

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Boolean (readonly)

Returns Indicates whether or not this object has been deleted in the third party platform.

Returns:

  • (Boolean) —

    Indicates whether or not this object has been deleted in the third party platform.



38
39
40
 
# File 'lib/merge_ruby_client/ats/types/job_interview_stage.rb', line 38

def remote_was_deleted
  @remote_was_deleted
end

#stage_order ⇒ Integer (readonly)

Returns The stage’s order, with the lowest values ordered first. If the third-party does not return details on the order of stages, this field will not be populated.

Returns:

  • (Integer) —

    The stage’s order, with the lowest values ordered first. If the third-party does not return details on the order of stages, this field will not be populated.



35
36
37
 
# File 'lib/merge_ruby_client/ats/types/job_interview_stage.rb', line 35

def stage_order
  @stage_order
end

Class Method Details

.from_json(json_object:) ⇒ Merge::Ats::JobInterviewStage

Deserialize a JSON object to an instance of JobInterviewStage

Parameters:

  • json_object (String)

Returns:



99
100
101
102
103
104
105
106
107
108
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_ruby_client/ats/types/job_interview_stage.rb', line 99

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  remote_id = parsed_json["remote_id"]
  created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
  modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
  name = parsed_json["name"]
  if parsed_json["job"].nil?
    job = nil
  else
    job = parsed_json["job"].to_json
    job = Merge::Ats::JobInterviewStageJob.from_json(json_object: job)
  end
  stage_order = parsed_json["stage_order"]
  remote_was_deleted = parsed_json["remote_was_deleted"]
  field_mappings = parsed_json["field_mappings"]
  remote_data = parsed_json["remote_data"]&.map do |item|
    item = item.to_json
    Merge::Ats::RemoteData.from_json(json_object: item)
  end
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    name: name,
    job: job,
    stage_order: stage_order,
    remote_was_deleted: remote_was_deleted,
    field_mappings: field_mappings,
    remote_data: remote_data,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/merge_ruby_client/ats/types/job_interview_stage.rb', line 148

def self.validate_raw(obj:)
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
  obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
  obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
  obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.job.nil? || Merge::Ats::JobInterviewStageJob.validate_raw(obj: obj.job)
  obj.stage_order&.is_a?(Integer) != false || raise("Passed value for field obj.stage_order is not the expected type, validation failed.")
  obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted is not the expected type, validation failed.")
  obj.field_mappings&.is_a?(Hash) != false || raise("Passed value for field obj.field_mappings is not the expected type, validation failed.")
  obj.remote_data&.is_a?(Array) != false || raise("Passed value for field obj.remote_data is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of JobInterviewStage to a JSON object

Returns:

  • (String) 


138
139
140
 
# File 'lib/merge_ruby_client/ats/types/job_interview_stage.rb', line 138

def to_json(*_args)
  @_field_set&.to_json
end