Skip to content

Commit ca72612

Browse files
band-swi-release-engineering[bot]DX-Bandwidthckoegel
authored
SWI-8615 Update SDK Based on Recent Spec Changes (#207)
* Generate SDK with OpenAPI Generator Version * update test --------- Co-authored-by: DX-Bandwidth <[email protected]> Co-authored-by: ckoegel <[email protected]>
1 parent fe86ce2 commit ca72612

12 files changed

+72
-71
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -168,9 +168,9 @@ Class | Method | HTTP request | Description
168168
*TollFreeVerificationApi* | [**requestTollFreeVerification**](docs/TollFreeVerificationApi.md#requestTollFreeVerification) | **POST** /accounts/{accountId}/tollFreeVerification | Request Toll-Free Verification
169169
*TollFreeVerificationApi* | [**updateTollFreeVerificationRequest**](docs/TollFreeVerificationApi.md#updateTollFreeVerificationRequest) | **PUT** /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Update Toll-Free Verification Request
170170
*TollFreeVerificationApi* | [**updateWebhookSubscription**](docs/TollFreeVerificationApi.md#updateWebhookSubscription) | **PUT** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id} | Update Webhook Subscription
171-
*TranscriptionsApi* | [**deleteRealTimeTranscription**](docs/TranscriptionsApi.md#deleteRealTimeTranscription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete a specific transcription
172-
*TranscriptionsApi* | [**getRealTimeTranscription**](docs/TranscriptionsApi.md#getRealTimeTranscription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Retrieve a specific transcription
173-
*TranscriptionsApi* | [**listRealTimeTranscriptions**](docs/TranscriptionsApi.md#listRealTimeTranscriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | Enumerate transcriptions made with StartTranscription
171+
*TranscriptionsApi* | [**deleteRealTimeTranscription**](docs/TranscriptionsApi.md#deleteRealTimeTranscription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete Real-time Transcription
172+
*TranscriptionsApi* | [**getRealTimeTranscription**](docs/TranscriptionsApi.md#getRealTimeTranscription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Get Real-time Transcription
173+
*TranscriptionsApi* | [**listRealTimeTranscriptions**](docs/TranscriptionsApi.md#listRealTimeTranscriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | List Real-time Transcriptions
174174

175175

176176
## Documentation for Models

api/openapi.yaml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4155,7 +4155,7 @@ paths:
41554155
url: https://voice.bandwidth.com/api/v2
41564156
/accounts/{accountId}/calls/{callId}/transcriptions:
41574157
get:
4158-
description: "Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription)."
4158+
description: "List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription)."
41594159
operationId: listRealTimeTranscriptions
41604160
parameters:
41614161
- description: Your Bandwidth Account ID.
@@ -4262,7 +4262,7 @@ paths:
42624262
schema:
42634263
$ref: '#/components/schemas/voiceApiError'
42644264
description: Internal Server Error
4265-
summary: Enumerate transcriptions made with StartTranscription
4265+
summary: List Real-time Transcriptions
42664266
tags:
42674267
- Transcriptions
42684268
x-accepts:
@@ -4387,7 +4387,7 @@ paths:
43874387
schema:
43884388
$ref: '#/components/schemas/voiceApiError'
43894389
description: Internal Server Error
4390-
summary: Delete a specific transcription
4390+
summary: Delete Real-time Transcription
43914391
tags:
43924392
- Transcriptions
43934393
x-accepts:
@@ -4510,7 +4510,7 @@ paths:
45104510
schema:
45114511
$ref: '#/components/schemas/voiceApiError'
45124512
description: Internal Server Error
4513-
summary: Retrieve a specific transcription
4513+
summary: Get Real-time Transcription
45144514
tags:
45154515
- Transcriptions
45164516
x-accepts:
@@ -8246,7 +8246,7 @@ components:
82468246
- type
82478247
title: CreateMessageRequestError
82488248
type: object
8249-
messageId:
8249+
id:
82508250
description: The ID of the message.
82518251
example: 1589228074636lm4k2je7j7jklbn2
82528252
type: string
@@ -8569,8 +8569,8 @@ components:
85698569
text: Hello world
85708570
type: REPLY
85718571
text: Hello world
8572-
messageId: 1589228074636lm4k2je7j7jklbn2
85738572
expiration: 2021-02-01T11:29:18-05:00
8573+
id: 1589228074636lm4k2je7j7jklbn2
85748574
time: 2025-01-01T18:20:16Z
85758575
to:
85768576
- "+15554443333"
@@ -9236,16 +9236,16 @@ components:
92369236
text: Hello world
92379237
type: REPLY
92389238
text: Hello world
9239-
messageId: 1589228074636lm4k2je7j7jklbn2
92409239
expiration: 2021-02-01T11:29:18-05:00
9240+
id: 1589228074636lm4k2je7j7jklbn2
92419241
time: 2025-01-01T18:20:16Z
92429242
to:
92439243
- "+15554443333"
92449244
tag: custom string
92459245
priority: default
92469246
direction: in
92479247
properties:
9248-
messageId:
9248+
id:
92499249
description: The ID of the message.
92509250
example: 1589228074636lm4k2je7j7jklbn2
92519251
type: string
@@ -9290,7 +9290,7 @@ components:
92909290
required:
92919291
- channelList
92929292
- direction
9293-
- messageId
9293+
- id
92949294
- time
92959295
- to
92969296
type: object
@@ -10450,8 +10450,8 @@ components:
1045010450
description: |-
1045110451
A URL that may be used to retrieve information about or update
1045210452
the state of this conference member. This is the URL of this member's
10453-
[Get Conference Member](/apis/voice/#operation/getConferenceMember) endpoint
10454-
and [Modify Conference Member](/apis/voice/#operation/updateConferenceMember)
10453+
[Get Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember) endpoint
10454+
and [Modify Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember)
1045510455
endpoint.
1045610456
example: https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/members/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
1045710457
format: uri
@@ -10789,7 +10789,7 @@ components:
1078910789
transcriptionUrl:
1079010790
description: |-
1079110791
A URL that may be used to retrieve the transcription itself. This points to the
10792-
[Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint.
10792+
[Get Call Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription) endpoint.
1079310793
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
1079410794
type: string
1079510795
type: object

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
@@ -9,7 +9,7 @@
99
|------------ | ------------- | ------------- | -------------|
1010
|**transcriptionId** | **String** | The programmable voice API transcription ID. | [optional] |
1111
|**transcriptionName** | **String** | The programmable voice API transcription name. This name could be provided by the user when creating the transcription. | [optional] |
12-
|**transcriptionUrl** | **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] |
12+
|**transcriptionUrl** | **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] |
1313

1414

1515

docs/ConferenceMember.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
|------------ | ------------- | ------------- | -------------|
1010
|**callId** | **String** | The call id associated with the event. | [optional] |
1111
|**conferenceId** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
12-
|**memberUrl** | **URI** | 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] |
12+
|**memberUrl** | **URI** | 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] |
1313
|**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] |
1414
|**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] |
1515
|**callIdsToCoach** | **List&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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The data returned in a multichannel message response.
88

99
| Name | Type | Description | Notes |
1010
|------------ | ------------- | ------------- | -------------|
11-
|**messageId** | **String** | The ID of the message. | |
11+
|**id** | **String** | The ID of the message. | |
1212
|**time** | **OffsetDateTime** | The time the message was received by the Bandwidth API. | |
1313
|**direction** | **MessageDirectionEnum** | | |
1414
|**to** | **Set&lt;String&gt;** | The destination phone number(s) of the message, in E164 format. | |

docs/TranscriptionsApi.md

Lines changed: 7 additions & 7 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-
| [**deleteRealTimeTranscription**](TranscriptionsApi.md#deleteRealTimeTranscription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete a specific transcription |
8-
| [**getRealTimeTranscription**](TranscriptionsApi.md#getRealTimeTranscription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Retrieve a specific transcription |
9-
| [**listRealTimeTranscriptions**](TranscriptionsApi.md#listRealTimeTranscriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | Enumerate transcriptions made with StartTranscription |
7+
| [**deleteRealTimeTranscription**](TranscriptionsApi.md#deleteRealTimeTranscription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete Real-time Transcription |
8+
| [**getRealTimeTranscription**](TranscriptionsApi.md#getRealTimeTranscription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Get Real-time Transcription |
9+
| [**listRealTimeTranscriptions**](TranscriptionsApi.md#listRealTimeTranscriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | List Real-time Transcriptions |
1010

1111

1212
<a id="deleteRealTimeTranscription"></a>
1313
# **deleteRealTimeTranscription**
1414
> deleteRealTimeTranscription(accountId, callId, transcriptionId)
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 &#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.
1919

@@ -92,7 +92,7 @@ null (empty response body)
9292
# **getRealTimeTranscription**
9393
> CallTranscriptionResponse getRealTimeTranscription(accountId, callId, transcriptionId)
9494
95-
Retrieve a specific transcription
95+
Get Real-time Transcription
9696

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

@@ -172,9 +172,9 @@ public class Example {
172172
# **listRealTimeTranscriptions**
173173
> List&lt;CallTranscriptionMetadata&gt; listRealTimeTranscriptions(accountId, callId)
174174
175-
Enumerate transcriptions made with StartTranscription
175+
List Real-time Transcriptions
176176

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

179179
### Example
180180
```java

0 commit comments

Comments
 (0)