Class: AssemblyAI::Realtime::RealtimeTemporaryTokenResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/assemblyai/realtime/types/realtime_temporary_token_response.rb

Constant Summary collapse

OMIT =
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(token:, additional_properties: nil) ⇒ AssemblyAI::Realtime::RealtimeTemporaryTokenResponse

Parameters:

  • token (String)

    The temporary authentication token for Streaming Speech-to-Text

  • additional_properties (OpenStruct) (defaults to: nil)

    Additional properties unmapped to the current class definition



22
23
24
25
26
# File 'lib/assemblyai/realtime/types/realtime_temporary_token_response.rb', line 22

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



12
13
14
# File 'lib/assemblyai/realtime/types/realtime_temporary_token_response.rb', line 12

def additional_properties
  @additional_properties
end

#tokenString (readonly)

Returns The temporary authentication token for Streaming Speech-to-Text.

Returns:

  • (String)

    The temporary authentication token for Streaming Speech-to-Text



10
11
12
# File 'lib/assemblyai/realtime/types/realtime_temporary_token_response.rb', line 10

def token
  @token
end

Class Method Details

.from_json(json_object:) ⇒ AssemblyAI::Realtime::RealtimeTemporaryTokenResponse

Deserialize a JSON object to an instance of RealtimeTemporaryTokenResponse

Parameters:

  • json_object (String)

Returns:



32
33
34
35
36
# File 'lib/assemblyai/realtime/types/realtime_temporary_token_response.rb', line 32

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  token = struct["token"]
  new(token: token, 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/assemblyai/realtime/types/realtime_temporary_token_response.rb', line 51

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of RealtimeTemporaryTokenResponse to a JSON object

Returns:

  • (String)


41
42
43
# File 'lib/assemblyai/realtime/types/realtime_temporary_token_response.rb', line 41

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