Generate SDK with OpenAPI Generator Version (#166)

Co-authored-by: DX-Bandwidth <[email protected]>

Author: band-swi-release-engineering[bot]

bandwidth.yml

@@ -1641,12 +1641,14 @@ components:
       enum:
         - INBOUND
         - OUTBOUND
+      example: INBOUND
     messageDirectionEnum:
       type: string
       description: The direction of the message. One of in out.
       enum:
         - in
         - out
+      example: in
     messageTypeEnum:
       type: string
       description: The type of message. Either SMS or MMS.
@@ -4797,17 +4799,9 @@ components:
         useCase:
           $ref: '#/components/schemas/useCase'
         useCaseSummary:
-          type: string
-          description: A general idea of the use case and customer.
-          minLength: 1
-          maxLength: 500
-          nullable: false
+          $ref: '#/components/schemas/useCaseSummary'
         productionMessageContent:
-          type: string
-          description: Example of message content.
-          minLength: 1
-          maxLength: 500
-          nullable: false
+          $ref: '#/components/schemas/productionMessageContent'
         optInWorkflow:
           $ref: '#/components/schemas/optInWorkflow'
         additionalInformation:
@@ -4816,6 +4810,7 @@ components:
           minLength: 0
           maxLength: 500
           nullable: true
+          example: Any additional information
         isvReseller:
           $ref: '#/components/schemas/isvReseller'
     verificationUpdateRequest:
@@ -4842,25 +4837,13 @@ components:
         useCase:
           $ref: '#/components/schemas/useCase'
         useCaseSummary:
-          type: string
-          description: A general idea of the use case and customer.
-          minLength: 0
-          maxLength: 500
-          nullable: false
+          $ref: '#/components/schemas/useCaseSummary'
         productionMessageContent:
-          type: string
-          description: Example of message content.
-          minLength: 0
-          maxLength: 500
-          nullable: false
+          $ref: '#/components/schemas/productionMessageContent'
         optInWorkflow:
           $ref: '#/components/schemas/optInWorkflow'
         additionalInformation:
-          type: string
-          description: Any additional information.
-          minLength: 0
-          maxLength: 500
-          nullable: true
+          $ref: '#/components/schemas/additionalInformation'
         isvReseller:
           $ref: '#/components/schemas/isvReseller'
     tfvBasicAuthentication:
@@ -4869,9 +4852,11 @@ components:
         username:
           type: string
           maxLength: 100
+          example: username
         password:
           type: string
           maxLength: 200
+          example: password
       required:
         - username
         - password
@@ -4986,6 +4971,7 @@ components:
           minLength: 0
           maxLength: 500
           nullable: true
+          example: 2230 Bandmate Way
         city:
           type: string
           description: The city of the business using the toll-free number.
@@ -5014,6 +5000,12 @@ components:
           maxLength: 500
           nullable: false
           example: https://www.example.com/path/to/resource
+    additionalInformation:
+      type: string
+      description: Any additional information.
+      minLength: 0
+      maxLength: 500
+      nullable: true
     optInWorkflow:
       type: object
       nullable: false
@@ -5101,6 +5093,20 @@ components:
       minLength: 0
       maxLength: 500
       example: 2FA
+    useCaseSummary:
+      type: string
+      description: A general idea of the use case and customer.
+      minLength: 0
+      maxLength: 500
+      nullable: false
+      example: Text summarizing the use case for the toll-free number
+    productionMessageContent:
+      type: string
+      description: Example of message content.
+      minLength: 0
+      maxLength: 500
+      nullable: false
+      example: Production message content
     webhookSubscriptionsListBody:
       description: >-
         A list of all webhook subscriptions registered for this account ID for
@@ -5277,28 +5283,13 @@ components:
         useCase:
           $ref: '#/components/schemas/useCase'
         useCaseSummary:
-          type: string
-          description: A general idea of the use case and customer.
-          minLength: 0
-          maxLength: 500
-          nullable: false
-          example: Text summarizing the use case for the toll-free number
+          $ref: '#/components/schemas/useCaseSummary'
         productionMessageContent:
-          type: string
-          description: Example of message content.
-          minLength: 0
-          maxLength: 500
-          nullable: false
-          example: Production message content
+          $ref: '#/components/schemas/productionMessageContent'
         optInWorkflow:
           $ref: '#/components/schemas/optInWorkflow'
         additionalInformation:
-          type: string
-          description: Any additional information.
-          minLength: 0
-          maxLength: 500
-          nullable: true
-          example: Any additional information
+          $ref: '#/components/schemas/additionalInformation'
         isvReseller:
           $ref: '#/components/schemas/isvReseller'
     tfvStatusEnum:
@@ -6235,6 +6226,7 @@ components:
         Not intended for explicit use. To use pagination, follow the links in
         the `Link` header of the response, as indicated in the endpoint
         description.
+      example: eyJwYWdlVG9rZW4iOiJ0b2tlbiJ9
     disconnectCause:
       name: disconnectCause
       in: query

docs/Address.md

@@ -20,7 +20,7 @@ require 'bandwidth-sdk'
 instance = Bandwidth::Address.new(
   name: Bandwidth Inc.,
   addr1: 2230 Bandmate Way,
-  addr2: null,
+  addr2: 2230 Bandmate Way,
   city: Raleigh,
   state: NC,
   zip: 27606,

docs/CallsApi.md

@@ -184,7 +184,7 @@ opts = {
   max_start_time: '2022-06-21T19:13:21Z', # String | Filter results to calls which have a `startTime` before or including `maxStartTime` (in ISO8601 format).
   disconnect_cause: 'hangup', # String | Filter results to calls with specified call Disconnect Cause.
   page_size: 500, # Integer | Specifies the max number of calls that will be returned.
-  page_token: 'page_token_example' # String | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description.
+  page_token: 'eyJwYWdlVG9rZW4iOiJ0b2tlbiJ9' # String | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description.
 }
 
 begin

docs/ConferencesApi.md

@@ -408,7 +408,7 @@ opts = {
   min_created_time: '2022-06-21T19:13:21Z', # String | Filter results to conferences which have a `createdTime` after or at `minCreatedTime` (in ISO8601 format).
   max_created_time: '2022-06-21T19:13:21Z', # String | Filter results to conferences which have a `createdTime` before or at `maxCreatedTime` (in ISO8601 format).
   page_size: 500, # Integer | Specifies the max number of conferences that will be returned.
-  page_token: 'page_token_example' # String | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description.
+  page_token: 'eyJwYWdlVG9rZW4iOiJ0b2tlbiJ9' # String | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description.
 }
 
 begin

docs/TfvBasicAuthentication.md

@@ -13,8 +13,8 @@
 require 'bandwidth-sdk'
 
 instance = Bandwidth::TfvBasicAuthentication.new(
-  username: null,
-  password: null
+  username: username,
+  password: password
 )
 ```
 

docs/TfvSubmissionInfo.md

@@ -27,7 +27,7 @@ instance = Bandwidth::TfvSubmissionInfo.new(
   use_case_summary: Text summarizing the use case for the toll-free number,
   production_message_content: Production message content,
   opt_in_workflow: null,
-  additional_information: Any additional information,
+  additional_information: null,
   isv_reseller: Test ISV
 )
 ```

docs/TollFreeVerificationApi.md

@@ -388,7 +388,7 @@ end
 
 api_instance = Bandwidth::TollFreeVerificationApi.new
 account_id = '9900000' # String | Your Bandwidth Account ID.
-verification_request = Bandwidth::VerificationRequest.new({business_address: Bandwidth::Address.new({name: 'Bandwidth Inc.', addr1: '2230 Bandmate Way', city: 'Raleigh', state: 'NC', zip: '27606', url: 'https://www.example.com/path/to/resource'}), business_contact: Bandwidth::Contact.new({first_name: 'John', last_name: 'Doe', email: '[email protected]', phone_number: '+19192654500'}), message_volume: 10000, phone_numbers: ['+18005555555'], use_case: '2FA', use_case_summary: 'use_case_summary_example', production_message_content: 'production_message_content_example', opt_in_workflow: Bandwidth::OptInWorkflow.new({description: 'Opt In Flow', image_urls: ['https://www.example.com/path/to/resource']})}) # VerificationRequest | Request for verification of a toll-free phone number.
+verification_request = Bandwidth::VerificationRequest.new({business_address: Bandwidth::Address.new({name: 'Bandwidth Inc.', addr1: '2230 Bandmate Way', city: 'Raleigh', state: 'NC', zip: '27606', url: 'https://www.example.com/path/to/resource'}), business_contact: Bandwidth::Contact.new({first_name: 'John', last_name: 'Doe', email: '[email protected]', phone_number: '+19192654500'}), message_volume: 10000, phone_numbers: ['+18005555555'], use_case: '2FA', use_case_summary: 'Text summarizing the use case for the toll-free number', production_message_content: 'Production message content', opt_in_workflow: Bandwidth::OptInWorkflow.new({description: 'Opt In Flow', image_urls: ['https://www.example.com/path/to/resource']})}) # VerificationRequest | Request for verification of a toll-free phone number.
 
 begin
   # Request Toll-Free Verification

docs/VerificationRequest.md

@@ -26,10 +26,10 @@ instance = Bandwidth::VerificationRequest.new(
   message_volume: 10000,
   phone_numbers: null,
   use_case: 2FA,
-  use_case_summary: null,
-  production_message_content: null,
+  use_case_summary: Text summarizing the use case for the toll-free number,
+  production_message_content: Production message content,
   opt_in_workflow: null,
-  additional_information: null,
+  additional_information: Any additional information,
   isv_reseller: Test ISV
 )
 ```

docs/VerificationUpdateRequest.md

@@ -24,8 +24,8 @@ instance = Bandwidth::VerificationUpdateRequest.new(
   business_contact: null,
   message_volume: 10000,
   use_case: 2FA,
-  use_case_summary: null,
-  production_message_content: null,
+  use_case_summary: Text summarizing the use case for the toll-free number,
+  production_message_content: Production message content,
   opt_in_workflow: null,
   additional_information: null,
   isv_reseller: Test ISV

lib/bandwidth-sdk/models/verification_request.rb

@@ -217,8 +217,8 @@ def list_invalid_properties
         invalid_properties.push('invalid value for "use_case_summary", the character length must be smaller than or equal to 500.')
       end
 
-      if @use_case_summary.to_s.length < 1
-        invalid_properties.push('invalid value for "use_case_summary", the character length must be great than or equal to 1.')
+      if @use_case_summary.to_s.length < 0
+        invalid_properties.push('invalid value for "use_case_summary", the character length must be great than or equal to 0.')
       end
 
       if @production_message_content.nil?
@@ -229,8 +229,8 @@ def list_invalid_properties
         invalid_properties.push('invalid value for "production_message_content", the character length must be smaller than or equal to 500.')
       end
 
-      if @production_message_content.to_s.length < 1
-        invalid_properties.push('invalid value for "production_message_content", the character length must be great than or equal to 1.')
+      if @production_message_content.to_s.length < 0
+        invalid_properties.push('invalid value for "production_message_content", the character length must be great than or equal to 0.')
       end
 
       if @opt_in_workflow.nil?
@@ -273,10 +273,10 @@ def valid?
       return false if @use_case.to_s.length < 0
       return false if @use_case_summary.nil?
       return false if @use_case_summary.to_s.length > 500
-      return false if @use_case_summary.to_s.length < 1
+      return false if @use_case_summary.to_s.length < 0
       return false if @production_message_content.nil?
       return false if @production_message_content.to_s.length > 500
-      return false if @production_message_content.to_s.length < 1
+      return false if @production_message_content.to_s.length < 0
       return false if @opt_in_workflow.nil?
       return false if !@additional_information.nil? && @additional_information.to_s.length > 500
       return false if !@additional_information.nil? && @additional_information.to_s.length < 0
@@ -350,8 +350,8 @@ def use_case_summary=(use_case_summary)
         fail ArgumentError, 'invalid value for "use_case_summary", the character length must be smaller than or equal to 500.'
       end
 
-      if use_case_summary.to_s.length < 1
-        fail ArgumentError, 'invalid value for "use_case_summary", the character length must be great than or equal to 1.'
+      if use_case_summary.to_s.length < 0
+        fail ArgumentError, 'invalid value for "use_case_summary", the character length must be great than or equal to 0.'
       end
 
       @use_case_summary = use_case_summary
@@ -368,8 +368,8 @@ def production_message_content=(production_message_content)
         fail ArgumentError, 'invalid value for "production_message_content", the character length must be smaller than or equal to 500.'
       end
 
-      if production_message_content.to_s.length < 1
-        fail ArgumentError, 'invalid value for "production_message_content", the character length must be great than or equal to 1.'
+      if production_message_content.to_s.length < 0
+        fail ArgumentError, 'invalid value for "production_message_content", the character length must be great than or equal to 0.'
       end
 
       @production_message_content = production_message_content