diff --git a/bandwidth.yml b/bandwidth.yml index b7f7968..3cc990a 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -3357,7 +3357,7 @@ components: | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are - `TN-Verification-Passed` or `TN-Verification-Failed`. | + `TN-Validation-Passed` or `TN-Validation-Failed`. | | attestationIndicator | (optional) The attestation level verified by Bandwidth. Possible values are `A` (full), `B` (partial) or `C` @@ -3375,7 +3375,7 @@ components: additionalProperties: type: string example: - verstat: TN-Verification-Passed + verstat: TN-Validation-Passed attestationIndicator: A originatingId: abc123 identity: @@ -5211,8 +5211,8 @@ components: description: >- (optional) The verification status indicating whether the verification was successful or not. Possible values are - TN-Verification-Passed and TN-Verification-Failed. - example: Tn-Verification-Passed + TN-Validation-Passed and TN-Validation-Failed. + example: Tn-Validation-Passed attestationIndicator: type: string description: >- diff --git a/docs/CallState.md b/docs/CallState.md index b076efb..a84f0d3 100644 --- a/docs/CallState.md +++ b/docs/CallState.md @@ -12,7 +12,7 @@ | **from** | **String** | The phone number that made the call, in E.164 format (e.g. +15555555555). | [optional] | | **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] | | **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] | -| **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] | +| **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] | | **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] | | **enqueued_time** | **Time** | The time this call was placed in queue. | [optional] | | **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( from: +19195554321, direction: null, state: disconnected, - stir_shaken: {"verstat":"TN-Verification-Passed","attestationIndicator":"A","originatingId":"abc123"}, + stir_shaken: {"verstat":"TN-Validation-Passed","attestationIndicator":"A","originatingId":"abc123"}, 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, enqueued_time: 2022-06-16T13:15:07.160Z, start_time: 2022-06-16T13:15:07.160Z, diff --git a/docs/StirShaken.md b/docs/StirShaken.md index 42f1e96..c69718c 100644 --- a/docs/StirShaken.md +++ b/docs/StirShaken.md @@ -4,7 +4,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **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] | +| **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] | | **attestation_indicator** | **String** | (optional) The attestation level verified by Bandwidth. Possible values are A (full), B (partial) or C (gateway). | [optional] | | **originating_id** | **String** | (optional) A unique origination identifier. | [optional] | @@ -14,7 +14,7 @@ require 'bandwidth-sdk' instance = Bandwidth::StirShaken.new( - verstat: Tn-Verification-Passed, + verstat: Tn-Validation-Passed, attestation_indicator: A, originating_id: 99759086-1335-11ed-9bcf-5f7d464e91af ) diff --git a/lib/bandwidth-sdk/models/call_state.rb b/lib/bandwidth-sdk/models/call_state.rb index 687ba02..44c22f2 100644 --- a/lib/bandwidth-sdk/models/call_state.rb +++ b/lib/bandwidth-sdk/models/call_state.rb @@ -38,7 +38,7 @@ class CallState # 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. attr_accessor :state - # 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). + # 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). attr_accessor :stir_shaken # 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. diff --git a/lib/bandwidth-sdk/models/stir_shaken.rb b/lib/bandwidth-sdk/models/stir_shaken.rb index 10f8b84..06dfc21 100644 --- a/lib/bandwidth-sdk/models/stir_shaken.rb +++ b/lib/bandwidth-sdk/models/stir_shaken.rb @@ -15,7 +15,7 @@ module Bandwidth class StirShaken - # (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Verification-Passed and TN-Verification-Failed. + # (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Validation-Passed and TN-Validation-Failed. attr_accessor :verstat # (optional) The attestation level verified by Bandwidth. Possible values are A (full), B (partial) or C (gateway).