bandwidth-sdk 12.1.0 → 13.1.0

data/lib/bandwidth-sdk/api_client.rb

@@ -6,7 +6,7 @@
 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
+Generator version: 7.7.0
 
 =end
 
@@ -17,6 +17,8 @@ require 'tempfile'
 require 'time'
 require 'faraday'
 require 'faraday/multipart' if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
+require 'marcel'
+
 
 module Bandwidth
   class ApiClient
@@ -48,9 +50,11 @@ module Bandwidth
     # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
     #   the data deserialized from response body (could be nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
+      stream = nil
       begin
         response = connection(opts).public_send(http_method.to_sym.downcase) do |req|
-          build_request(http_method, path, req, opts)
+          request = build_request(http_method, path, req, opts)
+          stream = download_file(request) if opts[:return_type] == 'File' || opts[:return_type] == 'Binary'
         end
 
         if config.debugging
@@ -75,7 +79,9 @@ module Bandwidth
         fail ApiError.new('Connection failed')
       end
 
-      if opts[:return_type]
+      if opts[:return_type] == 'File' || opts[:return_type] == 'Binary'
+        data = deserialize_file(response, stream)
+      elsif opts[:return_type]
         data = deserialize(response, opts[:return_type])
       else
         data = nil
@@ -117,7 +123,6 @@ module Bandwidth
 
       request.url url
       request.params = query_params
-      download_file(request) if opts[:return_type] == 'File' || opts[:return_type] == 'Binary'
       request
     end
 
@@ -136,8 +141,7 @@ module Bandwidth
         form_params.each do |key, value|
           case value
           when ::File, ::Tempfile
-            # TODO hardcode to application/octet-stream, need better way to detect content type
-            data[key] = Faraday::FilePart.new(value.path, 'application/octet-stream', value.path)
+            data[key] = Faraday::FilePart.new(value.path, Marcel::MimeType.for(Pathname.new(value.path)))
           when ::Array, nil
             # let Faraday handle Array and nil parameters
             data[key] = value
@@ -154,11 +158,40 @@ module Bandwidth
     end
 
     def download_file(request)
-      @stream = []
+      stream = []
 
       # handle streaming Responses
       request.options.on_data = Proc.new do |chunk, overall_received_bytes|
-        @stream << chunk
+        stream << chunk
+      end
+      stream
+    end
+
+    def deserialize_file(response, stream)
+      body = response.body
+      if @config.return_binary_data == true
+        # return byte stream
+        encoding = body.encoding
+        stream.join.force_encoding(encoding)
+      else
+        # return file instead of binary data
+        content_disposition = response.headers['Content-Disposition']
+        if content_disposition && content_disposition =~ /filename=/i
+          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+          prefix = sanitize_filename(filename)
+        else
+          prefix = 'download-'
+        end
+        prefix = prefix + '-' unless prefix.end_with?('-')
+        encoding = body.encoding
+        tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+        tempfile.write(stream.join.force_encoding(encoding))
+        tempfile.close
+        config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                            "explicitly with `tempfile.delete`"
+        tempfile
       end
     end
 
@@ -216,7 +249,7 @@ module Bandwidth
     # @param [String] mime MIME
     # @return [Boolean] True if the MIME is application/json
     def json_mime?(mime)
-      (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
+      (mime == '*/*') || !(mime =~ /^Application\/.*json(?!p)(;.*)?/i).nil?
     end
 
     # Deserialize the response to the given return type.
@@ -225,40 +258,10 @@ module Bandwidth
     # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
     def deserialize(response, return_type)
       body = response.body
-
-      # handle file downloading - return the File instance processed in request callbacks
-      # note that response body is empty when the file is written in chunks in request on_body callback
-      if return_type == 'File'
-        if @config.return_binary_data == true
-          # return byte stream
-          encoding = body.encoding
-          return @stream.join.force_encoding(encoding)
-        else
-          # return file instead of binary data
-          content_disposition = response.headers['Content-Disposition']
-          if content_disposition && content_disposition =~ /filename=/i
-            filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-            prefix = sanitize_filename(filename)
-          else
-            prefix = 'download-'
-          end
-          prefix = prefix + '-' unless prefix.end_with?('-')
-          encoding = body.encoding
-          @tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
-          @tempfile.write(@stream.join.force_encoding(encoding))
-          @tempfile.close
-          @config.logger.info "Temp file written to #{@tempfile.path}, please copy the file to a proper folder "\
-                              "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                              "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                              "explicitly with `tempfile.delete`"
-          return @tempfile
-        end
-      end
-
       return nil if body.nil? || body.empty?
 
       # return response body directly for String return type
-      return body if return_type == 'String'
+      return body.to_s if return_type == 'String'
 
       # ensuring a default content type
       content_type = response.headers['Content-Type'] || 'application/json'
@@ -325,7 +328,7 @@ module Bandwidth
     # @param [String] filename the filename to be sanitized
     # @return [String] the sanitized filename
     def sanitize_filename(filename)
-      filename.gsub(/.*[\/\\]/, '')
+      filename.split(/[\/\\]/).last
     end
 
     def build_request_url(path, opts = {})

data/lib/bandwidth-sdk/api_error.rb

@@ -6,7 +6,7 @@
 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
+Generator version: 7.7.0
 
 =end
 

data/lib/bandwidth-sdk/configuration.rb

@@ -6,7 +6,7 @@
 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
+Generator version: 7.7.0
 
 =end
 
@@ -79,6 +79,14 @@ module Bandwidth
     # @return [true, false]
     attr_accessor :debugging
 
+    # Set this to ignore operation servers for the API client. This is useful when you need to
+    # send requests to a different server than the one specified in the OpenAPI document.
+    # Will default to the base url defined in the spec but can be overridden by setting
+    # `scheme`, `host`, `base_path` directly.
+    # Default to false.
+    # @return [true, false]
+    attr_accessor :ignore_operation_servers
+
     # Defines the logger used for debugging.
     # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
     #
@@ -170,6 +178,7 @@ module Bandwidth
       @return_binary_data = false
       @params_encoder = nil
       @debugging = false
+      @ignore_operation_servers = false
       @inject_format = false
       @force_ending_format = false
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
@@ -204,6 +213,7 @@ module Bandwidth
 
     # Returns base URL for specified operation based on server settings
     def base_url(operation = nil)
+      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if ignore_operation_servers
       if operation_server_settings.key?(operation) then
         index = server_operation_index.fetch(operation, server_index)
         server_url(index.nil? ? 0 : index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])

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

@@ -6,7 +6,7 @@
 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
+Generator version: 7.7.0
 
 =end
 
@@ -170,7 +170,7 @@ module Bandwidth
       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)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

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

@@ -6,7 +6,7 @@
 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
+Generator version: 7.7.0
 
 =end
 
@@ -315,7 +315,7 @@ module Bandwidth
       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)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

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

@@ -6,7 +6,7 @@
 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
+Generator version: 7.7.0
 
 =end
 
@@ -337,7 +337,7 @@ module Bandwidth
       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)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

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

@@ -6,7 +6,7 @@
 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
+Generator version: 7.7.0
 
 =end
 
@@ -305,7 +305,7 @@ module Bandwidth
       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)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

data/lib/bandwidth-sdk/models/bxml/root.rb

@@ -36,12 +36,6 @@ module Bandwidth
         @nested_verbs.push(*nested_verbs)
       end
 
-      extend Gem::Deprecate
-      def add_verb(nested_verbs)
-        add_verbs(nested_verbs)
-      end
-      deprecate(:add_verb, 'add_verbs', 2024, 7)
-
       # Return BXML representaion of this response
       # @return [String] The XML response in string format.
       def to_bxml

data/lib/bandwidth-sdk/models/bxml/verbs/gather.rb

@@ -37,12 +37,6 @@ module Bandwidth
       def add_audio_verbs(audio_verbs)
         @nested_verbs.push(*audio_verbs)
       end
-
-      extend Gem::Deprecate
-      def add_audio_verb(audio_verbs)
-        add_audio_verbs(audio_verbs)
-      end
-      deprecate(:add_audio_verb, 'add_audio_verbs', 2024, 7)
     end
   end
 end

data/lib/bandwidth-sdk/models/bxml/verbs/start_stream.rb

@@ -23,12 +23,6 @@ module Bandwidth
       def add_stream_params(stream_params)
         @nested_verbs.push(*stream_params)
       end
-
-      extend Gem::Deprecate
-      def add_stream_param(stream_params)
-        add_stream_params(stream_params)
-      end
-      deprecate(:add_stream_param, 'add_stream_params', 2024, 7)
     end
   end
 end

data/lib/bandwidth-sdk/models/bxml/verbs/start_transcription.rb

@@ -24,12 +24,6 @@ module Bandwidth
       def add_custom_params(custom_params)
         @nested_verbs.push(*custom_params)
       end
-
-      extend Gem::Deprecate
-      def add_custom_param(custom_params)
-        add_custom_params(custom_params)
-      end
-      deprecate(:add_custom_param, 'add_custom_params', 2024, 7)
     end
   end
 end

data/lib/bandwidth-sdk/models/bxml/verbs/transfer.rb

@@ -30,12 +30,6 @@ module Bandwidth
       def add_transfer_recipients(recipients)
         @nested_verbs.push(*recipients)
       end
-
-      extend Gem::Deprecate
-      def add_transfer_recipient(recipients)
-        add_transfer_recipients(recipients)
-      end
-      deprecate(:add_transfer_recipient, 'add_transfer_recipients', 2024, 7)
     end
   end
 end

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

@@ -6,7 +6,7 @@
 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
+Generator version: 7.7.0
 
 =end
 

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

@@ -6,7 +6,7 @@
 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
+Generator version: 7.7.0
 
 =end
 
@@ -66,6 +66,9 @@ module Bandwidth
 
     attr_accessor :transcription
 
+    # A name to identify this recording.
+    attr_accessor :recording_name
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -108,7 +111,8 @@ module Bandwidth
         :'file_format' => :'fileFormat',
         :'status' => :'status',
         :'media_url' => :'mediaUrl',
-        :'transcription' => :'transcription'
+        :'transcription' => :'transcription',
+        :'recording_name' => :'recordingName'
       }
     end
 
@@ -137,7 +141,8 @@ module Bandwidth
         :'file_format' => :'FileFormatEnum',
         :'status' => :'String',
         :'media_url' => :'String',
-        :'transcription' => :'RecordingTranscriptionMetadata'
+        :'transcription' => :'RecordingTranscriptionMetadata',
+        :'recording_name' => :'String'
       }
     end
 
@@ -145,7 +150,7 @@ module Bandwidth
     def self.openapi_nullable
       Set.new([
         :'media_url',
-        :'transcription'
+        :'transcription',
       ])
     end
 
@@ -235,6 +240,10 @@ module Bandwidth
       if attributes.key?(:'transcription')
         self.transcription = attributes[:'transcription']
       end
+
+      if attributes.key?(:'recording_name')
+        self.recording_name = attributes[:'recording_name']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -274,7 +283,8 @@ module Bandwidth
           file_format == o.file_format &&
           status == o.status &&
           media_url == o.media_url &&
-          transcription == o.transcription
+          transcription == o.transcription &&
+          recording_name == o.recording_name
     end
 
     # @see the `==` method
@@ -286,7 +296,7 @@ module Bandwidth
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [application_id, account_id, call_id, parent_call_id, recording_id, to, from, transfer_caller_id, transfer_to, duration, direction, channels, start_time, end_time, file_format, status, media_url, transcription].hash
+      [application_id, account_id, call_id, parent_call_id, recording_id, to, from, transfer_caller_id, transfer_to, duration, direction, channels, start_time, end_time, file_format, status, media_url, transcription, recording_name].hash
     end
 
     # Builds the object from hash
@@ -351,7 +361,7 @@ module Bandwidth
       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)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

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

@@ -6,7 +6,7 @@
 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
+Generator version: 7.7.0
 
 =end
 
@@ -363,7 +363,7 @@ module Bandwidth
       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)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

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

@@ -6,7 +6,7 @@
 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
+Generator version: 7.7.0
 
 =end
 

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

@@ -6,7 +6,7 @@
 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
+Generator version: 7.7.0
 
 =end
 
@@ -15,14 +15,12 @@ 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
+    attr_accessor :transcript
 
     # How confident the transcription engine was in transcribing the associated audio (from `0` to `1`).
     attr_accessor :confidence
@@ -54,7 +52,7 @@ module Bandwidth
       {
         :'detected_language' => :'detectedLanguage',
         :'track' => :'track',
-        :'text' => :'text',
+        :'transcript' => :'transcript',
         :'confidence' => :'confidence'
       }
     end
@@ -67,9 +65,9 @@ module Bandwidth
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'detected_language' => :'String',
-        :'track' => :'String',
-        :'text' => :'String',
+        :'detected_language' => :'CallTranscriptionDetectedLanguageEnum',
+        :'track' => :'CallTranscriptionTrackEnum',
+        :'transcript' => :'String',
         :'confidence' => :'Float'
       }
     end
@@ -103,8 +101,8 @@ module Bandwidth
         self.track = attributes[:'track']
       end
 
-      if attributes.key?(:'text')
-        self.text = attributes[:'text']
+      if attributes.key?(:'transcript')
+        self.transcript = attributes[:'transcript']
       end
 
       if attributes.key?(:'confidence')
@@ -132,35 +130,11 @@ module Bandwidth
     # @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)
@@ -186,7 +160,7 @@ module Bandwidth
       self.class == o.class &&
           detected_language == o.detected_language &&
           track == o.track &&
-          text == o.text &&
+          transcript == o.transcript &&
           confidence == o.confidence
     end
 
@@ -199,7 +173,7 @@ module Bandwidth
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [detected_language, track, text, confidence].hash
+      [detected_language, track, transcript, confidence].hash
     end
 
     # Builds the object from hash
@@ -264,7 +238,7 @@ module Bandwidth
       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)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

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

@@ -0,0 +1,41 @@
+=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
+Generator version: 7.7.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Bandwidth
+  class CallTranscriptionDetectedLanguageEnum
+    EN_US = 'en-US'.freeze
+    ES_US = 'es-US'.freeze
+    FR_FR = 'fr-FR'.freeze
+
+    def self.all_vars
+      @all_vars ||= [EN_US, ES_US, FR_FR].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if CallTranscriptionDetectedLanguageEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #CallTranscriptionDetectedLanguageEnum"
+    end
+  end
+end