Class: CandidApiClient::CustomSchemas::V1::Types::SchemaField

Inherits:
Object
  • Object
show all
Defined in:
lib/candidhealth/custom_schemas/v_1/types/schema_field.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key:, type:, additional_properties: nil) ⇒ CandidApiClient::CustomSchemas::V1::Types::SchemaField

Parameters:



28
29
30
31
32
33
 
# File 'lib/candidhealth/custom_schemas/v_1/types/schema_field.rb', line 28

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



17
18
19
 
# File 'lib/candidhealth/custom_schemas/v_1/types/schema_field.rb', line 17

def additional_properties
  @additional_properties
end

#key ⇒ String (readonly)

Returns:

  • (String) 


13
14
15
 
# File 'lib/candidhealth/custom_schemas/v_1/types/schema_field.rb', line 13

def key
  @key
end

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

Returns:



15
16
17
 
# File 'lib/candidhealth/custom_schemas/v_1/types/schema_field.rb', line 15

def type
  @type
end

Class Method Details

.from_json(json_object:) ⇒ CandidApiClient::CustomSchemas::V1::Types::SchemaField

Deserialize a JSON object to an instance of SchemaField

Parameters:

  • json_object (String)

Returns:



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/candidhealth/custom_schemas/v_1/types/schema_field.rb', line 39

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


63
64
65
66
 
# File 'lib/candidhealth/custom_schemas/v_1/types/schema_field.rb', line 63

def self.validate_raw(obj:)
  obj.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
  obj.type.is_a?(CandidApiClient::Commons::Types::Primitive) != 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 SchemaField to a JSON object

Returns:

  • (String) 


53
54
55
 
# File 'lib/candidhealth/custom_schemas/v_1/types/schema_field.rb', line 53

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