SWI-5544 Update SDK Based on Recent Spec Changes (#141)

* Generate SDK with OpenAPI Generator Version 7.6.0 * Clean SDK using Rubocop * generate with 7.7.0-SNAPSHOT * SWI-5443 Add Prism Tests (#143) * switch to 7.7.0 * redo calls tests for prism * regenerate and update gemfile * remove webmock * update unit tests * update workflows * update api client tests * run prism first? * SWI-5470 Remove Deprecated add_verb methods (#142) * rake version? * what is going on * idfk * && * try to run in subshell * sleep then run? * use bash shell * update deploy wf --------- Co-authored-by: DX-Bandwidth <[email protected]> Co-authored-by: ckoegel <[email protected]> Co-authored-by: Cameron Koegel <[email protected]>
Bandwidth · Jul 8, 2024 · d185d5f · d185d5f
1 parent 15d91f9
commit d185d5f
Show file tree

Hide file tree

Showing 148 changed files with 661 additions and 1,175 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -55,8 +55,10 @@ jobs:
 
       - name: Install Packages and Test
         run: |
+          npm install -g @stoplight/prism-cli
           bundle install
-          rake unit
+          prism mock ./bandwidth.yml & (sleep 2; rake unit)
+        shell: bash
 
       - name: Deploy to Rubygems
         run: |

diff --git a/.github/workflows/test-pr.yml b/.github/workflows/test-pr.yml
@@ -45,8 +45,10 @@ jobs:
 
       - name: Install Packages and Test
         run: |
+          npm install -g @stoplight/prism-cli
           bundle install
-          rake unit
+          prism mock ./bandwidth.yml & (sleep 2; rake unit)
         env:
           RUBY_VERSION: ${{ matrix.ruby-version }}
           OPERATING_SYSTEM: ${{ matrix.os }}
+        shell: bash
diff --git a/.github/workflows/test-smoke.yml b/.github/workflows/test-smoke.yml
@@ -49,6 +49,7 @@ jobs:
         env:
           RUBY_VERSION: 3.2
           OPERATING_SYSTEM: ubuntu
+        shell: bash
 
   notify_for_failures:
     name: Notify for Failures

diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -13,8 +13,10 @@ docs/CallRecordingMetadata.md
 docs/CallState.md
 docs/CallStateEnum.md
 docs/CallTranscription.md
+docs/CallTranscriptionDetectedLanguageEnum.md
 docs/CallTranscriptionMetadata.md
 docs/CallTranscriptionResponse.md
+docs/CallTranscriptionTrackEnum.md
 docs/CallbackMethodEnum.md
 docs/CallsApi.md
 docs/CodeRequest.md
@@ -127,8 +129,10 @@ lib/bandwidth-sdk/models/call_recording_metadata.rb
 lib/bandwidth-sdk/models/call_state.rb
 lib/bandwidth-sdk/models/call_state_enum.rb
 lib/bandwidth-sdk/models/call_transcription.rb
+lib/bandwidth-sdk/models/call_transcription_detected_language_enum.rb
 lib/bandwidth-sdk/models/call_transcription_metadata.rb
 lib/bandwidth-sdk/models/call_transcription_response.rb
+lib/bandwidth-sdk/models/call_transcription_track_enum.rb
 lib/bandwidth-sdk/models/callback_method_enum.rb
 lib/bandwidth-sdk/models/code_request.rb
 lib/bandwidth-sdk/models/conference.rb

diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION
@@ -1 +1 @@
-7.6.0
+7.7.0
diff --git a/Gemfile b/Gemfile
@@ -3,9 +3,8 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rake', '~> 13.0.1'
+  gem 'rake', '~> 13.2.1'
   gem 'pry-byebug'
   gem 'rubocop', '~> 1.52.0'
-  gem 'webmock', '~> 3.18.0'
   gem 'simplecov', '~> 0.21.2'
 end
diff --git a/README.md b/README.md
@@ -159,8 +159,10 @@ Class | Method | HTTP request | Description
  - [Bandwidth::CallState](docs/CallState.md)
  - [Bandwidth::CallStateEnum](docs/CallStateEnum.md)
  - [Bandwidth::CallTranscription](docs/CallTranscription.md)
+ - [Bandwidth::CallTranscriptionDetectedLanguageEnum](docs/CallTranscriptionDetectedLanguageEnum.md)
  - [Bandwidth::CallTranscriptionMetadata](docs/CallTranscriptionMetadata.md)
  - [Bandwidth::CallTranscriptionResponse](docs/CallTranscriptionResponse.md)
+ - [Bandwidth::CallTranscriptionTrackEnum](docs/CallTranscriptionTrackEnum.md)
  - [Bandwidth::CallbackMethodEnum](docs/CallbackMethodEnum.md)
  - [Bandwidth::CodeRequest](docs/CodeRequest.md)
  - [Bandwidth::Conference](docs/Conference.md)

diff --git a/bandwidth-sdk.gemspec b/bandwidth-sdk.gemspec
@@ -8,7 +8,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: [email protected]
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.7.0
 
 =end
 

diff --git a/bandwidth.yml b/bandwidth.yml
@@ -2131,6 +2131,21 @@ components:
 
         and will include its result.
       example: async
+    callTranscriptionDetectedLanguageEnum:
+      type: string
+      enum:
+        - en-US
+        - es-US
+        - fr-FR
+      description: The detected language for this transcription.
+      example: en-US
+    callTranscriptionTrackEnum:
+      type: string
+      enum:
+        - inbound
+        - outbound
+      description: Which `track` this transcription is derived from.
+      example: inbound
     createCall:
       type: object
       required:
@@ -3265,7 +3280,7 @@ components:
         accountId:
           type: string
           description: The user account associated with the call.
-          example: '920012'
+          example: '9900000'
         callId:
           type: string
           description: The call id associated with the event.
@@ -3281,27 +3296,16 @@ components:
           example:
             - detectedLanguage: en-US
               track: inbound
-              text: Hello World! This is an example.
+              transcript: Hello World! This is an example.
               confidence: 0.9
     callTranscription:
       type: object
       properties:
         detectedLanguage:
-          type: string
-          enum:
-            - en-US
-            - es-US
-            - fr-FR
-          description: The detected language for this transcription.
-          example: en-US
+          $ref: '#/components/schemas/callTranscriptionDetectedLanguageEnum'
         track:
-          type: string
-          enum:
-            - inbound
-            - outbound
-          description: Which `track` this transcription is derived from.
-          example: inbound
-        text:
+          $ref: '#/components/schemas/callTranscriptionTrackEnum'
+        transcript:
           type: string
           description: The transcription itself.
           example: Hello World! This is an example.
@@ -3327,6 +3331,7 @@ components:
           $ref: '#/components/schemas/status'
         completedTime:
           type: string
+          format: date-time
           description: The time that the transcription was completed
           example: '2022-06-13T18:46:29.715Z'
         url:

diff --git a/custom_templates/Gemfile.mustache b/custom_templates/Gemfile.mustache
@@ -3,9 +3,8 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rake', '~> 13.0.1'
+  gem 'rake', '~> 13.2.1'
   gem 'pry-byebug'
   gem 'rubocop', '~> 1.52.0'
-  gem 'webmock', '~> 3.18.0'
   gem 'simplecov', '~> 0.21.2'
 end
diff --git a/docs/CallTranscription.md b/docs/CallTranscription.md
@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **detected_language** | **String** | The detected language for this transcription. | [optional] |
-| **track** | **String** | Which &#x60;track&#x60; this transcription is derived from. | [optional] |
-| **text** | **String** | The transcription itself. | [optional] |
+| **detected_language** | [**CallTranscriptionDetectedLanguageEnum**](CallTranscriptionDetectedLanguageEnum.md) |  | [optional] |
+| **track** | [**CallTranscriptionTrackEnum**](CallTranscriptionTrackEnum.md) |  | [optional] |
+| **transcript** | **String** | The transcription itself. | [optional] |
 | **confidence** | **Float** | How confident the transcription engine was in transcribing the associated audio (from &#x60;0&#x60; to &#x60;1&#x60;). | [optional] |
 
 ## Example
@@ -15,9 +15,9 @@
 require 'bandwidth-sdk'
 
 instance = Bandwidth::CallTranscription.new(
-  detected_language: en-US,
-  track: inbound,
-  text: Hello World! This is an example.,
+  detected_language: null,
+  track: null,
+  transcript: Hello World! This is an example.,
   confidence: 0.9
 )
 ```

diff --git a/docs/CallTranscriptionDetectedLanguageEnum.md b/docs/CallTranscriptionDetectedLanguageEnum.md
@@ -0,0 +1,15 @@
+# Bandwidth::CallTranscriptionDetectedLanguageEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::CallTranscriptionDetectedLanguageEnum.new()
+```
+
diff --git a/docs/CallTranscriptionResponse.md b/docs/CallTranscriptionResponse.md
@@ -15,10 +15,10 @@
 require 'bandwidth-sdk'
 
 instance = Bandwidth::CallTranscriptionResponse.new(
-  account_id: 920012,
+  account_id: 9900000,
   call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
   transcription_id: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b,
-  tracks: [{&quot;detectedLanguage&quot;:&quot;en-US&quot;,&quot;track&quot;:&quot;inbound&quot;,&quot;text&quot;:&quot;Hello World! This is an example.&quot;,&quot;confidence&quot;:0.9}]
+  tracks: [{&quot;detectedLanguage&quot;:&quot;en-US&quot;,&quot;track&quot;:&quot;inbound&quot;,&quot;transcript&quot;:&quot;Hello World! This is an example.&quot;,&quot;confidence&quot;:0.9}]
 )
 ```
 
diff --git a/docs/CallTranscriptionTrackEnum.md b/docs/CallTranscriptionTrackEnum.md
@@ -0,0 +1,15 @@
+# Bandwidth::CallTranscriptionTrackEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::CallTranscriptionTrackEnum.new()
+```
+
diff --git a/docs/RecordingTranscriptionMetadata.md b/docs/RecordingTranscriptionMetadata.md
@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | The unique transcription ID | [optional] |
 | **status** | **String** | The current status of the process. For recording, current possible values are &#39;processing&#39;, &#39;partial&#39;, &#39;complete&#39;, &#39;deleted&#39;, and &#39;error&#39;. For transcriptions, current possible values are &#39;none&#39;, &#39;processing&#39;, &#39;available&#39;, &#39;error&#39;, &#39;timeout&#39;, &#39;file-size-too-big&#39;, and &#39;file-size-too-small&#39;. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] |
-| **completed_time** | **String** | The time that the transcription was completed | [optional] |
+| **completed_time** | **Time** | The time that the transcription was completed | [optional] |
 | **url** | **String** | The URL of the [transcription](#operation/getCallTranscription) | [optional] |
 
 ## Example

diff --git a/lib/bandwidth-sdk.rb b/lib/bandwidth-sdk.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: [email protected]
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.7.0
 
 =end
 
@@ -26,8 +26,10 @@
 require 'bandwidth-sdk/models/call_state'
 require 'bandwidth-sdk/models/call_state_enum'
 require 'bandwidth-sdk/models/call_transcription'
+require 'bandwidth-sdk/models/call_transcription_detected_language_enum'
 require 'bandwidth-sdk/models/call_transcription_metadata'
 require 'bandwidth-sdk/models/call_transcription_response'
+require 'bandwidth-sdk/models/call_transcription_track_enum'
 require 'bandwidth-sdk/models/callback_method_enum'
 require 'bandwidth-sdk/models/code_request'
 require 'bandwidth-sdk/models/conference'

diff --git a/lib/bandwidth-sdk/api/calls_api.rb b/lib/bandwidth-sdk/api/calls_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: [email protected]
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.7.0
 
 =end
 

diff --git a/lib/bandwidth-sdk/api/conferences_api.rb b/lib/bandwidth-sdk/api/conferences_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: [email protected]
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.7.0
 
 =end
 

diff --git a/lib/bandwidth-sdk/api/media_api.rb b/lib/bandwidth-sdk/api/media_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: [email protected]
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.7.0
 
 =end
 

diff --git a/lib/bandwidth-sdk/api/messages_api.rb b/lib/bandwidth-sdk/api/messages_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: [email protected]
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.7.0
 
 =end
 

diff --git a/lib/bandwidth-sdk/api/mfa_api.rb b/lib/bandwidth-sdk/api/mfa_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: [email protected]
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.7.0
 
 =end
 

diff --git a/lib/bandwidth-sdk/api/phone_number_lookup_api.rb b/lib/bandwidth-sdk/api/phone_number_lookup_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: [email protected]
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.7.0
 
 =end
 

diff --git a/lib/bandwidth-sdk/api/recordings_api.rb b/lib/bandwidth-sdk/api/recordings_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: [email protected]
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.7.0
 
 =end
 

diff --git a/lib/bandwidth-sdk/api/statistics_api.rb b/lib/bandwidth-sdk/api/statistics_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: [email protected]
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.7.0
 
 =end
 

diff --git a/lib/bandwidth-sdk/api/transcriptions_api.rb b/lib/bandwidth-sdk/api/transcriptions_api.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: [email protected]
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.7.0
 
 =end
 

diff --git a/lib/bandwidth-sdk/api_client.rb b/lib/bandwidth-sdk/api_client.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: [email protected]
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.7.0
 
 =end
 

diff --git a/lib/bandwidth-sdk/api_error.rb b/lib/bandwidth-sdk/api_error.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: [email protected]
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.7.0
 
 =end