assemblyai 1.0.0.pre.beta.6 → 1.0.0.pre.beta.8

data/lib/assemblyai/transcripts/types/transcript_custom_spelling.rb

@@ -1,46 +1,61 @@
 # frozen_string_literal: true
 
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
-    # Object containing words or phrases to replace, and the word or phrase to replace with
+    # Object containing words or phrases to replace, and the word or phrase to replace
+    #  with
     class TranscriptCustomSpelling
-      attr_reader :from, :to, :additional_properties
+      # @return [Array<String>] Words or phrases to replace
+      attr_reader :from
+      # @return [String] Word or phrase to replace with
+      attr_reader :to
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
 
       # @param from [Array<String>] Words or phrases to replace
       # @param to [String] Word or phrase to replace with
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::TranscriptCustomSpelling]
+      # @return [AssemblyAI::Transcripts::TranscriptCustomSpelling]
       def initialize(from:, to:, additional_properties: nil)
-        # @type [Array<String>] Words or phrases to replace
         @from = from
-        # @type [String] Word or phrase to replace with
         @to = to
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = { "from": from, "to": to }
       end
 
       # Deserialize a JSON object to an instance of TranscriptCustomSpelling
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::TranscriptCustomSpelling]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::TranscriptCustomSpelling]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
-        JSON.parse(json_object)
-        from = struct.from
-        to = struct.to
-        new(from: from, to: to, additional_properties: struct)
+        from = struct["from"]
+        to = struct["to"]
+        new(
+          from: from,
+          to: to,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of TranscriptCustomSpelling to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "from": @from, "to": @to }.to_json
+        @_field_set&.to_json
       end
 
-      # 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.
+      # 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.
       #
       # @param obj [Object]
       # @return [Void]

data/lib/assemblyai/transcripts/types/transcript_language_code.rb

@@ -2,8 +2,9 @@
 
 module AssemblyAI
   class Transcripts
-    # The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/concepts/supported-languages).
-    # The default value is 'en_us'.
+    # The language of your audio file. Possible values are found in [Supported
+    #  Languages](https://www.assemblyai.com/docs/concepts/supported-languages).
+    #  The default value is 'en_us'.
     class TranscriptLanguageCode
       EN = "en"
       EN_AU = "en_au"

data/lib/assemblyai/transcripts/types/transcript_list.rb

@@ -2,30 +2,41 @@
 
 require_relative "page_details"
 require_relative "transcript_list_item"
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
+    # A list of transcripts. Transcripts are sorted from newest to oldest. The
+    #  previous URL always points to a page with older transcripts.
     class TranscriptList
-      attr_reader :page_details, :transcripts, :additional_properties
+      # @return [AssemblyAI::Transcripts::PageDetails]
+      attr_reader :page_details
+      # @return [Array<AssemblyAI::Transcripts::TranscriptListItem>]
+      attr_reader :transcripts
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
 
-      # @param page_details [Transcripts::PageDetails]
-      # @param transcripts [Array<Transcripts::TranscriptListItem>]
+      OMIT = Object.new
+
+      # @param page_details [AssemblyAI::Transcripts::PageDetails]
+      # @param transcripts [Array<AssemblyAI::Transcripts::TranscriptListItem>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::TranscriptList]
+      # @return [AssemblyAI::Transcripts::TranscriptList]
       def initialize(page_details:, transcripts:, additional_properties: nil)
-        # @type [Transcripts::PageDetails]
         @page_details = page_details
-        # @type [Array<Transcripts::TranscriptListItem>]
         @transcripts = transcripts
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = { "page_details": page_details, "transcripts": transcripts }
       end
 
       # Deserialize a JSON object to an instance of TranscriptList
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::TranscriptList]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::TranscriptList]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
@@ -33,28 +44,34 @@ module AssemblyAI
           page_details = nil
         else
           page_details = parsed_json["page_details"].to_json
-          page_details = Transcripts::PageDetails.from_json(json_object: page_details)
+          page_details = AssemblyAI::Transcripts::PageDetails.from_json(json_object: page_details)
         end
         transcripts = parsed_json["transcripts"]&.map do |v|
           v = v.to_json
-          Transcripts::TranscriptListItem.from_json(json_object: v)
+          AssemblyAI::Transcripts::TranscriptListItem.from_json(json_object: v)
         end
-        new(page_details: page_details, transcripts: transcripts, additional_properties: struct)
+        new(
+          page_details: page_details,
+          transcripts: transcripts,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of TranscriptList to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "page_details": @page_details, "transcripts": @transcripts }.to_json
+        @_field_set&.to_json
       end
 
-      # 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.
+      # 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.
       #
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        Transcripts::PageDetails.validate_raw(obj: obj.page_details)
+        AssemblyAI::Transcripts::PageDetails.validate_raw(obj: obj.page_details)
         obj.transcripts.is_a?(Array) != false || raise("Passed value for field obj.transcripts is not the expected type, validation failed.")
       end
     end

data/lib/assemblyai/transcripts/types/transcript_list_item.rb

@@ -2,80 +2,113 @@
 
 require_relative "transcript_status"
 require "date"
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     class TranscriptListItem
-      attr_reader :id, :resource_url, :status, :created, :completed, :audio_url, :additional_properties
+      # @return [String]
+      attr_reader :id
+      # @return [String]
+      attr_reader :resource_url
+      # @return [AssemblyAI::Transcripts::TranscriptStatus]
+      attr_reader :status
+      # @return [DateTime]
+      attr_reader :created
+      # @return [DateTime]
+      attr_reader :completed
+      # @return [String]
+      attr_reader :audio_url
+      # @return [String] Error message of why the transcript failed
+      attr_reader :error
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
 
       # @param id [String]
       # @param resource_url [String]
-      # @param status [Transcripts::TranscriptStatus]
+      # @param status [AssemblyAI::Transcripts::TranscriptStatus]
       # @param created [DateTime]
       # @param completed [DateTime]
       # @param audio_url [String]
+      # @param error [String] Error message of why the transcript failed
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::TranscriptListItem]
-      def initialize(id:, resource_url:, status:, created:, completed:, audio_url:, additional_properties: nil)
-        # @type [String]
+      # @return [AssemblyAI::Transcripts::TranscriptListItem]
+      def initialize(id:, resource_url:, status:, created:, completed:, audio_url:, error: OMIT,
+                     additional_properties: nil)
         @id = id
-        # @type [String]
         @resource_url = resource_url
-        # @type [Transcripts::TranscriptStatus]
         @status = status
-        # @type [DateTime]
         @created = created
-        # @type [DateTime]
         @completed = completed
-        # @type [String]
         @audio_url = audio_url
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @error = error if error != OMIT
         @additional_properties = additional_properties
+        @_field_set = {
+          "id": id,
+          "resource_url": resource_url,
+          "status": status,
+          "created": created,
+          "completed": completed,
+          "audio_url": audio_url,
+          "error": error
+        }.reject do |_k, v|
+          v == OMIT
+        end
       end
 
       # Deserialize a JSON object to an instance of TranscriptListItem
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::TranscriptListItem]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::TranscriptListItem]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        id = struct.id
-        resource_url = struct.resource_url
-        status = struct.status
+        id = struct["id"]
+        resource_url = struct["resource_url"]
+        status = struct["status"]
         created = (DateTime.parse(parsed_json["created"]) unless parsed_json["created"].nil?)
         completed = (DateTime.parse(parsed_json["completed"]) unless parsed_json["completed"].nil?)
-        audio_url = struct.audio_url
-        new(id: id, resource_url: resource_url, status: status, created: created, completed: completed,
-            audio_url: audio_url, additional_properties: struct)
+        audio_url = struct["audio_url"]
+        error = struct["error"]
+        new(
+          id: id,
+          resource_url: resource_url,
+          status: status,
+          created: created,
+          completed: completed,
+          audio_url: audio_url,
+          error: error,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of TranscriptListItem to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        {
-          "id": @id,
-          "resource_url": @resource_url,
-          "status": @status,
-          "created": @created,
-          "completed": @completed,
-          "audio_url": @audio_url
-        }.to_json
+        @_field_set&.to_json
       end
 
-      # 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.
+      # 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.
       #
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
         obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
         obj.resource_url.is_a?(String) != false || raise("Passed value for field obj.resource_url is not the expected type, validation failed.")
-        obj.status.is_a?(Transcripts::TranscriptStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+        obj.status.is_a?(AssemblyAI::Transcripts::TranscriptStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
         obj.created.is_a?(DateTime) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
         obj.completed.is_a?(DateTime) != false || raise("Passed value for field obj.completed is not the expected type, validation failed.")
         obj.audio_url.is_a?(String) != false || raise("Passed value for field obj.audio_url is not the expected type, validation failed.")
+        obj.error&.is_a?(String) != false || raise("Passed value for field obj.error is not the expected type, validation failed.")
       end
     end
   end