Class: Merge::Ats::ScreeningQuestionAnswer

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

Overview

# The ScreeningQuestionAnswer Object

### Description
The `ScreeningQuestionAnswer` object is used to represent candidate responses to
a screening question, for a specific application.
### Usage Example
TODO

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, question: OMIT, answer: OMIT, remote_was_deleted: OMIT, additional_properties: nil) ⇒ Merge::Ats::ScreeningQuestionAnswer

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.

  • question (Merge::Ats::ScreeningQuestionAnswerQuestion) (defaults to: OMIT) —

    The screening question associated with the candidate’s answer. To determine the data type of the answer, you can expand on the screening question by adding ‘screening_question_answers.question` to the `expand` query parameter.

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

    The candidate’s response to the screening question.

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

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

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/merge_ruby_client/ats/types/screening_question_answer.rb', line 54

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, question: OMIT, answer: OMIT,
               remote_was_deleted: 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
  @question = question if question != OMIT
  @answer = answer if answer != OMIT
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "question": question,
    "answer": answer,
    "remote_was_deleted": remote_was_deleted
  }.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



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

def additional_properties
  @additional_properties
end

#answer ⇒ String (readonly)

Returns The candidate’s response to the screening question.

Returns:

  • (String) —

    The candidate’s response to the screening question.



30
31
32
 
# File 'lib/merge_ruby_client/ats/types/screening_question_answer.rb', line 30

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



22
23
24
 
# File 'lib/merge_ruby_client/ats/types/screening_question_answer.rb', line 22

def created_at
  @created_at
end

#id ⇒ String (readonly)

Returns:

  • (String) 


18
19
20
 
# File 'lib/merge_ruby_client/ats/types/screening_question_answer.rb', line 18

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



24
25
26
 
# File 'lib/merge_ruby_client/ats/types/screening_question_answer.rb', line 24

def modified_at
  @modified_at
end

#question ⇒ Merge::Ats::ScreeningQuestionAnswerQuestion (readonly)

Returns The screening question associated with the candidate’s answer. To determine the data type of the answer, you can expand on the screening question by adding ‘screening_question_answers.question` to the `expand` query parameter.

Returns:

  • (Merge::Ats::ScreeningQuestionAnswerQuestion) —

    The screening question associated with the candidate’s answer. To determine the data type of the answer, you can expand on the screening question by adding ‘screening_question_answers.question` to the `expand` query parameter.



28
29
30
 
# File 'lib/merge_ruby_client/ats/types/screening_question_answer.rb', line 28

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



20
21
22
 
# File 'lib/merge_ruby_client/ats/types/screening_question_answer.rb', line 20

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.



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

def remote_was_deleted
  @remote_was_deleted
end

Class Method Details

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

Deserialize a JSON object to an instance of ScreeningQuestionAnswer

Parameters:

  • json_object (String)

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/merge_ruby_client/ats/types/screening_question_answer.rb', line 81

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["question"].nil?
    question = nil
  else
    question = parsed_json["question"].to_json
    question = Merge::Ats::ScreeningQuestionAnswerQuestion.from_json(json_object: question)
  end
  answer = parsed_json["answer"]
  remote_was_deleted = parsed_json["remote_was_deleted"]
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    question: question,
    answer: answer,
    remote_was_deleted: remote_was_deleted,
    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) 


121
122
123
124
125
126
127
128
129
 
# File 'lib/merge_ruby_client/ats/types/screening_question_answer.rb', line 121

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.question.nil? || Merge::Ats::ScreeningQuestionAnswerQuestion.validate_raw(obj: obj.question)
  obj.answer&.is_a?(String) != false || raise("Passed value for field obj.answer 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.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ScreeningQuestionAnswer to a JSON object

Returns:

  • (String) 


111
112
113
 
# File 'lib/merge_ruby_client/ats/types/screening_question_answer.rb', line 111

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