SWI-9389 Update SDK Based on Recent Spec Changes

.openapi-generator/FILES

@@ -48,6 +48,7 @@ docs/CreateMessageRequestError.md
 docs/CreateMultiChannelMessageResponse.md
 docs/CreateSyncLookupResponse.md
 docs/CreateSyncLookupResponseData.md
+docs/CustomTooManyRequestsError.md
 docs/DeactivationEventEnum.md
 docs/DisconnectCallback.md
 docs/Diversion.md
@@ -275,6 +276,7 @@ src/main/java/com/bandwidth/sdk/model/CreateMessageRequestError.java
 src/main/java/com/bandwidth/sdk/model/CreateMultiChannelMessageResponse.java
 src/main/java/com/bandwidth/sdk/model/CreateSyncLookupResponse.java
 src/main/java/com/bandwidth/sdk/model/CreateSyncLookupResponseData.java
+src/main/java/com/bandwidth/sdk/model/CustomTooManyRequestsError.java
 src/main/java/com/bandwidth/sdk/model/DeactivationEventEnum.java
 src/main/java/com/bandwidth/sdk/model/DisconnectCallback.java
 src/main/java/com/bandwidth/sdk/model/Diversion.java

README.md

@@ -226,6 +226,7 @@ Class | Method | HTTP request | Description
  - [CreateMultiChannelMessageResponse](docs/CreateMultiChannelMessageResponse.md)
  - [CreateSyncLookupResponse](docs/CreateSyncLookupResponse.md)
  - [CreateSyncLookupResponseData](docs/CreateSyncLookupResponseData.md)
+ - [CustomTooManyRequestsError](docs/CustomTooManyRequestsError.md)
  - [DeactivationEventEnum](docs/DeactivationEventEnum.md)
  - [DisconnectCallback](docs/DisconnectCallback.md)
  - [Diversion](docs/Diversion.md)

api/openapi.yaml

@@ -399,7 +399,10 @@ paths:
       url: https://messaging.bandwidth.com/api/v2
   /users/{accountId}/messages:
     get:
-      description: Returns a list of messages based on query parameters.
+      description: |
+        Returns a list of messages based on query parameters.
+
+        **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
       operationId: listMessages
       parameters:
       - description: Your Bandwidth Account ID.
@@ -709,6 +712,12 @@ paths:
               schema:
                 $ref: "#/components/schemas/messagingRequestError"
           description: Not Found
+        "405":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/messagingRequestError"
+          description: Method Not Allowed
         "415":
           content:
             application/json:
@@ -719,8 +728,16 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/messagingRequestError"
+                $ref: "#/components/schemas/customTooManyRequestsError"
           description: Too Many Requests
+          headers:
+            Retry-After:
+              description: The number of seconds to wait before retrying the request.
+              explode: false
+              schema:
+                example: 300
+                type: integer
+              style: simple
         "500":
           content:
             application/json:
@@ -7534,6 +7551,20 @@ components:
           schema:
             $ref: "#/components/schemas/multiChannelError"
       description: Internal Server Error
+    customTooManyRequestsError:
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/customTooManyRequestsError"
+      description: Too Many Requests
+      headers:
+        Retry-After:
+          description: The number of seconds to wait before retrying the request.
+          explode: false
+          schema:
+            example: 300
+            type: integer
+          style: simple
     createCallResponse:
       content:
         application/json:
@@ -8860,7 +8891,9 @@ components:
     rbmMessageMedia:
       properties:
         media:
-          $ref: "#/components/schemas/rbmMessageContentFile"
+          items:
+            $ref: "#/components/schemas/rbmMessageContentFile"
+          type: array
         suggestions:
           description: An array of suggested actions for the recipient.
           items:
@@ -9740,6 +9773,24 @@ components:
       - segmentCount
       - time
       - to
+    customTooManyRequestsError:
+      example:
+        description: Rate limit exceeded. Wait for Retry-After time before sending
+          another request.
+        type: rate_limit_exceeded
+      properties:
+        type:
+          example: rate_limit_exceeded
+          type: string
+        description:
+          example: Rate limit exceeded. Wait for Retry-After time before sending another
+            request.
+          type: string
+      required:
+      - description
+      - type
+      title: CustomTooManyRequestsError
+      type: object
     callbackMethodEnum:
       default: POST
       description: The HTTP method to use to deliver the callback. GET or POST. Default
@@ -13851,6 +13902,16 @@ components:
           description: Indicates whether the content is age-gated.
           example: false
           type: boolean
+        cvToken:
+          description: "The token provided by Campaign Verify to validate your political\
+            \ use case. Only required for 527 political organizations. If you are\
+            \ not a 527 political organization, this field should be omitted. If you\
+            \ pass an empty string, it will be passed along and potentially rejected."
+          example: cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw
+          maxLength: 500
+          minLength: 0
+          nullable: true
+          type: string
       required:
       - businessAddress
       - businessContact
@@ -13945,6 +14006,16 @@ components:
           description: Indicates whether the content is age-gated.
           example: false
           type: boolean
+        cvToken:
+          description: "The token provided by Campaign Verify to validate your political\
+            \ use case. Only required for 527 political organizations. If you are\
+            \ not a 527 political organization, this field should be omitted. If you\
+            \ pass an empty string, it will be passed along and potentially rejected."
+          example: cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw
+          maxLength: 500
+          minLength: 0
+          nullable: true
+          type: string
       required:
       - businessAddress
       - businessContact
@@ -14603,6 +14674,7 @@ components:
           useCaseSummary: Text summarizing the use case for the toll-free number
         declineReasonDescription: Invalid Information - Can't Validate URL - Website
           is not accessible / not available
+        cvToken: cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw
         status: VERIFIED
       properties:
         phoneNumber:
@@ -14654,6 +14726,16 @@ components:
             attribute will only be defined when the number is blocked.
           example: Toll-free number was used to send spam messages
           type: string
+        cvToken:
+          description: "The token provided by Campaign Verify to validate your political\
+            \ use case. Only required for 527 political organizations. If you are\
+            \ not a 527 political organization, this field should be omitted. If you\
+            \ pass an empty string, it will be passed along and potentially rejected."
+          example: cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw
+          maxLength: 500
+          minLength: 0
+          nullable: true
+          type: string
       type: object
     tfvSubmissionInfo:
       example:
@@ -14778,6 +14860,16 @@ components:
       nullable: true
       pattern: "^[ -~]{16,64}$"
       type: string
+    cvToken:
+      description: "The token provided by Campaign Verify to validate your political\
+        \ use case. Only required for 527 political organizations. If you are not\
+        \ a 527 political organization, this field should be omitted. If you pass\
+        \ an empty string, it will be passed along and potentially rejected."
+      example: cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw
+      maxLength: 500
+      minLength: 0
+      nullable: true
+      type: string
     rbmCardContent_media:
       allOf:
       - $ref: "#/components/schemas/rbmMessageContentFile"

bandwidth.yml

@@ -163,7 +163,13 @@ paths:
   /users/{accountId}/messages:
     get:
       summary: List Messages
-      description: Returns a list of messages based on query parameters.
+      description: >
+        Returns a list of messages based on query parameters.
+
+
+        **Rate Limit:** This endpoint is rate limited to 3500 requests per 5
+        minutes per Source IP address. Exceeding the limit returns HTTP 429 with
+        a `Retry-After` header.
       operationId: listMessages
       tags:
         - Messages
@@ -207,10 +213,12 @@ paths:
           $ref: '#/components/responses/messagingForbiddenError'
         '404':
           $ref: '#/components/responses/messagingNotFoundError'
+        '405':
+          $ref: '#/components/responses/messagingMethodNotAllowedError'
         '415':
           $ref: '#/components/responses/messagingInvalidMediaTypeError'
         '429':
-          $ref: '#/components/responses/messagingTooManyRequestsError'
+          $ref: '#/components/responses/customTooManyRequestsError'
         '500':
           $ref: '#/components/responses/messagingInternalServerError'
     post:
@@ -2257,7 +2265,9 @@ components:
       type: object
       properties:
         media:
-          $ref: '#/components/schemas/rbmMessageContentFile'
+          type: array
+          items:
+            $ref: '#/components/schemas/rbmMessageContentFile'
         suggestions:
           $ref: '#/components/schemas/multiChannelFullActions'
       required:
@@ -2944,6 +2954,21 @@ components:
         - direction
         - to
         - from
+    customTooManyRequestsError:
+      title: CustomTooManyRequestsError
+      type: object
+      properties:
+        type:
+          type: string
+          example: rate_limit_exceeded
+        description:
+          type: string
+          example: >-
+            Rate limit exceeded. Wait for Retry-After time before sending
+            another request.
+      required:
+        - type
+        - description
     callbackMethodEnum:
       type: string
       nullable: true
@@ -5954,6 +5979,8 @@ components:
           $ref: '#/components/schemas/helpMessageResponse'
         ageGatedContent:
           $ref: '#/components/schemas/ageGatedContent'
+        cvToken:
+          $ref: '#/components/schemas/cvToken'
     verificationUpdateRequest:
       type: object
       required:
@@ -6003,6 +6030,8 @@ components:
           $ref: '#/components/schemas/helpMessageResponse'
         ageGatedContent:
           $ref: '#/components/schemas/ageGatedContent'
+        cvToken:
+          $ref: '#/components/schemas/cvToken'
     tfvBasicAuthentication:
       type: object
       properties:
@@ -6454,6 +6483,8 @@ components:
           $ref: '#/components/schemas/blocked'
         blockedReason:
           $ref: '#/components/schemas/blockedReason'
+        cvToken:
+          $ref: '#/components/schemas/cvToken'
     tfvSubmissionInfo:
       type: object
       properties:
@@ -6518,6 +6549,18 @@ components:
       nullable: true
       pattern: ^[ -~]{16,64}$
       type: string
+    cvToken:
+      type: string
+      description: >-
+        The token provided by Campaign Verify to validate your political use
+        case. Only required for 527 political organizations. If you are not a
+        527 political organization, this field should be omitted. If you pass an
+        empty string, it will be passed along and potentially rejected.
+      minLength: 0
+      maxLength: 500
+      nullable: true
+      example: >-
+        cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw
   responses:
     createMessageResponse:
       description: Accepted
@@ -6732,6 +6775,18 @@ components:
               - type: internal-server-error
                 description: Internal server error. No further information available
                 source: {}
+    customTooManyRequestsError:
+      description: Too Many Requests
+      headers:
+        Retry-After:
+          description: The number of seconds to wait before retrying the request.
+          schema:
+            type: integer
+            example: 300
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/customTooManyRequestsError'
     createCallResponse:
       description: Created
       headers:

docs/CustomTooManyRequestsError.md

@@ -0,0 +1,14 @@
+
+
+# CustomTooManyRequestsError
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | **String** |  |  |
+|**description** | **String** |  |  |
+
+
+

docs/MessagesApi.md

@@ -97,7 +97,7 @@ public class Example {
 
 List Messages
 
-Returns a list of messages based on query parameters.
+Returns a list of messages based on query parameters.  **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header. 
 
 ### Example
 ```java
@@ -220,7 +220,8 @@ public class Example {
 | **401** | Unauthorized |  -  |
 | **403** | Forbidden |  -  |
 | **404** | Not Found |  -  |
+| **405** | Method Not Allowed |  -  |
 | **415** | Unsupported Media Type |  -  |
-| **429** | Too Many Requests |  -  |
+| **429** | Too Many Requests |  * Retry-After - The number of seconds to wait before retrying the request. <br>  |
 | **500** | Internal Server Error |  -  |
 

docs/MultiChannelChannelListRBMObjectAllOfContent.md

@@ -10,7 +10,7 @@ The content of the message.
 |------------ | ------------- | ------------- | -------------|
 |**text** | **String** | The text associated with the message. Must be 3270 characters or less |  |
 |**suggestions** | [**List<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. |  [optional] |
-|**media** | [**RbmMessageContentFile**](RbmMessageContentFile.md) |  |  |
+|**media** | [**List<RbmMessageContentFile>**](RbmMessageContentFile.md) |  |  |
 |**orientation** | **StandaloneCardOrientationEnum** |  |  |
 |**thumbnailImageAlignment** | **ThumbnailAlignmentEnum** |  |  |
 |**cardContent** | [**RbmCardContent**](RbmCardContent.md) |  |  |

docs/RbmMessageMedia.md

@@ -7,7 +7,7 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**media** | [**RbmMessageContentFile**](RbmMessageContentFile.md) |  |  |
+|**media** | [**List<RbmMessageContentFile>**](RbmMessageContentFile.md) |  |  |
 |**suggestions** | [**List<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. |  [optional] |
 
 

docs/TfvStatus.md

@@ -17,6 +17,7 @@
 |**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. |  [optional] |
 |**blockedReason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. |  [optional] |
+|**cvToken** | **String** | The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted. If you pass an empty string, it will be passed along and potentially rejected. |  [optional] |
 
 
 

docs/VerificationRequest.md

@@ -25,6 +25,7 @@
 |**businessEntityType** | **BusinessEntityTypeEnum** |  |  [optional] |
 |**helpMessageResponse** | **String** | A message that gets sent to users requesting help. |  [optional] |
 |**ageGatedContent** | **Boolean** | Indicates whether the content is age-gated. |  [optional] |
+|**cvToken** | **String** | The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted. If you pass an empty string, it will be passed along and potentially rejected. |  [optional] |