consolidate tfvStatus and rename linksObject

Author: ckoegel

.openapi-generator/FILES

@@ -47,9 +47,8 @@ docs/FailureWebhook.md
 docs/FieldError.md
 docs/FileFormatEnum.md
 docs/GatherCallback.md
-docs/GetTollFreeVerificationStatus200Response.md
 docs/InitiateCallback.md
-docs/Links.md
+docs/LinksObject.md
 docs/ListMessageDirectionEnum.md
 docs/ListMessageItem.md
 docs/LookupRequest.md
@@ -96,9 +95,8 @@ docs/TelephoneNumber.md
 docs/TfvBasicAuthentication.md
 docs/TfvCallbackStatusEnum.md
 docs/TfvError.md
+docs/TfvStatus.md
 docs/TfvStatusEnum.md
-docs/TfvStatusWithNoSubmissionInfo.md
-docs/TfvStatusWithSubmissionInfo.md
 docs/TfvSubmissionInfo.md
 docs/TfvSubmissionWrapper.md
 docs/TnLookupRequestError.md
@@ -206,9 +204,8 @@ src/main/java/com/bandwidth/sdk/model/FailureWebhook.java
 src/main/java/com/bandwidth/sdk/model/FieldError.java
 src/main/java/com/bandwidth/sdk/model/FileFormatEnum.java
 src/main/java/com/bandwidth/sdk/model/GatherCallback.java
-src/main/java/com/bandwidth/sdk/model/GetTollFreeVerificationStatus200Response.java
 src/main/java/com/bandwidth/sdk/model/InitiateCallback.java
-src/main/java/com/bandwidth/sdk/model/Links.java
+src/main/java/com/bandwidth/sdk/model/LinksObject.java
 src/main/java/com/bandwidth/sdk/model/ListMessageDirectionEnum.java
 src/main/java/com/bandwidth/sdk/model/ListMessageItem.java
 src/main/java/com/bandwidth/sdk/model/LookupRequest.java
@@ -249,9 +246,8 @@ src/main/java/com/bandwidth/sdk/model/TelephoneNumber.java
 src/main/java/com/bandwidth/sdk/model/TfvBasicAuthentication.java
 src/main/java/com/bandwidth/sdk/model/TfvCallbackStatusEnum.java
 src/main/java/com/bandwidth/sdk/model/TfvError.java
+src/main/java/com/bandwidth/sdk/model/TfvStatus.java
 src/main/java/com/bandwidth/sdk/model/TfvStatusEnum.java
-src/main/java/com/bandwidth/sdk/model/TfvStatusWithNoSubmissionInfo.java
-src/main/java/com/bandwidth/sdk/model/TfvStatusWithSubmissionInfo.java
 src/main/java/com/bandwidth/sdk/model/TfvSubmissionInfo.java
 src/main/java/com/bandwidth/sdk/model/TfvSubmissionWrapper.java
 src/main/java/com/bandwidth/sdk/model/TnLookupRequestError.java

README.md

@@ -215,9 +215,8 @@ Class | Method | HTTP request | Description
  - [FieldError](docs/FieldError.md)
  - [FileFormatEnum](docs/FileFormatEnum.md)
  - [GatherCallback](docs/GatherCallback.md)
- - [GetTollFreeVerificationStatus200Response](docs/GetTollFreeVerificationStatus200Response.md)
  - [InitiateCallback](docs/InitiateCallback.md)
- - [Links](docs/Links.md)
+ - [LinksObject](docs/LinksObject.md)
  - [ListMessageDirectionEnum](docs/ListMessageDirectionEnum.md)
  - [ListMessageItem](docs/ListMessageItem.md)
  - [LookupRequest](docs/LookupRequest.md)
@@ -258,9 +257,8 @@ Class | Method | HTTP request | Description
  - [TfvBasicAuthentication](docs/TfvBasicAuthentication.md)
  - [TfvCallbackStatusEnum](docs/TfvCallbackStatusEnum.md)
  - [TfvError](docs/TfvError.md)
+ - [TfvStatus](docs/TfvStatus.md)
  - [TfvStatusEnum](docs/TfvStatusEnum.md)
- - [TfvStatusWithNoSubmissionInfo](docs/TfvStatusWithNoSubmissionInfo.md)
- - [TfvStatusWithSubmissionInfo](docs/TfvStatusWithSubmissionInfo.md)
  - [TfvSubmissionInfo](docs/TfvSubmissionInfo.md)
  - [TfvSubmissionWrapper](docs/TfvSubmissionWrapper.md)
  - [TnLookupRequestError](docs/TnLookupRequestError.md)

api/openapi.yaml

@@ -4765,7 +4765,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/getTollFreeVerificationStatus_200_response'
+                $ref: '#/components/schemas/tfvStatus'
           description: OK
         "400":
           content:
@@ -7144,7 +7144,7 @@ components:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/getTollFreeVerificationStatus_200_response'
+            $ref: '#/components/schemas/tfvStatus'
       description: OK
     listWebhookSubscriptionsResponse:
       content:
@@ -11780,6 +11780,14 @@ components:
           $ref: '#/components/schemas/verificationUpdateRequest'
       type: object
     address:
+      example:
+        zip: "27606"
+        addr2: addr2
+        addr1: 2230 Bandmate Way
+        city: Raleigh
+        name: Bandwidth Inc.
+        state: NC
+        url: https://www.example.com/path/to/resource
       nullable: false
       properties:
         name:
@@ -11839,6 +11847,11 @@ components:
       - zip
       type: object
     optInWorkflow:
+      example:
+        imageUrls:
+        - https://www.example.com/path/to/resource
+        - https://www.example.com/path/to/resource
+        description: Opt In Flow
       nullable: false
       properties:
         description:
@@ -11869,6 +11882,11 @@ components:
       nullable: true
       type: string
     contact:
+      example:
+        firstName: John
+        lastName: Doe
+        phoneNumber: "+19192654500"
+        email: [email protected]
       nullable: false
       properties:
         firstName:
@@ -11988,7 +12006,7 @@ components:
           description: description
       properties:
         links:
-          $ref: '#/components/schemas/links'
+          $ref: '#/components/schemas/linksObject'
         errors:
           items:
             $ref: '#/components/schemas/error'
@@ -12000,7 +12018,7 @@ components:
       required:
       - data
       type: object
-    links:
+    linksObject:
       example:
         next: next
         previous: previous
@@ -12137,57 +12155,41 @@ components:
             field: error message
           type: object
       type: object
-    tfvStatusWithNoSubmissionInfo:
+    tfvStatus:
       example:
         internalTicketNumber: acde070d-8c4c-4f0d-9d8a-162843c10333
         phoneNumber: "+18005555555"
         resubmitAllowed: true
         createdDateTime: 2021-06-08T06:45:13Z
         modifiedDateTime: 2021-06-08T06:45:13Z
+        submission:
+          additionalInformation: Any additional information
+          useCase: 2FA
+          isvReseller: Test ISV
+          businessContact:
+            firstName: John
+            lastName: Doe
+            phoneNumber: "+19192654500"
+            email: [email protected]
+          messageVolume: 10000
+          productionMessageContent: Production message content
+          businessAddress:
+            zip: "27606"
+            addr2: addr2
+            addr1: 2230 Bandmate Way
+            city: Raleigh
+            name: Bandwidth Inc.
+            state: NC
+            url: https://www.example.com/path/to/resource
+          useCaseSummary: Text summarizing the use case for the toll-free number
+          optInWorkflow:
+            imageUrls:
+            - https://www.example.com/path/to/resource
+            - https://www.example.com/path/to/resource
+            description: Opt In Flow
         declineReasonDescription: Invalid Information - Can't Validate URL - Website
           is not accessible / not available
         status: VERIFIED
-      properties:
-        phoneNumber:
-          description: Toll-free telephone number in E.164 format.
-          example: "+18005555555"
-          maxLength: 12
-          minLength: 12
-          nullable: false
-          pattern: "^\\+1(800|833|844|855|866|877|888)[2-9]\\d{6}$"
-          type: string
-        status:
-          $ref: '#/components/schemas/tfvStatusEnum'
-        internalTicketNumber:
-          description: Unique identifier (UUID) generated by Bandwidth to assist in
-            tracking the verification status of a toll-free number - included in all
-            webhook payloads.
-          example: acde070d-8c4c-4f0d-9d8a-162843c10333
-          format: uuid
-          type: string
-        declineReasonDescription:
-          description: Explanation for why a verification request was declined.
-          example: Invalid Information - Can't Validate URL - Website is not accessible
-            / not available
-          nullable: false
-          type: string
-        resubmitAllowed:
-          description: Whether a Toll-Free Verification request qualifies for resubmission
-            via PUT.
-          example: true
-          type: boolean
-        createdDateTime:
-          description: Date and time the verification request was created.
-          example: 2021-06-08T06:45:13Z
-          format: date-time
-          type: string
-        modifiedDateTime:
-          description: Date and time the verification request was last modified.
-          example: 2021-06-08T06:45:13Z
-          format: date-time
-          type: string
-      type: object
-    tfvStatusWithSubmissionInfo:
       properties:
         phoneNumber:
           description: Toll-free telephone number in E.164 format.
@@ -12231,6 +12233,31 @@ components:
           $ref: '#/components/schemas/tfvSubmissionInfo'
       type: object
     tfvSubmissionInfo:
+      example:
+        additionalInformation: Any additional information
+        useCase: 2FA
+        isvReseller: Test ISV
+        businessContact:
+          firstName: John
+          lastName: Doe
+          phoneNumber: "+19192654500"
+          email: [email protected]
+        messageVolume: 10000
+        productionMessageContent: Production message content
+        businessAddress:
+          zip: "27606"
+          addr2: addr2
+          addr1: 2230 Bandmate Way
+          city: Raleigh
+          name: Bandwidth Inc.
+          state: NC
+          url: https://www.example.com/path/to/resource
+        useCaseSummary: Text summarizing the use case for the toll-free number
+        optInWorkflow:
+          imageUrls:
+          - https://www.example.com/path/to/resource
+          - https://www.example.com/path/to/resource
+          description: Opt In Flow
       properties:
         businessAddress:
           $ref: '#/components/schemas/address'
@@ -12297,10 +12324,6 @@ components:
       nullable: true
       pattern: "^[ -~]{16,64}$"
       type: string
-    getTollFreeVerificationStatus_200_response:
-      oneOf:
-      - $ref: '#/components/schemas/tfvStatusWithNoSubmissionInfo'
-      - $ref: '#/components/schemas/tfvStatusWithSubmissionInfo'
     webhookSubscription_basicAuthentication:
       description: "Basic authentication credentials are not required, but if present,\
         \ both username and password must be provided."

bandwidth.yml

@@ -5099,7 +5099,7 @@ components:
         - data
       properties:
         links:
-          $ref: '#/components/schemas/links'
+          $ref: '#/components/schemas/linksObject'
         errors:
           type: array
           items:
@@ -5108,7 +5108,7 @@ components:
           items:
             $ref: '#/components/schemas/webhookSubscription'
           type: array
-    links:
+    linksObject:
       type: object
       properties:
         first:
@@ -5225,30 +5225,7 @@ components:
           example:
             field: error message
       type: object
-    tfvStatusWithNoSubmissionInfo:
-      type: object
-      properties:
-        phoneNumber:
-          $ref: '#/components/schemas/tfPhoneNumber'
-        status:
-          $ref: '#/components/schemas/tfvStatusEnum'
-        internalTicketNumber:
-          $ref: '#/components/schemas/internalTicketNumber'
-        declineReasonDescription:
-          $ref: '#/components/schemas/declineReasonDescription'
-        resubmitAllowed:
-          $ref: '#/components/schemas/resubmitAllowed'
-        createdDateTime:
-          type: string
-          description: Date and time the verification request was created.
-          format: date-time
-          example: '2021-06-08T06:45:13.0Z'
-        modifiedDateTime:
-          type: string
-          description: Date and time the verification request was last modified.
-          format: date-time
-          example: '2021-06-08T06:45:13.0Z'
-    tfvStatusWithSubmissionInfo:
+    tfvStatus:
       type: object
       properties:
         phoneNumber:
@@ -5787,9 +5764,7 @@ components:
       content:
         application/json:
           schema:
-            oneOf:
-              - $ref: '#/components/schemas/tfvStatusWithNoSubmissionInfo'
-              - $ref: '#/components/schemas/tfvStatusWithSubmissionInfo'
+            $ref: '#/components/schemas/tfvStatus'
     listWebhookSubscriptionsResponse:
       description: OK
       content:

docs/LinksObject.md

@@ -0,0 +1,16 @@
+
+
+# LinksObject
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**first** | **String** | The first (or only) page of results matching the query. |  [optional] |
+|**next** | **String** | If more results exist than specified by 'size', this link returns the next page of 'size' results. |  [optional] |
+|**previous** | **String** | If the results are more than one page, this link returns the previous page of 'size' results. |  [optional] |
+|**last** | **String** | If more results exist than specified by 'size', this link return the last page of result. |  [optional] |
+
+
+

docs/TfvStatus.md

@@ -0,0 +1,20 @@
+
+
+# TfvStatus
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**phoneNumber** | **String** | Toll-free telephone number in E.164 format. |  [optional] |
+|**status** | **TfvStatusEnum** |  |  [optional] |
+|**internalTicketNumber** | **UUID** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number - included in all webhook payloads. |  [optional] |
+|**declineReasonDescription** | **String** | Explanation for why a verification request was declined. |  [optional] |
+|**resubmitAllowed** | **Boolean** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. |  [optional] |
+|**createdDateTime** | **OffsetDateTime** | Date and time the verification request was created. |  [optional] |
+|**modifiedDateTime** | **OffsetDateTime** | Date and time the verification request was last modified. |  [optional] |
+|**submission** | [**TfvSubmissionInfo**](TfvSubmissionInfo.md) |  |  [optional] |
+
+
+

docs/TollFreeVerificationApi.md

@@ -171,7 +171,7 @@ null (empty response body)
 
 <a id="getTollFreeVerificationStatus"></a>
 # **getTollFreeVerificationStatus**
-> GetTollFreeVerificationStatus200Response getTollFreeVerificationStatus(accountId, phoneNumber)
+> TfvStatus getTollFreeVerificationStatus(accountId, phoneNumber)
 
 Get Toll-Free Verification Status
 
@@ -201,7 +201,7 @@ public class Example {
     String accountId = "9900000"; // String | Your Bandwidth Account ID.
     String phoneNumber = "+18885555555"; // String | Valid Toll-Free telephone number in E.164 format.
     try {
-      GetTollFreeVerificationStatus200Response result = apiInstance.getTollFreeVerificationStatus(accountId, phoneNumber);
+      TfvStatus result = apiInstance.getTollFreeVerificationStatus(accountId, phoneNumber);
       System.out.println(result);
     } catch (ApiException e) {
       System.err.println("Exception when calling TollFreeVerificationApi#getTollFreeVerificationStatus");
@@ -223,7 +223,7 @@ public class Example {
 
 ### Return type
 
-[**GetTollFreeVerificationStatus200Response**](GetTollFreeVerificationStatus200Response.md)
+[**TfvStatus**](TfvStatus.md)
 
 ### Authorization