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

data/spec/api/messages_api_spec.rb

@@ -0,0 +1,193 @@
+# Unit tests for Bandwidth::MessagesApi
+describe 'MessagesApi' do
+  # message info
+  let(:mms_id) { '1687899647358cu2t57tczmbzcu2s' }
+  let(:sms_id) { '1687899647634s46mhdt7ifq5hnjl' }
+  let(:time) { '2023-06-27T21:00:47.358063Z' }
+  let(:segment_count) { 1 }
+  let(:direction) { Bandwidth::MessageDirectionEnum::OUT }
+  let(:text) { 'test text' }
+  let(:media_url) { 'https://cdn2.thecatapi.com/images/MTY3ODIyMQ.jpg' }
+  let(:tag) { 'test tag' }
+  let(:priority) { Bandwidth::PriorityEnum::HIGH }
+  let(:expiration_time) { (Time.now + 60).round.to_datetime.rfc3339 }
+  let(:total_count) { 2 }
+  let(:next_page_token) { 'YWZ0ZXI9MTAwJmxpbWl0PTEwMA' }
+  let(:list_message_direction) { Bandwidth::ListMessageDirectionEnum::OUTBOUND }
+  let(:list_message_status) { Bandwidth::MessageStatusEnum::SENT }
+  let(:list_message_type_mms) { Bandwidth::MessageTypeEnum::MMS }
+  let(:list_message_type_sms) { Bandwidth::MessageTypeEnum::SMS }
+  let(:mms_length) { 45151 }
+  let(:attachment_count) { 1 }
+  let(:recipient_count) { 1 }
+  let(:mms_error_code) { 0 }
+  let(:sms_error_code) { 4720 }
+  let(:carrier_name) { 'Other' }
+  let(:next_page_url) { "https://messaging.bandwidth.com/api/v2/users/#{BW_ACCOUNT_ID}/messages?messageDirection=#{list_message_direction}&sourceTn=%2B#{BW_NUMBER[1..-1]}&pageToken=#{next_page_token}" }
+
+  # stubs
+  let(:create_message_mms_headers_stub) { { 'content-type' => 'application/json' } }
+  let(:create_message_mms_body_stub) { "{\"id\":\"#{mms_id}\",\"owner\":\"#{BW_NUMBER}\",\"applicationId\":\"#{BW_MESSAGING_APPLICATION_ID}\",\"time\":\"#{time}\",\"segmentCount\":#{segment_count},\"direction\":\"#{direction}\",\"to\":[\"#{USER_NUMBER}\"],\"from\":\"#{BW_NUMBER}\",\"text\":\"#{text}\",\"media\":[\"#{media_url}\"],\"tag\":\"#{tag}\"}" }
+  let(:create_message_sms_headers_stub) { { 'content-type' => 'application/json' } }
+  let(:create_message_sms_body_stub) { "{\"id\":\"#{sms_id}\",\"owner\":\"#{BW_NUMBER}\",\"applicationId\":\"#{BW_MESSAGING_APPLICATION_ID}\",\"time\":\"#{time}\",\"segmentCount\":#{segment_count},\"direction\":\"#{direction}\",\"to\":[\"#{USER_NUMBER}\"],\"from\":\"#{BW_NUMBER}\",\"text\":\"#{text}\",\"tag\":\"#{tag}\",\"priority\":\"#{priority}\",\"expiration\":\"#{expiration_time}\"}" }
+  let(:list_messages_body_stub) { "{\"totalCount\":#{total_count},\"pageInfo\":{\"nextPage\":\"#{next_page_url}\",\"nextPageToken\":\"#{next_page_token}\"},\"messages\":[{\"messageId\":\"#{mms_id}\",\"accountId\":\"#{BW_ACCOUNT_ID}\",\"sourceTn\":\"#{BW_NUMBER}\",\"destinationTn\":\"#{USER_NUMBER}\",\"messageStatus\":\"#{list_message_status}\",\"messageDirection\":\"#{list_message_direction}\",\"messageType\":\"#{list_message_type_mms}\",\"segmentCount\":#{segment_count},\"messageLength\":#{mms_length},\"messageSize\":#{mms_length},\"attachmentCount\":#{attachment_count},\"recipientCount\":#{recipient_count},\"errorCode\":#{mms_error_code},\"carrierName\":null,\"campaignClass\":null,\"campaignId\":null,\"receiveTime\":\"#{time}\"},{\"messageId\":\"#{sms_id}\",\"accountId\":\"#{BW_ACCOUNT_ID}\",\"sourceTn\":\"#{BW_NUMBER}\",\"destinationTn\":\"#{USER_NUMBER}\",\"messageStatus\":\"#{list_message_status}\",\"messageDirection\":\"#{list_message_direction}\",\"messageType\":\"#{list_message_type_sms}\",\"segmentCount\":#{segment_count},\"messageLength\":#{text.length},\"messageSize\":null,\"attachmentCount\":null,\"recipientCount\":null,\"errorCode\":#{sms_error_code},\"carrierName\":\"#{carrier_name}\",\"campaignClass\":null,\"campaignId\":null,\"receiveTime\":\"#{time}\"}]}" }
+  let(:list_messages_headers_stub) { { 'content-type' => 'application/json', 'content-length' => "#{list_messages_body_stub.length}" } }
+  
+  before(:all) do
+    Bandwidth.configure do |config|
+      config.debugging = true
+    end
+    @messaging_api_instance = Bandwidth::MessagesApi.new
+  end
+
+  describe 'test an instance of MessagesApi' do
+    it 'should create an instance of MessagesApi' do
+      expect(@messaging_api_instance).to be_instance_of(Bandwidth::MessagesApi)
+    end
+  end
+
+  # Create Message
+  describe 'create_message' do
+    it 'creates an mms message' do
+      stub_request(:post, "https://messaging.bandwidth.com/api/v2/users/#{BW_ACCOUNT_ID}/messages").
+      to_return(status: 202, headers: create_message_mms_headers_stub, body: create_message_mms_body_stub)
+
+      message_request = Bandwidth::MessageRequest.new(
+        application_id: BW_MESSAGING_APPLICATION_ID,
+        to: [USER_NUMBER],
+        from: BW_NUMBER,
+        text: text,
+        media: [media_url],
+        tag: tag
+      )
+
+      data, status_code, headers = @messaging_api_instance.create_message_with_http_info(BW_ACCOUNT_ID, message_request)
+
+      expect(status_code).to eq(202)
+      expect(headers).to eq(create_message_mms_headers_stub)
+      expect(data).to be_instance_of(Bandwidth::Message)
+      expect(data.id).to eq(mms_id)
+      expect(data.owner).to eq(BW_NUMBER)
+      expect(data.application_id).to eq(BW_MESSAGING_APPLICATION_ID)
+      expect(data.time).to eq(Time.parse(time))
+      expect(data.segment_count).to eq(segment_count)
+      expect(data.direction).to eq(direction)
+      expect(data.to).to eq([USER_NUMBER])
+      expect(data.from).to eq(BW_NUMBER)
+      expect(data.text).to eq(text)
+      expect(data.media).to eq([media_url])
+      expect(data.tag).to eq(tag)
+    end
+
+    it 'creates an sms message' do
+      stub_request(:post, "https://messaging.bandwidth.com/api/v2/users/#{BW_ACCOUNT_ID}/messages").
+      to_return(status: 202, headers: create_message_sms_headers_stub, body: create_message_sms_body_stub)
+
+      message_request = Bandwidth::MessageRequest.new(
+        application_id: BW_MESSAGING_APPLICATION_ID,
+        to: [USER_NUMBER],
+        from: BW_NUMBER,
+        text: text,
+        tag: tag,
+        priority: priority,
+        expiration: expiration_time
+      )
+  
+      data, status_code, headers = @messaging_api_instance.create_message_with_http_info(BW_ACCOUNT_ID, message_request)
+  
+      expect(status_code).to eq(202)
+      expect(headers).to eq(create_message_sms_headers_stub)
+      expect(data).to be_instance_of(Bandwidth::Message)
+      expect(data.id).to eq(sms_id)
+      expect(data.owner).to eq(BW_NUMBER)
+      expect(data.application_id).to eq(BW_MESSAGING_APPLICATION_ID)
+      expect(data.time).to eq(Time.parse(time))
+      expect(data.segment_count).to eq(segment_count)
+      expect(data.direction).to eq(direction)
+      expect(data.to).to eq([USER_NUMBER])
+      expect(data.from).to eq(BW_NUMBER)
+      expect(data.text).to eq(text)
+      expect(data.tag).to eq(tag)
+      expect(data.priority).to eq(priority)
+      expect(data.expiration).to eq(Time.parse(expiration_time))
+    end
+
+    it 'causes an ArgumentError for a missing account_id' do
+      expect {
+        resp = @messaging_api_instance.create_message(nil, {})
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'causes an ArgumentError for a missing message_request' do
+      expect {
+        @messaging_api_instance.create_message(BW_ACCOUNT_ID, nil)
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  # List Messages
+  describe 'list_messages' do
+    it 'lists messages' do
+      stub_request(:get, "https://messaging.bandwidth.com/api/v2/users/#{BW_ACCOUNT_ID}/messages?messageDirection=#{list_message_direction}&sourceTn=%2B#{BW_NUMBER[1..-1]}").
+      to_return(status: 200, headers: list_messages_headers_stub, body: list_messages_body_stub)
+
+      get_opts = {
+        :source_tn => BW_NUMBER,
+        :message_direction => list_message_direction
+      }
+
+      data, status_code, headers = @messaging_api_instance.list_messages_with_http_info(BW_ACCOUNT_ID, get_opts)
+
+      expect(status_code).to eq(200)
+      expect(headers).to eq(list_messages_headers_stub)
+      expect(data).to be_instance_of(Bandwidth::MessagesList)
+      expect(data.total_count).to eq(total_count)
+      expect(data.page_info.next_page).to eq(next_page_url)
+      expect(data.page_info.next_page_token).to eq(next_page_token)
+      expect(data.messages.length).to eq(total_count)
+      expect(data.messages).to be_instance_of(Array)
+      expect(data.messages[0]).to be_instance_of(Bandwidth::ListMessageItem)
+      expect(data.messages[0].message_id).to eq(mms_id)
+      expect(data.messages[0].account_id).to eq(BW_ACCOUNT_ID)
+      expect(data.messages[0].source_tn).to eq(BW_NUMBER)
+      expect(data.messages[0].destination_tn).to eq(USER_NUMBER)
+      expect(data.messages[0].message_status).to eq(list_message_status)
+      expect(data.messages[0].message_direction).to eq(list_message_direction)
+      expect(data.messages[0].message_type).to eq(list_message_type_mms)
+      expect(data.messages[0].segment_count).to eq(segment_count)
+      expect(data.messages[0].error_code).to eq(mms_error_code)
+      expect(data.messages[0].receive_time).to eq(Time.parse(time))
+      expect(data.messages[0].carrier_name).to eq(nil)
+      expect(data.messages[0].message_size).to eq(mms_length)
+      expect(data.messages[0].message_length).to eq(mms_length)
+      expect(data.messages[0].attachment_count).to eq(attachment_count)
+      expect(data.messages[0].recipient_count).to eq(recipient_count)
+      expect(data.messages[0].campaign_class).to eq(nil)
+      expect(data.messages[0].campaign_id).to eq(nil)
+      expect(data.messages[1]).to be_instance_of(Bandwidth::ListMessageItem)
+      expect(data.messages[1].message_id).to eq(sms_id)
+      expect(data.messages[1].account_id).to eq(BW_ACCOUNT_ID)
+      expect(data.messages[1].source_tn).to eq(BW_NUMBER)
+      expect(data.messages[1].destination_tn).to eq(USER_NUMBER)
+      expect(data.messages[1].message_status).to eq(list_message_status)
+      expect(data.messages[1].message_direction).to eq(list_message_direction)
+      expect(data.messages[1].message_type).to eq(list_message_type_sms)
+      expect(data.messages[1].segment_count).to eq(segment_count)
+      expect(data.messages[1].error_code).to eq(sms_error_code)
+      expect(data.messages[1].receive_time).to eq(Time.parse(time))
+      expect(data.messages[1].carrier_name).to eq(carrier_name)
+      expect(data.messages[1].message_size).to eq(nil)
+      expect(data.messages[1].message_length).to eq(text.length)
+      expect(data.messages[1].attachment_count).to eq(nil)
+      expect(data.messages[1].recipient_count).to eq(nil)
+      expect(data.messages[1].campaign_class).to eq(nil)
+      expect(data.messages[1].campaign_id).to eq(nil)
+    end
+
+    it 'causes an ArgumentError for a missing account_id' do
+      expect {
+        resp = @messaging_api_instance.list_messages(nil)
+      }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/api/mfa_api_spec.rb

@@ -0,0 +1,130 @@
+# Unit tests for Bandwidth::MFAApi
+describe 'MFAApi' do
+  # mfa info
+  let(:message) { 'Your temporary {NAME} {SCOPE} code is: {CODE}' }
+  let(:message_id) { '1687965513364hx26ky4mpkll3m5a' }
+  let(:call_id) { 'c-28bba681-cffc7d67-904e-42c8-85c5-b5589ea583b4' }
+  let(:digits) { 6 }
+
+  # stubs
+  let(:generate_messaging_code_body_stub) { "{\"messageId\": \"#{message_id}\"}" }
+  let(:generate_messaging_code_headers_stub) { { 'content-type' => 'application/json', 'content-length' => "#{generate_messaging_code_body_stub.length}" } }
+  let(:generate_voice_code_body_stub) { "{\"callId\": \"#{call_id}\"}" }
+  let(:generate_voice_code_headers_stub) { { 'content-type' => 'application/json', 'content-length' => "#{generate_voice_code_body_stub.length}" } }
+  let(:verify_code_body_stub) { '{"valid": false}' }
+  let(:verify_code_headers_stub) { { 'content-type' => 'application/json', 'content-length' => "#{verify_code_body_stub.length}" } }
+  
+  before(:all) do
+    Bandwidth.configure do |config|
+      config.debugging = true
+    end
+    @mfa_api_instance = Bandwidth::MFAApi.new
+  end
+
+  describe 'test an instance of MFAApi' do
+    it 'should create an instance of MFAApi' do
+      expect(@mfa_api_instance).to be_instance_of(Bandwidth::MFAApi)
+    end
+  end
+
+  # Messaging Authentication Code
+  describe 'generate_messaging_code' do
+    it 'generates messaging mfa code' do
+      stub_request(:post, "https://mfa.bandwidth.com/api/v1/accounts/#{BW_ACCOUNT_ID}/code/messaging").
+      to_return(status: 200, headers: generate_messaging_code_headers_stub, body: generate_messaging_code_body_stub)
+
+      req_schema = Bandwidth::CodeRequest.new(
+        to: USER_NUMBER,
+        from: BW_NUMBER,
+        application_id: BW_MESSAGING_APPLICATION_ID,
+        message: message,
+        digits: digits
+      )
+
+      data, status_code, headers = @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)
+      expect(data.message_id).to eq(message_id)
+    end
+
+    it 'causes an ArgumentError for a missing account_id' do
+      expect {
+        resp = @mfa_api_instance.generate_messaging_code(nil, {})
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'causes an ArgumentError for a missing code_request' do
+      expect {
+        @mfa_api_instance.generate_messaging_code(BW_ACCOUNT_ID, nil)
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  # Voice Authentication Code
+  describe 'generate_voice_code' do
+    it 'generates voice mfa code' do
+      stub_request(:post, "https://mfa.bandwidth.com/api/v1/accounts/#{BW_ACCOUNT_ID}/code/voice").
+      to_return(status: 200, headers: generate_voice_code_headers_stub, body: generate_voice_code_body_stub)
+
+      req_schema = Bandwidth::CodeRequest.new(
+        to: USER_NUMBER,
+        from: BW_NUMBER,
+        application_id: BW_VOICE_APPLICATION_ID,
+        message: message,
+        digits: digits
+      )
+
+      data, status_code, headers = @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)
+      expect(data.call_id).to eq(call_id)
+    end
+
+    it 'causes an ArgumentError for a missing account_id' do
+      expect {
+        resp = @mfa_api_instance.generate_voice_code(nil, {})
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'causes an ArgumentError for a missing code_request' do
+      expect {
+        @mfa_api_instance.generate_voice_code(BW_ACCOUNT_ID, nil)
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  # Verify Authentication Code
+  describe 'verify_code' do
+    it 'verifies mfa code' do
+      stub_request(:post, "https://mfa.bandwidth.com/api/v1/accounts/#{BW_ACCOUNT_ID}/code/verify").
+      to_return(status: 200, headers: verify_code_headers_stub, body: verify_code_body_stub)
+
+      req_schema = Bandwidth::VerifyCodeRequest.new(
+        to: '+1000' + rand(1...10000000).to_s,
+        scope: '2FA',
+        expiration_time_in_minutes: 3,
+        code: '12345'
+      )
+
+      data, status_code, headers = @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)
+      expect(data.valid).to be false
+    end
+
+    it 'causes an ArgumentError for a missing account_id' do
+      expect {
+        resp = @mfa_api_instance.verify_code(nil, {})
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'causes an ArgumentError for a missing cvarify_ode_request' do
+      expect {
+        @mfa_api_instance.verify_code(BW_ACCOUNT_ID, nil)
+      }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/api/phone_number_lookup_api_spec.rb

@@ -0,0 +1,100 @@
+# Unit tests for Bandwidth::PhoneNumberLookupApi
+describe 'PhoneNumberLookupApi' do
+  # lookup info
+  let(:request_id) { '21e6d818-eaa9-4ca9-b1d8-d6085f5c79d4' }
+  let(:status_in_progress) { Bandwidth::LookupStatusEnum::IN_PROGRESS }
+  let(:status_complete) { Bandwidth::LookupStatusEnum::COMPLETE }
+  let(:response_code) { 0 }
+  let(:message) { 'NOERROR' }
+  let(:formatted) { "(#{BW_NUMBER[2..4]}) #{BW_NUMBER[5..7]}-#{BW_NUMBER[7..-1]}" }
+  let(:country) { 'US' }
+  let(:line_type) { 'Mobile' }
+  let(:line_provider) { 'AdHoc P2P - Bandwidth - SVR' }
+
+  # stubs
+  let(:create_lookup_headers_stub) { { 'content-type' => 'application/json' } }
+  let(:create_lookup_body_stub) { "{\"requestId\":\"#{request_id}\",\"status\":\"#{status_in_progress}\"}" }
+  let(:get_lookup_status_headers_stub) { { 'content-type' => 'application/json' } }
+  let(:get_lookup_status_body_stub) { "{\"requestId\":\"#{request_id}\",\"status\":\"#{status_complete}\",\"result\":[{\"Response Code\":#{response_code},\"Message\":\"#{message}\",\"E.164 Format\":\"#{BW_NUMBER}\",\"Formatted\":\"#{formatted}\",\"Country\":\"#{country}\",\"Line Type\":\"#{line_type}\",\"Line Provider\":\"#{line_provider}\"}]}" }
+  
+  before(:all) do
+    Bandwidth.configure do |config|
+      config.debugging = true
+    end
+    @phone_number_lookup_api_instance = Bandwidth::PhoneNumberLookupApi.new
+  end
+
+  describe 'test an instance of PhoneNumberLookupApi' do
+    it 'should create an instance of PhoneNumberLookupApi' do
+      expect(@phone_number_lookup_api_instance).to be_instance_of(Bandwidth::PhoneNumberLookupApi)
+    end
+  end
+
+  # Create Lookup
+  describe 'create_lookup' do
+    it 'creates a tn lookup request' do
+      stub_request(:post, "https://numbers.bandwidth.com/api/v1/accounts/#{BW_ACCOUNT_ID}/tnlookup").
+      to_return(status: 202, headers: create_lookup_headers_stub, body: create_lookup_body_stub)
+
+      tn_body = Bandwidth::LookupRequest.new(
+        tns: [BW_NUMBER]
+      )
+      data, status_code, headers = @phone_number_lookup_api_instance.create_lookup_with_http_info(BW_ACCOUNT_ID, tn_body)
+
+      expect(status_code).to eq(202)
+      expect(headers).to eq(create_lookup_headers_stub)
+      expect(data).to be_instance_of(Bandwidth::CreateLookupResponse)
+      expect(data.request_id).to eq(request_id)
+      expect(data.status).to eq(status_in_progress)
+    end
+
+    it 'causes an ArgumentError for a missing account_id' do
+      expect {
+        resp = @phone_number_lookup_api_instance.create_lookup(nil, {})
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'causes an ArgumentError for a missing lookup_request' do
+      expect {
+        @phone_number_lookup_api_instance.create_lookup(BW_ACCOUNT_ID, nil)
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  # Get Lookup Status
+  describe 'get_lookup_status' do
+    it 'gets lookup status' do
+      stub_request(:get, "https://numbers.bandwidth.com/api/v1/accounts/#{BW_ACCOUNT_ID}/tnlookup/#{request_id}").
+      to_return(status: 200, headers: get_lookup_status_headers_stub, body: get_lookup_status_body_stub)
+
+      data, status_code, headers = @phone_number_lookup_api_instance.get_lookup_status_with_http_info(BW_ACCOUNT_ID, request_id)
+
+      expect(status_code).to eq(200)
+      expect(headers).to eq(get_lookup_status_headers_stub)
+      expect(data).to be_instance_of(Bandwidth::LookupStatus)
+      expect(data.request_id).to eq(request_id)
+      expect(data.status).to eq(status_complete)
+      expect(data.result).to be_instance_of(Array)
+      expect(data.result[0]).to be_instance_of(Bandwidth::LookupResult)
+      expect(data.result[0].response_code).to eq(response_code)
+      expect(data.result[0].message).to eq(message)
+      expect(data.result[0].e_164_format).to eq(BW_NUMBER)
+      expect(data.result[0].formatted).to eq(formatted)
+      expect(data.result[0].country).to eq(country)
+      expect(data.result[0].line_type).to eq(line_type)
+      expect(data.result[0].line_provider).to eq(line_provider)
+    end
+
+    it 'causes an ArgumentError for a missing account_id' do
+      expect {
+        resp = @phone_number_lookup_api_instance.get_lookup_status(nil, '')
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'causes an ArgumentError for a missing request_id' do
+      expect {
+        @phone_number_lookup_api_instance.get_lookup_status(BW_ACCOUNT_ID, nil)
+      }.to raise_error(ArgumentError)
+    end
+  end
+end