bandwidth-sdk 11.0.0.pre.beta.1.1 → 11.0.0.pre.beta.3.0

data/lib/bandwidth-sdk/models/voice_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: 6.4.0
+OpenAPI Generator version: 7.0.0-SNAPSHOT
 
 =end
 
@@ -55,7 +55,7 @@ module Bandwidth
     # @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::VoiceApiError` initialize method"
+        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::VoiceApiError` initialize method'
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
@@ -82,6 +82,7 @@ module Bandwidth
     # 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
@@ -89,6 +90,7 @@ module Bandwidth
     # 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
 
@@ -118,37 +120,30 @@ module Bandwidth
     # @param [Hash] attributes Model attributes in the form of hash
     # @return [Object] Returns the model itself
     def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
       attributes = attributes.transform_keys(&:to_sym)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
+      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[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
           end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      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 _deserialize(type, value)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)
@@ -232,7 +227,5 @@ module Bandwidth
         value
       end
     end
-
   end
-
 end

data/lib/bandwidth-sdk/models/voice_code_response.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: 6.4.0
+OpenAPI Generator version: 7.0.0-SNAPSHOT
 
 =end
 
@@ -47,7 +47,7 @@ module Bandwidth
     # @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::VoiceCodeResponse` initialize method"
+        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::VoiceCodeResponse` initialize method'
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
@@ -66,6 +66,7 @@ module Bandwidth
     # 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
@@ -73,6 +74,7 @@ module Bandwidth
     # 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
 
@@ -100,37 +102,30 @@ module Bandwidth
     # @param [Hash] attributes Model attributes in the form of hash
     # @return [Object] Returns the model itself
     def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
       attributes = attributes.transform_keys(&:to_sym)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
+      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[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
           end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      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 _deserialize(type, value)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)
@@ -214,7 +209,5 @@ module Bandwidth
         value
       end
     end
-
   end
-
 end

data/lib/bandwidth-sdk/version.rb

@@ -6,10 +6,10 @@
 The version of the OpenAPI document: 1.0.0
 Contact: letstalk@bandwidth.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.4.0
+OpenAPI Generator version: 7.0.0-SNAPSHOT
 
 =end
 
 module Bandwidth
-  VERSION = '11.0.0.pre.beta.1.1'
+  VERSION = ENV.fetch('GEM_VERSION')
 end

data/lib/bandwidth-sdk.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: 6.4.0
+OpenAPI Generator version: 7.0.0-SNAPSHOT
 
 =end
 
@@ -60,6 +60,7 @@ require 'bandwidth-sdk/models/lookup_status_enum'
 require 'bandwidth-sdk/models/machine_detection_complete_callback'
 require 'bandwidth-sdk/models/machine_detection_configuration'
 require 'bandwidth-sdk/models/machine_detection_mode_enum'
+require 'bandwidth-sdk/models/machine_detection_result'
 require 'bandwidth-sdk/models/media'
 require 'bandwidth-sdk/models/message'
 require 'bandwidth-sdk/models/message_delivered_callback'
@@ -113,6 +114,7 @@ require 'bandwidth-sdk/models/bxml/verb'
 require 'bandwidth-sdk/models/bxml/nestable_verb'
 require 'bandwidth-sdk/models/bxml/verbs/bridge'
 require 'bandwidth-sdk/models/bxml/verbs/conference'
+require 'bandwidth-sdk/models/bxml/verbs/custom_param'
 require 'bandwidth-sdk/models/bxml/verbs/forward'
 require 'bandwidth-sdk/models/bxml/verbs/gather'
 require 'bandwidth-sdk/models/bxml/verbs/hangup'
@@ -130,9 +132,11 @@ require 'bandwidth-sdk/models/bxml/verbs/speak_sentence'
 require 'bandwidth-sdk/models/bxml/verbs/start_gather'
 require 'bandwidth-sdk/models/bxml/verbs/start_recording'
 require 'bandwidth-sdk/models/bxml/verbs/start_stream'
+require 'bandwidth-sdk/models/bxml/verbs/start_transcription'
 require 'bandwidth-sdk/models/bxml/verbs/stop_gather'
 require 'bandwidth-sdk/models/bxml/verbs/stop_recording'
 require 'bandwidth-sdk/models/bxml/verbs/stop_stream'
+require 'bandwidth-sdk/models/bxml/verbs/stop_transcription'
 require 'bandwidth-sdk/models/bxml/verbs/stream_param'
 require 'bandwidth-sdk/models/bxml/verbs/tag'
 require 'bandwidth-sdk/models/bxml/verbs/transfer'

data/openapi-config.yml

@@ -9,3 +9,4 @@ gemSummary: Bandwidth Ruby SDK
 gemVersion: 11.0.0
 library: faraday
 moduleName: Bandwidth
+templateDir: custom_templates

data/openapitools.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
+  "spaces": 2,
+  "generator-cli": {
+    "version": "6.5.0"
+  }
+}

data/spec/api/calls_api_spec.rb

@@ -0,0 +1,228 @@
+# Unit tests for Bandwidth::CallsApi
+describe 'CallsApi' do
+  # call info
+  let(:call_id) { 'c-15ac29a2-006c67ad-060f-4b98-b148-b753d6e5e2ce' }
+  let(:enqueued_time) { '2023-06-23T18:43:51.248Z' }
+  let(:call_url) { "https://voice.bandwidth.com/api/v2/accounts/#{BW_ACCOUNT_ID}/calls/#{call_id}" }
+  let(:call_timeout) { 30.0 }
+  let(:callback_timeout) { 15.0 }
+  let(:answer_method) { Bandwidth::CallbackMethodEnum::POST }
+  let(:answer_url) { BASE_CALLBACK_URL + '/callbacks/answer' }
+  let(:answer_fallback_url) { BASE_CALLBACK_URL + '/callbacks/answer' }
+  let(:answer_fallback_method) { Bandwidth::CallbackMethodEnum::POST }
+  let(:disconnect_method) { Bandwidth::CallbackMethodEnum::GET }
+  let(:disconnect_url) { BASE_CALLBACK_URL + '/callbacks/disconnect' }
+  let(:priority) { 5 }
+  let(:direction) { Bandwidth::CallDirectionEnum::OUTBOUND }
+  let(:state) { 'disconnected' }
+  let(:stir_shaken) { {} }
+  let(:start_time) { '2023-06-23T19:11:06.049Z' }
+  let(:end_time) { '2023-06-23T19:11:06.175Z' }
+  let(:disconnect_cause) { 'rejected' }
+  let(:error_message) { 'Destination not found' }
+  let(:error_id) { '779941c4-6482-461d-b370-177b4ad0b5a7' }
+  let(:last_update) { '2023-06-23T19:11:06.175Z' }
+  let(:tag) { 'test tag' }
+
+  # stubs
+  let(:create_call_headers_stub) { { 'content-type' => 'application/json' } }
+  let(:create_call_body_stub) { "{\"applicationId\":\"#{BW_VOICE_APPLICATION_ID}\",\"accountId\":\"#{BW_ACCOUNT_ID}\",\"callId\":\"#{call_id}\",\"to\":\"#{USER_NUMBER}\",\"from\":\"#{BW_NUMBER}\",\"enqueuedTime\":\"#{enqueued_time}\",\"callUrl\":\"#{call_url}\",\"callTimeout\":#{call_timeout},\"callbackTimeout\":#{callback_timeout},\"tag\":\"#{tag}\",\"answerMethod\":\"#{answer_method}\",\"answerUrl\":\"#{answer_url}\",\"answerFallbackUrl\":\"#{answer_fallback_url}\",\"answerFallbackMethod\":\"#{answer_fallback_method}\",\"disconnectMethod\":\"#{disconnect_method}\",\"disconnectUrl\":\"#{disconnect_url}\",\"priority\":#{priority}}" }
+  let(:create_call_bad_request_stub) { '{"type":"validation","description":"Invalid to: must be a valid SIP URI or an E164 TN"}' }
+  let(:get_call_state_headers_stub) { { 'content-type' => 'application/json' } }
+  let(:get_call_state_body_stub) { "{\"applicationId\":\"#{BW_VOICE_APPLICATION_ID}\",\"accountId\":\"#{BW_ACCOUNT_ID}\",\"callId\":\"#{call_id}\",\"to\":\"#{USER_NUMBER}\",\"from\":\"#{BW_NUMBER}\",\"direction\":\"#{direction}\",\"state\":\"#{state}\",\"stirShaken\":#{stir_shaken},\"enqueuedTime\":\"#{enqueued_time}\",\"startTime\":\"#{start_time}\",\"endTime\":\"#{end_time}\",\"disconnectCause\":\"#{disconnect_cause}\",\"errorMessage\":\"#{error_message}\",\"errorId\":\"#{error_id}\",\"lastUpdate\":\"#{last_update}\"}" }
+  let(:get_call_state_not_found_stub) { '{"type":"validation","description":"Call does-not-exist was not found."}' }
+  let(:get_call_state_unauthorized_stub) { '{"type":"authentication-error","description":"The credentials provided were invalid"}' }
+  let(:get_call_state_forbidden_stub) { '{"type":"authorization-error","description":"Access is denied"}' }
+  let(:update_call_headers_stub) { { 'content-length' => '0' } }
+  
+  before(:all) do
+    Bandwidth.configure do |config|
+      config.debugging = true
+    end
+    @calls_api_instance = Bandwidth::CallsApi.new
+  end
+
+  describe 'test an instance of CallsApi' do
+    it 'should create an instance of CallsApi' do
+      expect(@calls_api_instance).to be_instance_of(Bandwidth::CallsApi)
+    end
+  end
+
+  # Create Call
+  describe '#create_call' do
+    it 'creates a call with amd' do
+      stub_request(:post, "https://voice.bandwidth.com/api/v2/accounts/#{BW_ACCOUNT_ID}/calls").
+      to_return(status: 201, headers: create_call_headers_stub, body: create_call_body_stub)
+
+      amd_config = Bandwidth::MachineDetectionConfiguration.new(
+        mode: 'async',
+        detection_timeout: 5.0,
+        silence_timeout: 5.0,
+        speech_threshold: 5.0,
+        speech_end_threshold: 5.0,
+        delay_result: true,
+        callback_url: BASE_CALLBACK_URL + '/machineDetection',
+        callback_method: Bandwidth::CallbackMethodEnum::POST
+      )
+
+      call_body = Bandwidth::CreateCall.new(
+        application_id: BW_VOICE_APPLICATION_ID,
+        to: USER_NUMBER,
+        from: BW_NUMBER,
+        answer_url: answer_url,
+        answer_fallback_url: answer_fallback_url,
+        answer_method: answer_method,
+        disconnect_url: disconnect_url,
+        disconnect_method: disconnect_method,
+        machine_detection: amd_config,
+        call_timeout: call_timeout,
+        callback_timeout: callback_timeout,
+        tag: tag
+      )
+
+      data, status_code, headers = @calls_api_instance.create_call_with_http_info(BW_ACCOUNT_ID, call_body)
+
+      expect(status_code).to eq(201)
+      expect(headers).to eq(create_call_headers_stub)
+      expect(data).to be_instance_of(Bandwidth::CreateCallResponse)
+      expect(data.application_id).to eq(BW_VOICE_APPLICATION_ID)
+      expect(data.account_id).to eq(BW_ACCOUNT_ID)
+      expect(data.call_id).to eq(call_id)
+      expect(data.to).to eq(USER_NUMBER)
+      expect(data.from).to eq(BW_NUMBER)
+      expect(data.enqueued_time).to eq(Time.parse(enqueued_time))
+      expect(data.call_url).to eq(call_url)
+      expect(data.call_timeout).to eq(call_timeout)
+      expect(data.callback_timeout).to eq(callback_timeout)
+      expect(data.tag).to eq(tag)
+      expect(data.answer_method).to eq(answer_method)
+      expect(data.answer_url).to eq(answer_url)
+      expect(data.answer_fallback_method).to eq(answer_fallback_method)
+      expect(data.answer_fallback_url).to eq(answer_fallback_url)
+      expect(data.disconnect_method).to eq(disconnect_method)
+      expect(data.disconnect_url).to eq(disconnect_url)
+      expect(data.priority).to eq(priority)
+    end
+
+    it 'causes an ArgumentError for a missing account_id' do
+      expect {
+        @calls_api_instance.create_call(nil, {})
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'causes an ArgumentError for a missing create_call' do
+      expect {
+        @calls_api_instance.create_call(BW_ACCOUNT_ID, nil)
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  # Get Call State Information
+  describe '#get_call_state' do
+    it 'gets the call state' do
+      stub_request(:get, "https://voice.bandwidth.com/api/v2/accounts/#{BW_ACCOUNT_ID}/calls/#{call_id}").
+      to_return(status: 200, headers: get_call_state_headers_stub, body: get_call_state_body_stub)
+
+      data, status_code, headers = @calls_api_instance.get_call_state_with_http_info(BW_ACCOUNT_ID, call_id)
+
+      expect(status_code).to eq(200)
+      expect(headers).to eq(get_call_state_headers_stub)
+      expect(data).to be_instance_of(Bandwidth::CallState)
+      expect(data.application_id).to eq(BW_VOICE_APPLICATION_ID)
+      expect(data.account_id).to eq(BW_ACCOUNT_ID)
+      expect(data.call_id).to eq(call_id)
+      expect(data.to).to eq(USER_NUMBER)
+      expect(data.from).to eq(BW_NUMBER)
+      expect(data.direction).to eq(direction)
+      expect(data.stir_shaken).to eq(stir_shaken)
+      expect(data.state).to eq(state)
+      expect(data.enqueued_time).to eq(Time.parse(enqueued_time))
+      expect(data.start_time).to eq(Time.parse(start_time))
+      expect(data.end_time).to eq(Time.parse(end_time))
+      expect(data.disconnect_cause).to eq(disconnect_cause)
+      expect(data.error_message).to eq(error_message)
+      expect(data.error_id).to eq(error_id)
+      expect(data.last_update).to eq(Time.parse(last_update))
+    end
+
+    it 'causes an ArgumentError for a missing account_id' do
+      expect {
+        resp = @calls_api_instance.get_call_state(nil, '')
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'causes an ArgumentError for a missing call_id' do
+      expect {
+        @calls_api_instance.get_call_state(BW_ACCOUNT_ID, nil)
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  # Update Call
+  describe '#update_call' do
+    it 'creates and updates a call' do
+      stub_request(:post, "https://voice.bandwidth.com/api/v2/accounts/#{BW_ACCOUNT_ID}/calls/#{call_id}").
+      to_return(status: 200, headers: update_call_headers_stub)
+
+      update_call_body = Bandwidth::UpdateCall.new(
+        state: Bandwidth::CallStateEnum::ACTIVE,
+        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)
+
+      expect(status_code).to eq(200)
+      expect(headers).to eq(update_call_headers_stub)
+    end
+
+    it 'causes an ArgumentError for a missing account_id' do
+      expect {
+        resp = @calls_api_instance.update_call(nil, '', {})
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'causes an ArgumentError for a missing call_id' do
+      expect {
+        @calls_api_instance.update_call(BW_ACCOUNT_ID, nil, {})
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'causes an ArgumentError for a missing update_call' do
+      expect {
+        @calls_api_instance.update_call(BW_ACCOUNT_ID, '', nil)
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  # Update Call BXML
+  describe '#update_call_bxml' do
+    it 'updates a call using bxml' do
+      stub_request(:put, "https://voice.bandwidth.com/api/v2/accounts/#{BW_ACCOUNT_ID}/calls/#{call_id}/bxml").
+      to_return(status: 204)
+
+      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)
+
+      expect(status_code).to eq(204)
+    end
+
+    it 'causes an ArgumentError for a missing account_id' do
+      expect {
+        @calls_api_instance.update_call_bxml(nil, '', {})
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'causes an ArgumentError for a missing call_id' do
+      expect {
+        @calls_api_instance.update_call_bxml(BW_ACCOUNT_ID, nil, {})
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'causes an ArgumentError for a missing body' do
+      expect {
+        @calls_api_instance.update_call_bxml(BW_ACCOUNT_ID, '', nil)
+      }.to raise_error(ArgumentError)
+    end
+  end
+end