Class: Merge::Ats::PhoneNumberRequest

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

Overview

# The PhoneNumber Object

### Description
The `PhoneNumber` object is used to represent a candidate's phone number.
### Usage Example
Fetch from the `GET Candidate` endpoint and view their phone numbers.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(value: OMIT, phone_number_type: OMIT, integration_params: OMIT, linked_account_params: OMIT, additional_properties: nil) ⇒ Merge::Ats::PhoneNumberRequest

Parameters:

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

    The phone number.

  • phone_number_type (Merge::Ats::PhoneNumberTypeEnum) (defaults to: OMIT) —

    The type of phone number.

    • ‘HOME` - HOME

    • ‘WORK` - WORK

    • ‘MOBILE` - MOBILE

    • ‘SKYPE` - SKYPE

    • ‘OTHER` - OTHER

  • 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



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

def initialize(value: OMIT, phone_number_type: OMIT, integration_params: OMIT, linked_account_params: OMIT,
               additional_properties: nil)
  @value = value if value != OMIT
  @phone_number_type = phone_number_type if phone_number_type != OMIT
  @integration_params = integration_params if integration_params != OMIT
  @linked_account_params =  if  != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "value": value,
    "phone_number_type": phone_number_type,
    "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/phone_number_request.rb', line 29

def additional_properties
  @additional_properties
end

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

Returns:

  • (Hash{String => Object}) 


25
26
27
 
# File 'lib/merge_ruby_client/ats/types/phone_number_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/phone_number_request.rb', line 27

def 
  @linked_account_params
end

#phone_number_type ⇒ Merge::Ats::PhoneNumberTypeEnum (readonly)

Returns The type of phone number.

  • ‘HOME` - HOME

  • ‘WORK` - WORK

  • ‘MOBILE` - MOBILE

  • ‘SKYPE` - SKYPE

  • ‘OTHER` - OTHER.

Returns:



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

def phone_number_type
  @phone_number_type
end

#value ⇒ String (readonly)

Returns The phone number.

Returns:

  • (String) —

    The phone number.



16
17
18
 
# File 'lib/merge_ruby_client/ats/types/phone_number_request.rb', line 16

def value
  @value
end

Class Method Details

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

Deserialize a JSON object to an instance of PhoneNumberRequest

Parameters:

  • json_object (String)

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/merge_ruby_client/ats/types/phone_number_request.rb', line 68

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  value = parsed_json["value"]
  phone_number_type = parsed_json["phone_number_type"]
  integration_params = parsed_json["integration_params"]
   = parsed_json["linked_account_params"]
  new(
    value: value,
    phone_number_type: phone_number_type,
    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) 


97
98
99
100
101
102
 
# File 'lib/merge_ruby_client/ats/types/phone_number_request.rb', line 97

def self.validate_raw(obj:)
  obj.value&.is_a?(String) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
  obj.phone_number_type&.is_a?(Merge::Ats::PhoneNumberTypeEnum) != false || raise("Passed value for field obj.phone_number_type 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 PhoneNumberRequest to a JSON object

Returns:

  • (String) 


87
88
89
 
# File 'lib/merge_ruby_client/ats/types/phone_number_request.rb', line 87

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