SWI-9390 Update SDK Based on Recent Spec Changes (#191)

* Generate SDK with OpenAPI Generator Version

* regenerate

* unit test

* support discriminator for anyOf

* update rubocop

* update multi channel smoke tests

* fix unit test

---------

Co-authored-by: DX-Bandwidth <dx@bandwidth.com>
Co-authored-by: ckoegel <ckoegel1006@gmail.com>

Author: 3 people

Gemfile

@@ -5,6 +5,6 @@ gemspec
 group :development, :test do
   gem 'rake', '~> 13.2.1'
   gem 'pry-byebug'
-  gem 'rubocop', '~> 1.52.0'
+  gem 'rubocop', '~> 1.82.0'
   gem 'simplecov', '~> 0.21.2'
 end

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/listMessagesTooManyRequestsError'
         '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:
@@ -5875,15 +5885,13 @@ components:
       type: object
     internalTicketNumber:
       type: string
-      format: uuid
       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
     internalTicketNumberForWebhook:
       type: string
-      format: uuid
       description: >-
         Unique identifier (UUID) generated by Bandwidth to assist in tracking
         the verification status of a toll-free number.
@@ -5956,6 +5964,8 @@ components:
           $ref: '#/components/schemas/helpMessageResponse'
         ageGatedContent:
           $ref: '#/components/schemas/ageGatedContent'
+        cvToken:
+          $ref: '#/components/schemas/cvToken'
     verificationUpdateRequest:
       type: object
       required:
@@ -6005,6 +6015,8 @@ components:
           $ref: '#/components/schemas/helpMessageResponse'
         ageGatedContent:
           $ref: '#/components/schemas/ageGatedContent'
+        cvToken:
+          $ref: '#/components/schemas/cvToken'
     tfvBasicAuthentication:
       type: object
       properties:
@@ -6456,6 +6468,8 @@ components:
           $ref: '#/components/schemas/blocked'
         blockedReason:
           $ref: '#/components/schemas/blockedReason'
+        cvToken:
+          $ref: '#/components/schemas/cvToken'
     tfvSubmissionInfo:
       type: object
       properties:
@@ -6520,6 +6534,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
@@ -6734,6 +6760,21 @@ components:
               - type: internal-server-error
                 description: Internal server error. No further information available
                 source: {}
+    listMessagesTooManyRequestsError:
+      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/messagingRequestError"
+          example:
+            type: rate_limit_exceeded
+            description: Rate limit exceeded. Wait for Retry-After time before sending another request.
     createCallResponse:
       description: Created
       headers:

custom_templates/Gemfile.mustache

@@ -5,6 +5,6 @@ gemspec
 group :development, :test do
   gem 'rake', '~> 13.2.1'
   gem 'pry-byebug'
-  gem 'rubocop', '~> 1.52.0'
+  gem 'rubocop', '~> 1.82.0'
   gem 'simplecov', '~> 0.21.2'
 end

custom_templates/partial_anyof_module.mustache

@@ -0,0 +1,135 @@
+  {{#description}}
+  # {{{.}}}
+  {{/description}}
+  module {{classname}}
+    class << self
+      {{#anyOf}}
+      {{#-first}}
+      # List of class defined in anyOf (OpenAPI v3)
+      def openapi_any_of
+        [
+      {{/-first}}
+          :'{{{.}}}'{{^-last}},{{/-last}}
+      {{#-last}}
+        ]
+      end
+
+      {{/-last}}
+      {{/anyOf}}
+      {{#discriminator}}
+      {{#propertyName}}
+      # Discriminator's property name (OpenAPI v3)
+      def openapi_discriminator_name
+        :'{{{.}}}'
+      end
+
+      {{/propertyName}}
+      {{#mappedModels}}
+      {{#-first}}
+      # Discriminator's mapping (OpenAPI v3)
+      def openapi_discriminator_mapping
+        {
+      {{/-first}}
+          :'{{{mappingName}}}' => :'{{{modelName}}}'{{^-last}},{{/-last}}
+      {{#-last}}
+        }
+      end
+
+      {{/-last}}
+      {{/mappedModels}}
+      {{/discriminator}}
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of anyOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+      {{#discriminator}}
+        discriminator_value = data[openapi_discriminator_name]
+        return nil if discriminator_value.nil?
+      {{#mappedModels}}
+      {{#-first}}
+
+        klass = openapi_discriminator_mapping[discriminator_value.to_s.to_sym]
+        return nil unless klass
+
+        {{moduleName}}.const_get(klass).build_from_hash(data)
+      {{/-first}}
+      {{/mappedModels}}
+      {{^mappedModels}}
+        {{moduleName}}.const_get(discriminator_value).build_from_hash(data)
+      {{/mappedModels}}
+      {{/discriminator}}
+      {{^discriminator}}
+        # Go through the list of anyOf items and attempt to identify the appropriate one.
+        # Note:
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_any_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            return find_and_cast_into_type(klass, data)
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_any_of.include?(:AnyType) ? data : nil
+      {{/discriminator}}
+      end
+      {{^discriminator}}
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.iso8601(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = {{moduleName}}.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_any_of) # nested anyOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+      {{/discriminator}}
+    end
+  end

docs/MessagesApi.md

@@ -89,7 +89,7 @@ end
 
 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. 
 
 ### Examples
 

docs/RbmActionBase.md

@@ -16,7 +16,7 @@ require 'bandwidth-sdk'
 instance = Bandwidth::RbmActionBase.new(
   type: null,
   text: Hello world,
-  postback_data: [B@13866865
+  postback_data: [B@665f88e1
 )
 ```
 

docs/RbmMessageMedia.md

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

docs/RbmSuggestionResponse.md

@@ -14,7 +14,7 @@ require 'bandwidth-sdk'
 
 instance = Bandwidth::RbmSuggestionResponse.new(
   text: Yes, I would like to proceed,
-  postback_data: [B@13866865
+  postback_data: [B@665f88e1
 )
 ```
 

docs/TfvStatus.md

@@ -14,6 +14,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] |
 | **blocked_reason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] |
+| **cv_token** | **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] |
 
 ## Example
 
@@ -30,7 +31,8 @@ instance = Bandwidth::TfvStatus.new(
   modified_date_time: 2021-06-08T06:45:13Z,
   submission: null,
   blocked: true,
-  blocked_reason: Toll-free number was used to send spam messages
+  blocked_reason: Toll-free number was used to send spam messages,
+  cv_token: cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw
 )
 ```
 

docs/VerificationRequest.md

@@ -22,6 +22,7 @@
 | **business_entity_type** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) |  | [optional] |
 | **help_message_response** | **String** | A message that gets sent to users requesting help. | [optional] |
 | **age_gated_content** | **Boolean** | Indicates whether the content is age-gated. | [optional] |
+| **cv_token** | **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] |
 
 ## Example
 
@@ -46,7 +47,8 @@ instance = Bandwidth::VerificationRequest.new(
   business_registration_type: null,
   business_entity_type: null,
   help_message_response: Please contact support for assistance.,
-  age_gated_content: false
+  age_gated_content: false,
+  cv_token: cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw
 )
 ```