SWI-8913 Deprecate TN Lookup V1 (#84)

Author: ckoegel

api/phone-number-lookup-api.ts

@@ -41,6 +41,7 @@ export const PhoneNumberLookupApiAxiosParamCreator = function (configuration?: C
          * @param {string} accountId Your Bandwidth Account ID.
          * @param {LookupRequest} lookupRequest Phone number lookup request.
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
         createLookup: async (accountId: string, lookupRequest: LookupRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -85,6 +86,7 @@ export const PhoneNumberLookupApiAxiosParamCreator = function (configuration?: C
          * @param {string} accountId Your Bandwidth Account ID.
          * @param {string} requestId The phone number lookup request ID from Bandwidth.
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
         getLookupStatus: async (accountId: string, requestId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
@@ -137,6 +139,7 @@ export const PhoneNumberLookupApiFp = function(configuration?: Configuration) {
          * @param {string} accountId Your Bandwidth Account ID.
          * @param {LookupRequest} lookupRequest Phone number lookup request.
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
         async createLookup(accountId: string, lookupRequest: LookupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLookupResponse>> {
@@ -151,6 +154,7 @@ export const PhoneNumberLookupApiFp = function(configuration?: Configuration) {
          * @param {string} accountId Your Bandwidth Account ID.
          * @param {string} requestId The phone number lookup request ID from Bandwidth.
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
         async getLookupStatus(accountId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LookupStatus>> {
@@ -175,6 +179,7 @@ export const PhoneNumberLookupApiFactory = function (configuration?: Configurati
          * @param {string} accountId Your Bandwidth Account ID.
          * @param {LookupRequest} lookupRequest Phone number lookup request.
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
         createLookup(accountId: string, lookupRequest: LookupRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateLookupResponse> {
@@ -186,6 +191,7 @@ export const PhoneNumberLookupApiFactory = function (configuration?: Configurati
          * @param {string} accountId Your Bandwidth Account ID.
          * @param {string} requestId The phone number lookup request ID from Bandwidth.
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
         getLookupStatus(accountId: string, requestId: string, options?: RawAxiosRequestConfig): AxiosPromise<LookupStatus> {
@@ -207,6 +213,7 @@ export class PhoneNumberLookupApi extends BaseAPI {
      * @param {string} accountId Your Bandwidth Account ID.
      * @param {LookupRequest} lookupRequest Phone number lookup request.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof PhoneNumberLookupApi
      */
@@ -220,6 +227,7 @@ export class PhoneNumberLookupApi extends BaseAPI {
      * @param {string} accountId Your Bandwidth Account ID.
      * @param {string} requestId The phone number lookup request ID from Bandwidth.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof PhoneNumberLookupApi
      */

bandwidth.yml

@@ -1330,6 +1330,7 @@ paths:
     servers: *ref_2
   /accounts/{accountId}/tnlookup:
     post:
+      deprecated: true
       summary: Create Lookup
       description: Create a Phone Number Lookup Request.
       operationId: createLookup
@@ -1359,6 +1360,7 @@ paths:
         description: Production
   /accounts/{accountId}/tnlookup/{requestId}:
     get:
+      deprecated: true
       summary: Get Lookup Request Status
       description: Get an existing Phone Number Lookup Request.
       operationId: getLookupStatus
@@ -3357,7 +3359,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 +3377,7 @@ components:
           additionalProperties:
             type: string
           example:
-            verstat: TN-Verification-Passed
+            verstat: TN-Validation-Passed
             attestationIndicator: A
             originatingId: abc123
         identity:
@@ -5211,8 +5213,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: >-

docs/CallState.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **from** | **string** | The phone number that made the call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
 **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) |  | [optional] [default to undefined]
 **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] [default to undefined]
-**stirShaken** | **{ [key: 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] [default to undefined]
+**stirShaken** | **{ [key: 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] [default to undefined]
 **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] [default to undefined]
 **enqueuedTime** | **string** | The time this call was placed in queue. | [optional] [default to undefined]
 **startTime** | **string** | The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue. | [optional] [default to undefined]

docs/StirShaken.md

@@ -5,7 +5,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] [default to undefined]
+**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] [default to undefined]
 **attestationIndicator** | **string** | (optional) The attestation level verified by Bandwidth. Possible values are A (full), B (partial) or C (gateway). | [optional] [default to undefined]
 **originatingId** | **string** | (optional) A unique origination identifier. | [optional] [default to undefined]
 

models/call-state.ts

@@ -72,7 +72,7 @@ export interface CallState {
      */
     'state'?: 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).
+     * 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).
      * @type {{ [key: string]: string; }}
      * @memberof CallState
      */

models/stir-shaken.ts

@@ -21,7 +21,7 @@
  */
 export interface 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.
      * @type {string}
      * @memberof StirShaken
      */