SWI-8618 Update SDK Based on Recent Spec Changes

README.md

@@ -153,9 +153,9 @@ Class | Method | HTTP request | Description
 *Bandwidth::TollFreeVerificationApi* | [**request_toll_free_verification**](docs/TollFreeVerificationApi.md#request_toll_free_verification) | **POST** /accounts/{accountId}/tollFreeVerification | Request Toll-Free Verification
 *Bandwidth::TollFreeVerificationApi* | [**update_toll_free_verification_request**](docs/TollFreeVerificationApi.md#update_toll_free_verification_request) | **PUT** /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Update Toll-Free Verification Request
 *Bandwidth::TollFreeVerificationApi* | [**update_webhook_subscription**](docs/TollFreeVerificationApi.md#update_webhook_subscription) | **PUT** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id} | Update Webhook Subscription
-*Bandwidth::TranscriptionsApi* | [**delete_real_time_transcription**](docs/TranscriptionsApi.md#delete_real_time_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete a specific transcription
-*Bandwidth::TranscriptionsApi* | [**get_real_time_transcription**](docs/TranscriptionsApi.md#get_real_time_transcription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Retrieve a specific transcription
-*Bandwidth::TranscriptionsApi* | [**list_real_time_transcriptions**](docs/TranscriptionsApi.md#list_real_time_transcriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | Enumerate transcriptions made with StartTranscription
+*Bandwidth::TranscriptionsApi* | [**delete_real_time_transcription**](docs/TranscriptionsApi.md#delete_real_time_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete Real-time Transcription
+*Bandwidth::TranscriptionsApi* | [**get_real_time_transcription**](docs/TranscriptionsApi.md#get_real_time_transcription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Get Real-time Transcription
+*Bandwidth::TranscriptionsApi* | [**list_real_time_transcriptions**](docs/TranscriptionsApi.md#list_real_time_transcriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | List Real-time Transcriptions
 
 
 ## Documentation for Models

bandwidth.yml

@@ -1157,9 +1157,9 @@ paths:
     get:
       tags:
         - Transcriptions
-      summary: Enumerate transcriptions made with StartTranscription
+      summary: List Real-time Transcriptions
       description: >-
-        Enumerates the transcriptions created on this call via
+        List the transcriptions created on this call via
         [startTranscription](/docs/voice/bxml/startTranscription).
       operationId: listRealTimeTranscriptions
       parameters:
@@ -1189,7 +1189,7 @@ paths:
     get:
       tags:
         - Transcriptions
-      summary: Retrieve a specific transcription
+      summary: Get Real-time Transcription
       description: >-
         Retrieve the specified transcription that was created on this call via
         [startTranscription](/docs/voice/bxml/startTranscription).
@@ -1220,7 +1220,7 @@ paths:
     delete:
       tags:
         - Transcriptions
-      summary: Delete a specific transcription
+      summary: Delete Real-time Transcription
       description: >-
         Delete the specified transcription that was created on this call via
         [startTranscription](/docs/voice/bxml/startTranscription).
@@ -1929,7 +1929,7 @@ components:
       required:
         - type
         - description
-    messageId:
+    id:
       type: string
       description: The ID of the message.
       example: 1589228074636lm4k2je7j7jklbn2
@@ -2549,8 +2549,8 @@ components:
       description: The data returned in a multichannel message response.
       type: object
       properties:
-        messageId:
-          $ref: '#/components/schemas/messageId'
+        id:
+          $ref: '#/components/schemas/id'
         time:
           description: The time the message was received by the Bandwidth API.
           type: string
@@ -2586,7 +2586,7 @@ components:
         expiration:
           $ref: '#/components/schemas/expiration'
       required:
-        - messageId
+        - id
         - time
         - direction
         - to
@@ -3738,11 +3738,12 @@ components:
             the state of this conference member. This is the URL of this
             member's
 
-            [Get Conference Member](/apis/voice/#operation/getConferenceMember)
+            [Get Conference
+            Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember)
             endpoint
 
             and [Modify Conference
-            Member](/apis/voice/#operation/updateConferenceMember)
+            Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember)
 
             endpoint.
           example: >-
@@ -4094,7 +4095,7 @@ components:
             points to the
 
             [Get Call
-            Transcription](/apis/voice/#operation/getCallTranscription)
+            Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription)
             endpoint.
           example: >-
             https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b

docs/CallTranscriptionMetadata.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **transcription_id** | **String** | The programmable voice API transcription ID. | [optional] |
 | **transcription_name** | **String** | The programmable voice API transcription name. This name could be provided by the user when creating the transcription. | [optional] |
-| **transcription_url** | **String** | A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint. | [optional] |
+| **transcription_url** | **String** | A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription) endpoint. | [optional] |
 
 ## Example
 

docs/ConferenceMember.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **call_id** | **String** | The call id associated with the event. | [optional] |
 | **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
-| **member_url** | **String** | A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member's [Get Conference Member](/apis/voice/#operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice/#operation/updateConferenceMember) endpoint. | [optional] |
+| **member_url** | **String** | A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member's [Get Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember) endpoint. | [optional] |
 | **mute** | **Boolean** | Whether or not this member is currently muted. Members who are muted are still able to hear other participants.  If used in a PUT request, updates this member's mute status. Has no effect if omitted. | [optional] |
 | **hold** | **Boolean** | Whether or not this member is currently on hold. Members who are on hold are not able to hear or speak in the conference.  If used in a PUT request, updates this member's hold status. Has no effect if omitted. | [optional] |
 | **call_ids_to_coach** | **Array<String>** | If this member had a value set for `callIdsToCoach` in its [Conference](/docs/voice/bxml/conference) verb or this list was added with a previous PUT request to modify the member, this is that list of calls.  If present in a PUT request, modifies the calls that this member is coaching. Has no effect if omitted. See the documentation for the [Conference](/docs/voice/bxml/conference) verb for more details about coaching. Note that this will not add the matching calls to the conference; each call must individually execute a Conference verb to join. | [optional] |

docs/MultiChannelMessageResponseData.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **message_id** | **String** | The ID of the message. |  |
+| **id** | **String** | The ID of the message. |  |
 | **time** | **Time** | The time the message was received by the Bandwidth API. |  |
 | **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) |  |  |
 | **to** | **Array<String>** | The destination phone number(s) of the message, in E164 format. |  |
@@ -19,7 +19,7 @@
 require 'bandwidth-sdk'
 
 instance = Bandwidth::MultiChannelMessageResponseData.new(
-  message_id: 1589228074636lm4k2je7j7jklbn2,
+  id: 1589228074636lm4k2je7j7jklbn2,
   time: 2025-01-01T18:20:16Z,
   direction: null,
   to: ["+15554443333"],

docs/TranscriptionsApi.md

@@ -4,16 +4,16 @@ All URIs are relative to *http://localhost*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**delete_real_time_transcription**](TranscriptionsApi.md#delete_real_time_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete a specific transcription |
-| [**get_real_time_transcription**](TranscriptionsApi.md#get_real_time_transcription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Retrieve a specific transcription |
-| [**list_real_time_transcriptions**](TranscriptionsApi.md#list_real_time_transcriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | Enumerate transcriptions made with StartTranscription |
+| [**delete_real_time_transcription**](TranscriptionsApi.md#delete_real_time_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete Real-time Transcription |
+| [**get_real_time_transcription**](TranscriptionsApi.md#get_real_time_transcription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Get Real-time Transcription |
+| [**list_real_time_transcriptions**](TranscriptionsApi.md#list_real_time_transcriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | List Real-time Transcriptions |
 
 
 ## delete_real_time_transcription
 
 > delete_real_time_transcription(account_id, call_id, transcription_id)
 
-Delete a specific transcription
+Delete Real-time Transcription
 
 Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).  Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
 
@@ -35,7 +35,7 @@ call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programma
 transcription_id = 't-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Transcription ID.
 
 begin
-  # Delete a specific transcription
+  # Delete Real-time Transcription
   api_instance.delete_real_time_transcription(account_id, call_id, transcription_id)
 rescue Bandwidth::ApiError => e
   puts "Error when calling TranscriptionsApi->delete_real_time_transcription: #{e}"
@@ -50,7 +50,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  # Delete a specific transcription
+  # Delete Real-time Transcription
   data, status_code, headers = api_instance.delete_real_time_transcription_with_http_info(account_id, call_id, transcription_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -86,7 +86,7 @@ nil (empty response body)
 
 > <CallTranscriptionResponse> get_real_time_transcription(account_id, call_id, transcription_id)
 
-Retrieve a specific transcription
+Get Real-time Transcription
 
 Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
 
@@ -108,7 +108,7 @@ call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programma
 transcription_id = 't-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Transcription ID.
 
 begin
-  # Retrieve a specific transcription
+  # Get Real-time Transcription
   result = api_instance.get_real_time_transcription(account_id, call_id, transcription_id)
   p result
 rescue Bandwidth::ApiError => e
@@ -124,7 +124,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Retrieve a specific transcription
+  # Get Real-time Transcription
   data, status_code, headers = api_instance.get_real_time_transcription_with_http_info(account_id, call_id, transcription_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -160,9 +160,9 @@ end
 
 > <Array<CallTranscriptionMetadata>> list_real_time_transcriptions(account_id, call_id)
 
-Enumerate transcriptions made with StartTranscription
+List Real-time Transcriptions
 
-Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
+List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
 
 ### Examples
 
@@ -181,7 +181,7 @@ account_id = '9900000' # String | Your Bandwidth Account ID.
 call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID.
 
 begin
-  # Enumerate transcriptions made with StartTranscription
+  # List Real-time Transcriptions
   result = api_instance.list_real_time_transcriptions(account_id, call_id)
   p result
 rescue Bandwidth::ApiError => e
@@ -197,7 +197,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Enumerate transcriptions made with StartTranscription
+  # List Real-time Transcriptions
   data, status_code, headers = api_instance.list_real_time_transcriptions_with_http_info(account_id, call_id)
   p status_code # => 2xx
   p headers # => { ... }

lib/bandwidth-sdk/api/transcriptions_api.rb

@@ -19,7 +19,7 @@ class TranscriptionsApi
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Delete a specific transcription
+    # Delete Real-time Transcription
     # Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).  Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
     # @param account_id [String] Your Bandwidth Account ID.
     # @param call_id [String] Programmable Voice API Call ID.
@@ -31,7 +31,7 @@ def delete_real_time_transcription(account_id, call_id, transcription_id, opts =
       nil
     end
 
-    # Delete a specific transcription
+    # Delete Real-time Transcription
     # Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).  Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
     # @param account_id [String] Your Bandwidth Account ID.
     # @param call_id [String] Programmable Voice API Call ID.
@@ -94,7 +94,7 @@ def delete_real_time_transcription_with_http_info(account_id, call_id, transcrip
       return data, status_code, headers
     end
 
-    # Retrieve a specific transcription
+    # Get Real-time Transcription
     # Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
     # @param account_id [String] Your Bandwidth Account ID.
     # @param call_id [String] Programmable Voice API Call ID.
@@ -106,7 +106,7 @@ def get_real_time_transcription(account_id, call_id, transcription_id, opts = {}
       data
     end
 
-    # Retrieve a specific transcription
+    # Get Real-time Transcription
     # Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
     # @param account_id [String] Your Bandwidth Account ID.
     # @param call_id [String] Programmable Voice API Call ID.
@@ -169,8 +169,8 @@ def get_real_time_transcription_with_http_info(account_id, call_id, transcriptio
       return data, status_code, headers
     end
 
-    # Enumerate transcriptions made with StartTranscription
-    # Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
+    # List Real-time Transcriptions
+    # List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
     # @param account_id [String] Your Bandwidth Account ID.
     # @param call_id [String] Programmable Voice API Call ID.
     # @param [Hash] opts the optional parameters
@@ -180,8 +180,8 @@ def list_real_time_transcriptions(account_id, call_id, opts = {})
       data
     end
 
-    # Enumerate transcriptions made with StartTranscription
-    # Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
+    # List Real-time Transcriptions
+    # List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
     # @param account_id [String] Your Bandwidth Account ID.
     # @param call_id [String] Programmable Voice API Call ID.
     # @param [Hash] opts the optional parameters

lib/bandwidth-sdk/models/call_transcription_metadata.rb

@@ -21,7 +21,7 @@ class CallTranscriptionMetadata
     # The programmable voice API transcription name. This name could be provided by the user when creating the transcription.
     attr_accessor :transcription_name
 
-    # A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint.
+    # A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription) endpoint.
     attr_accessor :transcription_url
 
     # Attribute mapping from ruby-style variable name to JSON key.

lib/bandwidth-sdk/models/conference_member.rb

@@ -21,7 +21,7 @@ class ConferenceMember
     # The unique, Bandwidth-generated ID of the conference that was recorded
     attr_accessor :conference_id
 
-    # A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member's [Get Conference Member](/apis/voice/#operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice/#operation/updateConferenceMember) endpoint.
+    # A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member's [Get Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember) endpoint.
     attr_accessor :member_url
 
     # Whether or not this member is currently muted. Members who are muted are still able to hear other participants.  If used in a PUT request, updates this member's mute status. Has no effect if omitted.