Class: AssemblyAI::Transcripts::RedactedAudioResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/assemblyai/transcripts/types/redacted_audio_response.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(status:, redacted_audio_url:, additional_properties: nil) ⇒ AssemblyAI::Transcripts::RedactedAudioResponse

Parameters:

  • status (AssemblyAI::Transcripts::REDACTED_AUDIO_STATUS) —

    The status of the redacted audio

  • redacted_audio_url (String) —

    The URL of the redacted audio file

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

    Additional properties unmapped to the current class definition



26
27
28
29
30
31
 
# File 'lib/assemblyai/transcripts/types/redacted_audio_response.rb', line 26

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



15
16
17
 
# File 'lib/assemblyai/transcripts/types/redacted_audio_response.rb', line 15

def additional_properties
  @additional_properties
end

#redacted_audio_url ⇒ String (readonly)

Returns The URL of the redacted audio file.

Returns:

  • (String) —

    The URL of the redacted audio file



13
14
15
 
# File 'lib/assemblyai/transcripts/types/redacted_audio_response.rb', line 13

def redacted_audio_url
  @redacted_audio_url
end

#status ⇒ AssemblyAI::Transcripts::REDACTED_AUDIO_STATUS (readonly)

Returns The status of the redacted audio.

Returns:



11
12
13
 
# File 'lib/assemblyai/transcripts/types/redacted_audio_response.rb', line 11

def status
  @status
end

Class Method Details

.from_json(json_object:) ⇒ AssemblyAI::Transcripts::RedactedAudioResponse

Deserialize a JSON object to an instance of RedactedAudioResponse

Parameters:

  • json_object (String)

Returns:



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/assemblyai/transcripts/types/redacted_audio_response.rb', line 37

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


61
62
63
64
 
# File 'lib/assemblyai/transcripts/types/redacted_audio_response.rb', line 61

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of RedactedAudioResponse to a JSON object

Returns:

  • (String) 


51
52
53
 
# File 'lib/assemblyai/transcripts/types/redacted_audio_response.rb', line 51

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