Skip to content

Commit bcada45

Browse files
band-swi-release-engineering[bot]DX-Bandwidthckoegel
authored
SWI-11520 Update SDK Based on Recent Spec Changes (#214)
* Generate SDK with OpenAPI Generator Version * unit tests --------- Co-authored-by: DX-Bandwidth <dx@bandwidth.com> Co-authored-by: ckoegel <ckoegel1006@gmail.com>
1 parent f084f66 commit bcada45

16 files changed

Lines changed: 477 additions & 13 deletions

.openapi-generator/FILES

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,7 @@ docs/RbmWebViewEnum.md
164164
docs/RecordingAvailableCallback.md
165165
docs/RecordingCompleteCallback.md
166166
docs/RecordingStateEnum.md
167+
docs/RecordingTranscriptionClip.md
167168
docs/RecordingTranscriptionMetadata.md
168169
docs/RecordingTranscriptions.md
169170
docs/RecordingsApi.md
@@ -384,6 +385,7 @@ lib/bandwidth-sdk/models/rbm_web_view_enum.rb
384385
lib/bandwidth-sdk/models/recording_available_callback.rb
385386
lib/bandwidth-sdk/models/recording_complete_callback.rb
386387
lib/bandwidth-sdk/models/recording_state_enum.rb
388+
lib/bandwidth-sdk/models/recording_transcription_clip.rb
387389
lib/bandwidth-sdk/models/recording_transcription_metadata.rb
388390
lib/bandwidth-sdk/models/recording_transcriptions.rb
389391
lib/bandwidth-sdk/models/redirect_callback.rb

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -328,6 +328,7 @@ Class | Method | HTTP request | Description
328328
- [Bandwidth::RecordingAvailableCallback](docs/RecordingAvailableCallback.md)
329329
- [Bandwidth::RecordingCompleteCallback](docs/RecordingCompleteCallback.md)
330330
- [Bandwidth::RecordingStateEnum](docs/RecordingStateEnum.md)
331+
- [Bandwidth::RecordingTranscriptionClip](docs/RecordingTranscriptionClip.md)
331332
- [Bandwidth::RecordingTranscriptionMetadata](docs/RecordingTranscriptionMetadata.md)
332333
- [Bandwidth::RecordingTranscriptions](docs/RecordingTranscriptions.md)
333334
- [Bandwidth::RedirectCallback](docs/RedirectCallback.md)

bandwidth.yml

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4354,6 +4354,72 @@ components:
43544354
type: array
43554355
items:
43564356
$ref: '#/components/schemas/transcription'
4357+
clips:
4358+
type: array
4359+
description: >-
4360+
A list of individual speech clips with speaker, timing, and
4361+
confidence information.
4362+
items:
4363+
$ref: '#/components/schemas/recordingTranscriptionClip'
4364+
example:
4365+
transcripts:
4366+
- speaker: 0
4367+
text: Hi, is Thursday at two still good for you? Perfect, talk soon.
4368+
confidence: 0.96
4369+
- speaker: 1
4370+
text: Yes, that works great. See you then! Sounds good, bye!
4371+
confidence: 0.97
4372+
clips:
4373+
- speaker: 0
4374+
text: Hi, is Thursday at two still good for you?
4375+
confidence: 0.97
4376+
startTimeSeconds: 0.4
4377+
endTimeSeconds: 3.1
4378+
- speaker: 1
4379+
text: Yes, that works great. See you then!
4380+
confidence: 0.95
4381+
startTimeSeconds: 3.8
4382+
endTimeSeconds: 6.2
4383+
- speaker: 0
4384+
text: Perfect, talk soon.
4385+
confidence: 0.94
4386+
startTimeSeconds: 6.9
4387+
endTimeSeconds: 8.1
4388+
- speaker: 1
4389+
text: Sounds good, bye!
4390+
confidence: 0.98
4391+
startTimeSeconds: 8.5
4392+
endTimeSeconds: 9.7
4393+
recordingTranscriptionClip:
4394+
type: object
4395+
properties:
4396+
speaker:
4397+
type: integer
4398+
description: Zero-based index identifying the speaker.
4399+
example: 0
4400+
text:
4401+
type: string
4402+
description: The transcribed text of this clip.
4403+
example: Hi there, thanks for calling!
4404+
confidence:
4405+
type: number
4406+
format: double
4407+
minimum: 0
4408+
maximum: 1
4409+
description: >-
4410+
How confident the transcription engine was in transcribing this clip
4411+
(from `0.0` to `1.0`).
4412+
example: 0.85
4413+
startTimeSeconds:
4414+
type: number
4415+
format: double
4416+
description: The start time of this clip within the recording, in seconds.
4417+
example: 2.3
4418+
endTimeSeconds:
4419+
type: number
4420+
format: double
4421+
description: The end time of this clip within the recording, in seconds.
4422+
example: 3.1
43574423
callTranscriptionMetadataList:
43584424
type: array
43594425
items:
@@ -5480,6 +5546,10 @@ components:
54805546
transcription:
54815547
type: object
54825548
properties:
5549+
speaker:
5550+
type: integer
5551+
description: Zero-based index identifying the speaker.
5552+
example: 0
54835553
text:
54845554
type: string
54855555
description: The transcribed text

docs/RbmActionBase.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ require 'bandwidth-sdk'
1616
instance = Bandwidth::RbmActionBase.new(
1717
type: null,
1818
text: Hello world,
19-
postback_data: [B@20706e70
19+
postback_data: [B@3c29f6be
2020
)
2121
```
2222

docs/RbmSuggestionResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ require 'bandwidth-sdk'
1515

1616
instance = Bandwidth::RbmSuggestionResponse.new(
1717
text: Yes, I would like to proceed,
18-
postback_data: [B@20706e70,
18+
postback_data: [B@3c29f6be,
1919
paired_message_id: 1752697342534u24xerqdukke523x
2020
)
2121
```

docs/RecordingTranscriptionClip.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Bandwidth::RecordingTranscriptionClip
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **speaker** | **Integer** | Zero-based index identifying the speaker. | [optional] |
8+
| **text** | **String** | The transcribed text of this clip. | [optional] |
9+
| **confidence** | **Float** | How confident the transcription engine was in transcribing this clip (from &#x60;0.0&#x60; to &#x60;1.0&#x60;). | [optional] |
10+
| **start_time_seconds** | **Float** | The start time of this clip within the recording, in seconds. | [optional] |
11+
| **end_time_seconds** | **Float** | The end time of this clip within the recording, in seconds. | [optional] |
12+
13+
## Example
14+
15+
```ruby
16+
require 'bandwidth-sdk'
17+
18+
instance = Bandwidth::RecordingTranscriptionClip.new(
19+
speaker: 0,
20+
text: Hi there, thanks for calling!,
21+
confidence: 0.85,
22+
start_time_seconds: 2.3,
23+
end_time_seconds: 3.1
24+
)
25+
```
26+

docs/RecordingTranscriptions.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,16 @@
55
| Name | Type | Description | Notes |
66
| ---- | ---- | ----------- | ----- |
77
| **transcripts** | [**Array&lt;Transcription&gt;**](Transcription.md) | | [optional] |
8+
| **clips** | [**Array&lt;RecordingTranscriptionClip&gt;**](RecordingTranscriptionClip.md) | A list of individual speech clips with speaker, timing, and confidence information. | [optional] |
89

910
## Example
1011

1112
```ruby
1213
require 'bandwidth-sdk'
1314

1415
instance = Bandwidth::RecordingTranscriptions.new(
15-
transcripts: null
16+
transcripts: null,
17+
clips: null
1618
)
1719
```
1820

docs/Transcription.md

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

55
| Name | Type | Description | Notes |
66
| ---- | ---- | ----------- | ----- |
7+
| **speaker** | **Integer** | Zero-based index identifying the speaker. | [optional] |
78
| **text** | **String** | The transcribed text | [optional] |
89
| **confidence** | **Float** | The confidence on the recognized content, ranging from &#x60;0.0&#x60; to &#x60;1.0&#x60; with &#x60;1.0&#x60; being the highest confidence. | [optional] |
910

@@ -13,6 +14,7 @@
1314
require 'bandwidth-sdk'
1415

1516
instance = Bandwidth::Transcription.new(
17+
speaker: 0,
1618
text: Nice talking to you, friend!,
1719
confidence: 0.9
1820
)

lib/bandwidth-sdk.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,7 @@
170170
require 'bandwidth-sdk/models/recording_available_callback'
171171
require 'bandwidth-sdk/models/recording_complete_callback'
172172
require 'bandwidth-sdk/models/recording_state_enum'
173+
require 'bandwidth-sdk/models/recording_transcription_clip'
173174
require 'bandwidth-sdk/models/recording_transcription_metadata'
174175
require 'bandwidth-sdk/models/recording_transcriptions'
175176
require 'bandwidth-sdk/models/redirect_callback'

0 commit comments

Comments
 (0)