bandwidth-sdk 16.2.1 → 16.2.2

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.
Files changed (12) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +15 -15
  3. data/bandwidth.yml +6 -4
  4. data/coverage/.resultset.json +5 -1
  5. data/coverage/index.html +209 -161
  6. data/docs/CallState.md +2 -2
  7. data/docs/StirShaken.md +2 -2
  8. data/lib/bandwidth-sdk/api/phone_number_lookup_api.rb +4 -0
  9. data/lib/bandwidth-sdk/models/call_state.rb +1 -1
  10. data/lib/bandwidth-sdk/models/stir_shaken.rb +1 -1
  11. data/lib/bandwidth-sdk/version.rb +1 -1
  12. metadata +46 -46
data/docs/CallState.md CHANGED
@@ -12,7 +12,7 @@
12
12
  | **from** | **String** | The phone number that made the call, in E.164 format (e.g. +15555555555). | [optional] |
13
13
  | **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] |
14
14
  | **state** | **String** | The current state of the call. Current possible values are `queued`, `initiated`, `answered` and `disconnected`. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] |
15
- | **stir_shaken** | **Hash<String, String>** | For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. | Property | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-Verification-Passed` or `TN-Verification-Failed`. | | attestationIndicator | (optional) The attestation level verified by Bandwidth. Possible values are `A` (full), `B` (partial) or `C` (gateway). | | originatingId | (optional) A unique origination identifier. | Note that these are common properties but that the `stirShaken` object is free form and can contain other key-value pairs. More information: [Understanding STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken). | [optional] |
15
+ | **stir_shaken** | **Hash<String, String>** | For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. | Property | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-Validation-Passed` or `TN-Validation-Failed`. | | attestationIndicator | (optional) The attestation level verified by Bandwidth. Possible values are `A` (full), `B` (partial) or `C` (gateway). | | originatingId | (optional) A unique origination identifier. | Note that these are common properties but that the `stirShaken` object is free form and can contain other key-value pairs. More information: [Understanding STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken). | [optional] |
16
16
  | **identity** | **String** | The value of the `Identity` header from the inbound invite request. Only present for inbound calls and if the account is configured to forward this header. | [optional] |
17
17
  | **enqueued_time** | **Time** | The time this call was placed in queue. | [optional] |
18
18
  | **start_time** | **Time** | The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue. | [optional] |
@@ -37,7 +37,7 @@ instance = Bandwidth::CallState.new(
37
37
  from: +19195554321,
38
38
  direction: null,
39
39
  state: disconnected,
40
- stir_shaken: {"verstat":"TN-Verification-Passed","attestationIndicator":"A","originatingId":"abc123"},
40
+ stir_shaken: {"verstat":"TN-Validation-Passed","attestationIndicator":"A","originatingId":"abc123"},
41
41
  identity: eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9idy1zaGFrZW4tY2VydC1wdWIuczMuYW1hem9uYXdzLmNvbS9iYW5kd2lkdGgtc2hha2VuLWNlcnRfMjAyMzA3MTYucGVtIn0.eyJhdHRlc3QiOiJBIiwiZGVzdCI6eyJ0biI6WyIxOTg0MjgyMDI4MCJdfSwiaWF0IjoxNjU2NTM0MzM2LCJvcmlnIjp7InRuIjoiMTkxOTQ0NDI2ODMifSwib3JpZ2lkIjoiNDk0NTlhOGEtNDJmNi0zNTFjLTkzNjEtYWRmNTdhOWUwOGNhIn0.56un9sRw_uH-sbJvnUsqdevlVxbOVjn8MVlGTlBMicjaZuRRwxfiNp-C9zYCMKTTCbc-QdYPN05F61XNVN4D3w;info=<https://bw-shaken-cert-pub.s3.amazonaws.com/bandwidth-shaken-cert_20230716.pem>;alg=ES256;ppt=shaken,
42
42
  enqueued_time: 2022-06-16T13:15:07.160Z,
43
43
  start_time: 2022-06-16T13:15:07.160Z,
data/docs/StirShaken.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **verstat** | **String** | (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Verification-Passed and TN-Verification-Failed. | [optional] |
7
+ | **verstat** | **String** | (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Validation-Passed and TN-Validation-Failed. | [optional] |
8
8
  | **attestation_indicator** | **String** | (optional) The attestation level verified by Bandwidth. Possible values are A (full), B (partial) or C (gateway). | [optional] |
9
9
  | **originating_id** | **String** | (optional) A unique origination identifier. | [optional] |
10
10
 
@@ -14,7 +14,7 @@
14
14
  require 'bandwidth-sdk'
15
15
 
16
16
  instance = Bandwidth::StirShaken.new(
17
- verstat: Tn-Verification-Passed,
17
+ verstat: Tn-Validation-Passed,
18
18
  attestation_indicator: A,
19
19
  originating_id: 99759086-1335-11ed-9bcf-5f7d464e91af
20
20
  )
data/lib/bandwidth-sdk/api/phone_number_lookup_api.rb CHANGED
@@ -26,6 +26,7 @@ module Bandwidth
26
26
  # @param [Hash] opts the optional parameters
27
27
  # @return [CreateLookupResponse]
28
28
  def create_lookup(account_id, lookup_request, opts = {})
29
+ warn '[DEPRECATION NOTICE] `create_lookup` is deprecated.'
29
30
  data, _status_code, _headers = create_lookup_with_http_info(account_id, lookup_request, opts)
30
31
  data
31
32
  end
@@ -37,6 +38,7 @@ module Bandwidth
37
38
  # @param [Hash] opts the optional parameters
38
39
  # @return [Array<(CreateLookupResponse, Integer, Hash)>] CreateLookupResponse data, response status code and response headers
39
40
  def create_lookup_with_http_info(account_id, lookup_request, opts = {})
41
+ warn '[DEPRECATION NOTICE] `create_lookup_with_http_info` is deprecated.'
40
42
  if @api_client.config.debugging
41
43
  @api_client.config.logger.debug 'Calling API: PhoneNumberLookupApi.create_lookup ...'
42
44
  end
@@ -100,6 +102,7 @@ module Bandwidth
100
102
  # @param [Hash] opts the optional parameters
101
103
  # @return [LookupStatus]
102
104
  def get_lookup_status(account_id, request_id, opts = {})
105
+ warn '[DEPRECATION NOTICE] `get_lookup_status` is deprecated.'
103
106
  data, _status_code, _headers = get_lookup_status_with_http_info(account_id, request_id, opts)
104
107
  data
105
108
  end
@@ -111,6 +114,7 @@ module Bandwidth
111
114
  # @param [Hash] opts the optional parameters
112
115
  # @return [Array<(LookupStatus, Integer, Hash)>] LookupStatus data, response status code and response headers
113
116
  def get_lookup_status_with_http_info(account_id, request_id, opts = {})
117
+ warn '[DEPRECATION NOTICE] `get_lookup_status_with_http_info` is deprecated.'
114
118
  if @api_client.config.debugging
115
119
  @api_client.config.logger.debug 'Calling API: PhoneNumberLookupApi.get_lookup_status ...'
116
120
  end
data/lib/bandwidth-sdk/models/call_state.rb CHANGED
@@ -38,7 +38,7 @@ module Bandwidth
38
38
  # The current state of the call. Current possible values are `queued`, `initiated`, `answered` and `disconnected`. Additional states may be added in the future, so your application must be tolerant of unknown values.
39
39
  attr_accessor :state
40
40
 
41
- # For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. | Property | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-Verification-Passed` or `TN-Verification-Failed`. | | attestationIndicator | (optional) The attestation level verified by Bandwidth. Possible values are `A` (full), `B` (partial) or `C` (gateway). | | originatingId | (optional) A unique origination identifier. | Note that these are common properties but that the `stirShaken` object is free form and can contain other key-value pairs. More information: [Understanding STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken).
41
+ # For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. | Property | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-Validation-Passed` or `TN-Validation-Failed`. | | attestationIndicator | (optional) The attestation level verified by Bandwidth. Possible values are `A` (full), `B` (partial) or `C` (gateway). | | originatingId | (optional) A unique origination identifier. | Note that these are common properties but that the `stirShaken` object is free form and can contain other key-value pairs. More information: [Understanding STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken).
42
42
  attr_accessor :stir_shaken
43
43
 
44
44
  # The value of the `Identity` header from the inbound invite request. Only present for inbound calls and if the account is configured to forward this header.
data/lib/bandwidth-sdk/models/stir_shaken.rb CHANGED
@@ -15,7 +15,7 @@ require 'time'
15
15
 
16
16
  module Bandwidth
17
17
  class StirShaken
18
- # (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Verification-Passed and TN-Verification-Failed.
18
+ # (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Validation-Passed and TN-Validation-Failed.
19
19
  attr_accessor :verstat
20
20
 
21
21
  # (optional) The attestation level verified by Bandwidth. Possible values are A (full), B (partial) or C (gateway).
data/lib/bandwidth-sdk/version.rb CHANGED
@@ -11,5 +11,5 @@ Generator version: 7.8.0
11
11
  =end
12
12
 
13
13
  module Bandwidth
14
- VERSION = '16.2.1'
14
+ VERSION = '16.2.2'
15
15
  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: 16.2.1
4
+ version: 16.2.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Bandwidth
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-09-09 00:00:00.000000000 Z
11
+ date: 2025-10-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -606,67 +606,67 @@ summary: Bandwidth Ruby SDK
606
606
  test_files:
607
607
  - spec/call_utils.rb
608
608
  - spec/fixtures/ruby_cat.jpeg
609
- - spec/smoke/phone_number_lookup_api_spec.rb
610
- - spec/smoke/transcriptions_api_spec.rb
609
+ - spec/smoke/statistics_api_spec.rb
611
610
  - spec/smoke/toll_free_verification_api_spec.rb
612
- - spec/smoke/multi_channel_api_spec.rb
611
+ - spec/smoke/media_api_spec.rb
612
+ - spec/smoke/transcriptions_api_spec.rb
613
+ - spec/smoke/mfa_api_spec.rb
614
+ - spec/smoke/phone_number_lookup_api_spec.rb
613
615
  - spec/smoke/messages_api_spec.rb
616
+ - spec/smoke/multi_channel_api_spec.rb
614
617
  - spec/smoke/conferences_api_spec.rb
615
618
  - spec/smoke/recordings_api_spec.rb
616
- - spec/smoke/mfa_api_spec.rb
617
- - spec/smoke/statistics_api_spec.rb
618
619
  - spec/smoke/calls_api_spec.rb
619
- - spec/smoke/media_api_spec.rb
620
620
  - spec/spec_helper.rb
621
- - spec/unit/api/phone_number_lookup_api_spec.rb
622
- - spec/unit/api/transcriptions_api_spec.rb
621
+ - spec/unit/api/statistics_api_spec.rb
623
622
  - spec/unit/api/toll_free_verification_api_spec.rb
624
- - spec/unit/api/multi_channel_api_spec.rb
623
+ - spec/unit/api/media_api_spec.rb
624
+ - spec/unit/api/transcriptions_api_spec.rb
625
+ - spec/unit/api/mfa_api_spec.rb
626
+ - spec/unit/api/phone_number_lookup_api_spec.rb
625
627
  - spec/unit/api/messages_api_spec.rb
628
+ - spec/unit/api/multi_channel_api_spec.rb
626
629
  - spec/unit/api/conferences_api_spec.rb
627
630
  - spec/unit/api/recordings_api_spec.rb
628
- - spec/unit/api/mfa_api_spec.rb
629
- - spec/unit/api/statistics_api_spec.rb
630
631
  - spec/unit/api/calls_api_spec.rb
631
- - spec/unit/api/media_api_spec.rb
632
- - spec/unit/client/api_error_spec.rb
633
- - spec/unit/client/configuration_spec.rb
634
- - spec/unit/client/api_client_spec.rb
635
- - spec/unit/models/verify_code_request_spec.rb
636
- - spec/unit/models/call_state_spec.rb
637
- - spec/unit/models/tfv_error_spec.rb
638
- - spec/unit/models/bxml/verbs/gather_spec.rb
639
- - spec/unit/models/bxml/verbs/stop_recording_spec.rb
640
- - spec/unit/models/bxml/verbs/stop_transcription_spec.rb
641
- - spec/unit/models/bxml/verbs/ring_spec.rb
642
- - spec/unit/models/bxml/verbs/resume_recording_spec.rb
643
- - spec/unit/models/bxml/verbs/record_spec.rb
644
- - spec/unit/models/bxml/verbs/start_stream_spec.rb
645
- - spec/unit/models/bxml/verbs/pause_spec.rb
632
+ - spec/unit/models/message_spec.rb
633
+ - spec/unit/models/bxml/response_spec.rb
634
+ - spec/unit/models/bxml/verb_spec.rb
635
+ - spec/unit/models/bxml/nestable_verb_spec.rb
636
+ - spec/unit/models/bxml/verbs/stream_param_spec.rb
646
637
  - spec/unit/models/bxml/verbs/start_gather_spec.rb
647
- - spec/unit/models/bxml/verbs/hangup_spec.rb
648
- - spec/unit/models/bxml/verbs/redirect_spec.rb
649
- - spec/unit/models/bxml/verbs/bridge_spec.rb
650
- - spec/unit/models/bxml/verbs/start_transcription_spec.rb
651
- - spec/unit/models/bxml/verbs/custom_param_spec.rb
652
638
  - spec/unit/models/bxml/verbs/conference_spec.rb
653
639
  - spec/unit/models/bxml/verbs/stop_gather_spec.rb
654
- - spec/unit/models/bxml/verbs/pause_recording_spec.rb
640
+ - spec/unit/models/bxml/verbs/start_recording_spec.rb
641
+ - spec/unit/models/bxml/verbs/start_stream_spec.rb
642
+ - spec/unit/models/bxml/verbs/speak_sentence_spec.rb
643
+ - spec/unit/models/bxml/verbs/custom_param_spec.rb
644
+ - spec/unit/models/bxml/verbs/transfer_spec.rb
645
+ - spec/unit/models/bxml/verbs/gather_spec.rb
646
+ - spec/unit/models/bxml/verbs/hangup_spec.rb
647
+ - spec/unit/models/bxml/verbs/resume_recording_spec.rb
655
648
  - spec/unit/models/bxml/verbs/sip_uri_spec.rb
656
- - spec/unit/models/bxml/verbs/forward_spec.rb
649
+ - spec/unit/models/bxml/verbs/start_transcription_spec.rb
657
650
  - spec/unit/models/bxml/verbs/play_audio_spec.rb
658
- - spec/unit/models/bxml/verbs/stop_stream_spec.rb
659
- - spec/unit/models/bxml/verbs/transfer_spec.rb
660
651
  - spec/unit/models/bxml/verbs/send_dtmf_spec.rb
661
- - spec/unit/models/bxml/verbs/speak_sentence_spec.rb
662
- - spec/unit/models/bxml/verbs/tag_spec.rb
663
- - spec/unit/models/bxml/verbs/stream_param_spec.rb
664
- - spec/unit/models/bxml/verbs/start_recording_spec.rb
652
+ - spec/unit/models/bxml/verbs/forward_spec.rb
653
+ - spec/unit/models/bxml/verbs/stop_recording_spec.rb
654
+ - spec/unit/models/bxml/verbs/ring_spec.rb
655
+ - spec/unit/models/bxml/verbs/stop_stream_spec.rb
656
+ - spec/unit/models/bxml/verbs/bridge_spec.rb
665
657
  - spec/unit/models/bxml/verbs/phone_number_spec.rb
666
- - spec/unit/models/bxml/verb_spec.rb
658
+ - spec/unit/models/bxml/verbs/pause_spec.rb
659
+ - spec/unit/models/bxml/verbs/pause_recording_spec.rb
660
+ - spec/unit/models/bxml/verbs/record_spec.rb
661
+ - spec/unit/models/bxml/verbs/tag_spec.rb
662
+ - spec/unit/models/bxml/verbs/stop_transcription_spec.rb
663
+ - spec/unit/models/bxml/verbs/redirect_spec.rb
667
664
  - spec/unit/models/bxml/bxml_spec.rb
668
- - spec/unit/models/bxml/response_spec.rb
669
- - spec/unit/models/bxml/nestable_verb_spec.rb
670
- - spec/unit/models/call_state_enum_spec.rb
665
+ - spec/unit/models/verify_code_request_spec.rb
671
666
  - spec/unit/models/verify_code_response_spec.rb
672
- - spec/unit/models/message_spec.rb
667
+ - spec/unit/models/call_state_spec.rb
668
+ - spec/unit/models/tfv_error_spec.rb
669
+ - spec/unit/models/call_state_enum_spec.rb
670
+ - spec/unit/client/configuration_spec.rb
671
+ - spec/unit/client/api_error_spec.rb
672
+ - spec/unit/client/api_client_spec.rb