Class: AssemblyAI::Transcripts::TranscriptCustomSpelling

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

Overview

Object containing words or phrases to replace, and the word or phrase to replace

with

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(from:, to:, additional_properties: nil) ⇒ AssemblyAI::Transcripts::TranscriptCustomSpelling

Parameters:

  • from (Array<String>) —

    Words or phrases to replace

  • to (String) —

    Word or phrase to replace with

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

    Additional properties unmapped to the current class definition



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

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



16
17
18
 
# File 'lib/assemblyai/transcripts/types/transcript_custom_spelling.rb', line 16

def additional_properties
  @additional_properties
end

#from ⇒ Array<String> (readonly)

Returns Words or phrases to replace.

Returns:

  • (Array<String>) —

    Words or phrases to replace



12
13
14
 
# File 'lib/assemblyai/transcripts/types/transcript_custom_spelling.rb', line 12

def from
  @from
end

#to ⇒ String (readonly)

Returns Word or phrase to replace with.

Returns:

  • (String) —

    Word or phrase to replace with



14
15
16
 
# File 'lib/assemblyai/transcripts/types/transcript_custom_spelling.rb', line 14

def to
  @to
end

Class Method Details

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

Deserialize a JSON object to an instance of TranscriptCustomSpelling

Parameters:

  • json_object (String)

Returns:



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

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


62
63
64
65
 
# File 'lib/assemblyai/transcripts/types/transcript_custom_spelling.rb', line 62

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of TranscriptCustomSpelling to a JSON object

Returns:

  • (String) 


52
53
54
 
# File 'lib/assemblyai/transcripts/types/transcript_custom_spelling.rb', line 52

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