bandwidth-sdk 11.3.0 → 12.0.0

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

@@ -0,0 +1,214 @@
+=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 RecordingTranscriptions
+    attr_accessor :transcripts
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'transcripts' => :'transcripts'
+      }
+    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
+      {
+        :'transcripts' => :'Array<Transcription>'
+      }
+    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::RecordingTranscriptions` 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::RecordingTranscriptions`. 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?(:'transcripts')
+        if (value = attributes[:'transcripts']).is_a?(Array)
+          self.transcripts = value
+        end
+      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
+      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'
+      true
+    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 &&
+          transcripts == o.transcripts
+    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
+      [transcripts].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

data/lib/bandwidth-sdk/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 7.0.0
 =end
 
 module Bandwidth
-  VERSION = '11.3.0'
+  VERSION = '12.0.0'
 end

data/lib/bandwidth-sdk.rb

@@ -25,6 +25,9 @@ require 'bandwidth-sdk/models/call_direction_enum'
 require 'bandwidth-sdk/models/call_recording_metadata'
 require 'bandwidth-sdk/models/call_state'
 require 'bandwidth-sdk/models/call_state_enum'
+require 'bandwidth-sdk/models/call_transcription'
+require 'bandwidth-sdk/models/call_transcription_metadata'
+require 'bandwidth-sdk/models/call_transcription_response'
 require 'bandwidth-sdk/models/callback_method_enum'
 require 'bandwidth-sdk/models/code_request'
 require 'bandwidth-sdk/models/conference'
@@ -84,6 +87,8 @@ require 'bandwidth-sdk/models/priority_enum'
 require 'bandwidth-sdk/models/recording_available_callback'
 require 'bandwidth-sdk/models/recording_complete_callback'
 require 'bandwidth-sdk/models/recording_state_enum'
+require 'bandwidth-sdk/models/recording_transcription_metadata'
+require 'bandwidth-sdk/models/recording_transcriptions'
 require 'bandwidth-sdk/models/redirect_callback'
 require 'bandwidth-sdk/models/redirect_method_enum'
 require 'bandwidth-sdk/models/stir_shaken'
@@ -92,8 +97,6 @@ require 'bandwidth-sdk/models/tn_lookup_request_error'
 require 'bandwidth-sdk/models/transcribe_recording'
 require 'bandwidth-sdk/models/transcription'
 require 'bandwidth-sdk/models/transcription_available_callback'
-require 'bandwidth-sdk/models/transcription_list'
-require 'bandwidth-sdk/models/transcription_metadata'
 require 'bandwidth-sdk/models/transfer_answer_callback'
 require 'bandwidth-sdk/models/transfer_complete_callback'
 require 'bandwidth-sdk/models/transfer_disconnect_callback'
@@ -150,6 +153,7 @@ require 'bandwidth-sdk/api/messages_api'
 require 'bandwidth-sdk/api/phone_number_lookup_api'
 require 'bandwidth-sdk/api/recordings_api'
 require 'bandwidth-sdk/api/statistics_api'
+require 'bandwidth-sdk/api/transcriptions_api'
 
 module Bandwidth
   class << self

data/spec/api/calls_api_spec.rb

@@ -180,7 +180,7 @@ describe 'CallsApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @calls_api_instance.get_call_state(nil, '')
+        @calls_api_instance.get_call_state(nil, '')
       }.to raise_error(ArgumentError)
     end
 
@@ -202,7 +202,7 @@ describe 'CallsApi' do
         redirect_url: MANTECA_BASE_URL + '/bxml/pause'
       )
 
-      data, status_code, headers = @calls_api_instance.update_call_with_http_info(BW_ACCOUNT_ID, call_id, update_call_body)
+      _data, status_code, headers = @calls_api_instance.update_call_with_http_info(BW_ACCOUNT_ID, call_id, update_call_body)
 
       expect(status_code).to eq(200)
       expect(headers).to eq(update_call_headers_stub)
@@ -210,7 +210,7 @@ describe 'CallsApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @calls_api_instance.update_call(nil, '', {})
+        @calls_api_instance.update_call(nil, '', {})
       }.to raise_error(ArgumentError)
     end
 
@@ -235,7 +235,7 @@ describe 'CallsApi' do
 
       update_bxml = '<?xml version="1.0" encoding="UTF-8"?><Bxml><SpeakSentence locale="en_US" gender="female" voice="susan">This is a test bxml response</SpeakSentence><Pause duration="3"/></Bxml>'
 
-      data, status_code, headers = @calls_api_instance.update_call_bxml_with_http_info(BW_ACCOUNT_ID, call_id, update_bxml)
+      _data, status_code = @calls_api_instance.update_call_bxml_with_http_info(BW_ACCOUNT_ID, call_id, update_bxml)
 
       expect(status_code).to eq(204)
     end

data/spec/api/conferences_api_spec.rb

@@ -61,7 +61,7 @@ describe 'ConferencesApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @conferences_api_instance.download_conference_recording(nil, '', '')
+        @conferences_api_instance.download_conference_recording(nil, '', '')
       }.to raise_error(ArgumentError)
     end
 
@@ -107,7 +107,7 @@ describe 'ConferencesApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @conferences_api_instance.get_conference(nil, '')
+        @conferences_api_instance.get_conference(nil, '')
       }.to raise_error(ArgumentError)
     end
 
@@ -139,7 +139,7 @@ describe 'ConferencesApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @conferences_api_instance.get_conference_member(nil, '', '')
+        @conferences_api_instance.get_conference_member(nil, '', '')
       }.to raise_error(ArgumentError)
     end
 
@@ -182,7 +182,7 @@ describe 'ConferencesApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @conferences_api_instance.get_conference_recording(nil, '', '')
+        @conferences_api_instance.get_conference_recording(nil, '', '')
       }.to raise_error(ArgumentError)
     end
 
@@ -226,7 +226,7 @@ describe 'ConferencesApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @conferences_api_instance.list_conference_recordings(nil, '')
+        @conferences_api_instance.list_conference_recordings(nil, '')
       }.to raise_error(ArgumentError)
     end
 
@@ -263,7 +263,7 @@ describe 'ConferencesApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @conferences_api_instance.list_conferences(nil, {})
+        @conferences_api_instance.list_conferences(nil, {})
       }.to raise_error(ArgumentError)
     end
 
@@ -298,13 +298,13 @@ describe 'ConferencesApi' do
         fallback_password: 'password'
       )
 
-      data, status_code, headers = @conferences_api_instance.update_conference_with_http_info(BW_ACCOUNT_ID, conference_id, update_conference_body)
+      _data, status_code = @conferences_api_instance.update_conference_with_http_info(BW_ACCOUNT_ID, conference_id, update_conference_body)
       expect(status_code).to eq(204)
     end
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @conferences_api_instance.update_conference(nil, '', '')
+        @conferences_api_instance.update_conference(nil, '', '')
       }.to raise_error(ArgumentError)
     end
 
@@ -329,13 +329,13 @@ describe 'ConferencesApi' do
 
       update_bxml = '<?xml version="1.0" encoding="UTF-8"?><Bxml><StartRecording/><SpeakSentence locale="en_US" gender="female" voice="susan">This should be a conference recording.</SpeakSentence><StopRecording/></Bxml>'
 
-      data, status_code, headers = @conferences_api_instance.update_conference_bxml_with_http_info(BW_ACCOUNT_ID, conference_id, update_bxml)
+      _data, status_code = @conferences_api_instance.update_conference_bxml_with_http_info(BW_ACCOUNT_ID, conference_id, update_bxml)
       expect(status_code).to eq(204)
     end
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @conferences_api_instance.update_conference_bxml(nil, '', '')
+        @conferences_api_instance.update_conference_bxml(nil, '', '')
       }.to raise_error(ArgumentError)
     end
 
@@ -362,13 +362,13 @@ describe 'ConferencesApi' do
         mute: false
       )
 
-      data, status_code, headers = @conferences_api_instance.update_conference_member_with_http_info(BW_ACCOUNT_ID, conference_id, call_id, update_conference_member)
+      _data, status_code = @conferences_api_instance.update_conference_member_with_http_info(BW_ACCOUNT_ID, conference_id, call_id, update_conference_member)
       expect(status_code).to eq(204)
     end
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @conferences_api_instance.update_conference_member(nil, '', '', {})
+        @conferences_api_instance.update_conference_member(nil, '', '', {})
       }.to raise_error(ArgumentError)
     end
 

data/spec/api/media_api_spec.rb

@@ -30,14 +30,14 @@ describe 'MediaApi' do
       stub_request(:delete, "https://messaging.bandwidth.com/api/v2/users/#{BW_ACCOUNT_ID}/media/#{media_name}").
       to_return(status: 204)
 
-      data, status_code, headers = @media_api_instance.delete_media_with_http_info(BW_ACCOUNT_ID, media_name)
+      _data, status_code = @media_api_instance.delete_media_with_http_info(BW_ACCOUNT_ID, media_name)
 
       expect(status_code).to eq(204)
     end
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @media_api_instance.delete_media(nil, '')
+        @media_api_instance.delete_media(nil, '')
       }.to raise_error(ArgumentError)
     end
 
@@ -63,7 +63,7 @@ describe 'MediaApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @media_api_instance.get_media(nil, '')
+        @media_api_instance.get_media(nil, '')
       }.to raise_error(ArgumentError)
     end
 
@@ -93,7 +93,7 @@ describe 'MediaApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @media_api_instance.list_media(nil)
+        @media_api_instance.list_media(nil)
       }.to raise_error(ArgumentError)
     end
   end
@@ -104,13 +104,13 @@ describe 'MediaApi' do
       stub_request(:put, "https://messaging.bandwidth.com/api/v2/users/#{BW_ACCOUNT_ID}/media/#{media_name}").
       to_return(status: 204)
 
-      data, status_code, headers = @media_api_instance.upload_media_with_http_info(BW_ACCOUNT_ID, media_name, media_data)
+      _data, status_code = @media_api_instance.upload_media_with_http_info(BW_ACCOUNT_ID, media_name, media_data)
       expect(status_code).to eq(204)
     end
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @media_api_instance.upload_media(nil, '', '')
+        @media_api_instance.upload_media(nil, '', '')
       }.to raise_error(ArgumentError)
     end
 

data/spec/api/messages_api_spec.rb

@@ -114,7 +114,7 @@ describe 'MessagesApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @messaging_api_instance.create_message(nil, {})
+        @messaging_api_instance.create_message(nil, {})
       }.to raise_error(ArgumentError)
     end
 
@@ -186,7 +186,7 @@ describe 'MessagesApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @messaging_api_instance.list_messages(nil)
+        @messaging_api_instance.list_messages(nil)
       }.to raise_error(ArgumentError)
     end
   end

data/spec/api/mfa_api_spec.rb

@@ -41,7 +41,7 @@ describe 'MFAApi' do
         digits: digits
       )
 
-      data, status_code, headers = @mfa_api_instance.generate_messaging_code_with_http_info(BW_ACCOUNT_ID, req_schema)
+      data, status_code = @mfa_api_instance.generate_messaging_code_with_http_info(BW_ACCOUNT_ID, req_schema)
 
       expect(status_code).to eq(200)
       expect(data).to be_instance_of(Bandwidth::MessagingCodeResponse)
@@ -50,7 +50,7 @@ describe 'MFAApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @mfa_api_instance.generate_messaging_code(nil, {})
+        @mfa_api_instance.generate_messaging_code(nil, {})
       }.to raise_error(ArgumentError)
     end
 
@@ -75,7 +75,7 @@ describe 'MFAApi' do
         digits: digits
       )
 
-      data, status_code, headers = @mfa_api_instance.generate_voice_code_with_http_info(BW_ACCOUNT_ID, req_schema)
+      data, status_code = @mfa_api_instance.generate_voice_code_with_http_info(BW_ACCOUNT_ID, req_schema)
 
       expect(status_code).to eq(200)
       expect(data).to be_instance_of(Bandwidth::VoiceCodeResponse)
@@ -84,7 +84,7 @@ describe 'MFAApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @mfa_api_instance.generate_voice_code(nil, {})
+        @mfa_api_instance.generate_voice_code(nil, {})
       }.to raise_error(ArgumentError)
     end
 
@@ -108,7 +108,7 @@ describe 'MFAApi' do
         code: '12345'
       )
 
-      data, status_code, headers = @mfa_api_instance.verify_code_with_http_info(BW_ACCOUNT_ID, req_schema)
+      data, status_code = @mfa_api_instance.verify_code_with_http_info(BW_ACCOUNT_ID, req_schema)
 
       expect(status_code).to eq(200)
       expect(data).to be_instance_of(Bandwidth::VerifyCodeResponse)
@@ -117,7 +117,7 @@ describe 'MFAApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @mfa_api_instance.verify_code(nil, {})
+        @mfa_api_instance.verify_code(nil, {})
       }.to raise_error(ArgumentError)
     end
 

data/spec/api/phone_number_lookup_api_spec.rb

@@ -50,7 +50,7 @@ describe 'PhoneNumberLookupApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @phone_number_lookup_api_instance.create_lookup(nil, {})
+        @phone_number_lookup_api_instance.create_lookup(nil, {})
       }.to raise_error(ArgumentError)
     end
 
@@ -87,7 +87,7 @@ describe 'PhoneNumberLookupApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @phone_number_lookup_api_instance.get_lookup_status(nil, '')
+        @phone_number_lookup_api_instance.get_lookup_status(nil, '')
       }.to raise_error(ArgumentError)
     end