Class: CandidApiClient::Commons::Types::PhoneNumber

Inherits:
Object
  • Object
show all
Defined in:
lib/candidhealth/commons/types/phone_number.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(number:, type:, additional_properties: nil) ⇒ CandidApiClient::Commons::Types::PhoneNumber

Parameters:



27
28
29
30
31
32
 
# File 'lib/candidhealth/commons/types/phone_number.rb', line 27

def initialize(number:, type:, additional_properties: nil)
  @number = number
  @type = type
  @additional_properties = additional_properties
  @_field_set = { "number": number, "type": type }
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



16
17
18
 
# File 'lib/candidhealth/commons/types/phone_number.rb', line 16

def additional_properties
  @additional_properties
end

#number ⇒ String (readonly)

Returns:

  • (String) 


12
13
14
 
# File 'lib/candidhealth/commons/types/phone_number.rb', line 12

def number
  @number
end

#type ⇒ CandidApiClient::Commons::Types::PhoneNumberType (readonly)

Returns:



14
15
16
 
# File 'lib/candidhealth/commons/types/phone_number.rb', line 14

def type
  @type
end

Class Method Details

.from_json(json_object:) ⇒ CandidApiClient::Commons::Types::PhoneNumber

Deserialize a JSON object to an instance of PhoneNumber

Parameters:

  • json_object (String)

Returns:



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/candidhealth/commons/types/phone_number.rb', line 38

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  number = struct["number"]
  type = struct["type"]
  new(
    number: number,
    type: type,
    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) 


62
63
64
65
 
# File 'lib/candidhealth/commons/types/phone_number.rb', line 62

def self.validate_raw(obj:)
  obj.number.is_a?(String) != false || raise("Passed value for field obj.number is not the expected type, validation failed.")
  obj.type.is_a?(CandidApiClient::Commons::Types::PhoneNumberType) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of PhoneNumber to a JSON object

Returns:

  • (String) 


52
53
54
 
# File 'lib/candidhealth/commons/types/phone_number.rb', line 52

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