Class: Merge::Ats::Scorecard

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

Overview

# The Scorecard Object

### Description
The `Scorecard` object is used to represent an interviewer's candidate
recommendation based on a particular interview.
### Usage Example
Fetch from the `LIST Scorecards` endpoint and filter by `application` to show
all scorecard for an applicant.

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, application: OMIT, interview: OMIT, interviewer: OMIT, remote_created_at: OMIT, submitted_at: OMIT, overall_recommendation: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Ats::Scorecard

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.

  • application (Merge::Ats::ScorecardApplication) (defaults to: OMIT) —

    The application being scored.

  • interview (Merge::Ats::ScorecardInterview) (defaults to: OMIT) —

    The interview being scored.

  • interviewer (Merge::Ats::ScorecardInterviewer) (defaults to: OMIT) —

    The interviewer doing the scoring.

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

    When the third party’s scorecard was created.

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

    When the scorecard was submitted.

  • overall_recommendation (Merge::Ats::OverallRecommendationEnum) (defaults to: OMIT) —

    The inteviewer’s recommendation.

    • ‘DEFINITELY_NO` - DEFINITELY_NO

    • ‘NO` - NO

    • ‘YES` - YES

    • ‘STRONG_YES` - STRONG_YES

    • ‘NO_DECISION` - NO_DECISION

  • 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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/merge_ruby_client/ats/types/scorecard.rb', line 83

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, application: OMIT,
               interview: OMIT, interviewer: OMIT, remote_created_at: OMIT, submitted_at: OMIT, overall_recommendation: 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
  @application = application if application != OMIT
  @interview = interview if interview != OMIT
  @interviewer = interviewer if interviewer != OMIT
  @remote_created_at = remote_created_at if remote_created_at != OMIT
  @submitted_at = submitted_at if submitted_at != OMIT
  @overall_recommendation = overall_recommendation if overall_recommendation != 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,
    "application": application,
    "interview": interview,
    "interviewer": interviewer,
    "remote_created_at": remote_created_at,
    "submitted_at": submitted_at,
    "overall_recommendation": overall_recommendation,
    "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



55
56
57
 
# File 'lib/merge_ruby_client/ats/types/scorecard.rb', line 55

def additional_properties
  @additional_properties
end

#application ⇒ Merge::Ats::ScorecardApplication (readonly)

Returns The application being scored.

Returns:



31
32
33
 
# File 'lib/merge_ruby_client/ats/types/scorecard.rb', line 31

def application
  @application
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.



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

def created_at
  @created_at
end

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

Returns:

  • (Hash{String => Object}) 


51
52
53
 
# File 'lib/merge_ruby_client/ats/types/scorecard.rb', line 51

def field_mappings
  @field_mappings
end

#id ⇒ String (readonly)

Returns:

  • (String) 


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

def id
  @id
end

#interview ⇒ Merge::Ats::ScorecardInterview (readonly)

Returns The interview being scored.

Returns:



33
34
35
 
# File 'lib/merge_ruby_client/ats/types/scorecard.rb', line 33

def interview
  @interview
end

#interviewer ⇒ Merge::Ats::ScorecardInterviewer (readonly)

Returns The interviewer doing the scoring.

Returns:



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

def interviewer
  @interviewer
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.



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

def modified_at
  @modified_at
end

#overall_recommendation ⇒ Merge::Ats::OverallRecommendationEnum (readonly)

Returns The inteviewer’s recommendation.

  • ‘DEFINITELY_NO` - DEFINITELY_NO

  • ‘NO` - NO

  • ‘YES` - YES

  • ‘STRONG_YES` - STRONG_YES

  • ‘NO_DECISION` - NO_DECISION.

Returns:

  • (Merge::Ats::OverallRecommendationEnum) —

    The inteviewer’s recommendation.

    • ‘DEFINITELY_NO` - DEFINITELY_NO

    • ‘NO` - NO

    • ‘YES` - YES

    • ‘STRONG_YES` - STRONG_YES

    • ‘NO_DECISION` - NO_DECISION



46
47
48
 
# File 'lib/merge_ruby_client/ats/types/scorecard.rb', line 46

def overall_recommendation
  @overall_recommendation
end

#remote_created_at ⇒ DateTime (readonly)

Returns When the third party’s scorecard was created.

Returns:

  • (DateTime) —

    When the third party’s scorecard was created.



37
38
39
 
# File 'lib/merge_ruby_client/ats/types/scorecard.rb', line 37

def remote_created_at
  @remote_created_at
end

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

Returns:



53
54
55
 
# File 'lib/merge_ruby_client/ats/types/scorecard.rb', line 53

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.



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

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.



49
50
51
 
# File 'lib/merge_ruby_client/ats/types/scorecard.rb', line 49

def remote_was_deleted
  @remote_was_deleted
end

#submitted_at ⇒ DateTime (readonly)

Returns When the scorecard was submitted.

Returns:

  • (DateTime) —

    When the scorecard was submitted.



39
40
41
 
# File 'lib/merge_ruby_client/ats/types/scorecard.rb', line 39

def submitted_at
  @submitted_at
end

Class Method Details

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

Deserialize a JSON object to an instance of Scorecard

Parameters:

  • json_object (String)

Returns:



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
 
# File 'lib/merge_ruby_client/ats/types/scorecard.rb', line 122

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?)
  if parsed_json["application"].nil?
    application = nil
  else
    application = parsed_json["application"].to_json
    application = Merge::Ats::ScorecardApplication.from_json(json_object: application)
  end
  if parsed_json["interview"].nil?
    interview = nil
  else
    interview = parsed_json["interview"].to_json
    interview = Merge::Ats::ScorecardInterview.from_json(json_object: interview)
  end
  if parsed_json["interviewer"].nil?
    interviewer = nil
  else
    interviewer = parsed_json["interviewer"].to_json
    interviewer = Merge::Ats::ScorecardInterviewer.from_json(json_object: interviewer)
  end
  remote_created_at = unless parsed_json["remote_created_at"].nil?
                        DateTime.parse(parsed_json["remote_created_at"])
                      end
  submitted_at = (DateTime.parse(parsed_json["submitted_at"]) unless parsed_json["submitted_at"].nil?)
  overall_recommendation = parsed_json["overall_recommendation"]
  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,
    application: application,
    interview: interview,
    interviewer: interviewer,
    remote_created_at: remote_created_at,
    submitted_at: submitted_at,
    overall_recommendation: overall_recommendation,
    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) 


189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/merge_ruby_client/ats/types/scorecard.rb', line 189

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.application.nil? || Merge::Ats::ScorecardApplication.validate_raw(obj: obj.application)
  obj.interview.nil? || Merge::Ats::ScorecardInterview.validate_raw(obj: obj.interview)
  obj.interviewer.nil? || Merge::Ats::ScorecardInterviewer.validate_raw(obj: obj.interviewer)
  obj.remote_created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.remote_created_at is not the expected type, validation failed.")
  obj.submitted_at&.is_a?(DateTime) != false || raise("Passed value for field obj.submitted_at is not the expected type, validation failed.")
  obj.overall_recommendation&.is_a?(Merge::Ats::OverallRecommendationEnum) != false || raise("Passed value for field obj.overall_recommendation 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 Scorecard to a JSON object

Returns:

  • (String) 


179
180
181
 
# File 'lib/merge_ruby_client/ats/types/scorecard.rb', line 179

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