Skip to content

SWI-8650 Update SDK Based on Recent Spec Changes #208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ckoegel merged 1 commit into from
Sep 17, 2025
Merged

SWI-8650 Update SDK Based on Recent Spec Changes #208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions api/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9959,7 +9959,7 @@ components:
enqueuedTime: 2022-06-16T13:15:07.16Z
lastUpdate: 2022-06-16T13:15:18.314Z
stirShaken:
verstat: TN-Verification-Passed
verstat: TN-Validation-Passed
attestationIndicator: A
originatingId: abc123
from: "+19195554321"
Expand Down Expand Up @@ -10018,15 +10018,15 @@ components:

| 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`. |
| 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).
example:
verstat: TN-Verification-Passed
verstat: TN-Validation-Passed
attestationIndicator: A
originatingId: abc123
nullable: true
Expand Down Expand Up @@ -12875,9 +12875,8 @@ components:
properties:
verstat:
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
was successful or not. Possible values are TN-Validation-Passed and TN-Validation-Failed.
example: Tn-Validation-Passed
type: string
attestationIndicator:
description: "(optional) The attestation level verified by Bandwidth. Possible\
Expand Down
8 changes: 4 additions & 4 deletions bandwidth.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand All @@ -3375,7 +3375,7 @@ components:
additionalProperties:
type: string
example:
verstat: TN-Verification-Passed
verstat: TN-Validation-Passed
attestationIndicator: A
originatingId: abc123
identity:
Expand Down Expand Up @@ -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: >-
Expand Down
2 changes: 1 addition & 1 deletion docs/CallState.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
|**from** | **String** | The phone number that made the call, in E.164 format (e.g. +15555555555). | [optional] |
|**direction** | **CallDirectionEnum** | | [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] |
|**stirShaken** | **Map<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] |
|**stirShaken** | **Map<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] |
|**enqueuedTime** | **OffsetDateTime** | The time this call was placed in queue. | [optional] |
|**startTime** | **OffsetDateTime** | The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue. | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/StirShaken.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,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] |
|**attestationIndicator** | **String** | (optional) The attestation level verified by Bandwidth. Possible values are A (full), B (partial) or C (gateway). | [optional] |
|**originatingId** | **String** | (optional) A unique origination identifier. | [optional] |

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/bandwidth/sdk/model/CallState.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ public CallState putStirShakenItem(String key, String stirShakenItem) {
}

/**
* 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).
* @return stirShaken
*/
@javax.annotation.Nullable
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/bandwidth/sdk/model/StirShaken.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ public StirShaken verstat(@javax.annotation.Nullable String verstat) {
}

/**
* (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.
* @return verstat
*/
@javax.annotation.Nullable
Expand Down