bandwidth-sdk 16.2.2 → 17.0.1

data/spec/unit/api/multi_channel_api_spec.rb

@@ -22,7 +22,7 @@ describe 'MultiChannelApi' do
   # Create Multi-Channel Message
   describe 'create_multi_channel_message' do
     it 'creates a multi channel message' do
-      message_body = Bandwidth::MultiChannelChannelListObject.new(
+      message_body = Bandwidth::MultiChannelChannelListSMSObject.new(
         from: BW_NUMBER,
         application_id: BW_MESSAGING_APPLICATION_ID,
         channel: Bandwidth::MultiChannelMessageChannelEnum::SMS,
@@ -30,6 +30,7 @@ describe 'MultiChannelApi' do
           text: 'Hello, this is a test message.',
         )
       )
+      
       multi_channel_message_request = Bandwidth::MultiChannelMessageRequest.new(
         to: USER_NUMBER,
         channel_list: [message_body],
@@ -42,7 +43,17 @@ describe 'MultiChannelApi' do
 
       expect(status_code).to eq(202)
       expect(data).to be_instance_of(Bandwidth::CreateMultiChannelMessageResponse)
-    end if false # skip because prism can't handle a oneOf with differing required fields
+      expect(data.links).to be_instance_of(Array)
+      expect(data.data).to be_instance_of(Bandwidth::MultiChannelMessageResponseData)
+      expect(data.data.id).to be_instance_of(String)
+      expect(data.data.time).to be_instance_of(Time)
+      expect(data.data.direction).to be_one_of(Bandwidth::MessageDirectionEnum.all_vars)
+      expect(data.data.to).to be_instance_of(Array)
+      expect(data.data.tag).to be_instance_of(String)
+      expect(data.data.priority).to be_one_of(Bandwidth::PriorityEnum.all_vars)
+      expect(data.data.expiration).to be_instance_of(Time)
+      expect(data.data.channel_list).to be_instance_of(Array)
+    end
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {

data/spec/unit/api/phone_number_lookup_api_spec.rb

@@ -1,6 +1,7 @@
 # Unit tests for Bandwidth::PhoneNumberLookupApi
 describe 'PhoneNumberLookupApi' do
-  let(:request_id) { '21e6d818-eaa9-4ca9-b1d8-d6085f5c79d4' } 
+  let(:phone_numbers) { [BW_NUMBER, USER_NUMBER] }
+  let(:request_id) { '123e4567-e89b-12d3-a456-426614174000' }
 
   before(:all) do
     Bandwidth.configure do |config|
@@ -10,77 +11,91 @@ describe 'PhoneNumberLookupApi' do
       config.ignore_operation_servers = true
       config.host = '127.0.0.1:4010'
     end
-    @phone_number_lookup_api_instance = Bandwidth::PhoneNumberLookupApi.new
+    @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)
+      expect(@api_instance).to be_instance_of(Bandwidth::PhoneNumberLookupApi)
     end
   end
 
-  # Create Lookup
-  describe 'create_lookup' do
-    it 'creates a tn lookup request' do
-      tn_body = Bandwidth::LookupRequest.new(
-        tns: [BW_NUMBER]
+  # Create Asynchronous Bulk Number Lookup
+  describe 'create_async_bulk_lookup test' do
+    it 'should work' do
+      request = Bandwidth::AsyncLookupRequest.new(
+        phone_numbers: phone_numbers,
       )
-      data, status_code = @phone_number_lookup_api_instance.create_lookup_with_http_info(BW_ACCOUNT_ID, tn_body)
 
-      expect(status_code).to eq(202)
-      expect(data).to be_instance_of(Bandwidth::CreateLookupResponse)
-      expect(data.request_id.length).to eq(36)
-      expect(data.status).to be_one_of(Bandwidth::LookupStatusEnum.all_vars)
-    end
-
-    it 'causes an ArgumentError for a missing account_id' do
-      expect {
-        @phone_number_lookup_api_instance.create_lookup(nil, {})
-      }.to raise_error(ArgumentError)
-    end
+      data, status_code = @api_instance.create_async_bulk_lookup_with_http_info(BW_ACCOUNT_ID, request)
 
-    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)
+      expect(status_code).to eq(202)
+      expect(data).to be_instance_of(Bandwidth::CreateAsyncBulkLookupResponse)
+      expect(data.links[0]).to be_instance_of(Bandwidth::LinkSchema)
+      expect(data.links[0].rel).to be_instance_of(String)
+      expect(data.links[0].href).to be_instance_of(String)
+      expect(data.links[0].method).to be_instance_of(String)
+      expect(data.data).to be_instance_of(Bandwidth::CreateAsyncBulkLookupResponseData)
+      expect(data.data.request_id).to be_instance_of(String)
+      expect(data.data.status).to eq(Bandwidth::InProgressLookupStatusEnum::IN_PROGRESS)
+      expect(data.errors).to be_instance_of(Array)
     end
   end
 
-  # Get Lookup Status
-  describe 'get_lookup_status' do
-    it 'gets lookup status' do
-      data, status_code = @phone_number_lookup_api_instance.get_lookup_status_with_http_info(
-        BW_ACCOUNT_ID, request_id, { header_params: { 'Prefer' => 'example=lookupMultipleNumbersPartialCompleteExample' } })
+  # Create Synchronous Number Lookup
+  describe 'create_sync_lookup test' do
+    it 'should work' do
+      request = Bandwidth::SyncLookupRequest.new(
+        phone_numbers: phone_numbers,
+      )
 
-      expect(status_code).to eq(200)
-      expect(data).to be_instance_of(Bandwidth::LookupStatus)
-      expect(data.request_id.length).to eq(36)
-      expect(data.status).to be_one_of(Bandwidth::LookupStatusEnum.all_vars)
-      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 be_instance_of(Integer)
-      expect(data.result[0].message).to be_instance_of(String)
-      expect(data.result[0].e_164_format.length).to eq(12)
-      expect(data.result[0].formatted.length).to eq(14)
-      expect(data.result[0].country).to be_instance_of(String)
-      expect(data.result[0].line_type).to be_instance_of(String)
-      expect(data.result[0].line_provider).to be_instance_of(String)
-      expect(data.result[0].mobile_country_code).to be_instance_of(String)
-      expect(data.result[0].mobile_network_code).to be_instance_of(String)
-      expect(data.failed_telephone_numbers).to be_instance_of(Array)
-      expect(data.failed_telephone_numbers[0]).to be_instance_of(String)
-    end
+      data, status_code = @api_instance.create_sync_lookup_with_http_info(BW_ACCOUNT_ID, request)
 
-    it 'causes an ArgumentError for a missing account_id' do
-      expect {
-        @phone_number_lookup_api_instance.get_lookup_status(nil, '')
-      }.to raise_error(ArgumentError)
+      expect(status_code).to equal_to(200)
+      expect(data).to be_instance_of(Bandwidth::CreateSyncLookupResponse)
+      expect(data.links[0]).to be_instance_of(Bandwidth::LinkSchema)
+      expect(data.links[0].rel).to be_instance_of(String)
+      expect(data.links[0].href).to be_instance_of(String)
+      expect(data.links[0].method).to be_instance_of(String)
+      expect(data.data.request_id).to be_instance_of(String)
+      expect(data.data.status).to eq(Bandwidth::CompletedLookupStatusEnum::COMPLETE)
+      expect(data.data.results).to be_instance_of(Array)
+      expect(data.data.results[0]).to be_instance_of(Bandwidth::LookupResult)
+      expect(data.data.results[0].phone_number).to be_instance_of(String)
+      expect(data.data.results[0].line_type).to eq(Bandwidth::LineTypeEnum::MOBILE)
+      expect(data.data.results[0].messaging_provider).to be_instance_of(String)
+      expect(data.data.results[0].voice_provider).to be_instance_of(String)
+      expect(data.data.results[0].country_code_a3).to be_instance_of(String)
+      expect(data.data.results[0].latest_message_delivery_status).to eq(Bandwidth::LatestMessageDeliveryStatusEnum::ACTIVE)
+      expect(data.data.results[0].initial_message_delivery_status_date).to be_instance_of(Date)
+      expect(data.data.results[0].latest_message_delivery_status_date).to be_instance_of(Date)
+      expect(data.errors).to be_instance_of(Array)
     end
+  end
+
+  # Get Asynchronous Bulk Number Lookup
+  describe 'get_async_bulk_lookup test' do
+    it 'should work' do
+      data, status_code = @api_instance.get_async_bulk_lookup_with_http_info(BW_ACCOUNT_ID, request_id)
 
-    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)
+      expect(status_code).to equal_to(200)
+      expect(data).to be_instance_of(Bandwidth::GetAsyncBulkLookupResponse)
+      expect(data.links[0]).to be_instance_of(Bandwidth::LinkSchema)
+      expect(data.links[0].rel).to be_instance_of(String)
+      expect(data.links[0].href).to be_instance_of(String)
+      expect(data.links[0].method).to be_instance_of(String)
+      expect(data.data.request_id).to be_instance_of(String)
+      expect(data.data.status).to eq(Bandwidth::InProgressLookupStatusEnum::COMPLETE)
+      expect(data.data.results).to be_instance_of(Array)
+      expect(data.data.results[0]).to be_instance_of(Bandwidth::LookupResult)
+      expect(data.data.results[0].phone_number).to be_instance_of(String)
+      expect(data.data.results[0].line_type).to eq(Bandwidth::LineTypeEnum::MOBILE)
+      expect(data.data.results[0].messaging_provider).to be_instance_of(String)
+      expect(data.data.results[0].voice_provider).to be_instance_of(String)
+      expect(data.data.results[0].country_code_a3).to be_instance_of(String)
+      expect(data.data.results[0].latest_message_delivery_status).to eq(Bandwidth::LatestMessageDeliveryStatusEnum::ACTIVE)
+      expect(data.data.results[0].initial_message_delivery_status_date).to be_instance_of(Date)
+      expect(data.data.results[0].latest_message_delivery_status_date).to be_instance_of(Date)
+      expect(data.errors).to be_instance_of(Array)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bandwidth-sdk
 version: !ruby/object:Gem::Version
-  version: 16.2.2
+  version: 17.0.1
 platform: ruby
 authors:
 - Bandwidth
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-28 00:00:00.000000000 Z
+date: 2025-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -147,6 +147,7 @@ files:
 - docs/AdditionalDenialReason.md
 - docs/Address.md
 - docs/AnswerCallback.md
+- docs/AsyncLookupRequest.md
 - docs/BlockedWebhook.md
 - docs/BridgeCompleteCallback.md
 - docs/BridgeTargetCompleteCallback.md
@@ -166,6 +167,7 @@ files:
 - docs/CallsApi.md
 - docs/CardWidthEnum.md
 - docs/CodeRequest.md
+- docs/CompletedLookupStatusEnum.md
 - docs/Conference.md
 - docs/ConferenceCompletedCallback.md
 - docs/ConferenceCreatedCallback.md
@@ -178,11 +180,15 @@ files:
 - docs/ConferenceStateEnum.md
 - docs/ConferencesApi.md
 - docs/Contact.md
+- docs/CreateAsyncBulkLookupResponse.md
+- docs/CreateAsyncBulkLookupResponseData.md
 - docs/CreateCall.md
 - docs/CreateCallResponse.md
-- docs/CreateLookupResponse.md
 - docs/CreateMessageRequestError.md
 - docs/CreateMultiChannelMessageResponse.md
+- docs/CreateSyncLookupResponse.md
+- docs/CreateSyncLookupResponseData.md
+- docs/DeactivationEventEnum.md
 - docs/DisconnectCallback.md
 - docs/Diversion.md
 - docs/DtmfCallback.md
@@ -193,18 +199,24 @@ files:
 - docs/FieldError.md
 - docs/FileFormatEnum.md
 - docs/GatherCallback.md
+- docs/GetAsyncBulkLookupResponse.md
+- docs/GetAsyncBulkLookupResponseData.md
+- docs/InProgressLookupStatusEnum.md
 - docs/InboundCallback.md
 - docs/InboundCallbackMessage.md
 - docs/InboundCallbackTypeEnum.md
 - docs/InitiateCallback.md
+- docs/LatestMessageDeliveryStatusEnum.md
+- docs/LineTypeEnum.md
 - docs/Link.md
+- docs/LinkSchema.md
 - docs/LinksObject.md
 - docs/ListMessageDirectionEnum.md
 - docs/ListMessageItem.md
-- docs/LookupRequest.md
+- docs/LookupErrorResponse.md
+- docs/LookupErrorSchema.md
+- docs/LookupErrorSchemaMeta.md
 - docs/LookupResult.md
-- docs/LookupStatus.md
-- docs/LookupStatusEnum.md
 - docs/MFAApi.md
 - docs/MachineDetectionCompleteCallback.md
 - docs/MachineDetectionConfiguration.md
@@ -229,14 +241,22 @@ files:
 - docs/MultiChannelAction.md
 - docs/MultiChannelActionCalendarEvent.md
 - docs/MultiChannelApi.md
-- docs/MultiChannelChannelListObject.md
-- docs/MultiChannelChannelListObjectContent.md
+- docs/MultiChannelChannelListMMSObject.md
+- docs/MultiChannelChannelListMMSResponseObject.md
+- docs/MultiChannelChannelListObjectBase.md
+- docs/MultiChannelChannelListOwnerObject.md
+- docs/MultiChannelChannelListRBMObject.md
+- docs/MultiChannelChannelListRBMObjectAllOfContent.md
+- docs/MultiChannelChannelListRBMResponseObject.md
+- docs/MultiChannelChannelListRequestObject.md
+- docs/MultiChannelChannelListResponseObject.md
+- docs/MultiChannelChannelListSMSObject.md
+- docs/MultiChannelChannelListSMSResponseObject.md
 - docs/MultiChannelError.md
 - docs/MultiChannelMessageChannelEnum.md
 - docs/MultiChannelMessageContent.md
 - docs/MultiChannelMessageRequest.md
 - docs/MultiChannelMessageResponseData.md
-- docs/MultiChannelMessageResponseDataChannelListInner.md
 - docs/OptInWorkflow.md
 - docs/PageInfo.md
 - docs/PhoneNumberLookupApi.md
@@ -273,6 +293,7 @@ files:
 - docs/StatusCallbackMessage.md
 - docs/StatusCallbackTypeEnum.md
 - docs/StirShaken.md
+- docs/SyncLookupRequest.md
 - docs/TelephoneNumber.md
 - docs/TfvBasicAuthentication.md
 - docs/TfvCallbackStatusEnum.md
@@ -282,7 +303,6 @@ files:
 - docs/TfvSubmissionInfo.md
 - docs/TfvSubmissionWrapper.md
 - docs/ThumbnailAlignmentEnum.md
-- docs/TnLookupRequestError.md
 - docs/TollFreeVerificationApi.md
 - docs/TranscribeRecording.md
 - docs/Transcription.md
@@ -328,6 +348,7 @@ files:
 - lib/bandwidth-sdk/models/additional_denial_reason.rb
 - lib/bandwidth-sdk/models/address.rb
 - lib/bandwidth-sdk/models/answer_callback.rb
+- lib/bandwidth-sdk/models/async_lookup_request.rb
 - lib/bandwidth-sdk/models/blocked_webhook.rb
 - lib/bandwidth-sdk/models/bridge_complete_callback.rb
 - lib/bandwidth-sdk/models/bridge_target_complete_callback.rb
@@ -379,6 +400,7 @@ files:
 - lib/bandwidth-sdk/models/callback_method_enum.rb
 - lib/bandwidth-sdk/models/card_width_enum.rb
 - lib/bandwidth-sdk/models/code_request.rb
+- lib/bandwidth-sdk/models/completed_lookup_status_enum.rb
 - lib/bandwidth-sdk/models/conference.rb
 - lib/bandwidth-sdk/models/conference_completed_callback.rb
 - lib/bandwidth-sdk/models/conference_created_callback.rb
@@ -390,11 +412,15 @@ files:
 - lib/bandwidth-sdk/models/conference_redirect_callback.rb
 - lib/bandwidth-sdk/models/conference_state_enum.rb
 - lib/bandwidth-sdk/models/contact.rb
+- lib/bandwidth-sdk/models/create_async_bulk_lookup_response.rb
+- lib/bandwidth-sdk/models/create_async_bulk_lookup_response_data.rb
 - lib/bandwidth-sdk/models/create_call.rb
 - lib/bandwidth-sdk/models/create_call_response.rb
-- lib/bandwidth-sdk/models/create_lookup_response.rb
 - lib/bandwidth-sdk/models/create_message_request_error.rb
 - lib/bandwidth-sdk/models/create_multi_channel_message_response.rb
+- lib/bandwidth-sdk/models/create_sync_lookup_response.rb
+- lib/bandwidth-sdk/models/create_sync_lookup_response_data.rb
+- lib/bandwidth-sdk/models/deactivation_event_enum.rb
 - lib/bandwidth-sdk/models/disconnect_callback.rb
 - lib/bandwidth-sdk/models/diversion.rb
 - lib/bandwidth-sdk/models/dtmf_callback.rb
@@ -405,18 +431,24 @@ files:
 - lib/bandwidth-sdk/models/field_error.rb
 - lib/bandwidth-sdk/models/file_format_enum.rb
 - lib/bandwidth-sdk/models/gather_callback.rb
+- lib/bandwidth-sdk/models/get_async_bulk_lookup_response.rb
+- lib/bandwidth-sdk/models/get_async_bulk_lookup_response_data.rb
+- lib/bandwidth-sdk/models/in_progress_lookup_status_enum.rb
 - lib/bandwidth-sdk/models/inbound_callback.rb
 - lib/bandwidth-sdk/models/inbound_callback_message.rb
 - lib/bandwidth-sdk/models/inbound_callback_type_enum.rb
 - lib/bandwidth-sdk/models/initiate_callback.rb
+- lib/bandwidth-sdk/models/latest_message_delivery_status_enum.rb
+- lib/bandwidth-sdk/models/line_type_enum.rb
 - lib/bandwidth-sdk/models/link.rb
+- lib/bandwidth-sdk/models/link_schema.rb
 - lib/bandwidth-sdk/models/links_object.rb
 - lib/bandwidth-sdk/models/list_message_direction_enum.rb
 - lib/bandwidth-sdk/models/list_message_item.rb
-- lib/bandwidth-sdk/models/lookup_request.rb
+- lib/bandwidth-sdk/models/lookup_error_response.rb
+- lib/bandwidth-sdk/models/lookup_error_schema.rb
+- lib/bandwidth-sdk/models/lookup_error_schema_meta.rb
 - lib/bandwidth-sdk/models/lookup_result.rb
-- lib/bandwidth-sdk/models/lookup_status.rb
-- lib/bandwidth-sdk/models/lookup_status_enum.rb
 - lib/bandwidth-sdk/models/machine_detection_complete_callback.rb
 - lib/bandwidth-sdk/models/machine_detection_configuration.rb
 - lib/bandwidth-sdk/models/machine_detection_mode_enum.rb
@@ -437,14 +469,22 @@ files:
 - lib/bandwidth-sdk/models/mms_message_content_file.rb
 - lib/bandwidth-sdk/models/multi_channel_action.rb
 - lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb
-- lib/bandwidth-sdk/models/multi_channel_channel_list_object.rb
-- lib/bandwidth-sdk/models/multi_channel_channel_list_object_content.rb
+- lib/bandwidth-sdk/models/multi_channel_channel_list_mms_object.rb
+- lib/bandwidth-sdk/models/multi_channel_channel_list_mms_response_object.rb
+- lib/bandwidth-sdk/models/multi_channel_channel_list_object_base.rb
+- lib/bandwidth-sdk/models/multi_channel_channel_list_owner_object.rb
+- lib/bandwidth-sdk/models/multi_channel_channel_list_rbm_object.rb
+- lib/bandwidth-sdk/models/multi_channel_channel_list_rbm_object_all_of_content.rb
+- lib/bandwidth-sdk/models/multi_channel_channel_list_rbm_response_object.rb
+- lib/bandwidth-sdk/models/multi_channel_channel_list_request_object.rb
+- lib/bandwidth-sdk/models/multi_channel_channel_list_response_object.rb
+- lib/bandwidth-sdk/models/multi_channel_channel_list_sms_object.rb
+- lib/bandwidth-sdk/models/multi_channel_channel_list_sms_response_object.rb
 - lib/bandwidth-sdk/models/multi_channel_error.rb
 - lib/bandwidth-sdk/models/multi_channel_message_channel_enum.rb
 - lib/bandwidth-sdk/models/multi_channel_message_content.rb
 - lib/bandwidth-sdk/models/multi_channel_message_request.rb
 - lib/bandwidth-sdk/models/multi_channel_message_response_data.rb
-- lib/bandwidth-sdk/models/multi_channel_message_response_data_channel_list_inner.rb
 - lib/bandwidth-sdk/models/opt_in_workflow.rb
 - lib/bandwidth-sdk/models/page_info.rb
 - lib/bandwidth-sdk/models/priority_enum.rb
@@ -478,6 +518,7 @@ files:
 - lib/bandwidth-sdk/models/status_callback_message.rb
 - lib/bandwidth-sdk/models/status_callback_type_enum.rb
 - lib/bandwidth-sdk/models/stir_shaken.rb
+- lib/bandwidth-sdk/models/sync_lookup_request.rb
 - lib/bandwidth-sdk/models/telephone_number.rb
 - lib/bandwidth-sdk/models/tfv_basic_authentication.rb
 - lib/bandwidth-sdk/models/tfv_callback_status_enum.rb
@@ -487,7 +528,6 @@ files:
 - lib/bandwidth-sdk/models/tfv_submission_info.rb
 - lib/bandwidth-sdk/models/tfv_submission_wrapper.rb
 - lib/bandwidth-sdk/models/thumbnail_alignment_enum.rb
-- lib/bandwidth-sdk/models/tn_lookup_request_error.rb
 - lib/bandwidth-sdk/models/transcribe_recording.rb
 - lib/bandwidth-sdk/models/transcription.rb
 - lib/bandwidth-sdk/models/transcription_available_callback.rb

data/docs/LookupStatus.md

@@ -1,24 +0,0 @@
-# Bandwidth::LookupStatus
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **request_id** | **String** | The requestId. | [optional] |
-| **status** | [**LookupStatusEnum**](LookupStatusEnum.md) |  | [optional] |
-| **result** | [**Array<LookupResult>**](LookupResult.md) | The carrier information results for the specified telephone number. | [optional] |
-| **failed_telephone_numbers** | **Array<String>** | The telephone numbers whose lookup failed. | [optional] |
-
-## Example
-
-```ruby
-require 'bandwidth-sdk'
-
-instance = Bandwidth::LookupStatus.new(
-  request_id: 004223a0-8b17-41b1-bf81-20732adf5590,
-  status: null,
-  result: null,
-  failed_telephone_numbers: ["+191955512345"]
-)
-```
-

data/docs/TnLookupRequestError.md

@@ -1,18 +0,0 @@
-# Bandwidth::TnLookupRequestError
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **message** | **String** | A description of what validation error occurred. | [optional] |
-
-## Example
-
-```ruby
-require 'bandwidth-sdk'
-
-instance = Bandwidth::TnLookupRequestError.new(
-  message: example error message
-)
-```
-