Class: CandidApiClient::Commons::Types::RequestValidationError

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(field_name:, human_readable_message: OMIT, additional_properties: nil) ⇒ CandidApiClient::Commons::Types::RequestValidationError

Parameters:

  • field_name (String)
  • human_readable_message (String) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



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

def initialize(field_name:, human_readable_message: OMIT, additional_properties: nil)
  @field_name = field_name
  @human_readable_message = human_readable_message if human_readable_message != OMIT
  @additional_properties = additional_properties
  @_field_set = { "fieldName": field_name, "humanReadableMessage": human_readable_message }.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



15
16
17
 
# File 'lib/candidhealth/commons/types/request_validation_error.rb', line 15

def additional_properties
  @additional_properties
end

#field_name ⇒ String (readonly)

Returns:

  • (String) 


11
12
13
 
# File 'lib/candidhealth/commons/types/request_validation_error.rb', line 11

def field_name
  @field_name
end

#human_readable_message ⇒ String (readonly)

Returns:

  • (String) 


13
14
15
 
# File 'lib/candidhealth/commons/types/request_validation_error.rb', line 13

def human_readable_message
  @human_readable_message
end

Class Method Details

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

Deserialize a JSON object to an instance of RequestValidationError

Parameters:

  • json_object (String)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  field_name = struct["fieldName"]
  human_readable_message = struct["humanReadableMessage"]
  new(
    field_name: field_name,
    human_readable_message: human_readable_message,
    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/commons/types/request_validation_error.rb', line 63

def self.validate_raw(obj:)
  obj.field_name.is_a?(String) != false || raise("Passed value for field obj.field_name is not the expected type, validation failed.")
  obj.human_readable_message&.is_a?(String) != false || raise("Passed value for field obj.human_readable_message is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of RequestValidationError to a JSON object

Returns:

  • (String) 


53
54
55
 
# File 'lib/candidhealth/commons/types/request_validation_error.rb', line 53

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