From e7e30b1536b089445f8921b02b6e4b9cf0e23896 Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Tue, 9 Sep 2025 14:07:00 +0000 Subject: [PATCH] Generate SDK with OpenAPI Generator Version --- README.md | 6 ++--- bandwidth.yml | 23 ++++++++-------- docs/CallTranscriptionMetadata.md | 2 +- docs/ConferenceMember.md | 2 +- docs/MultiChannelMessageResponseData.md | 4 +-- docs/TranscriptionsApi.md | 26 +++++++++---------- lib/bandwidth-sdk/api/transcriptions_api.rb | 16 ++++++------ .../models/call_transcription_metadata.rb | 2 +- lib/bandwidth-sdk/models/conference_member.rb | 2 +- .../multi_channel_message_response_data.rb | 22 ++++++++-------- 10 files changed, 53 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 2f137c2a..bbdeb6af 100644 --- a/README.md +++ b/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 diff --git a/bandwidth.yml b/bandwidth.yml index 004fb91b..b7f79686 100644 --- a/bandwidth.yml +++ b/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 diff --git a/docs/CallTranscriptionMetadata.md b/docs/CallTranscriptionMetadata.md index a5fdd655..e72c647f 100644 --- a/docs/CallTranscriptionMetadata.md +++ b/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 diff --git a/docs/ConferenceMember.md b/docs/ConferenceMember.md index 6948cfc4..9cae8505 100644 --- a/docs/ConferenceMember.md +++ b/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] | diff --git a/docs/MultiChannelMessageResponseData.md b/docs/MultiChannelMessageResponseData.md index a679ea2d..a3fa6267 100644 --- a/docs/MultiChannelMessageResponseData.md +++ b/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"], diff --git a/docs/TranscriptionsApi.md b/docs/TranscriptionsApi.md index 9ca40c38..b58e2adc 100644 --- a/docs/TranscriptionsApi.md +++ b/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) > 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 > > 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 # => { ... } diff --git a/lib/bandwidth-sdk/api/transcriptions_api.rb b/lib/bandwidth-sdk/api/transcriptions_api.rb index 32cdba7d..d8adb7fb 100644 --- a/lib/bandwidth-sdk/api/transcriptions_api.rb +++ b/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 diff --git a/lib/bandwidth-sdk/models/call_transcription_metadata.rb b/lib/bandwidth-sdk/models/call_transcription_metadata.rb index 546b229b..2a18bdc1 100644 --- a/lib/bandwidth-sdk/models/call_transcription_metadata.rb +++ b/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. diff --git a/lib/bandwidth-sdk/models/conference_member.rb b/lib/bandwidth-sdk/models/conference_member.rb index 71ac2b5b..6d4928ba 100644 --- a/lib/bandwidth-sdk/models/conference_member.rb +++ b/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. diff --git a/lib/bandwidth-sdk/models/multi_channel_message_response_data.rb b/lib/bandwidth-sdk/models/multi_channel_message_response_data.rb index d6f2101a..d87c37c6 100644 --- a/lib/bandwidth-sdk/models/multi_channel_message_response_data.rb +++ b/lib/bandwidth-sdk/models/multi_channel_message_response_data.rb @@ -17,7 +17,7 @@ module Bandwidth # The data returned in a multichannel message response. class MultiChannelMessageResponseData # The ID of the message. - attr_accessor :message_id + attr_accessor :id # The time the message was received by the Bandwidth API. attr_accessor :time @@ -63,7 +63,7 @@ def valid?(value) # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'message_id' => :'messageId', + :'id' => :'id', :'time' => :'time', :'direction' => :'direction', :'to' => :'to', @@ -82,7 +82,7 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'message_id' => :'String', + :'id' => :'String', :'time' => :'Time', :'direction' => :'MessageDirectionEnum', :'to' => :'Array', @@ -114,10 +114,10 @@ def initialize(attributes = {}) h[k.to_sym] = v } - if attributes.key?(:'message_id') - self.message_id = attributes[:'message_id'] + if attributes.key?(:'id') + self.id = attributes[:'id'] else - self.message_id = nil + self.id = nil end if attributes.key?(:'time') @@ -166,8 +166,8 @@ def initialize(attributes = {}) def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new - if @message_id.nil? - invalid_properties.push('invalid value for "message_id", message_id cannot be nil.') + if @id.nil? + invalid_properties.push('invalid value for "id", id cannot be nil.') end if @time.nil? @@ -197,7 +197,7 @@ def list_invalid_properties # @return true if the model is valid def valid? warn '[DEPRECATED] the `valid?` method is obsolete' - return false if @message_id.nil? + return false if @id.nil? return false if @time.nil? return false if @direction.nil? return false if @to.nil? @@ -235,7 +235,7 @@ def channel_list=(channel_list) def ==(o) return true if self.equal?(o) self.class == o.class && - message_id == o.message_id && + id == o.id && time == o.time && direction == o.direction && to == o.to && @@ -254,7 +254,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [message_id, time, direction, to, channel_list, tag, priority, expiration].hash + [id, time, direction, to, channel_list, tag, priority, expiration].hash end # Builds the object from hash