Class: Merge::Ats::ScreeningQuestionAnswerRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/ats/types/screening_question_answer_request.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(remote_id: OMIT, question: OMIT, answer: OMIT, integration_params: OMIT, linked_account_params: OMIT, additional_properties: nil) ⇒ Merge::Ats::ScreeningQuestionAnswerRequest

Parameters:

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

    The third-party API ID of the matching object.

  • question (Merge::Ats::ScreeningQuestionAnswerRequestQuestion) (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.

  • integration_params (Hash{String => Object}) (defaults to: OMIT)
  • linked_account_params (Hash{String => Object}) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/merge_ruby_client/ats/types/screening_question_answer_request.rb', line 45

def initialize(remote_id: OMIT, question: OMIT, answer: OMIT, integration_params: OMIT,
               linked_account_params: OMIT, additional_properties: nil)
  @remote_id = remote_id if remote_id != OMIT
  @question = question if question != OMIT
  @answer = answer if answer != OMIT
  @integration_params = integration_params if integration_params != OMIT
  @linked_account_params =  if  != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "remote_id": remote_id,
    "question": question,
    "answer": answer,
    "integration_params": integration_params,
    "linked_account_params": 
  }.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



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

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.



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

def answer
  @answer
end

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

Returns:

  • (Hash{String => Object}) 


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

def integration_params
  @integration_params
end

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

Returns:

  • (Hash{String => Object}) 


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

def 
  @linked_account_params
end

#question ⇒ Merge::Ats::ScreeningQuestionAnswerRequestQuestion (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::ScreeningQuestionAnswerRequestQuestion) —

    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.



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

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.



17
18
19
 
# File 'lib/merge_ruby_client/ats/types/screening_question_answer_request.rb', line 17

def remote_id
  @remote_id
end

Class Method Details

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

Deserialize a JSON object to an instance of ScreeningQuestionAnswerRequest

Parameters:

  • json_object (String)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  remote_id = parsed_json["remote_id"]
  if parsed_json["question"].nil?
    question = nil
  else
    question = parsed_json["question"].to_json
    question = Merge::Ats::ScreeningQuestionAnswerRequestQuestion.from_json(json_object: question)
  end
  answer = parsed_json["answer"]
  integration_params = parsed_json["integration_params"]
   = parsed_json["linked_account_params"]
  new(
    remote_id: remote_id,
    question: question,
    answer: answer,
    integration_params: integration_params,
    linked_account_params: ,
    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) 


104
105
106
107
108
109
110
 
# File 'lib/merge_ruby_client/ats/types/screening_question_answer_request.rb', line 104

def self.validate_raw(obj:)
  obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
  obj.question.nil? || Merge::Ats::ScreeningQuestionAnswerRequestQuestion.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.integration_params&.is_a?(Hash) != false || raise("Passed value for field obj.integration_params is not the expected type, validation failed.")
  obj.&.is_a?(Hash) != false || raise("Passed value for field obj.linked_account_params is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ScreeningQuestionAnswerRequest to a JSON object

Returns:

  • (String) 


94
95
96
 
# File 'lib/merge_ruby_client/ats/types/screening_question_answer_request.rb', line 94

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