SWI-7771 Update SDK Based on Recent Spec Changes

api/openapi.yaml

@@ -12197,6 +12197,30 @@ components:
         via PUT.
       example: true
       type: boolean
+    blocked:
+      description: Whether a Toll-Free Verification is blocked. This attribute will
+        only be defined when the number is blocked. (Not Available Until 5/28/2025)
+      example: true
+      type: boolean
+    blockedReason:
+      description: The reason why the Toll-Free Verification is blocked. This attribute
+        will only be defined when the number is blocked. (Not Available Until 5/28/2025)
+      example: Toll-free number was used to send spam messages
+      type: string
+    privacyPolicyUrl:
+      description: The Toll-Free Verification request privacy policy URL. (Not Available
+        Until 5/28/2025)
+      example: http://your-company.com/privacyPolicyUrl.pdf
+      type: string
+    termsAndConditionsUrl:
+      description: The Toll-Free Verification request terms and conditions policy
+        URL. (Not Available Until 5/28/2025)
+      example: http://your-company.com/termsAndConditionsUrl.pdf
+      type: string
+    businessDBA:
+      description: The company 'Doing Business As'. (Not Available Until 5/28/2025)
+      example: SecondCompany Name
+      type: string
     additionalDenialReason:
       properties:
         statusCode:
@@ -12292,6 +12316,20 @@ components:
           minLength: 0
           nullable: true
           type: string
+        privacyPolicyUrl:
+          description: The Toll-Free Verification request privacy policy URL. (Not
+            Available Until 5/28/2025)
+          example: http://your-company.com/privacyPolicyUrl.pdf
+          type: string
+        termsAndConditionsUrl:
+          description: The Toll-Free Verification request terms and conditions policy
+            URL. (Not Available Until 5/28/2025)
+          example: http://your-company.com/termsAndConditionsUrl.pdf
+          type: string
+        businessDBA:
+          description: The company 'Doing Business As'. (Not Available Until 5/28/2025)
+          example: SecondCompany Name
+          type: string
       required:
       - businessAddress
       - businessContact
@@ -12338,6 +12376,7 @@ components:
           $ref: '#/components/schemas/optInWorkflow'
         additionalInformation:
           description: Any additional information.
+          example: Any additional information
           maxLength: 500
           minLength: 0
           nullable: true
@@ -12349,6 +12388,20 @@ components:
           minLength: 0
           nullable: true
           type: string
+        privacyPolicyUrl:
+          description: The Toll-Free Verification request privacy policy URL. (Not
+            Available Until 5/28/2025)
+          example: http://your-company.com/privacyPolicyUrl.pdf
+          type: string
+        termsAndConditionsUrl:
+          description: The Toll-Free Verification request terms and conditions policy
+            URL. (Not Available Until 5/28/2025)
+          example: http://your-company.com/termsAndConditionsUrl.pdf
+          type: string
+        businessDBA:
+          description: The company 'Doing Business As'. (Not Available Until 5/28/2025)
+          example: SecondCompany Name
+          type: string
       required:
       - businessAddress
       - businessContact
@@ -12491,6 +12544,18 @@ components:
           default: UNVERIFIED
           example: UNVERIFIED
           type: string
+        blocked:
+          description: Whether a Toll-Free Verification is blocked. This attribute
+            will only be defined when the number is blocked. (Not Available Until
+            5/28/2025)
+          example: true
+          type: boolean
+        blockedReason:
+          description: The reason why the Toll-Free Verification is blocked. This
+            attribute will only be defined when the number is blocked. (Not Available
+            Until 5/28/2025)
+          example: Toll-free number was used to send spam messages
+          type: string
       type: object
     verificationWebhook:
       properties:
@@ -12590,6 +12655,7 @@ components:
       type: object
     additionalInformation:
       description: Any additional information.
+      example: Any additional information
       maxLength: 500
       minLength: 0
       nullable: true
@@ -12921,12 +12987,16 @@ components:
       example:
         internalTicketNumber: acde070d-8c4c-4f0d-9d8a-162843c10333
         phoneNumber: "+18005555555"
+        blocked: true
+        blockedReason: Toll-free number was used to send spam messages
         resubmitAllowed: true
         createdDateTime: 2021-06-08T06:45:13Z
         modifiedDateTime: 2021-06-08T06:45:13Z
         submission:
-          additionalInformation: additionalInformation
+          additionalInformation: Any additional information
           useCase: 2FA
+          termsAndConditionsUrl: http://your-company.com/termsAndConditionsUrl.pdf
+          businessDBA: SecondCompany Name
           isvReseller: Test ISV
           businessContact:
             firstName: John
@@ -12943,6 +13013,7 @@ components:
             name: Bandwidth Inc.
             state: NC
             url: https://www.example.com/path/to/resource
+          privacyPolicyUrl: http://your-company.com/privacyPolicyUrl.pdf
           useCaseSummary: Text summarizing the use case for the toll-free number
           optInWorkflow:
             imageUrls:
@@ -12993,11 +13064,25 @@ components:
           type: string
         submission:
           $ref: '#/components/schemas/tfvSubmissionInfo'
+        blocked:
+          description: Whether a Toll-Free Verification is blocked. This attribute
+            will only be defined when the number is blocked. (Not Available Until
+            5/28/2025)
+          example: true
+          type: boolean
+        blockedReason:
+          description: The reason why the Toll-Free Verification is blocked. This
+            attribute will only be defined when the number is blocked. (Not Available
+            Until 5/28/2025)
+          example: Toll-free number was used to send spam messages
+          type: string
       type: object
     tfvSubmissionInfo:
       example:
-        additionalInformation: additionalInformation
+        additionalInformation: Any additional information
         useCase: 2FA
+        termsAndConditionsUrl: http://your-company.com/termsAndConditionsUrl.pdf
+        businessDBA: SecondCompany Name
         isvReseller: Test ISV
         businessContact:
           firstName: John
@@ -13014,6 +13099,7 @@ components:
           name: Bandwidth Inc.
           state: NC
           url: https://www.example.com/path/to/resource
+        privacyPolicyUrl: http://your-company.com/privacyPolicyUrl.pdf
         useCaseSummary: Text summarizing the use case for the toll-free number
         optInWorkflow:
           imageUrls:
@@ -13055,6 +13141,7 @@ components:
           $ref: '#/components/schemas/optInWorkflow'
         additionalInformation:
           description: Any additional information.
+          example: Any additional information
           maxLength: 500
           minLength: 0
           nullable: true
@@ -13066,6 +13153,20 @@ components:
           minLength: 0
           nullable: true
           type: string
+        privacyPolicyUrl:
+          description: The Toll-Free Verification request privacy policy URL. (Not
+            Available Until 5/28/2025)
+          example: http://your-company.com/privacyPolicyUrl.pdf
+          type: string
+        termsAndConditionsUrl:
+          description: The Toll-Free Verification request terms and conditions policy
+            URL. (Not Available Until 5/28/2025)
+          example: http://your-company.com/termsAndConditionsUrl.pdf
+          type: string
+        businessDBA:
+          description: The company 'Doing Business As'. (Not Available Until 5/28/2025)
+          example: SecondCompany Name
+          type: string
       type: object
     tfvStatusEnum:
       enum:

bandwidth.yml

@@ -5228,6 +5228,35 @@ components:
         PUT.
       example: true
       type: boolean
+    blocked:
+      description: >-
+        Whether a Toll-Free Verification is blocked. This attribute will only be
+        defined when the number is blocked. (Not Available Until 5/28/2025)
+      example: true
+      type: boolean
+    blockedReason:
+      description: >-
+        The reason why the Toll-Free Verification is blocked. This attribute
+        will only be defined when the number is blocked. (Not Available Until
+        5/28/2025)
+      example: Toll-free number was used to send spam messages
+      type: string
+    privacyPolicyUrl:
+      description: >-
+        The Toll-Free Verification request privacy policy URL. (Not Available
+        Until 5/28/2025)
+      example: http://your-company.com/privacyPolicyUrl.pdf
+      type: string
+    termsAndConditionsUrl:
+      description: >-
+        The Toll-Free Verification request terms and conditions policy URL. (Not
+        Available Until 5/28/2025)
+      example: http://your-company.com/termsAndConditionsUrl.pdf
+      type: string
+    businessDBA:
+      description: The company 'Doing Business As'. (Not Available Until 5/28/2025)
+      example: SecondCompany Name
+      type: string
     additionalDenialReason:
       properties:
         statusCode:
@@ -5308,6 +5337,12 @@ components:
           example: Any additional information
         isvReseller:
           $ref: '#/components/schemas/isvReseller'
+        privacyPolicyUrl:
+          $ref: '#/components/schemas/privacyPolicyUrl'
+        termsAndConditionsUrl:
+          $ref: '#/components/schemas/termsAndConditionsUrl'
+        businessDBA:
+          $ref: '#/components/schemas/businessDBA'
     verificationUpdateRequest:
       type: object
       required:
@@ -5341,6 +5376,12 @@ components:
           $ref: '#/components/schemas/additionalInformation'
         isvReseller:
           $ref: '#/components/schemas/isvReseller'
+        privacyPolicyUrl:
+          $ref: '#/components/schemas/privacyPolicyUrl'
+        termsAndConditionsUrl:
+          $ref: '#/components/schemas/termsAndConditionsUrl'
+        businessDBA:
+          $ref: '#/components/schemas/businessDBA'
     tfvBasicAuthentication:
       type: object
       properties:
@@ -5419,6 +5460,10 @@ components:
           $ref: '#/components/schemas/resubmitAllowed'
         status:
           $ref: '#/components/schemas/tfvUnverifiedStatus'
+        blocked:
+          $ref: '#/components/schemas/blocked'
+        blockedReason:
+          $ref: '#/components/schemas/blockedReason'
     verificationWebhook:
       type: object
       properties:
@@ -5501,6 +5546,7 @@ components:
       minLength: 0
       maxLength: 500
       nullable: true
+      example: Any additional information
     optInWorkflow:
       type: object
       nullable: false
@@ -5762,6 +5808,10 @@ components:
           example: '2021-06-08T06:45:13.0Z'
         submission:
           $ref: '#/components/schemas/tfvSubmissionInfo'
+        blocked:
+          $ref: '#/components/schemas/blocked'
+        blockedReason:
+          $ref: '#/components/schemas/blockedReason'
     tfvSubmissionInfo:
       type: object
       properties:
@@ -5787,6 +5837,12 @@ components:
           $ref: '#/components/schemas/additionalInformation'
         isvReseller:
           $ref: '#/components/schemas/isvReseller'
+        privacyPolicyUrl:
+          $ref: '#/components/schemas/privacyPolicyUrl'
+        termsAndConditionsUrl:
+          $ref: '#/components/schemas/termsAndConditionsUrl'
+        businessDBA:
+          $ref: '#/components/schemas/businessDBA'
     tfvStatusEnum:
       type: string
       enum:

docs/TfvStatus.md

@@ -15,6 +15,8 @@
 |**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] |
+|**blocked** | **Boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) |  [optional] |
+|**blockedReason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) |  [optional] |
 
 
 

docs/TfvSubmissionInfo.md

@@ -16,6 +16,9 @@
 |**optInWorkflow** | [**OptInWorkflow**](OptInWorkflow.md) |  |  [optional] |
 |**additionalInformation** | **String** | Any additional information. |  [optional] |
 |**isvReseller** | **String** | ISV name. |  [optional] |
+|**privacyPolicyUrl** | **String** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) |  [optional] |
+|**termsAndConditionsUrl** | **String** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) |  [optional] |
+|**businessDBA** | **String** | The company 'Doing Business As'. (Not Available Until 5/28/2025) |  [optional] |
 
 
 

docs/VerificationDenialWebhook.md

@@ -15,6 +15,8 @@
 |**phoneNumber** | **String** | Toll-free telephone number in E.164 format. |  [optional] |
 |**resubmitAllowed** | **Boolean** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. |  [optional] |
 |**status** | **String** |  |  [optional] |
+|**blocked** | **Boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) |  [optional] |
+|**blockedReason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) |  [optional] |
 
 
 

docs/VerificationRequest.md

@@ -17,6 +17,9 @@
 |**optInWorkflow** | [**OptInWorkflow**](OptInWorkflow.md) |  |  |
 |**additionalInformation** | **String** | Any additional information. |  [optional] |
 |**isvReseller** | **String** | ISV name. |  [optional] |
+|**privacyPolicyUrl** | **String** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) |  [optional] |
+|**termsAndConditionsUrl** | **String** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) |  [optional] |
+|**businessDBA** | **String** | The company 'Doing Business As'. (Not Available Until 5/28/2025) |  [optional] |
 
 
 

docs/VerificationUpdateRequest.md

@@ -16,6 +16,9 @@
 |**optInWorkflow** | [**OptInWorkflow**](OptInWorkflow.md) |  |  |
 |**additionalInformation** | **String** | Any additional information. |  [optional] |
 |**isvReseller** | **String** | ISV name. |  [optional] |
+|**privacyPolicyUrl** | **String** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) |  [optional] |
+|**termsAndConditionsUrl** | **String** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) |  [optional] |
+|**businessDBA** | **String** | The company 'Doing Business As'. (Not Available Until 5/28/2025) |  [optional] |