Skip to content

Commit 272a7a8

Browse files
Generate SDK with OpenAPI Generator Version (#183)
Co-authored-by: DX-Bandwidth <[email protected]>
1 parent b2aa356 commit 272a7a8

10 files changed

+53
-52
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,9 +153,9 @@ Class | Method | HTTP request | Description
153153
*Bandwidth::TollFreeVerificationApi* | [**request_toll_free_verification**](docs/TollFreeVerificationApi.md#request_toll_free_verification) | **POST** /accounts/{accountId}/tollFreeVerification | Request Toll-Free Verification
154154
*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
155155
*Bandwidth::TollFreeVerificationApi* | [**update_webhook_subscription**](docs/TollFreeVerificationApi.md#update_webhook_subscription) | **PUT** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id} | Update Webhook Subscription
156-
*Bandwidth::TranscriptionsApi* | [**delete_real_time_transcription**](docs/TranscriptionsApi.md#delete_real_time_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete a specific transcription
157-
*Bandwidth::TranscriptionsApi* | [**get_real_time_transcription**](docs/TranscriptionsApi.md#get_real_time_transcription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Retrieve a specific transcription
158-
*Bandwidth::TranscriptionsApi* | [**list_real_time_transcriptions**](docs/TranscriptionsApi.md#list_real_time_transcriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | Enumerate transcriptions made with StartTranscription
156+
*Bandwidth::TranscriptionsApi* | [**delete_real_time_transcription**](docs/TranscriptionsApi.md#delete_real_time_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete Real-time Transcription
157+
*Bandwidth::TranscriptionsApi* | [**get_real_time_transcription**](docs/TranscriptionsApi.md#get_real_time_transcription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Get Real-time Transcription
158+
*Bandwidth::TranscriptionsApi* | [**list_real_time_transcriptions**](docs/TranscriptionsApi.md#list_real_time_transcriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | List Real-time Transcriptions
159159

160160

161161
## Documentation for Models

bandwidth.yml

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1157,9 +1157,9 @@ paths:
11571157
get:
11581158
tags:
11591159
- Transcriptions
1160-
summary: Enumerate transcriptions made with StartTranscription
1160+
summary: List Real-time Transcriptions
11611161
description: >-
1162-
Enumerates the transcriptions created on this call via
1162+
List the transcriptions created on this call via
11631163
[startTranscription](/docs/voice/bxml/startTranscription).
11641164
operationId: listRealTimeTranscriptions
11651165
parameters:
@@ -1189,7 +1189,7 @@ paths:
11891189
get:
11901190
tags:
11911191
- Transcriptions
1192-
summary: Retrieve a specific transcription
1192+
summary: Get Real-time Transcription
11931193
description: >-
11941194
Retrieve the specified transcription that was created on this call via
11951195
[startTranscription](/docs/voice/bxml/startTranscription).
@@ -1220,7 +1220,7 @@ paths:
12201220
delete:
12211221
tags:
12221222
- Transcriptions
1223-
summary: Delete a specific transcription
1223+
summary: Delete Real-time Transcription
12241224
description: >-
12251225
Delete the specified transcription that was created on this call via
12261226
[startTranscription](/docs/voice/bxml/startTranscription).
@@ -1929,7 +1929,7 @@ components:
19291929
required:
19301930
- type
19311931
- description
1932-
messageId:
1932+
id:
19331933
type: string
19341934
description: The ID of the message.
19351935
example: 1589228074636lm4k2je7j7jklbn2
@@ -2549,8 +2549,8 @@ components:
25492549
description: The data returned in a multichannel message response.
25502550
type: object
25512551
properties:
2552-
messageId:
2553-
$ref: '#/components/schemas/messageId'
2552+
id:
2553+
$ref: '#/components/schemas/id'
25542554
time:
25552555
description: The time the message was received by the Bandwidth API.
25562556
type: string
@@ -2586,7 +2586,7 @@ components:
25862586
expiration:
25872587
$ref: '#/components/schemas/expiration'
25882588
required:
2589-
- messageId
2589+
- id
25902590
- time
25912591
- direction
25922592
- to
@@ -3738,11 +3738,12 @@ components:
37383738
the state of this conference member. This is the URL of this
37393739
member's
37403740
3741-
[Get Conference Member](/apis/voice/#operation/getConferenceMember)
3741+
[Get Conference
3742+
Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember)
37423743
endpoint
37433744
37443745
and [Modify Conference
3745-
Member](/apis/voice/#operation/updateConferenceMember)
3746+
Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember)
37463747
37473748
endpoint.
37483749
example: >-
@@ -4094,7 +4095,7 @@ components:
40944095
points to the
40954096
40964097
[Get Call
4097-
Transcription](/apis/voice/#operation/getCallTranscription)
4098+
Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription)
40984099
endpoint.
40994100
example: >-
41004101
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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
| ---- | ---- | ----------- | ----- |
77
| **transcription_id** | **String** | The programmable voice API transcription ID. | [optional] |
88
| **transcription_name** | **String** | The programmable voice API transcription name. This name could be provided by the user when creating the transcription. | [optional] |
9-
| **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] |
9+
| **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] |
1010

1111
## Example
1212

docs/ConferenceMember.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
| ---- | ---- | ----------- | ----- |
77
| **call_id** | **String** | The call id associated with the event. | [optional] |
88
| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
9-
| **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&#39;s [Get Conference Member](/apis/voice/#operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice/#operation/updateConferenceMember) endpoint. | [optional] |
9+
| **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&#39;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] |
1010
| **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&#39;s mute status. Has no effect if omitted. | [optional] |
1111
| **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&#39;s hold status. Has no effect if omitted. | [optional] |
1212
| **call_ids_to_coach** | **Array&lt;String&gt;** | If this member had a value set for &#x60;callIdsToCoach&#x60; 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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
| Name | Type | Description | Notes |
66
| ---- | ---- | ----------- | ----- |
7-
| **message_id** | **String** | The ID of the message. | |
7+
| **id** | **String** | The ID of the message. | |
88
| **time** | **Time** | The time the message was received by the Bandwidth API. | |
99
| **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | |
1010
| **to** | **Array&lt;String&gt;** | The destination phone number(s) of the message, in E164 format. | |
@@ -19,7 +19,7 @@
1919
require 'bandwidth-sdk'
2020

2121
instance = Bandwidth::MultiChannelMessageResponseData.new(
22-
message_id: 1589228074636lm4k2je7j7jklbn2,
22+
id: 1589228074636lm4k2je7j7jklbn2,
2323
time: 2025-01-01T18:20:16Z,
2424
direction: null,
2525
to: [&quot;+15554443333&quot;],

docs/TranscriptionsApi.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ All URIs are relative to *http://localhost*
44

55
| Method | HTTP request | Description |
66
| ------ | ------------ | ----------- |
7-
| [**delete_real_time_transcription**](TranscriptionsApi.md#delete_real_time_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete a specific transcription |
8-
| [**get_real_time_transcription**](TranscriptionsApi.md#get_real_time_transcription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Retrieve a specific transcription |
9-
| [**list_real_time_transcriptions**](TranscriptionsApi.md#list_real_time_transcriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | Enumerate transcriptions made with StartTranscription |
7+
| [**delete_real_time_transcription**](TranscriptionsApi.md#delete_real_time_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete Real-time Transcription |
8+
| [**get_real_time_transcription**](TranscriptionsApi.md#get_real_time_transcription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Get Real-time Transcription |
9+
| [**list_real_time_transcriptions**](TranscriptionsApi.md#list_real_time_transcriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | List Real-time Transcriptions |
1010

1111

1212
## delete_real_time_transcription
1313

1414
> delete_real_time_transcription(account_id, call_id, transcription_id)
1515
16-
Delete a specific transcription
16+
Delete Real-time Transcription
1717

1818
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.
1919

@@ -35,7 +35,7 @@ call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programma
3535
transcription_id = 't-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Transcription ID.
3636

3737
begin
38-
# Delete a specific transcription
38+
# Delete Real-time Transcription
3939
api_instance.delete_real_time_transcription(account_id, call_id, transcription_id)
4040
rescue Bandwidth::ApiError => e
4141
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
5050
5151
```ruby
5252
begin
53-
# Delete a specific transcription
53+
# Delete Real-time Transcription
5454
data, status_code, headers = api_instance.delete_real_time_transcription_with_http_info(account_id, call_id, transcription_id)
5555
p status_code # => 2xx
5656
p headers # => { ... }
@@ -86,7 +86,7 @@ nil (empty response body)
8686

8787
> <CallTranscriptionResponse> get_real_time_transcription(account_id, call_id, transcription_id)
8888
89-
Retrieve a specific transcription
89+
Get Real-time Transcription
9090

9191
Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
9292

@@ -108,7 +108,7 @@ call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programma
108108
transcription_id = 't-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Transcription ID.
109109

110110
begin
111-
# Retrieve a specific transcription
111+
# Get Real-time Transcription
112112
result = api_instance.get_real_time_transcription(account_id, call_id, transcription_id)
113113
p result
114114
rescue Bandwidth::ApiError => e
@@ -124,7 +124,7 @@ This returns an Array which contains the response data, status code and headers.
124124
125125
```ruby
126126
begin
127-
# Retrieve a specific transcription
127+
# Get Real-time Transcription
128128
data, status_code, headers = api_instance.get_real_time_transcription_with_http_info(account_id, call_id, transcription_id)
129129
p status_code # => 2xx
130130
p headers # => { ... }
@@ -160,9 +160,9 @@ end
160160

161161
> <Array<CallTranscriptionMetadata>> list_real_time_transcriptions(account_id, call_id)
162162
163-
Enumerate transcriptions made with StartTranscription
163+
List Real-time Transcriptions
164164

165-
Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
165+
List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
166166

167167
### Examples
168168

@@ -181,7 +181,7 @@ account_id = '9900000' # String | Your Bandwidth Account ID.
181181
call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID.
182182

183183
begin
184-
# Enumerate transcriptions made with StartTranscription
184+
# List Real-time Transcriptions
185185
result = api_instance.list_real_time_transcriptions(account_id, call_id)
186186
p result
187187
rescue Bandwidth::ApiError => e
@@ -197,7 +197,7 @@ This returns an Array which contains the response data, status code and headers.
197197
198198
```ruby
199199
begin
200-
# Enumerate transcriptions made with StartTranscription
200+
# List Real-time Transcriptions
201201
data, status_code, headers = api_instance.list_real_time_transcriptions_with_http_info(account_id, call_id)
202202
p status_code # => 2xx
203203
p headers # => { ... }

lib/bandwidth-sdk/api/transcriptions_api.rb

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class TranscriptionsApi
1919
def initialize(api_client = ApiClient.default)
2020
@api_client = api_client
2121
end
22-
# Delete a specific transcription
22+
# Delete Real-time Transcription
2323
# 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.
2424
# @param account_id [String] Your Bandwidth Account ID.
2525
# @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 =
3131
nil
3232
end
3333

34-
# Delete a specific transcription
34+
# Delete Real-time Transcription
3535
# Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a &#x60;200&#x60; 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.
3636
# @param account_id [String] Your Bandwidth Account ID.
3737
# @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
9494
return data, status_code, headers
9595
end
9696

97-
# Retrieve a specific transcription
97+
# Get Real-time Transcription
9898
# Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
9999
# @param account_id [String] Your Bandwidth Account ID.
100100
# @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 = {}
106106
data
107107
end
108108

109-
# Retrieve a specific transcription
109+
# Get Real-time Transcription
110110
# Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
111111
# @param account_id [String] Your Bandwidth Account ID.
112112
# @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
169169
return data, status_code, headers
170170
end
171171

172-
# Enumerate transcriptions made with StartTranscription
173-
# Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
172+
# List Real-time Transcriptions
173+
# List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
174174
# @param account_id [String] Your Bandwidth Account ID.
175175
# @param call_id [String] Programmable Voice API Call ID.
176176
# @param [Hash] opts the optional parameters
@@ -180,8 +180,8 @@ def list_real_time_transcriptions(account_id, call_id, opts = {})
180180
data
181181
end
182182

183-
# Enumerate transcriptions made with StartTranscription
184-
# Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
183+
# List Real-time Transcriptions
184+
# List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
185185
# @param account_id [String] Your Bandwidth Account ID.
186186
# @param call_id [String] Programmable Voice API Call ID.
187187
# @param [Hash] opts the optional parameters

lib/bandwidth-sdk/models/call_transcription_metadata.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class CallTranscriptionMetadata
2121
# The programmable voice API transcription name. This name could be provided by the user when creating the transcription.
2222
attr_accessor :transcription_name
2323

24-
# A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint.
24+
# 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.
2525
attr_accessor :transcription_url
2626

2727
# Attribute mapping from ruby-style variable name to JSON key.

lib/bandwidth-sdk/models/conference_member.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class ConferenceMember
2121
# The unique, Bandwidth-generated ID of the conference that was recorded
2222
attr_accessor :conference_id
2323

24-
# 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.
24+
# 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.
2525
attr_accessor :member_url
2626

2727
# 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.

0 commit comments

Comments
 (0)