DX-4080 Update SDK Based on Recent Spec Changes

api/openapi.yaml

@@ -301,9 +301,9 @@ paths:
       - application/octet-stream
     put:
       description: |-
-        Upload a file. You may add headers to the request in order to provide some control to your media file.
+        Upload a file.
 
-        If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten.
+        Filename should always be unique. Reusing filenames may result in the wrong media being sent.
 
         A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
       operationId: uploadMedia
@@ -338,8 +338,9 @@ paths:
         schema:
           type: string
         style: simple
-      - description: General-header field is used to specify directives that MUST
-          be obeyed by all caching mechanisms along the request/response chain.
+      - description: Pass-through header stored with the media and returned when the
+          media is retrieved by the user. Does not affect internal server caching
+          behavior.
         example: no-cache
         explode: false
         in: header
@@ -4939,7 +4940,12 @@ paths:
       callbacks:
         tfVerificationStatus:
           $ref: "#/components/callbacks/tfVerificationStatus"
-      description: Submit a request for verification of a toll-free phone number.
+      description: |-
+        Submit a request for verification of a toll-free phone number.
+
+        **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`.
+        This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted.
+        Today, these requests are accepted with a `202`.
       operationId: requestTollFreeVerification
       parameters:
       - description: Your Bandwidth Account ID.
@@ -4996,6 +5002,16 @@ paths:
               schema:
                 $ref: "#/components/schemas/tfvError"
           description: Method Not Allowed
+        "409":
+          content:
+            application/json:
+              example:
+                description: "TFV request already in progress for phone number: +18005551234"
+                type: conflict
+              schema:
+                $ref: "#/components/schemas/tfvError"
+          description: Conflict. A toll-free verification for the phone number is
+            already in progress.
         "429":
           content:
             application/json:
@@ -5034,7 +5050,10 @@ paths:
       url: https://api.bandwidth.com/api/v2
   /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification:
     delete:
-      description: Delete a toll-free verification submission for a toll-free number.
+      description: |-
+        Delete a toll-free verification submission for a toll-free number.
+
+        **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously.
       operationId: deleteVerificationRequest
       parameters:
       - description: Your Bandwidth Account ID.
@@ -5250,6 +5269,9 @@ paths:
       description: |-
         Updates a toll-free verification request.
         Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).
+        Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission.
+
+        **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`.
       operationId: updateTollFreeVerificationRequest
       parameters:
       - description: Your Bandwidth Account ID.
@@ -5306,6 +5328,15 @@ paths:
               schema:
                 $ref: "#/components/schemas/tfvError"
           description: Forbidden
+        "404":
+          content:
+            application/json:
+              example:
+                description: Cannot find the requested resource.
+                type: Not Found
+              schema:
+                $ref: "#/components/schemas/tfvError"
+          description: Cannot find the requested resource.
         "405":
           content:
             application/json:
@@ -5315,6 +5346,16 @@ paths:
               schema:
                 $ref: "#/components/schemas/tfvError"
           description: Method Not Allowed
+        "409":
+          content:
+            application/json:
+              example:
+                description: "TFV request already in progress for phone number: +18005551234"
+                type: conflict
+              schema:
+                $ref: "#/components/schemas/tfvError"
+          description: Conflict. A toll-free verification for the phone number is
+            already in progress.
         "429":
           content:
             application/json:
@@ -7383,8 +7424,8 @@ components:
         type: string
       style: simple
     cacheControl:
-      description: General-header field is used to specify directives that MUST be
-        obeyed by all caching mechanisms along the request/response chain.
+      description: Pass-through header stored with the media and returned when the
+        media is retrieved by the user. Does not affect internal server caching behavior.
       example: no-cache
       explode: false
       in: header
@@ -9035,6 +9076,16 @@ components:
           schema:
             $ref: "#/components/schemas/tfvError"
       description: Cannot find the requested resource.
+    tfvConflictResponse:
+      content:
+        application/json:
+          example:
+            description: "TFV request already in progress for phone number: +18005551234"
+            type: conflict
+          schema:
+            $ref: "#/components/schemas/tfvError"
+      description: Conflict. A toll-free verification for the phone number is already
+        in progress.
     tfvNotAllowedResponse:
       content:
         application/json:

bandwidth.yml

@@ -88,12 +88,11 @@ paths:
     put:
       summary: Upload Media
       description: >-
-        Upload a file. You may add headers to the request in order to provide
-        some control to your media file.
+        Upload a file.
 
 
-        If a file is uploaded with the same name as a file that already exists
-        under this account, the previous file will be overwritten.
+        Filename should always be unique. Reusing filenames may result in the
+        wrong media being sent.
 
 
         A list of supported media types can be found at [Bandwidth
@@ -1404,7 +1403,19 @@ paths:
       tags:
         - Toll-Free Verification
       summary: Request Toll-Free Verification
-      description: Submit a request for verification of a toll-free phone number.
+      description: >-
+        Submit a request for verification of a toll-free phone number.
+
+
+        **Upcoming change (effective January 2027):** If any phone number in the
+        request already has a verification in progress, the request will be
+        rejected with a `409 Conflict`.
+
+        This check is all-or-nothing: if a single phone number conflicts, the
+        entire request is rejected and **none** of the phone numbers in the
+        request are submitted.
+
+        Today, these requests are accepted with a `202`.
       operationId: requestTollFreeVerification
       parameters:
         - $ref: '#/components/parameters/accountId4'
@@ -1421,6 +1432,8 @@ paths:
           $ref: '#/components/responses/tfvForbiddenResponse'
         '405':
           $ref: '#/components/responses/tfvNotAllowedResponse'
+        '409':
+          $ref: '#/components/responses/tfvConflictResponse'
         '429':
           $ref: '#/components/responses/tfvTooManyRequestsResponse'
         '500':
@@ -1477,6 +1490,14 @@ paths:
         Submissions are only eligible for resubmission for 7 days within being
         processed and if resubmission is allowed (resubmitAllowed field is
         true).
+
+        Returns a `404` if no verification request exists for the phone number,
+        and a `400` if the existing request is not eligible for resubmission.
+
+
+        **Upcoming change (effective January 2027):** If a verification for the
+        phone number is in progress, the update will be rejected with a `409
+        Conflict`.
       operationId: updateTollFreeVerificationRequest
       parameters:
         - $ref: '#/components/parameters/accountId4'
@@ -1492,8 +1513,12 @@ paths:
           $ref: '#/components/responses/tfvUnauthorizedResponse'
         '403':
           $ref: '#/components/responses/tfvForbiddenResponse'
+        '404':
+          $ref: '#/components/responses/tfvNotFoundResponse'
         '405':
           $ref: '#/components/responses/tfvNotAllowedResponse'
+        '409':
+          $ref: '#/components/responses/tfvConflictResponse'
         '429':
           $ref: '#/components/responses/tfvTooManyRequestsResponse'
         '500':
@@ -1504,7 +1529,13 @@ paths:
         tfVerificationStatus:
           $ref: '#/components/callbacks/tfVerificationStatus'
     delete:
-      description: Delete a toll-free verification submission for a toll-free number.
+      description: >-
+        Delete a toll-free verification submission for a toll-free number.
+
+
+        **Upcoming change (effective January 2027):** If a verification for the
+        phone number is in progress, it will be cancelled and the submission
+        will then be deleted asynchronously.
       operationId: deleteVerificationRequest
       parameters:
         - $ref: '#/components/parameters/accountId4'
@@ -8072,6 +8103,17 @@ components:
           example:
             description: Cannot find the requested resource.
             type: Not Found
+    tfvConflictResponse:
+      description: >-
+        Conflict. A toll-free verification for the phone number is already in
+        progress.
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/tfvError'
+          example:
+            description: 'TFV request already in progress for phone number: +18005551234'
+            type: conflict
     tfvNotAllowedResponse:
       description: Method Not Allowed
       content:
@@ -8256,8 +8298,8 @@ components:
       style: simple
       explode: false
       description: >-
-        General-header field is used to specify directives that MUST be obeyed
-        by all caching mechanisms along the request/response chain.
+        Pass-through header stored with the media and returned when the media is
+        retrieved by the user. Does not affect internal server caching behavior.
       example: no-cache
       schema:
         type: string

docs/MediaApi.md

@@ -261,7 +261,7 @@ public class Example {
 
 Upload Media
 
-Upload a file. You may add headers to the request in order to provide some control to your media file.  If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten.  A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
+Upload a file.  Filename should always be unique. Reusing filenames may result in the wrong media being sent.  A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
 
 ### Example
 ```java
@@ -292,7 +292,7 @@ public class Example {
     String mediaId = "bw.png"; // String | The ID of the media file.
     File body = new File("/path/to/file"); // File | 
     String contentType = "audio/wav"; // String | The media type of the entity-body.
-    String cacheControl = "no-cache"; // String | General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
+    String cacheControl = "no-cache"; // String | Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior.
     try {
       apiInstance.uploadMedia(accountId, mediaId, body, contentType, cacheControl);
     } catch (ApiException e) {
@@ -314,7 +314,7 @@ public class Example {
 | **mediaId** | **String**| The ID of the media file. | |
 | **body** | **File**|  | |
 | **contentType** | **String**| The media type of the entity-body. | [optional] |
-| **cacheControl** | **String**| General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. | [optional] |
+| **cacheControl** | **String**| Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. | [optional] |
 
 ### Return type
 

docs/TollFreeVerificationApi.md

@@ -103,7 +103,7 @@ public class Example {
 
 Delete a Toll-Free Verification Submission
 
-Delete a toll-free verification submission for a toll-free number.
+Delete a toll-free verification submission for a toll-free number.  **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously.
 
 ### Example
 ```java
@@ -502,7 +502,7 @@ public class Example {
 
 Request Toll-Free Verification
 
-Submit a request for verification of a toll-free phone number.
+Submit a request for verification of a toll-free phone number.  **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`.
 
 ### Example
 ```java
@@ -572,6 +572,7 @@ null (empty response body)
 | **401** | Unauthorized |  -  |
 | **403** | Forbidden |  -  |
 | **405** | Method Not Allowed |  -  |
+| **409** | Conflict. A toll-free verification for the phone number is already in progress. |  -  |
 | **429** | Too Many Requests |  -  |
 | **500** | Internal Server Error |  -  |
 | **503** | Service Unavailable |  -  |
@@ -582,7 +583,7 @@ null (empty response body)
 
 Update Toll-Free Verification Request
 
-Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).
+Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission.  **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`.
 
 ### Example
 ```java
@@ -653,7 +654,9 @@ null (empty response body)
 | **400** | Bad Request |  -  |
 | **401** | Unauthorized |  -  |
 | **403** | Forbidden |  -  |
+| **404** | Cannot find the requested resource. |  -  |
 | **405** | Method Not Allowed |  -  |
+| **409** | Conflict. A toll-free verification for the phone number is already in progress. |  -  |
 | **429** | Too Many Requests |  -  |
 | **500** | Internal Server Error |  -  |
 | **503** | Service Unavailable |  -  |