bandwidth-sdk 11.3.0 → 12.1.0

data/lib/bandwidth-sdk/api/transcriptions_api.rb

@@ -0,0 +1,241 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.0
+
+=end
+
+require 'cgi'
+
+module Bandwidth
+  class TranscriptionsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Delete a specific transcription
+    # Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).  Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
+    # @param account_id [String] Your Bandwidth Account ID.
+    # @param call_id [String] Programmable Voice API Call ID.
+    # @param transcription_id [String] Programmable Voice API Transcription ID.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_real_time_transcription(account_id, call_id, transcription_id, opts = {})
+      delete_real_time_transcription_with_http_info(account_id, call_id, transcription_id, opts)
+      nil
+    end
+
+    # Delete a specific transcription
+    # Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).  Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
+    # @param account_id [String] Your Bandwidth Account ID.
+    # @param call_id [String] Programmable Voice API Call ID.
+    # @param transcription_id [String] Programmable Voice API Transcription ID.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_real_time_transcription_with_http_info(account_id, call_id, transcription_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TranscriptionsApi.delete_real_time_transcription ...'
+      end
+      # verify the required parameter 'account_id' is set
+      if @api_client.config.client_side_validation && account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling TranscriptionsApi.delete_real_time_transcription"
+      end
+      # verify the required parameter 'call_id' is set
+      if @api_client.config.client_side_validation && call_id.nil?
+        fail ArgumentError, "Missing the required parameter 'call_id' when calling TranscriptionsApi.delete_real_time_transcription"
+      end
+      # verify the required parameter 'transcription_id' is set
+      if @api_client.config.client_side_validation && transcription_id.nil?
+        fail ArgumentError, "Missing the required parameter 'transcription_id' when calling TranscriptionsApi.delete_real_time_transcription"
+      end
+      # resource path
+      local_var_path = '/accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId}'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s)).sub('{' + 'callId' + '}', CGI.escape(call_id.to_s)).sub('{' + 'transcriptionId' + '}', CGI.escape(transcription_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Basic']
+
+      new_options = opts.merge(
+        :operation => :"TranscriptionsApi.delete_real_time_transcription",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TranscriptionsApi#delete_real_time_transcription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve a specific transcription
+    # Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
+    # @param account_id [String] Your Bandwidth Account ID.
+    # @param call_id [String] Programmable Voice API Call ID.
+    # @param transcription_id [String] Programmable Voice API Transcription ID.
+    # @param [Hash] opts the optional parameters
+    # @return [CallTranscriptionResponse]
+    def get_real_time_transcription(account_id, call_id, transcription_id, opts = {})
+      data, _status_code, _headers = get_real_time_transcription_with_http_info(account_id, call_id, transcription_id, opts)
+      data
+    end
+
+    # Retrieve a specific transcription
+    # Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
+    # @param account_id [String] Your Bandwidth Account ID.
+    # @param call_id [String] Programmable Voice API Call ID.
+    # @param transcription_id [String] Programmable Voice API Transcription ID.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CallTranscriptionResponse, Integer, Hash)>] CallTranscriptionResponse data, response status code and response headers
+    def get_real_time_transcription_with_http_info(account_id, call_id, transcription_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TranscriptionsApi.get_real_time_transcription ...'
+      end
+      # verify the required parameter 'account_id' is set
+      if @api_client.config.client_side_validation && account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling TranscriptionsApi.get_real_time_transcription"
+      end
+      # verify the required parameter 'call_id' is set
+      if @api_client.config.client_side_validation && call_id.nil?
+        fail ArgumentError, "Missing the required parameter 'call_id' when calling TranscriptionsApi.get_real_time_transcription"
+      end
+      # verify the required parameter 'transcription_id' is set
+      if @api_client.config.client_side_validation && transcription_id.nil?
+        fail ArgumentError, "Missing the required parameter 'transcription_id' when calling TranscriptionsApi.get_real_time_transcription"
+      end
+      # resource path
+      local_var_path = '/accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId}'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s)).sub('{' + 'callId' + '}', CGI.escape(call_id.to_s)).sub('{' + 'transcriptionId' + '}', CGI.escape(transcription_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CallTranscriptionResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Basic']
+
+      new_options = opts.merge(
+        :operation => :"TranscriptionsApi.get_real_time_transcription",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TranscriptionsApi#get_real_time_transcription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Enumerate transcriptions made with StartTranscription
+    # Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
+    # @param account_id [String] Your Bandwidth Account ID.
+    # @param call_id [String] Programmable Voice API Call ID.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<CallTranscriptionMetadata>]
+    def list_real_time_transcriptions(account_id, call_id, opts = {})
+      data, _status_code, _headers = list_real_time_transcriptions_with_http_info(account_id, call_id, opts)
+      data
+    end
+
+    # Enumerate transcriptions made with StartTranscription
+    # Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
+    # @param account_id [String] Your Bandwidth Account ID.
+    # @param call_id [String] Programmable Voice API Call ID.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<CallTranscriptionMetadata>, Integer, Hash)>] Array<CallTranscriptionMetadata> data, response status code and response headers
+    def list_real_time_transcriptions_with_http_info(account_id, call_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TranscriptionsApi.list_real_time_transcriptions ...'
+      end
+      # verify the required parameter 'account_id' is set
+      if @api_client.config.client_side_validation && account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling TranscriptionsApi.list_real_time_transcriptions"
+      end
+      # verify the required parameter 'call_id' is set
+      if @api_client.config.client_side_validation && call_id.nil?
+        fail ArgumentError, "Missing the required parameter 'call_id' when calling TranscriptionsApi.list_real_time_transcriptions"
+      end
+      # resource path
+      local_var_path = '/accounts/{accountId}/calls/{callId}/transcriptions'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s)).sub('{' + 'callId' + '}', CGI.escape(call_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<CallTranscriptionMetadata>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Basic']
+
+      new_options = opts.merge(
+        :operation => :"TranscriptionsApi.list_real_time_transcriptions",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TranscriptionsApi#list_real_time_transcriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/bandwidth-sdk/configuration.rb

@@ -410,19 +410,19 @@ module Bandwidth
           description: "Production",
           }
         ],
-        "RecordingsApi.delete_call_transcription": [
+        "RecordingsApi.delete_recording": [
           {
           url: "https://voice.bandwidth.com/api/v2",
           description: "Production",
           }
         ],
-        "RecordingsApi.delete_recording": [
+        "RecordingsApi.delete_recording_media": [
           {
           url: "https://voice.bandwidth.com/api/v2",
           description: "Production",
           }
         ],
-        "RecordingsApi.delete_recording_media": [
+        "RecordingsApi.delete_recording_transcription": [
           {
           url: "https://voice.bandwidth.com/api/v2",
           description: "Production",
@@ -440,7 +440,7 @@ module Bandwidth
           description: "Production",
           }
         ],
-        "RecordingsApi.get_call_transcription": [
+        "RecordingsApi.get_recording_transcription": [
           {
           url: "https://voice.bandwidth.com/api/v2",
           description: "Production",
@@ -476,6 +476,24 @@ module Bandwidth
           description: "Production",
           }
         ],
+        "TranscriptionsApi.delete_real_time_transcription": [
+          {
+          url: "https://voice.bandwidth.com/api/v2",
+          description: "Production",
+          }
+        ],
+        "TranscriptionsApi.get_real_time_transcription": [
+          {
+          url: "https://voice.bandwidth.com/api/v2",
+          description: "Production",
+          }
+        ],
+        "TranscriptionsApi.list_real_time_transcriptions": [
+          {
+          url: "https://voice.bandwidth.com/api/v2",
+          description: "Production",
+          }
+        ],
       }
     end
 

data/lib/bandwidth-sdk/models/answer_callback.rb

@@ -28,7 +28,7 @@ module Bandwidth
     # The id of the application associated with the call.
     attr_accessor :application_id
 
-    # The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous.
+    # The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).
     attr_accessor :from
 
     # The phone number that received the call, in E.164 format (e.g. +15555555555).

data/lib/bandwidth-sdk/models/bridge_complete_callback.rb

@@ -28,7 +28,7 @@ module Bandwidth
     # The id of the application associated with the call.
     attr_accessor :application_id
 
-    # The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous.
+    # The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).
     attr_accessor :from
 
     # The phone number that received the call, in E.164 format (e.g. +15555555555).

data/lib/bandwidth-sdk/models/bridge_target_complete_callback.rb

@@ -28,7 +28,7 @@ module Bandwidth
     # The id of the application associated with the call.
     attr_accessor :application_id
 
-    # The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous.
+    # The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).
     attr_accessor :from
 
     # The phone number that received the call, in E.164 format (e.g. +15555555555).

data/lib/bandwidth-sdk/models/call_recording_metadata.rb

@@ -33,10 +33,10 @@ module Bandwidth
     # The phone number that received the call, in E.164 format (e.g. +15555555555).
     attr_accessor :to
 
-    # The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous.
+    # The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).
     attr_accessor :from
 
-    # The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable.
+    # The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555).
     attr_accessor :transfer_caller_id
 
     # The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555).
@@ -137,7 +137,7 @@ module Bandwidth
         :'file_format' => :'FileFormatEnum',
         :'status' => :'String',
         :'media_url' => :'String',
-        :'transcription' => :'TranscriptionMetadata'
+        :'transcription' => :'RecordingTranscriptionMetadata'
       }
     end
 

data/lib/bandwidth-sdk/models/call_transcription.rb

@@ -0,0 +1,317 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Bandwidth
+  class CallTranscription
+    # The detected language for this transcription.
+    attr_accessor :detected_language
+
+    # Which `track` this transcription is derived from.
+    attr_accessor :track
+
+    # The transcription itself.
+    attr_accessor :text
+
+    # How confident the transcription engine was in transcribing the associated audio (from `0` to `1`).
+    attr_accessor :confidence
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'detected_language' => :'detectedLanguage',
+        :'track' => :'track',
+        :'text' => :'text',
+        :'confidence' => :'confidence'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'detected_language' => :'String',
+        :'track' => :'String',
+        :'text' => :'String',
+        :'confidence' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::CallTranscription` initialize method'
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::CallTranscription`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'detected_language')
+        self.detected_language = attributes[:'detected_language']
+      end
+
+      if attributes.key?(:'track')
+        self.track = attributes[:'track']
+      end
+
+      if attributes.key?(:'text')
+        self.text = attributes[:'text']
+      end
+
+      if attributes.key?(:'confidence')
+        self.confidence = attributes[:'confidence']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if !@confidence.nil? && @confidence > 1
+        invalid_properties.push('invalid value for "confidence", must be smaller than or equal to 1.')
+      end
+
+      if !@confidence.nil? && @confidence < 0
+        invalid_properties.push('invalid value for "confidence", must be greater than or equal to 0.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      detected_language_validator = EnumAttributeValidator.new('String', ['en-US', 'es-US', 'fr-FR'])
+      return false unless detected_language_validator.valid?(@detected_language)
+      track_validator = EnumAttributeValidator.new('String', ['inbound', 'outbound'])
+      return false unless track_validator.valid?(@track)
+      return false if !@confidence.nil? && @confidence > 1
+      return false if !@confidence.nil? && @confidence < 0
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] detected_language Object to be assigned
+    def detected_language=(detected_language)
+      validator = EnumAttributeValidator.new('String', ['en-US', 'es-US', 'fr-FR'])
+      unless validator.valid?(detected_language)
+        fail ArgumentError, "invalid value for \"detected_language\", must be one of #{validator.allowable_values}."
+      end
+      @detected_language = detected_language
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] track Object to be assigned
+    def track=(track)
+      validator = EnumAttributeValidator.new('String', ['inbound', 'outbound'])
+      unless validator.valid?(track)
+        fail ArgumentError, "invalid value for \"track\", must be one of #{validator.allowable_values}."
+      end
+      @track = track
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] confidence Value to be assigned
+    def confidence=(confidence)
+      if confidence.nil?
+        fail ArgumentError, 'confidence cannot be nil'
+      end
+
+      if confidence > 1
+        fail ArgumentError, 'invalid value for "confidence", must be smaller than or equal to 1.'
+      end
+
+      if confidence < 0
+        fail ArgumentError, 'invalid value for "confidence", must be greater than or equal to 0.'
+      end
+
+      @confidence = confidence
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          detected_language == o.detected_language &&
+          track == o.track &&
+          text == o.text &&
+          confidence == o.confidence
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [detected_language, track, text, confidence].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Bandwidth.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end