Generate SDK with OpenAPI Generator Version (#245)

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

bandwidth/models/verification_request.py

@@ -36,8 +36,8 @@ class VerificationRequest(BaseModel):
     message_volume: Annotated[int, Field(le=10000000, strict=True, ge=10)] = Field(description="Estimated monthly volume of messages from the toll-free number.", alias="messageVolume")
     phone_numbers: Annotated[List[Annotated[str, Field(min_length=12, strict=True, max_length=12)]], Field(min_length=1, max_length=10)] = Field(alias="phoneNumbers")
     use_case: Annotated[str, Field(min_length=0, strict=True, max_length=500)] = Field(description="The category of the use case.", alias="useCase")
-    use_case_summary: Annotated[str, Field(min_length=1, strict=True, max_length=500)] = Field(description="A general idea of the use case and customer.", alias="useCaseSummary")
-    production_message_content: Annotated[str, Field(min_length=1, strict=True, max_length=500)] = Field(description="Example of message content.", alias="productionMessageContent")
+    use_case_summary: Annotated[str, Field(min_length=0, strict=True, max_length=500)] = Field(description="A general idea of the use case and customer.", alias="useCaseSummary")
+    production_message_content: Annotated[str, Field(min_length=0, strict=True, max_length=500)] = Field(description="Example of message content.", alias="productionMessageContent")
     opt_in_workflow: OptInWorkflow = Field(alias="optInWorkflow")
     additional_information: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=500)]] = Field(default=None, description="Any additional information.", alias="additionalInformation")
     isv_reseller: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=500)]] = Field(default=None, description="ISV name.", alias="isvReseller")

docs/CallsApi.md

@@ -235,7 +235,7 @@ with bandwidth.ApiClient(configuration) as api_client:
     max_start_time = '2022-06-21T19:13:21Z' # str | Filter results to calls which have a `startTime` before or including `maxStartTime` (in ISO8601 format). (optional)
     disconnect_cause = 'hangup' # str | Filter results to calls with specified call Disconnect Cause. (optional)
     page_size = 1000 # int | Specifies the max number of calls that will be returned. (optional) (default to 1000)
-    page_token = 'page_token_example' # str | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. (optional)
+    page_token = 'eyJwYWdlVG9rZW4iOiJ0b2tlbiJ9' # str | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. (optional)
 
     try:
         # Get Calls

docs/ConferencesApi.md

@@ -508,7 +508,7 @@ with bandwidth.ApiClient(configuration) as api_client:
     min_created_time = '2022-06-21T19:13:21Z' # str | Filter results to conferences which have a `createdTime` after or at `minCreatedTime` (in ISO8601 format). (optional)
     max_created_time = '2022-06-21T19:13:21Z' # str | Filter results to conferences which have a `createdTime` before or at `maxCreatedTime` (in ISO8601 format). (optional)
     page_size = 1000 # int | Specifies the max number of conferences that will be returned. (optional) (default to 1000)
-    page_token = 'page_token_example' # str | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. (optional)
+    page_token = 'eyJwYWdlVG9rZW4iOiJ0b2tlbiJ9' # str | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. (optional)
 
     try:
         # Get Conferences