Class: Pinnacle::MediaPayload

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type:, url:, additional_properties: nil) ⇒ Pinnacle::MediaPayload

Parameters:

  • type (String)
  • url (String)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



24
25
26
27
28
29
 
# File 'lib/rcs/types/media_payload.rb', line 24

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



13
14
15
 
# File 'lib/rcs/types/media_payload.rb', line 13

def additional_properties
  @additional_properties
end

#type ⇒ String (readonly)

Returns:

  • (String) 


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

def type
  @type
end

#url ⇒ String (readonly)

Returns:

  • (String) 


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

def url
  @url
end

Class Method Details

.from_json(json_object:) ⇒ Pinnacle::MediaPayload

Deserialize a JSON object to an instance of MediaPayload

Parameters:

  • json_object (String)

Returns:



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/rcs/types/media_payload.rb', line 35

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


60
61
62
63
 
# File 'lib/rcs/types/media_payload.rb', line 60

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of MediaPayload to a JSON object

Returns:

  • (String) 


50
51
52
 
# File 'lib/rcs/types/media_payload.rb', line 50

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