Class: Pinnacle::BadRequestErrorBody

Inherits:
Object
  • Object
show all
Defined in:
lib/rcs/types/bad_request_error_body.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(error: OMIT, success: OMIT, additional_properties: nil) ⇒ Pinnacle::BadRequestErrorBody

Parameters:

  • error (Pinnacle::BadRequestErrorBodyError) (defaults to: OMIT)
  • success (Boolean) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



25
26
27
28
29
30
31
32
 
# File 'lib/rcs/types/bad_request_error_body.rb', line 25

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



14
15
16
 
# File 'lib/rcs/types/bad_request_error_body.rb', line 14

def additional_properties
  @additional_properties
end

#error ⇒ Pinnacle::BadRequestErrorBodyError (readonly)

Returns:



10
11
12
 
# File 'lib/rcs/types/bad_request_error_body.rb', line 10

def error
  @error
end

#success ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


12
13
14
 
# File 'lib/rcs/types/bad_request_error_body.rb', line 12

def success
  @success
end

Class Method Details

.from_json(json_object:) ⇒ Pinnacle::BadRequestErrorBody

Deserialize a JSON object to an instance of BadRequestErrorBody

Parameters:

  • json_object (String)

Returns:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/rcs/types/bad_request_error_body.rb', line 38

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  if parsed_json["error"].nil?
    error = nil
  else
    error = parsed_json["error"].to_json
    error = Pinnacle::BadRequestErrorBodyError.from_json(json_object: error)
  end
  success = parsed_json["success"]
  new(
    error: error,
    success: success,
    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) 


68
69
70
71
 
# File 'lib/rcs/types/bad_request_error_body.rb', line 68

def self.validate_raw(obj:)
  obj.error.nil? || Pinnacle::BadRequestErrorBodyError.validate_raw(obj: obj.error)
  obj.success&.is_a?(Boolean) != false || raise("Passed value for field obj.success is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of BadRequestErrorBody to a JSON object

Returns:

  • (String) 


58
59
60
 
# File 'lib/rcs/types/bad_request_error_body.rb', line 58

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