Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions bandwidth.yml
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 bandwidth/models/call_state.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ class CallState(BaseModel):
var_from: Optional[StrictStr] = Field(default=None, description="The phone number that made the call, in E.164 format (e.g. +15555555555).", alias="from")
direction: Optional[CallDirectionEnum] = None
state: Optional[StrictStr] = Field(default=None, description="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.")
stir_shaken: Optional[Dict[str, StrictStr]] = Field(default=None, description="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).", alias="stirShaken")
stir_shaken: Optional[Dict[str, StrictStr]] = Field(default=None, description="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).", alias="stirShaken")
identity: Optional[StrictStr] = Field(default=None, description="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.")
enqueued_time: Optional[datetime] = Field(default=None, description="The time this call was placed in queue.", alias="enqueuedTime")
start_time: Optional[datetime] = Field(default=None, description="The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue.", alias="startTime")
Expand Down
2 changes: 1 addition & 1 deletion bandwidth/models/stir_shaken.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class StirShaken(BaseModel):
"""
StirShaken
""" # noqa: E501
verstat: Optional[StrictStr] = Field(default=None, description="(optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Verification-Passed and TN-Verification-Failed.")
verstat: Optional[StrictStr] = Field(default=None, description="(optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Validation-Passed and TN-Validation-Failed.")
attestation_indicator: Optional[StrictStr] = Field(default=None, description="(optional) The attestation level verified by Bandwidth. Possible values are A (full), B (partial) or C (gateway).", alias="attestationIndicator")
originating_id: Optional[StrictStr] = Field(default=None, description="(optional) A unique origination identifier.", alias="originatingId")
additional_properties: Dict[str, Any] = {}
Expand Down
2 changes: 1 addition & 1 deletion docs/CallState.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Name | Type | Description | Notes
**var_from** | **str** | The phone number that made the call, in E.164 format (e.g. +15555555555). | [optional]
**direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional]
**state** | **str** | 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** | **Dict[str, str]** | 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** | **Dict[str, str]** | 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** | **str** | 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** | **datetime** | The time this call was placed in queue. | [optional]
**start_time** | **datetime** | 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
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**verstat** | **str** | (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Verification-Passed and TN-Verification-Failed. | [optional]
**verstat** | **str** | (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** | **str** | (optional) The attestation level verified by Bandwidth. Possible values are A (full), B (partial) or C (gateway). | [optional]
**originating_id** | **str** | (optional) A unique origination identifier. | [optional]

Expand Down