assemblyai 1.0.0.pre.beta.7 → 1.0.0.pre.beta.8

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

@@ -1,49 +1,65 @@
 # frozen_string_literal: true
 
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     class ContentSafetyLabel
-      attr_reader :label, :confidence, :severity, :additional_properties
+      # @return [String] The label of the sensitive topic
+      attr_reader :label
+      # @return [Float] The confidence score for the topic being discussed, from 0 to 1
+      attr_reader :confidence
+      # @return [Float] How severely the topic is discussed in the section, from 0 to 1
+      attr_reader :severity
+      # @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 label [String] The label of the sensitive topic
       # @param confidence [Float] The confidence score for the topic being discussed, from 0 to 1
       # @param severity [Float] How severely the topic is discussed in the section, from 0 to 1
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::ContentSafetyLabel]
+      # @return [AssemblyAI::Transcripts::ContentSafetyLabel]
       def initialize(label:, confidence:, severity:, additional_properties: nil)
-        # @type [String] The label of the sensitive topic
         @label = label
-        # @type [Float] The confidence score for the topic being discussed, from 0 to 1
         @confidence = confidence
-        # @type [Float] How severely the topic is discussed in the section, from 0 to 1
         @severity = severity
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = { "label": label, "confidence": confidence, "severity": severity }
       end
 
       # Deserialize a JSON object to an instance of ContentSafetyLabel
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::ContentSafetyLabel]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::ContentSafetyLabel]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
-        JSON.parse(json_object)
-        label = struct.label
-        confidence = struct.confidence
-        severity = struct.severity
-        new(label: label, confidence: confidence, severity: severity, additional_properties: struct)
+        label = struct["label"]
+        confidence = struct["confidence"]
+        severity = struct["severity"]
+        new(
+          label: label,
+          confidence: confidence,
+          severity: severity,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of ContentSafetyLabel to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "label": @label, "confidence": @confidence, "severity": @severity }.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/content_safety_label_result.rb

@@ -2,73 +2,95 @@
 
 require_relative "content_safety_label"
 require_relative "timestamp"
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     class ContentSafetyLabelResult
-      attr_reader :text, :labels, :sentences_idx_start, :sentences_idx_end, :timestamp, :additional_properties
+      # @return [String] The transcript of the section flagged by the Content Moderation model
+      attr_reader :text
+      # @return [Array<AssemblyAI::Transcripts::ContentSafetyLabel>] An array of safety labels, one per sensitive topic that was detected in the
+      #  section
+      attr_reader :labels
+      # @return [Integer] The sentence index at which the section begins
+      attr_reader :sentences_idx_start
+      # @return [Integer] The sentence index at which the section ends
+      attr_reader :sentences_idx_end
+      # @return [AssemblyAI::Transcripts::Timestamp] Timestamp information for the section
+      attr_reader :timestamp
+      # @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 text [String] The transcript of the section flagged by the Content Moderation model
-      # @param labels [Array<Transcripts::ContentSafetyLabel>] An array of safety labels, one per sensitive topic that was detected in the section
+      # @param labels [Array<AssemblyAI::Transcripts::ContentSafetyLabel>] An array of safety labels, one per sensitive topic that was detected in the
+      #  section
       # @param sentences_idx_start [Integer] The sentence index at which the section begins
       # @param sentences_idx_end [Integer] The sentence index at which the section ends
-      # @param timestamp [Transcripts::Timestamp] Timestamp information for the section
+      # @param timestamp [AssemblyAI::Transcripts::Timestamp] Timestamp information for the section
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::ContentSafetyLabelResult]
+      # @return [AssemblyAI::Transcripts::ContentSafetyLabelResult]
       def initialize(text:, labels:, sentences_idx_start:, sentences_idx_end:, timestamp:, additional_properties: nil)
-        # @type [String] The transcript of the section flagged by the Content Moderation model
         @text = text
-        # @type [Array<Transcripts::ContentSafetyLabel>] An array of safety labels, one per sensitive topic that was detected in the section
         @labels = labels
-        # @type [Integer] The sentence index at which the section begins
         @sentences_idx_start = sentences_idx_start
-        # @type [Integer] The sentence index at which the section ends
         @sentences_idx_end = sentences_idx_end
-        # @type [Transcripts::Timestamp] Timestamp information for the section
         @timestamp = timestamp
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = {
+          "text": text,
+          "labels": labels,
+          "sentences_idx_start": sentences_idx_start,
+          "sentences_idx_end": sentences_idx_end,
+          "timestamp": timestamp
+        }
       end
 
       # Deserialize a JSON object to an instance of ContentSafetyLabelResult
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::ContentSafetyLabelResult]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::ContentSafetyLabelResult]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        text = struct.text
+        text = struct["text"]
         labels = parsed_json["labels"]&.map do |v|
           v = v.to_json
-          Transcripts::ContentSafetyLabel.from_json(json_object: v)
+          AssemblyAI::Transcripts::ContentSafetyLabel.from_json(json_object: v)
         end
-        sentences_idx_start = struct.sentences_idx_start
-        sentences_idx_end = struct.sentences_idx_end
+        sentences_idx_start = struct["sentences_idx_start"]
+        sentences_idx_end = struct["sentences_idx_end"]
         if parsed_json["timestamp"].nil?
           timestamp = nil
         else
           timestamp = parsed_json["timestamp"].to_json
-          timestamp = Transcripts::Timestamp.from_json(json_object: timestamp)
+          timestamp = AssemblyAI::Transcripts::Timestamp.from_json(json_object: timestamp)
         end
-        new(text: text, labels: labels, sentences_idx_start: sentences_idx_start, sentences_idx_end: sentences_idx_end,
-            timestamp: timestamp, additional_properties: struct)
+        new(
+          text: text,
+          labels: labels,
+          sentences_idx_start: sentences_idx_start,
+          sentences_idx_end: sentences_idx_end,
+          timestamp: timestamp,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of ContentSafetyLabelResult to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        {
-          "text": @text,
-          "labels": @labels,
-          "sentences_idx_start": @sentences_idx_start,
-          "sentences_idx_end": @sentences_idx_end,
-          "timestamp": @timestamp
-        }.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]
@@ -77,7 +99,7 @@ module AssemblyAI
         obj.labels.is_a?(Array) != false || raise("Passed value for field obj.labels is not the expected type, validation failed.")
         obj.sentences_idx_start.is_a?(Integer) != false || raise("Passed value for field obj.sentences_idx_start is not the expected type, validation failed.")
         obj.sentences_idx_end.is_a?(Integer) != false || raise("Passed value for field obj.sentences_idx_end is not the expected type, validation failed.")
-        Transcripts::Timestamp.validate_raw(obj: obj.timestamp)
+        AssemblyAI::Transcripts::Timestamp.validate_raw(obj: obj.timestamp)
       end
     end
   end

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

@@ -2,73 +2,95 @@
 
 require_relative "audio_intelligence_model_status"
 require_relative "content_safety_label_result"
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     # An array of results for the Content Moderation model, if it is enabled.
-    # See [Content moderation](https://www.assemblyai.com/docs/models/content-moderation) for more information.
+    #  See [Content
+    #  moderation](https://www.assemblyai.com/docs/models/content-moderation) for more
+    #  information.
     class ContentSafetyLabelsResult
-      attr_reader :status, :results, :summary, :severity_score_summary, :additional_properties
+      # @return [AssemblyAI::Transcripts::AudioIntelligenceModelStatus] The status of the Content Moderation model. Either success, or unavailable in
+      #  the rare case that the model failed.
+      attr_reader :status
+      # @return [Array<AssemblyAI::Transcripts::ContentSafetyLabelResult>]
+      attr_reader :results
+      # @return [Hash{String => Float}] A summary of the Content Moderation confidence results for the entire audio file
+      attr_reader :summary
+      # @return [Hash{String => AssemblyAI::Transcripts::SeverityScoreSummary}] A summary of the Content Moderation severity results for the entire audio file
+      attr_reader :severity_score_summary
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
 
-      # @param status [Transcripts::AudioIntelligenceModelStatus] The status of the Content Moderation model. Either success, or unavailable in the rare case that the model failed.
-      # @param results [Array<Transcripts::ContentSafetyLabelResult>]
+      OMIT = Object.new
+
+      # @param status [AssemblyAI::Transcripts::AudioIntelligenceModelStatus] The status of the Content Moderation model. Either success, or unavailable in
+      #  the rare case that the model failed.
+      # @param results [Array<AssemblyAI::Transcripts::ContentSafetyLabelResult>]
       # @param summary [Hash{String => Float}] A summary of the Content Moderation confidence results for the entire audio file
-      # @param severity_score_summary [Hash{String => Transcripts::SeverityScoreSummary}] A summary of the Content Moderation severity results for the entire audio file
+      # @param severity_score_summary [Hash{String => AssemblyAI::Transcripts::SeverityScoreSummary}] A summary of the Content Moderation severity results for the entire audio file
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::ContentSafetyLabelsResult]
+      # @return [AssemblyAI::Transcripts::ContentSafetyLabelsResult]
       def initialize(status:, results:, summary:, severity_score_summary:, additional_properties: nil)
-        # @type [Transcripts::AudioIntelligenceModelStatus] The status of the Content Moderation model. Either success, or unavailable in the rare case that the model failed.
         @status = status
-        # @type [Array<Transcripts::ContentSafetyLabelResult>]
         @results = results
-        # @type [Hash{String => Float}] A summary of the Content Moderation confidence results for the entire audio file
         @summary = summary
-        # @type [Hash{String => Transcripts::SeverityScoreSummary}] A summary of the Content Moderation severity results for the entire audio file
         @severity_score_summary = severity_score_summary
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = {
+          "status": status,
+          "results": results,
+          "summary": summary,
+          "severity_score_summary": severity_score_summary
+        }
       end
 
       # Deserialize a JSON object to an instance of ContentSafetyLabelsResult
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::ContentSafetyLabelsResult]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::ContentSafetyLabelsResult]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        status = struct.status
+        status = struct["status"]
         results = parsed_json["results"]&.map do |v|
           v = v.to_json
-          Transcripts::ContentSafetyLabelResult.from_json(json_object: v)
+          AssemblyAI::Transcripts::ContentSafetyLabelResult.from_json(json_object: v)
         end
-        summary = struct.summary
-        severity_score_summary = parsed_json["severity_score_summary"]&.transform_values do |_k, v|
+        summary = struct["summary"]
+        severity_score_summary = parsed_json["severity_score_summary"]&.transform_values do |v|
           v = v.to_json
-          Transcripts::SeverityScoreSummary.from_json(json_object: v)
+          AssemblyAI::Transcripts::SeverityScoreSummary.from_json(json_object: v)
         end
-        new(status: status, results: results, summary: summary, severity_score_summary: severity_score_summary,
-            additional_properties: struct)
+        new(
+          status: status,
+          results: results,
+          summary: summary,
+          severity_score_summary: severity_score_summary,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of ContentSafetyLabelsResult to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        {
-          "status": @status,
-          "results": @results,
-          "summary": @summary,
-          "severity_score_summary": @severity_score_summary
-        }.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.status.is_a?(Transcripts::AudioIntelligenceModelStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+        obj.status.is_a?(AssemblyAI::Transcripts::AudioIntelligenceModelStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
         obj.results.is_a?(Array) != false || raise("Passed value for field obj.results is not the expected type, validation failed.")
         obj.summary.is_a?(Hash) != false || raise("Passed value for field obj.summary is not the expected type, validation failed.")
         obj.severity_score_summary.is_a?(Hash) != false || raise("Passed value for field obj.severity_score_summary is not the expected type, validation failed.")

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

@@ -1,60 +1,80 @@
 # frozen_string_literal: true
 
 require_relative "entity_type"
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     # A detected entity
     class Entity
-      attr_reader :entity_type, :text, :start, :end_, :additional_properties
+      # @return [AssemblyAI::Transcripts::EntityType] The type of entity for the detected entity
+      attr_reader :entity_type
+      # @return [String] The text for the detected entity
+      attr_reader :text
+      # @return [Integer] The starting time, in milliseconds, at which the detected entity appears in the
+      #  audio file
+      attr_reader :start
+      # @return [Integer] The ending time, in milliseconds, for the detected entity in the audio file
+      attr_reader :end_
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
 
-      # @param entity_type [Transcripts::EntityType] The type of entity for the detected entity
+      OMIT = Object.new
+
+      # @param entity_type [AssemblyAI::Transcripts::EntityType] The type of entity for the detected entity
       # @param text [String] The text for the detected entity
-      # @param start [Integer] The starting time, in milliseconds, at which the detected entity appears in the audio file
+      # @param start [Integer] The starting time, in milliseconds, at which the detected entity appears in the
+      #  audio file
       # @param end_ [Integer] The ending time, in milliseconds, for the detected entity in the audio file
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::Entity]
+      # @return [AssemblyAI::Transcripts::Entity]
       def initialize(entity_type:, text:, start:, end_:, additional_properties: nil)
-        # @type [Transcripts::EntityType] The type of entity for the detected entity
         @entity_type = entity_type
-        # @type [String] The text for the detected entity
         @text = text
-        # @type [Integer] The starting time, in milliseconds, at which the detected entity appears in the audio file
         @start = start
-        # @type [Integer] The ending time, in milliseconds, for the detected entity in the audio file
         @end_ = end_
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = { "entity_type": entity_type, "text": text, "start": start, "end": end_ }
       end
 
       # Deserialize a JSON object to an instance of Entity
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::Entity]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::Entity]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
-        JSON.parse(json_object)
-        entity_type = struct.entity_type
-        text = struct.text
-        start = struct.start
-        end_ = struct.end
-        new(entity_type: entity_type, text: text, start: start, end_: end_, additional_properties: struct)
+        entity_type = struct["entity_type"]
+        text = struct["text"]
+        start = struct["start"]
+        end_ = struct["end"]
+        new(
+          entity_type: entity_type,
+          text: text,
+          start: start,
+          end_: end_,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of Entity to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "entity_type": @entity_type, "text": @text, "start": @start, "end": @end_ }.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.entity_type.is_a?(Transcripts::EntityType) != false || raise("Passed value for field obj.entity_type is not the expected type, validation failed.")
+        obj.entity_type.is_a?(AssemblyAI::Transcripts::EntityType) != false || raise("Passed value for field obj.entity_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.start.is_a?(Integer) != false || raise("Passed value for field obj.start is not the expected type, validation failed.")
         obj.end_.is_a?(Integer) != false || raise("Passed value for field obj.end_ is not the expected type, validation failed.")

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

@@ -1,65 +1,91 @@
 # frozen_string_literal: true
 
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
-    # Details of the transcript page. Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts.
+    # Details of the transcript page. Transcripts are sorted from newest to oldest.
+    #  The previous URL always points to a page with older transcripts.
     class PageDetails
-      attr_reader :limit, :result_count, :current_url, :prev_url, :next_url, :additional_properties
+      # @return [Integer]
+      attr_reader :limit
+      # @return [Integer]
+      attr_reader :result_count
+      # @return [String]
+      attr_reader :current_url
+      # @return [String] The URL to the next page of transcripts. The previous URL always points to a
+      #  page with older transcripts.
+      attr_reader :prev_url
+      # @return [String] The URL to the next page of transcripts. The next URL always points to a page
+      #  with newer transcripts.
+      attr_reader :next_url
+      # @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 limit [Integer]
       # @param result_count [Integer]
       # @param current_url [String]
-      # @param prev_url [String] The URL to the next page of transcripts. The previous URL always points to a page with older transcripts.
-      # @param next_url [String] The URL to the next page of transcripts. The next URL always points to a page with newer transcripts.
+      # @param prev_url [String] The URL to the next page of transcripts. The previous URL always points to a
+      #  page with older transcripts.
+      # @param next_url [String] The URL to the next page of transcripts. The next URL always points to a page
+      #  with newer transcripts.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::PageDetails]
-      def initialize(limit:, result_count:, current_url:, prev_url: nil, next_url: nil, additional_properties: nil)
-        # @type [Integer]
+      # @return [AssemblyAI::Transcripts::PageDetails]
+      def initialize(limit:, result_count:, current_url:, prev_url: OMIT, next_url: OMIT, additional_properties: nil)
         @limit = limit
-        # @type [Integer]
         @result_count = result_count
-        # @type [String]
         @current_url = current_url
-        # @type [String] The URL to the next page of transcripts. The previous URL always points to a page with older transcripts.
-        @prev_url = prev_url
-        # @type [String] The URL to the next page of transcripts. The next URL always points to a page with newer transcripts.
-        @next_url = next_url
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @prev_url = prev_url if prev_url != OMIT
+        @next_url = next_url if next_url != OMIT
         @additional_properties = additional_properties
+        @_field_set = {
+          "limit": limit,
+          "result_count": result_count,
+          "current_url": current_url,
+          "prev_url": prev_url,
+          "next_url": next_url
+        }.reject do |_k, v|
+          v == OMIT
+        end
       end
 
       # Deserialize a JSON object to an instance of PageDetails
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::PageDetails]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::PageDetails]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
-        JSON.parse(json_object)
-        limit = struct.limit
-        result_count = struct.result_count
-        current_url = struct.current_url
-        prev_url = struct.prev_url
-        next_url = struct.next_url
-        new(limit: limit, result_count: result_count, current_url: current_url, prev_url: prev_url, next_url: next_url,
-            additional_properties: struct)
+        limit = struct["limit"]
+        result_count = struct["result_count"]
+        current_url = struct["current_url"]
+        prev_url = struct["prev_url"]
+        next_url = struct["next_url"]
+        new(
+          limit: limit,
+          result_count: result_count,
+          current_url: current_url,
+          prev_url: prev_url,
+          next_url: next_url,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of PageDetails to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        {
-          "limit": @limit,
-          "result_count": @result_count,
-          "current_url": @current_url,
-          "prev_url": @prev_url,
-          "next_url": @next_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]