bandwidth-sdk 16.2.2 → 17.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +8 -8
- data/README.md +20 -7
- data/bandwidth.yml +551 -277
- data/coverage/.last_run.json +1 -1
- data/coverage/.resultset.json +197 -94
- data/coverage/index.html +2425 -1307
- data/docs/AsyncLookupRequest.md +18 -0
- data/docs/{LookupRequest.md → CompletedLookupStatusEnum.md} +2 -5
- data/docs/CreateAsyncBulkLookupResponse.md +22 -0
- data/docs/{CreateLookupResponse.md → CreateAsyncBulkLookupResponseData.md} +4 -4
- data/docs/CreateSyncLookupResponse.md +22 -0
- data/docs/CreateSyncLookupResponseData.md +22 -0
- data/docs/DeactivationEventEnum.md +15 -0
- data/docs/GetAsyncBulkLookupResponse.md +22 -0
- data/docs/GetAsyncBulkLookupResponseData.md +22 -0
- data/docs/InProgressLookupStatusEnum.md +15 -0
- data/docs/LatestMessageDeliveryStatusEnum.md +15 -0
- data/docs/{LookupStatusEnum.md → LineTypeEnum.md} +2 -2
- data/docs/LinkSchema.md +22 -0
- data/docs/LookupErrorResponse.md +22 -0
- data/docs/LookupErrorSchema.md +24 -0
- data/docs/LookupErrorSchemaMeta.md +22 -0
- data/docs/LookupResult.md +22 -18
- data/docs/PhoneNumberLookupApi.md +111 -38
- data/docs/RbmActionBase.md +1 -1
- data/docs/RbmSuggestionResponse.md +1 -1
- data/docs/SyncLookupRequest.md +18 -0
- data/lib/bandwidth-sdk/api/phone_number_lookup_api.rb +117 -47
- data/lib/bandwidth-sdk/configuration.rb +10 -4
- data/lib/bandwidth-sdk/models/async_lookup_request.rb +232 -0
- data/lib/bandwidth-sdk/models/completed_lookup_status_enum.rb +41 -0
- data/lib/bandwidth-sdk/models/create_async_bulk_lookup_response.rb +235 -0
- data/lib/bandwidth-sdk/models/{create_lookup_response.rb → create_async_bulk_lookup_response_data.rb} +5 -5
- data/lib/bandwidth-sdk/models/create_sync_lookup_response.rb +234 -0
- data/lib/bandwidth-sdk/models/{lookup_status.rb → create_sync_lookup_response_data.rb} +15 -27
- data/lib/bandwidth-sdk/models/deactivation_event_enum.rb +39 -0
- data/lib/bandwidth-sdk/models/get_async_bulk_lookup_response.rb +234 -0
- data/lib/bandwidth-sdk/models/get_async_bulk_lookup_response_data.rb +257 -0
- data/lib/bandwidth-sdk/models/{lookup_status_enum.rb → in_progress_lookup_status_enum.rb} +3 -3
- data/lib/bandwidth-sdk/models/latest_message_delivery_status_enum.rb +41 -0
- data/lib/bandwidth-sdk/models/line_type_enum.rb +42 -0
- data/lib/bandwidth-sdk/models/{lookup_request.rb → link_schema.rb} +31 -20
- data/lib/bandwidth-sdk/models/lookup_error_response.rb +235 -0
- data/lib/bandwidth-sdk/models/lookup_error_schema.rb +242 -0
- data/lib/bandwidth-sdk/models/{tn_lookup_request_error.rb → lookup_error_schema_meta.rb} +29 -8
- data/lib/bandwidth-sdk/models/lookup_result.rb +102 -63
- data/lib/bandwidth-sdk/models/sync_lookup_request.rb +232 -0
- data/lib/bandwidth-sdk/version.rb +1 -1
- data/lib/bandwidth-sdk.rb +17 -5
- data/spec/smoke/multi_channel_api_spec.rb +1 -1
- data/spec/smoke/phone_number_lookup_api_spec.rb +65 -70
- data/spec/unit/api/phone_number_lookup_api_spec.rb +71 -56
- metadata +36 -12
- data/docs/LookupStatus.md +0 -24
- data/docs/TnLookupRequestError.md +0 -18
|
@@ -1,91 +1,86 @@
|
|
|
1
|
-
# Integration
|
|
2
|
-
describe 'PhoneNumberLookupApi
|
|
1
|
+
# Integration tests for Bandwidth::PhoneNumberLookupApi
|
|
2
|
+
describe 'PhoneNumberLookupApi' do
|
|
3
|
+
let(:phone_numbers) { [BW_NUMBER, USER_NUMBER] }
|
|
4
|
+
|
|
3
5
|
before(:all) do
|
|
4
6
|
Bandwidth.configure do |config|
|
|
5
7
|
config.username = BW_USERNAME
|
|
6
8
|
config.password = BW_PASSWORD
|
|
7
9
|
end
|
|
8
|
-
@
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
10
|
+
@api_instance = Bandwidth::PhoneNumberLookupApi.new
|
|
11
|
+
end
|
|
12
|
+
describe 'test an instance of PhoneNumberLookupApi' do
|
|
13
|
+
it 'should create an instance of PhoneNumberLookupApi' do
|
|
14
|
+
expect(@api_instance).to be_instance_of(Bandwidth::PhoneNumberLookupApi)
|
|
15
|
+
end
|
|
12
16
|
end
|
|
13
17
|
|
|
14
|
-
# Create Lookup
|
|
15
|
-
describe '
|
|
16
|
-
it '
|
|
17
|
-
|
|
18
|
-
|
|
18
|
+
# Create Asynchronous Bulk Number Lookup
|
|
19
|
+
describe 'create_get_async_bulk_lookup test' do
|
|
20
|
+
it 'should work' do
|
|
21
|
+
request = Bandwidth::AsyncLookupRequest.new(
|
|
22
|
+
phone_numbers: phone_numbers,
|
|
19
23
|
)
|
|
20
|
-
data, status_code = @api_instance_tnlookup.create_lookup_with_http_info(BW_ACCOUNT_ID, tn_body)
|
|
21
24
|
|
|
22
|
-
|
|
23
|
-
expect(data).to be_instance_of(Bandwidth::CreateLookupResponse)
|
|
24
|
-
expect(data.request_id.length).to eq(36)
|
|
25
|
-
expect(data.status).to be_instance_of(String)
|
|
25
|
+
create_data, create_status_code = @api_instance.create_async_bulk_lookup_with_http_info(BW_ACCOUNT_ID, request)
|
|
26
26
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
27
|
+
expect(create_status_code).to eq(202)
|
|
28
|
+
expect(create_data).to be_instance_of(Bandwidth::CreateAsyncBulkLookupResponse)
|
|
29
|
+
expect(create_data.links[0]).to be_instance_of(Bandwidth::LinkSchema)
|
|
30
|
+
expect(create_data.links[0].rel).to be_instance_of(String)
|
|
31
|
+
expect(create_data.links[0].href).to be_instance_of(String)
|
|
32
|
+
expect(create_data.links[0].method).to be_instance_of(String)
|
|
33
|
+
expect(create_data.data).to be_instance_of(Bandwidth::CreateAsyncBulkLookupResponseData)
|
|
34
|
+
expect(create_data.data.request_id).to be_instance_of(String)
|
|
35
|
+
expect(create_data.data.status).to be_one_of(Bandwidth::InProgressLookupStatusEnum.all_vars)
|
|
36
|
+
expect(create_data.errors).to be_instance_of(Array)
|
|
31
37
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
it 'gets lookup status' do
|
|
35
|
-
data, status_code = @api_instance_tnlookup.get_lookup_status_with_http_info(BW_ACCOUNT_ID, $lookup_request_id)
|
|
38
|
+
request_id = create_data.data.request_id
|
|
39
|
+
sleep(10)
|
|
36
40
|
|
|
37
|
-
|
|
38
|
-
expect(
|
|
39
|
-
expect(
|
|
40
|
-
expect(
|
|
41
|
-
expect(
|
|
42
|
-
expect(
|
|
43
|
-
expect(
|
|
41
|
+
get_data, get_status_code = @api_instance.get_async_bulk_lookup_with_http_info(BW_ACCOUNT_ID, request_id)
|
|
42
|
+
expect(get_status_code).to equal_to(200)
|
|
43
|
+
expect(get_data).to be_instance_of(Bandwidth::GetAsyncBulkLookupResponse)
|
|
44
|
+
expect(get_data.links[0]).to be_instance_of(Bandwidth::LinkSchema)
|
|
45
|
+
expect(get_data.links[0].rel).to be_instance_of(String)
|
|
46
|
+
expect(get_data.links[0].href).to be_instance_of(String)
|
|
47
|
+
expect(get_data.links[0].method).to be_instance_of(String)
|
|
48
|
+
expect(get_data.data.request_id).to eq(request_id)
|
|
49
|
+
expect(get_data.data.status).to eq(Bandwidth::InProgressLookupStatusEnum::COMPLETE)
|
|
50
|
+
expect(get_data.data.results).to be_instance_of(Array)
|
|
51
|
+
expect(get_data.data.results[0]).to be_instance_of(Bandwidth::LookupResult)
|
|
52
|
+
expect(get_data.data.results[0].phone_number).to be_instance_of(String)
|
|
53
|
+
expect(get_data.data.results[0].line_type).to be_one_of(Bandwidth::LineTypeEnum.all_vars)
|
|
54
|
+
expect(get_data.data.results[0].messaging_provider).to be_instance_of(String)
|
|
55
|
+
expect(get_data.data.results[0].voice_provider).to be_instance_of(String)
|
|
56
|
+
expect(get_data.data.results[0].country_code_a3).to be_instance_of(String)
|
|
44
57
|
end
|
|
45
58
|
end
|
|
46
59
|
|
|
47
|
-
#
|
|
48
|
-
describe '
|
|
49
|
-
it '
|
|
50
|
-
|
|
51
|
-
|
|
60
|
+
# Create Synchronous Number Lookup
|
|
61
|
+
describe 'create_sync_lookup test' do
|
|
62
|
+
it 'should work' do
|
|
63
|
+
request = Bandwidth::SyncLookupRequest.new(
|
|
64
|
+
phone_numbers: phone_numbers,
|
|
52
65
|
)
|
|
53
66
|
|
|
54
|
-
|
|
55
|
-
@api_instance_tnlookup.create_lookup_with_http_info(BW_ACCOUNT_ID, tn_body_bad)
|
|
56
|
-
}.to raise_error { |e|
|
|
57
|
-
expect(e).to be_instance_of(Bandwidth::ApiError)
|
|
58
|
-
expect(e.code).to eq(400)
|
|
59
|
-
}
|
|
60
|
-
end
|
|
61
|
-
|
|
62
|
-
it 'causes a 404 error' do
|
|
63
|
-
req_id_dne = '12345678-abcd-cdef-9876-12345678abcd'
|
|
64
|
-
|
|
65
|
-
expect {
|
|
66
|
-
@api_instance_tnlookup.get_lookup_status_with_http_info(BW_ACCOUNT_ID, req_id_dne)
|
|
67
|
-
}.to raise_error { |e|
|
|
68
|
-
expect(e).to be_instance_of(Bandwidth::ApiError)
|
|
69
|
-
expect(e.code).to eq(404)
|
|
70
|
-
}
|
|
71
|
-
end
|
|
72
|
-
|
|
73
|
-
it 'causes a 401 error' do
|
|
74
|
-
Bandwidth.configure do |config|
|
|
75
|
-
config.username = UNAUTHORIZED_USERNAME
|
|
76
|
-
config.password = UNAUTHORIZED_PASSWORD
|
|
77
|
-
end
|
|
78
|
-
|
|
79
|
-
tn_body = Bandwidth::LookupRequest.new(
|
|
80
|
-
tns: [BW_NUMBER]
|
|
81
|
-
)
|
|
67
|
+
data, status_code = @api_instance.create_sync_lookup_with_http_info(BW_ACCOUNT_ID, request)
|
|
82
68
|
|
|
83
|
-
expect
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
69
|
+
expect(status_code).to equal_to(200)
|
|
70
|
+
expect(data).to be_instance_of(Bandwidth::CreateSyncLookupResponse)
|
|
71
|
+
expect(data.links[0]).to be_instance_of(Bandwidth::LinkSchema)
|
|
72
|
+
expect(data.links[0].rel).to be_instance_of(String)
|
|
73
|
+
expect(data.links[0].href).to be_instance_of(String)
|
|
74
|
+
expect(data.links[0].method).to be_instance_of(String)
|
|
75
|
+
expect(data.data.request_id).to be_instance_of(String)
|
|
76
|
+
expect(data.data.status).to eq(Bandwidth::CompletedLookupStatusEnum::COMPLETE)
|
|
77
|
+
expect(data.data.results).to be_instance_of(Array)
|
|
78
|
+
expect(data.data.results[0]).to be_instance_of(Bandwidth::LookupResult)
|
|
79
|
+
expect(data.data.results[0].phone_number).to be_instance_of(String)
|
|
80
|
+
expect(data.data.results[0].line_type).to be_one_of(Bandwidth::LineTypeEnum.all_vars)
|
|
81
|
+
expect(data.data.results[0].messaging_provider).to be_instance_of(String)
|
|
82
|
+
expect(data.data.results[0].voice_provider).to be_instance_of(String)
|
|
83
|
+
expect(data.data.results[0].country_code_a3).to be_instance_of(String)
|
|
89
84
|
end
|
|
90
85
|
end
|
|
91
86
|
end
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# Unit tests for Bandwidth::PhoneNumberLookupApi
|
|
2
2
|
describe 'PhoneNumberLookupApi' do
|
|
3
|
-
let(:
|
|
3
|
+
let(:phone_numbers) { [BW_NUMBER, USER_NUMBER] }
|
|
4
|
+
let(:request_id) { '123e4567-e89b-12d3-a456-426614174000' }
|
|
4
5
|
|
|
5
6
|
before(:all) do
|
|
6
7
|
Bandwidth.configure do |config|
|
|
@@ -10,77 +11,91 @@ describe 'PhoneNumberLookupApi' do
|
|
|
10
11
|
config.ignore_operation_servers = true
|
|
11
12
|
config.host = '127.0.0.1:4010'
|
|
12
13
|
end
|
|
13
|
-
@
|
|
14
|
+
@api_instance = Bandwidth::PhoneNumberLookupApi.new
|
|
14
15
|
end
|
|
15
|
-
|
|
16
16
|
describe 'test an instance of PhoneNumberLookupApi' do
|
|
17
17
|
it 'should create an instance of PhoneNumberLookupApi' do
|
|
18
|
-
expect(@
|
|
18
|
+
expect(@api_instance).to be_instance_of(Bandwidth::PhoneNumberLookupApi)
|
|
19
19
|
end
|
|
20
20
|
end
|
|
21
21
|
|
|
22
|
-
# Create Lookup
|
|
23
|
-
describe '
|
|
24
|
-
it '
|
|
25
|
-
|
|
26
|
-
|
|
22
|
+
# Create Asynchronous Bulk Number Lookup
|
|
23
|
+
describe 'create_async_bulk_lookup test' do
|
|
24
|
+
it 'should work' do
|
|
25
|
+
request = Bandwidth::AsyncLookupRequest.new(
|
|
26
|
+
phone_numbers: phone_numbers,
|
|
27
27
|
)
|
|
28
|
-
data, status_code = @phone_number_lookup_api_instance.create_lookup_with_http_info(BW_ACCOUNT_ID, tn_body)
|
|
29
28
|
|
|
30
|
-
|
|
31
|
-
expect(data).to be_instance_of(Bandwidth::CreateLookupResponse)
|
|
32
|
-
expect(data.request_id.length).to eq(36)
|
|
33
|
-
expect(data.status).to be_one_of(Bandwidth::LookupStatusEnum.all_vars)
|
|
34
|
-
end
|
|
35
|
-
|
|
36
|
-
it 'causes an ArgumentError for a missing account_id' do
|
|
37
|
-
expect {
|
|
38
|
-
@phone_number_lookup_api_instance.create_lookup(nil, {})
|
|
39
|
-
}.to raise_error(ArgumentError)
|
|
40
|
-
end
|
|
29
|
+
data, status_code = @api_instance.create_async_bulk_lookup_with_http_info(BW_ACCOUNT_ID, request)
|
|
41
30
|
|
|
42
|
-
|
|
43
|
-
expect
|
|
44
|
-
|
|
45
|
-
|
|
31
|
+
expect(status_code).to eq(202)
|
|
32
|
+
expect(data).to be_instance_of(Bandwidth::CreateAsyncBulkLookupResponse)
|
|
33
|
+
expect(data.links[0]).to be_instance_of(Bandwidth::LinkSchema)
|
|
34
|
+
expect(data.links[0].rel).to be_instance_of(String)
|
|
35
|
+
expect(data.links[0].href).to be_instance_of(String)
|
|
36
|
+
expect(data.links[0].method).to be_instance_of(String)
|
|
37
|
+
expect(data.data).to be_instance_of(Bandwidth::CreateAsyncBulkLookupResponseData)
|
|
38
|
+
expect(data.data.request_id).to be_instance_of(String)
|
|
39
|
+
expect(data.data.status).to eq(Bandwidth::InProgressLookupStatusEnum::IN_PROGRESS)
|
|
40
|
+
expect(data.errors).to be_instance_of(Array)
|
|
46
41
|
end
|
|
47
42
|
end
|
|
48
43
|
|
|
49
|
-
#
|
|
50
|
-
describe '
|
|
51
|
-
it '
|
|
52
|
-
|
|
53
|
-
|
|
44
|
+
# Create Synchronous Number Lookup
|
|
45
|
+
describe 'create_sync_lookup test' do
|
|
46
|
+
it 'should work' do
|
|
47
|
+
request = Bandwidth::SyncLookupRequest.new(
|
|
48
|
+
phone_numbers: phone_numbers,
|
|
49
|
+
)
|
|
54
50
|
|
|
55
|
-
|
|
56
|
-
expect(data).to be_instance_of(Bandwidth::LookupStatus)
|
|
57
|
-
expect(data.request_id.length).to eq(36)
|
|
58
|
-
expect(data.status).to be_one_of(Bandwidth::LookupStatusEnum.all_vars)
|
|
59
|
-
expect(data.result).to be_instance_of(Array)
|
|
60
|
-
expect(data.result[0]).to be_instance_of(Bandwidth::LookupResult)
|
|
61
|
-
expect(data.result[0].response_code).to be_instance_of(Integer)
|
|
62
|
-
expect(data.result[0].message).to be_instance_of(String)
|
|
63
|
-
expect(data.result[0].e_164_format.length).to eq(12)
|
|
64
|
-
expect(data.result[0].formatted.length).to eq(14)
|
|
65
|
-
expect(data.result[0].country).to be_instance_of(String)
|
|
66
|
-
expect(data.result[0].line_type).to be_instance_of(String)
|
|
67
|
-
expect(data.result[0].line_provider).to be_instance_of(String)
|
|
68
|
-
expect(data.result[0].mobile_country_code).to be_instance_of(String)
|
|
69
|
-
expect(data.result[0].mobile_network_code).to be_instance_of(String)
|
|
70
|
-
expect(data.failed_telephone_numbers).to be_instance_of(Array)
|
|
71
|
-
expect(data.failed_telephone_numbers[0]).to be_instance_of(String)
|
|
72
|
-
end
|
|
51
|
+
data, status_code = @api_instance.create_sync_lookup_with_http_info(BW_ACCOUNT_ID, request)
|
|
73
52
|
|
|
74
|
-
|
|
75
|
-
expect
|
|
76
|
-
|
|
77
|
-
|
|
53
|
+
expect(status_code).to equal_to(200)
|
|
54
|
+
expect(data).to be_instance_of(Bandwidth::CreateSyncLookupResponse)
|
|
55
|
+
expect(data.links[0]).to be_instance_of(Bandwidth::LinkSchema)
|
|
56
|
+
expect(data.links[0].rel).to be_instance_of(String)
|
|
57
|
+
expect(data.links[0].href).to be_instance_of(String)
|
|
58
|
+
expect(data.links[0].method).to be_instance_of(String)
|
|
59
|
+
expect(data.data.request_id).to be_instance_of(String)
|
|
60
|
+
expect(data.data.status).to eq(Bandwidth::CompletedLookupStatusEnum::COMPLETE)
|
|
61
|
+
expect(data.data.results).to be_instance_of(Array)
|
|
62
|
+
expect(data.data.results[0]).to be_instance_of(Bandwidth::LookupResult)
|
|
63
|
+
expect(data.data.results[0].phone_number).to be_instance_of(String)
|
|
64
|
+
expect(data.data.results[0].line_type).to eq(Bandwidth::LineTypeEnum::MOBILE)
|
|
65
|
+
expect(data.data.results[0].messaging_provider).to be_instance_of(String)
|
|
66
|
+
expect(data.data.results[0].voice_provider).to be_instance_of(String)
|
|
67
|
+
expect(data.data.results[0].country_code_a3).to be_instance_of(String)
|
|
68
|
+
expect(data.data.results[0].latest_message_delivery_status).to eq(Bandwidth::LatestMessageDeliveryStatusEnum::ACTIVE)
|
|
69
|
+
expect(data.data.results[0].initial_message_delivery_status_date).to be_instance_of(Date)
|
|
70
|
+
expect(data.data.results[0].latest_message_delivery_status_date).to be_instance_of(Date)
|
|
71
|
+
expect(data.errors).to be_instance_of(Array)
|
|
78
72
|
end
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
# Get Asynchronous Bulk Number Lookup
|
|
76
|
+
describe 'get_async_bulk_lookup test' do
|
|
77
|
+
it 'should work' do
|
|
78
|
+
data, status_code = @api_instance.get_async_bulk_lookup_with_http_info(BW_ACCOUNT_ID, request_id)
|
|
79
79
|
|
|
80
|
-
|
|
81
|
-
expect
|
|
82
|
-
|
|
83
|
-
|
|
80
|
+
expect(status_code).to equal_to(200)
|
|
81
|
+
expect(data).to be_instance_of(Bandwidth::GetAsyncBulkLookupResponse)
|
|
82
|
+
expect(data.links[0]).to be_instance_of(Bandwidth::LinkSchema)
|
|
83
|
+
expect(data.links[0].rel).to be_instance_of(String)
|
|
84
|
+
expect(data.links[0].href).to be_instance_of(String)
|
|
85
|
+
expect(data.links[0].method).to be_instance_of(String)
|
|
86
|
+
expect(data.data.request_id).to be_instance_of(String)
|
|
87
|
+
expect(data.data.status).to eq(Bandwidth::InProgressLookupStatusEnum::COMPLETE)
|
|
88
|
+
expect(data.data.results).to be_instance_of(Array)
|
|
89
|
+
expect(data.data.results[0]).to be_instance_of(Bandwidth::LookupResult)
|
|
90
|
+
expect(data.data.results[0].phone_number).to be_instance_of(String)
|
|
91
|
+
expect(data.data.results[0].line_type).to eq(Bandwidth::LineTypeEnum::MOBILE)
|
|
92
|
+
expect(data.data.results[0].messaging_provider).to be_instance_of(String)
|
|
93
|
+
expect(data.data.results[0].voice_provider).to be_instance_of(String)
|
|
94
|
+
expect(data.data.results[0].country_code_a3).to be_instance_of(String)
|
|
95
|
+
expect(data.data.results[0].latest_message_delivery_status).to eq(Bandwidth::LatestMessageDeliveryStatusEnum::ACTIVE)
|
|
96
|
+
expect(data.data.results[0].initial_message_delivery_status_date).to be_instance_of(Date)
|
|
97
|
+
expect(data.data.results[0].latest_message_delivery_status_date).to be_instance_of(Date)
|
|
98
|
+
expect(data.errors).to be_instance_of(Array)
|
|
84
99
|
end
|
|
85
100
|
end
|
|
86
101
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: bandwidth-sdk
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version:
|
|
4
|
+
version: 17.0.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Bandwidth
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2025-
|
|
11
|
+
date: 2025-11-11 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: faraday
|
|
@@ -147,6 +147,7 @@ files:
|
|
|
147
147
|
- docs/AdditionalDenialReason.md
|
|
148
148
|
- docs/Address.md
|
|
149
149
|
- docs/AnswerCallback.md
|
|
150
|
+
- docs/AsyncLookupRequest.md
|
|
150
151
|
- docs/BlockedWebhook.md
|
|
151
152
|
- docs/BridgeCompleteCallback.md
|
|
152
153
|
- docs/BridgeTargetCompleteCallback.md
|
|
@@ -166,6 +167,7 @@ files:
|
|
|
166
167
|
- docs/CallsApi.md
|
|
167
168
|
- docs/CardWidthEnum.md
|
|
168
169
|
- docs/CodeRequest.md
|
|
170
|
+
- docs/CompletedLookupStatusEnum.md
|
|
169
171
|
- docs/Conference.md
|
|
170
172
|
- docs/ConferenceCompletedCallback.md
|
|
171
173
|
- docs/ConferenceCreatedCallback.md
|
|
@@ -178,11 +180,15 @@ files:
|
|
|
178
180
|
- docs/ConferenceStateEnum.md
|
|
179
181
|
- docs/ConferencesApi.md
|
|
180
182
|
- docs/Contact.md
|
|
183
|
+
- docs/CreateAsyncBulkLookupResponse.md
|
|
184
|
+
- docs/CreateAsyncBulkLookupResponseData.md
|
|
181
185
|
- docs/CreateCall.md
|
|
182
186
|
- docs/CreateCallResponse.md
|
|
183
|
-
- docs/CreateLookupResponse.md
|
|
184
187
|
- docs/CreateMessageRequestError.md
|
|
185
188
|
- docs/CreateMultiChannelMessageResponse.md
|
|
189
|
+
- docs/CreateSyncLookupResponse.md
|
|
190
|
+
- docs/CreateSyncLookupResponseData.md
|
|
191
|
+
- docs/DeactivationEventEnum.md
|
|
186
192
|
- docs/DisconnectCallback.md
|
|
187
193
|
- docs/Diversion.md
|
|
188
194
|
- docs/DtmfCallback.md
|
|
@@ -193,18 +199,24 @@ files:
|
|
|
193
199
|
- docs/FieldError.md
|
|
194
200
|
- docs/FileFormatEnum.md
|
|
195
201
|
- docs/GatherCallback.md
|
|
202
|
+
- docs/GetAsyncBulkLookupResponse.md
|
|
203
|
+
- docs/GetAsyncBulkLookupResponseData.md
|
|
204
|
+
- docs/InProgressLookupStatusEnum.md
|
|
196
205
|
- docs/InboundCallback.md
|
|
197
206
|
- docs/InboundCallbackMessage.md
|
|
198
207
|
- docs/InboundCallbackTypeEnum.md
|
|
199
208
|
- docs/InitiateCallback.md
|
|
209
|
+
- docs/LatestMessageDeliveryStatusEnum.md
|
|
210
|
+
- docs/LineTypeEnum.md
|
|
200
211
|
- docs/Link.md
|
|
212
|
+
- docs/LinkSchema.md
|
|
201
213
|
- docs/LinksObject.md
|
|
202
214
|
- docs/ListMessageDirectionEnum.md
|
|
203
215
|
- docs/ListMessageItem.md
|
|
204
|
-
- docs/
|
|
216
|
+
- docs/LookupErrorResponse.md
|
|
217
|
+
- docs/LookupErrorSchema.md
|
|
218
|
+
- docs/LookupErrorSchemaMeta.md
|
|
205
219
|
- docs/LookupResult.md
|
|
206
|
-
- docs/LookupStatus.md
|
|
207
|
-
- docs/LookupStatusEnum.md
|
|
208
220
|
- docs/MFAApi.md
|
|
209
221
|
- docs/MachineDetectionCompleteCallback.md
|
|
210
222
|
- docs/MachineDetectionConfiguration.md
|
|
@@ -273,6 +285,7 @@ files:
|
|
|
273
285
|
- docs/StatusCallbackMessage.md
|
|
274
286
|
- docs/StatusCallbackTypeEnum.md
|
|
275
287
|
- docs/StirShaken.md
|
|
288
|
+
- docs/SyncLookupRequest.md
|
|
276
289
|
- docs/TelephoneNumber.md
|
|
277
290
|
- docs/TfvBasicAuthentication.md
|
|
278
291
|
- docs/TfvCallbackStatusEnum.md
|
|
@@ -282,7 +295,6 @@ files:
|
|
|
282
295
|
- docs/TfvSubmissionInfo.md
|
|
283
296
|
- docs/TfvSubmissionWrapper.md
|
|
284
297
|
- docs/ThumbnailAlignmentEnum.md
|
|
285
|
-
- docs/TnLookupRequestError.md
|
|
286
298
|
- docs/TollFreeVerificationApi.md
|
|
287
299
|
- docs/TranscribeRecording.md
|
|
288
300
|
- docs/Transcription.md
|
|
@@ -328,6 +340,7 @@ files:
|
|
|
328
340
|
- lib/bandwidth-sdk/models/additional_denial_reason.rb
|
|
329
341
|
- lib/bandwidth-sdk/models/address.rb
|
|
330
342
|
- lib/bandwidth-sdk/models/answer_callback.rb
|
|
343
|
+
- lib/bandwidth-sdk/models/async_lookup_request.rb
|
|
331
344
|
- lib/bandwidth-sdk/models/blocked_webhook.rb
|
|
332
345
|
- lib/bandwidth-sdk/models/bridge_complete_callback.rb
|
|
333
346
|
- lib/bandwidth-sdk/models/bridge_target_complete_callback.rb
|
|
@@ -379,6 +392,7 @@ files:
|
|
|
379
392
|
- lib/bandwidth-sdk/models/callback_method_enum.rb
|
|
380
393
|
- lib/bandwidth-sdk/models/card_width_enum.rb
|
|
381
394
|
- lib/bandwidth-sdk/models/code_request.rb
|
|
395
|
+
- lib/bandwidth-sdk/models/completed_lookup_status_enum.rb
|
|
382
396
|
- lib/bandwidth-sdk/models/conference.rb
|
|
383
397
|
- lib/bandwidth-sdk/models/conference_completed_callback.rb
|
|
384
398
|
- lib/bandwidth-sdk/models/conference_created_callback.rb
|
|
@@ -390,11 +404,15 @@ files:
|
|
|
390
404
|
- lib/bandwidth-sdk/models/conference_redirect_callback.rb
|
|
391
405
|
- lib/bandwidth-sdk/models/conference_state_enum.rb
|
|
392
406
|
- lib/bandwidth-sdk/models/contact.rb
|
|
407
|
+
- lib/bandwidth-sdk/models/create_async_bulk_lookup_response.rb
|
|
408
|
+
- lib/bandwidth-sdk/models/create_async_bulk_lookup_response_data.rb
|
|
393
409
|
- lib/bandwidth-sdk/models/create_call.rb
|
|
394
410
|
- lib/bandwidth-sdk/models/create_call_response.rb
|
|
395
|
-
- lib/bandwidth-sdk/models/create_lookup_response.rb
|
|
396
411
|
- lib/bandwidth-sdk/models/create_message_request_error.rb
|
|
397
412
|
- lib/bandwidth-sdk/models/create_multi_channel_message_response.rb
|
|
413
|
+
- lib/bandwidth-sdk/models/create_sync_lookup_response.rb
|
|
414
|
+
- lib/bandwidth-sdk/models/create_sync_lookup_response_data.rb
|
|
415
|
+
- lib/bandwidth-sdk/models/deactivation_event_enum.rb
|
|
398
416
|
- lib/bandwidth-sdk/models/disconnect_callback.rb
|
|
399
417
|
- lib/bandwidth-sdk/models/diversion.rb
|
|
400
418
|
- lib/bandwidth-sdk/models/dtmf_callback.rb
|
|
@@ -405,18 +423,24 @@ files:
|
|
|
405
423
|
- lib/bandwidth-sdk/models/field_error.rb
|
|
406
424
|
- lib/bandwidth-sdk/models/file_format_enum.rb
|
|
407
425
|
- lib/bandwidth-sdk/models/gather_callback.rb
|
|
426
|
+
- lib/bandwidth-sdk/models/get_async_bulk_lookup_response.rb
|
|
427
|
+
- lib/bandwidth-sdk/models/get_async_bulk_lookup_response_data.rb
|
|
428
|
+
- lib/bandwidth-sdk/models/in_progress_lookup_status_enum.rb
|
|
408
429
|
- lib/bandwidth-sdk/models/inbound_callback.rb
|
|
409
430
|
- lib/bandwidth-sdk/models/inbound_callback_message.rb
|
|
410
431
|
- lib/bandwidth-sdk/models/inbound_callback_type_enum.rb
|
|
411
432
|
- lib/bandwidth-sdk/models/initiate_callback.rb
|
|
433
|
+
- lib/bandwidth-sdk/models/latest_message_delivery_status_enum.rb
|
|
434
|
+
- lib/bandwidth-sdk/models/line_type_enum.rb
|
|
412
435
|
- lib/bandwidth-sdk/models/link.rb
|
|
436
|
+
- lib/bandwidth-sdk/models/link_schema.rb
|
|
413
437
|
- lib/bandwidth-sdk/models/links_object.rb
|
|
414
438
|
- lib/bandwidth-sdk/models/list_message_direction_enum.rb
|
|
415
439
|
- lib/bandwidth-sdk/models/list_message_item.rb
|
|
416
|
-
- lib/bandwidth-sdk/models/
|
|
440
|
+
- lib/bandwidth-sdk/models/lookup_error_response.rb
|
|
441
|
+
- lib/bandwidth-sdk/models/lookup_error_schema.rb
|
|
442
|
+
- lib/bandwidth-sdk/models/lookup_error_schema_meta.rb
|
|
417
443
|
- lib/bandwidth-sdk/models/lookup_result.rb
|
|
418
|
-
- lib/bandwidth-sdk/models/lookup_status.rb
|
|
419
|
-
- lib/bandwidth-sdk/models/lookup_status_enum.rb
|
|
420
444
|
- lib/bandwidth-sdk/models/machine_detection_complete_callback.rb
|
|
421
445
|
- lib/bandwidth-sdk/models/machine_detection_configuration.rb
|
|
422
446
|
- lib/bandwidth-sdk/models/machine_detection_mode_enum.rb
|
|
@@ -478,6 +502,7 @@ files:
|
|
|
478
502
|
- lib/bandwidth-sdk/models/status_callback_message.rb
|
|
479
503
|
- lib/bandwidth-sdk/models/status_callback_type_enum.rb
|
|
480
504
|
- lib/bandwidth-sdk/models/stir_shaken.rb
|
|
505
|
+
- lib/bandwidth-sdk/models/sync_lookup_request.rb
|
|
481
506
|
- lib/bandwidth-sdk/models/telephone_number.rb
|
|
482
507
|
- lib/bandwidth-sdk/models/tfv_basic_authentication.rb
|
|
483
508
|
- lib/bandwidth-sdk/models/tfv_callback_status_enum.rb
|
|
@@ -487,7 +512,6 @@ files:
|
|
|
487
512
|
- lib/bandwidth-sdk/models/tfv_submission_info.rb
|
|
488
513
|
- lib/bandwidth-sdk/models/tfv_submission_wrapper.rb
|
|
489
514
|
- lib/bandwidth-sdk/models/thumbnail_alignment_enum.rb
|
|
490
|
-
- lib/bandwidth-sdk/models/tn_lookup_request_error.rb
|
|
491
515
|
- lib/bandwidth-sdk/models/transcribe_recording.rb
|
|
492
516
|
- lib/bandwidth-sdk/models/transcription.rb
|
|
493
517
|
- lib/bandwidth-sdk/models/transcription_available_callback.rb
|
data/docs/LookupStatus.md
DELETED
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# Bandwidth::LookupStatus
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **request_id** | **String** | The requestId. | [optional] |
|
|
8
|
-
| **status** | [**LookupStatusEnum**](LookupStatusEnum.md) | | [optional] |
|
|
9
|
-
| **result** | [**Array<LookupResult>**](LookupResult.md) | The carrier information results for the specified telephone number. | [optional] |
|
|
10
|
-
| **failed_telephone_numbers** | **Array<String>** | The telephone numbers whose lookup failed. | [optional] |
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```ruby
|
|
15
|
-
require 'bandwidth-sdk'
|
|
16
|
-
|
|
17
|
-
instance = Bandwidth::LookupStatus.new(
|
|
18
|
-
request_id: 004223a0-8b17-41b1-bf81-20732adf5590,
|
|
19
|
-
status: null,
|
|
20
|
-
result: null,
|
|
21
|
-
failed_telephone_numbers: ["+191955512345"]
|
|
22
|
-
)
|
|
23
|
-
```
|
|
24
|
-
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
# Bandwidth::TnLookupRequestError
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **message** | **String** | A description of what validation error occurred. | [optional] |
|
|
8
|
-
|
|
9
|
-
## Example
|
|
10
|
-
|
|
11
|
-
```ruby
|
|
12
|
-
require 'bandwidth-sdk'
|
|
13
|
-
|
|
14
|
-
instance = Bandwidth::TnLookupRequestError.new(
|
|
15
|
-
message: example error message
|
|
16
|
-
)
|
|
17
|
-
```
|
|
18
|
-
|