Class: Vapi::ClientMessageMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/types/client_message_metadata.rb

Constant Summary collapse

OMIT =
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(metadata:, additional_properties: nil) ⇒ Vapi::ClientMessageMetadata

Parameters:

  • metadata (String)

    This is the metadata content

  • additional_properties (OpenStruct) (defaults to: nil)

    Additional properties unmapped to the current class definition



21
22
23
24
25
# File 'lib/vapi_server_sdk/types/client_message_metadata.rb', line 21

def initialize(metadata:, additional_properties: nil)
  @metadata = 
  @additional_properties = additional_properties
  @_field_set = { "metadata":  }
end

Instance Attribute Details

#additional_propertiesOpenStruct (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/vapi_server_sdk/types/client_message_metadata.rb', line 11

def additional_properties
  @additional_properties
end

#metadataString (readonly)

Returns This is the metadata content.

Returns:

  • (String)

    This is the metadata content



9
10
11
# File 'lib/vapi_server_sdk/types/client_message_metadata.rb', line 9

def 
  @metadata
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::ClientMessageMetadata

Deserialize a JSON object to an instance of ClientMessageMetadata

Parameters:

  • json_object (String)

Returns:



31
32
33
34
35
36
# File 'lib/vapi_server_sdk/types/client_message_metadata.rb', line 31

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


51
52
53
# File 'lib/vapi_server_sdk/types/client_message_metadata.rb', line 51

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ClientMessageMetadata to a JSON object

Returns:

  • (String)


41
42
43
# File 'lib/vapi_server_sdk/types/client_message_metadata.rb', line 41

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