bandwidth-sdk 13.0.0 → 13.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -22,6 +22,7 @@
22
22
  | **status** | **String** | The current status of the process. For recording, current possible values are 'processing', 'partial', 'complete', 'deleted', and 'error'. For transcriptions, current possible values are 'none', 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and 'file-size-too-small'. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] |
23
23
  | **media_url** | **String** | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [optional] |
24
24
  | **transcription** | [**RecordingTranscriptionMetadata**](RecordingTranscriptionMetadata.md) | | [optional] |
25
+ | **recording_name** | **String** | A name to identify this recording. | [optional] |
25
26
 
26
27
  ## Example
27
28
 
@@ -46,7 +47,8 @@ instance = Bandwidth::CallRecordingMetadata.new(
46
47
  file_format: null,
47
48
  status: completed,
48
49
  media_url: https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/recordings/r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833/media,
49
- transcription: null
50
+ transcription: null,
51
+ recording_name: my-recording-name
50
52
  )
51
53
  ```
52
54
 
@@ -5,6 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **transcription_id** | **String** | The programmable voice API transcription ID. | [optional] |
8
+ | **transcription_name** | **String** | The programmable voice API transcription name. This name could be provided by the user when creating the transcription. | [optional] |
8
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
10
 
10
11
  ## Example
@@ -14,6 +15,7 @@ require 'bandwidth-sdk'
14
15
 
15
16
  instance = Bandwidth::CallTranscriptionMetadata.new(
16
17
  transcription_id: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b,
18
+ transcription_name: live_transcription,
17
19
  transcription_url: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
18
20
  )
19
21
  ```
@@ -15,6 +15,7 @@
15
15
  | **file_format** | [**FileFormatEnum**](FileFormatEnum.md) | | [optional] |
16
16
  | **status** | **String** | The current status of the process. For recording, current possible values are 'processing', 'partial', 'complete', 'deleted', and 'error'. For transcriptions, current possible values are 'none', 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and 'file-size-too-small'. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] |
17
17
  | **media_url** | **String** | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [optional] |
18
+ | **recording_name** | **String** | A name to identify this recording. | [optional] |
18
19
 
19
20
  ## Example
20
21
 
@@ -32,7 +33,8 @@ instance = Bandwidth::ConferenceRecordingMetadata.new(
32
33
  end_time: 2022-06-17T22:20Z,
33
34
  file_format: null,
34
35
  status: completed,
35
- media_url: https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/recordings/r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833/media
36
+ media_url: https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/recordings/r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833/media,
37
+ recording_name: my-recording-name
36
38
  )
37
39
  ```
38
40
 
@@ -66,6 +66,9 @@ module Bandwidth
66
66
 
67
67
  attr_accessor :transcription
68
68
 
69
+ # A name to identify this recording.
70
+ attr_accessor :recording_name
71
+
69
72
  class EnumAttributeValidator
70
73
  attr_reader :datatype
71
74
  attr_reader :allowable_values
@@ -108,7 +111,8 @@ module Bandwidth
108
111
  :'file_format' => :'fileFormat',
109
112
  :'status' => :'status',
110
113
  :'media_url' => :'mediaUrl',
111
- :'transcription' => :'transcription'
114
+ :'transcription' => :'transcription',
115
+ :'recording_name' => :'recordingName'
112
116
  }
113
117
  end
114
118
 
@@ -137,7 +141,8 @@ module Bandwidth
137
141
  :'file_format' => :'FileFormatEnum',
138
142
  :'status' => :'String',
139
143
  :'media_url' => :'String',
140
- :'transcription' => :'RecordingTranscriptionMetadata'
144
+ :'transcription' => :'RecordingTranscriptionMetadata',
145
+ :'recording_name' => :'String'
141
146
  }
142
147
  end
143
148
 
@@ -145,7 +150,7 @@ module Bandwidth
145
150
  def self.openapi_nullable
146
151
  Set.new([
147
152
  :'media_url',
148
- :'transcription'
153
+ :'transcription',
149
154
  ])
150
155
  end
151
156
 
@@ -235,6 +240,10 @@ module Bandwidth
235
240
  if attributes.key?(:'transcription')
236
241
  self.transcription = attributes[:'transcription']
237
242
  end
243
+
244
+ if attributes.key?(:'recording_name')
245
+ self.recording_name = attributes[:'recording_name']
246
+ end
238
247
  end
239
248
 
240
249
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -274,7 +283,8 @@ module Bandwidth
274
283
  file_format == o.file_format &&
275
284
  status == o.status &&
276
285
  media_url == o.media_url &&
277
- transcription == o.transcription
286
+ transcription == o.transcription &&
287
+ recording_name == o.recording_name
278
288
  end
279
289
 
280
290
  # @see the `==` method
@@ -286,7 +296,7 @@ module Bandwidth
286
296
  # Calculates hash code according to all attributes.
287
297
  # @return [Integer] Hash code
288
298
  def hash
289
- [application_id, account_id, call_id, parent_call_id, recording_id, to, from, transfer_caller_id, transfer_to, duration, direction, channels, start_time, end_time, file_format, status, media_url, transcription].hash
299
+ [application_id, account_id, call_id, parent_call_id, recording_id, to, from, transfer_caller_id, transfer_to, duration, direction, channels, start_time, end_time, file_format, status, media_url, transcription, recording_name].hash
290
300
  end
291
301
 
292
302
  # Builds the object from hash
@@ -18,6 +18,9 @@ module Bandwidth
18
18
  # The programmable voice API transcription ID.
19
19
  attr_accessor :transcription_id
20
20
 
21
+ # The programmable voice API transcription name. This name could be provided by the user when creating the transcription.
22
+ attr_accessor :transcription_name
23
+
21
24
  # A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint.
22
25
  attr_accessor :transcription_url
23
26
 
@@ -25,6 +28,7 @@ module Bandwidth
25
28
  def self.attribute_map
26
29
  {
27
30
  :'transcription_id' => :'transcriptionId',
31
+ :'transcription_name' => :'transcriptionName',
28
32
  :'transcription_url' => :'transcriptionUrl'
29
33
  }
30
34
  end
@@ -38,6 +42,7 @@ module Bandwidth
38
42
  def self.openapi_types
39
43
  {
40
44
  :'transcription_id' => :'String',
45
+ :'transcription_name' => :'String',
41
46
  :'transcription_url' => :'String'
42
47
  }
43
48
  end
@@ -67,6 +72,10 @@ module Bandwidth
67
72
  self.transcription_id = attributes[:'transcription_id']
68
73
  end
69
74
 
75
+ if attributes.key?(:'transcription_name')
76
+ self.transcription_name = attributes[:'transcription_name']
77
+ end
78
+
70
79
  if attributes.key?(:'transcription_url')
71
80
  self.transcription_url = attributes[:'transcription_url']
72
81
  end
@@ -93,6 +102,7 @@ module Bandwidth
93
102
  return true if self.equal?(o)
94
103
  self.class == o.class &&
95
104
  transcription_id == o.transcription_id &&
105
+ transcription_name == o.transcription_name &&
96
106
  transcription_url == o.transcription_url
97
107
  end
98
108
 
@@ -105,7 +115,7 @@ module Bandwidth
105
115
  # Calculates hash code according to all attributes.
106
116
  # @return [Integer] Hash code
107
117
  def hash
108
- [transcription_id, transcription_url].hash
118
+ [transcription_id, transcription_name, transcription_url].hash
109
119
  end
110
120
 
111
121
  # Builds the object from hash
@@ -47,6 +47,9 @@ module Bandwidth
47
47
  # The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded.
48
48
  attr_accessor :media_url
49
49
 
50
+ # A name to identify this recording.
51
+ attr_accessor :recording_name
52
+
50
53
  class EnumAttributeValidator
51
54
  attr_reader :datatype
52
55
  attr_reader :allowable_values
@@ -82,7 +85,8 @@ module Bandwidth
82
85
  :'end_time' => :'endTime',
83
86
  :'file_format' => :'fileFormat',
84
87
  :'status' => :'status',
85
- :'media_url' => :'mediaUrl'
88
+ :'media_url' => :'mediaUrl',
89
+ :'recording_name' => :'recordingName'
86
90
  }
87
91
  end
88
92
 
@@ -104,14 +108,15 @@ module Bandwidth
104
108
  :'end_time' => :'Time',
105
109
  :'file_format' => :'FileFormatEnum',
106
110
  :'status' => :'String',
107
- :'media_url' => :'String'
111
+ :'media_url' => :'String',
112
+ :'recording_name' => :'String'
108
113
  }
109
114
  end
110
115
 
111
116
  # List of attributes with nullable: true
112
117
  def self.openapi_nullable
113
118
  Set.new([
114
- :'media_url'
119
+ :'media_url',
115
120
  ])
116
121
  end
117
122
 
@@ -173,6 +178,10 @@ module Bandwidth
173
178
  if attributes.key?(:'media_url')
174
179
  self.media_url = attributes[:'media_url']
175
180
  end
181
+
182
+ if attributes.key?(:'recording_name')
183
+ self.recording_name = attributes[:'recording_name']
184
+ end
176
185
  end
177
186
 
178
187
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -205,7 +214,8 @@ module Bandwidth
205
214
  end_time == o.end_time &&
206
215
  file_format == o.file_format &&
207
216
  status == o.status &&
208
- media_url == o.media_url
217
+ media_url == o.media_url &&
218
+ recording_name == o.recording_name
209
219
  end
210
220
 
211
221
  # @see the `==` method
@@ -217,7 +227,7 @@ module Bandwidth
217
227
  # Calculates hash code according to all attributes.
218
228
  # @return [Integer] Hash code
219
229
  def hash
220
- [account_id, conference_id, name, recording_id, duration, channels, start_time, end_time, file_format, status, media_url].hash
230
+ [account_id, conference_id, name, recording_id, duration, channels, start_time, end_time, file_format, status, media_url, recording_name].hash
221
231
  end
222
232
 
223
233
  # Builds the object from hash
@@ -11,5 +11,5 @@ Generator version: 7.7.0
11
11
  =end
12
12
 
13
13
  module Bandwidth
14
- VERSION = '13.0.0'
14
+ VERSION = '13.1.0'
15
15
  end
@@ -47,6 +47,7 @@ describe 'TranscriptionsApi Integration Tests' do
47
47
  expect(data[0]).to be_instance_of(Bandwidth::CallTranscriptionMetadata)
48
48
  expect(data[0].transcription_id).to be_instance_of(String)
49
49
  expect(data[0].transcription_url).to be_instance_of(String)
50
+ expect(data[0].transcription_name).to be_instance_of(String)
50
51
  $transcription_id = data[0].transcription_id
51
52
  end
52
53
  end
@@ -160,7 +160,8 @@ describe 'RecordingsApi' do
160
160
  expect(data.transcription.status).to be_instance_of(String)
161
161
  expect(data.transcription.completed_time).to be_instance_of(Time)
162
162
  expect(data.transcription.url).to start_with('http')
163
- end
163
+ expect(data.recording_name).to be_instance_of(String)
164
+ end if false # skip due to prism error
164
165
 
165
166
  it 'causes an ArgumentError for a missing account_id' do
166
167
  expect {
@@ -243,6 +244,7 @@ describe 'RecordingsApi' do
243
244
  expect(data[0].transcription.status).to be_instance_of(String)
244
245
  expect(data[0].transcription.completed_time).to be_instance_of(Time)
245
246
  expect(data[0].transcription.url).to start_with('http')
247
+ expect(data[0].recording_name).to be_instance_of(String)
246
248
  end
247
249
 
248
250
  it 'causes an ArgumentError for a missing account_id' do
@@ -282,6 +284,7 @@ describe 'RecordingsApi' do
282
284
  expect(data[0].transcription.status).to be_instance_of(String)
283
285
  expect(data[0].transcription.completed_time).to be_instance_of(Time)
284
286
  expect(data[0].transcription.url).to start_with('http')
287
+ expect(data[0].recording_name).to be_instance_of(String)
285
288
  end
286
289
 
287
290
  it 'causes an ArgumentError for a missing account_id' do
@@ -57,6 +57,7 @@ describe 'TranscriptionsApi' do
57
57
  expect(data[0]).to be_instance_of(Bandwidth::CallTranscriptionMetadata)
58
58
  expect(data[0].transcription_id).to be_instance_of(String)
59
59
  expect(data[0].transcription_url).to be_instance_of(String)
60
+ expect(data[0].transcription_name).to be_instance_of(String)
60
61
  end
61
62
 
62
63
  it 'causes an ArgumentError for a missing account_id' do
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: bandwidth-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 13.0.0
4
+ version: 13.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Bandwidth
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-07-16 00:00:00.000000000 Z
11
+ date: 2024-08-13 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -494,62 +494,62 @@ summary: Bandwidth Ruby SDK
494
494
  test_files:
495
495
  - spec/call_utils.rb
496
496
  - spec/fixtures/ruby_cat.jpeg
497
- - spec/smoke/conferences_api_spec.rb
498
- - spec/smoke/mfa_api_spec.rb
497
+ - spec/smoke/phone_number_lookup_api_spec.rb
499
498
  - spec/smoke/recordings_api_spec.rb
500
499
  - spec/smoke/media_api_spec.rb
501
- - spec/smoke/calls_api_spec.rb
502
500
  - spec/smoke/transcriptions_api_spec.rb
503
- - spec/smoke/messages_api_spec.rb
504
- - spec/smoke/phone_number_lookup_api_spec.rb
501
+ - spec/smoke/conferences_api_spec.rb
505
502
  - spec/smoke/statistics_api_spec.rb
503
+ - spec/smoke/calls_api_spec.rb
504
+ - spec/smoke/mfa_api_spec.rb
505
+ - spec/smoke/messages_api_spec.rb
506
506
  - spec/spec_helper.rb
507
+ - spec/unit/api/phone_number_lookup_api_spec.rb
508
+ - spec/unit/api/recordings_api_spec.rb
509
+ - spec/unit/api/media_api_spec.rb
510
+ - spec/unit/api/transcriptions_api_spec.rb
511
+ - spec/unit/api/conferences_api_spec.rb
512
+ - spec/unit/api/statistics_api_spec.rb
513
+ - spec/unit/api/calls_api_spec.rb
514
+ - spec/unit/api/mfa_api_spec.rb
515
+ - spec/unit/api/messages_api_spec.rb
516
+ - spec/unit/client/api_error_spec.rb
517
+ - spec/unit/client/configuration_spec.rb
518
+ - spec/unit/client/api_client_spec.rb
507
519
  - spec/unit/models/message_spec.rb
520
+ - spec/unit/models/call_state_enum_spec.rb
521
+ - spec/unit/models/verify_code_request_spec.rb
522
+ - spec/unit/models/call_state_spec.rb
523
+ - spec/unit/models/deferred_result_spec.rb
524
+ - spec/unit/models/bxml/response_spec.rb
525
+ - spec/unit/models/bxml/verb_spec.rb
526
+ - spec/unit/models/bxml/nestable_verb_spec.rb
527
+ - spec/unit/models/bxml/bxml_spec.rb
528
+ - spec/unit/models/bxml/verbs/play_audio_spec.rb
529
+ - spec/unit/models/bxml/verbs/forward_spec.rb
530
+ - spec/unit/models/bxml/verbs/stop_stream_spec.rb
531
+ - spec/unit/models/bxml/verbs/hangup_spec.rb
508
532
  - spec/unit/models/bxml/verbs/redirect_spec.rb
509
- - spec/unit/models/bxml/verbs/stop_gather_spec.rb
510
- - spec/unit/models/bxml/verbs/tag_spec.rb
511
533
  - spec/unit/models/bxml/verbs/start_transcription_spec.rb
534
+ - spec/unit/models/bxml/verbs/start_stream_spec.rb
512
535
  - spec/unit/models/bxml/verbs/stream_param_spec.rb
513
536
  - spec/unit/models/bxml/verbs/pause_spec.rb
514
- - spec/unit/models/bxml/verbs/send_dtmf_spec.rb
515
- - spec/unit/models/bxml/verbs/transfer_spec.rb
516
- - spec/unit/models/bxml/verbs/stop_recording_spec.rb
517
- - spec/unit/models/bxml/verbs/conference_spec.rb
518
- - spec/unit/models/bxml/verbs/stop_transcription_spec.rb
519
- - spec/unit/models/bxml/verbs/play_audio_spec.rb
520
- - spec/unit/models/bxml/verbs/custom_param_spec.rb
521
- - spec/unit/models/bxml/verbs/forward_spec.rb
522
- - spec/unit/models/bxml/verbs/gather_spec.rb
523
- - spec/unit/models/bxml/verbs/sip_uri_spec.rb
524
- - spec/unit/models/bxml/verbs/phone_number_spec.rb
525
- - spec/unit/models/bxml/verbs/stop_stream_spec.rb
526
- - spec/unit/models/bxml/verbs/start_recording_spec.rb
527
- - spec/unit/models/bxml/verbs/bridge_spec.rb
528
537
  - spec/unit/models/bxml/verbs/record_spec.rb
529
- - spec/unit/models/bxml/verbs/start_stream_spec.rb
530
- - spec/unit/models/bxml/verbs/hangup_spec.rb
531
538
  - spec/unit/models/bxml/verbs/ring_spec.rb
532
- - spec/unit/models/bxml/verbs/pause_recording_spec.rb
533
- - spec/unit/models/bxml/verbs/speak_sentence_spec.rb
539
+ - spec/unit/models/bxml/verbs/phone_number_spec.rb
540
+ - spec/unit/models/bxml/verbs/tag_spec.rb
541
+ - spec/unit/models/bxml/verbs/bridge_spec.rb
542
+ - spec/unit/models/bxml/verbs/gather_spec.rb
543
+ - spec/unit/models/bxml/verbs/custom_param_spec.rb
544
+ - spec/unit/models/bxml/verbs/sip_uri_spec.rb
534
545
  - spec/unit/models/bxml/verbs/resume_recording_spec.rb
546
+ - spec/unit/models/bxml/verbs/send_dtmf_spec.rb
547
+ - spec/unit/models/bxml/verbs/conference_spec.rb
548
+ - spec/unit/models/bxml/verbs/stop_recording_spec.rb
549
+ - spec/unit/models/bxml/verbs/pause_recording_spec.rb
550
+ - spec/unit/models/bxml/verbs/start_recording_spec.rb
535
551
  - spec/unit/models/bxml/verbs/start_gather_spec.rb
536
- - spec/unit/models/bxml/bxml_spec.rb
537
- - spec/unit/models/bxml/nestable_verb_spec.rb
538
- - spec/unit/models/bxml/response_spec.rb
539
- - spec/unit/models/bxml/verb_spec.rb
540
- - spec/unit/models/call_state_enum_spec.rb
541
- - spec/unit/models/verify_code_request_spec.rb
542
- - spec/unit/models/call_state_spec.rb
543
- - spec/unit/models/deferred_result_spec.rb
544
- - spec/unit/api/conferences_api_spec.rb
545
- - spec/unit/api/mfa_api_spec.rb
546
- - spec/unit/api/recordings_api_spec.rb
547
- - spec/unit/api/media_api_spec.rb
548
- - spec/unit/api/calls_api_spec.rb
549
- - spec/unit/api/transcriptions_api_spec.rb
550
- - spec/unit/api/messages_api_spec.rb
551
- - spec/unit/api/phone_number_lookup_api_spec.rb
552
- - spec/unit/api/statistics_api_spec.rb
553
- - spec/unit/client/api_client_spec.rb
554
- - spec/unit/client/api_error_spec.rb
555
- - spec/unit/client/configuration_spec.rb
552
+ - spec/unit/models/bxml/verbs/transfer_spec.rb
553
+ - spec/unit/models/bxml/verbs/stop_transcription_spec.rb
554
+ - spec/unit/models/bxml/verbs/stop_gather_spec.rb
555
+ - spec/unit/models/bxml/verbs/speak_sentence_spec.rb