Class: Pinnacle::SendResponse

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(message: OMIT, additional_properties: nil) ⇒ Pinnacle::SendResponse

Parameters:

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

    Confirmation message that the message was sent successfully

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



21
22
23
24
25
26
27
 
# File 'lib/rcs/types/send_response.rb', line 21

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



11
12
13
 
# File 'lib/rcs/types/send_response.rb', line 11

def additional_properties
  @additional_properties
end

#message ⇒ String (readonly)

Returns Confirmation message that the message was sent successfully.

Returns:

  • (String) —

    Confirmation message that the message was sent successfully



9
10
11
 
# File 'lib/rcs/types/send_response.rb', line 9

def message
  @message
end

Class Method Details

.from_json(json_object:) ⇒ Pinnacle::SendResponse

Deserialize a JSON object to an instance of SendResponse

Parameters:

  • json_object (String)

Returns:



33
34
35
36
37
38
 
# File 'lib/rcs/types/send_response.rb', line 33

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


53
54
55
 
# File 'lib/rcs/types/send_response.rb', line 53

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of SendResponse to a JSON object

Returns:

  • (String) 


43
44
45
 
# File 'lib/rcs/types/send_response.rb', line 43

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