Class: Vapi::TextContent

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

Constant Summary collapse

OMIT =
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type:, text:, language:, additional_properties: nil) ⇒ Vapi::TextContent

Parameters:

  • type (String)
  • text (String)
  • language (Vapi::TextContentLanguage)
  • additional_properties (OpenStruct) (defaults to: nil)

    Additional properties unmapped to the current class definition



28
29
30
31
32
33
34
# File 'lib/vapi_server_sdk/types/text_content.rb', line 28

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



16
17
18
# File 'lib/vapi_server_sdk/types/text_content.rb', line 16

def additional_properties
  @additional_properties
end

#languageVapi::TextContentLanguage (readonly)



14
15
16
# File 'lib/vapi_server_sdk/types/text_content.rb', line 14

def language
  @language
end

#textString (readonly)

Returns:

  • (String)


12
13
14
# File 'lib/vapi_server_sdk/types/text_content.rb', line 12

def text
  @text
end

#typeString (readonly)

Returns:

  • (String)


10
11
12
# File 'lib/vapi_server_sdk/types/text_content.rb', line 10

def type
  @type
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::TextContent

Deserialize a JSON object to an instance of TextContent

Parameters:

  • json_object (String)

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
# File 'lib/vapi_server_sdk/types/text_content.rb', line 40

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


67
68
69
70
71
# File 'lib/vapi_server_sdk/types/text_content.rb', line 67

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.text.is_a?(String) != false || raise("Passed value for field obj.text is not the expected type, validation failed.")
  obj.language.is_a?(Vapi::TextContentLanguage) != false || raise("Passed value for field obj.language is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of TextContent to a JSON object

Returns:

  • (String)


57
58
59
# File 'lib/vapi_server_sdk/types/text_content.rb', line 57

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