bandwidth-sdk 14.1.0 → 14.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bdb1b7c482e15f9c426d84f1292002787add71f9dd04ad1087d9f7efb0fb9a08
4
- data.tar.gz: 4a21ad6e7a9abacbecf39d1a979f516110481fba4131946da5d396a9301011cc
3
+ metadata.gz: 3e8f8a31d5f34debc0b6fb21567c5d4eedf97f7c0cea92490cc87fdabce70e2b
4
+ data.tar.gz: 9b69c11f01d08272980838ac9494d0699f88b057428d13d3a5c3ffac5737410b
5
5
  SHA512:
6
- metadata.gz: 1d96e4474ef6c991bba0bfaf4dee3753cac624d40a276cf1356fc3c021264f2c641da8ba209d38662f7df3e4e2b4924122ebd5923a7229e801fea11231a3295b
7
- data.tar.gz: 2f64031e34bcab9cda314a889ceca8dd5582a24819c351ce6996e979283d6854fc40ad4c80bed0800d9dca016ee6626dc0e9e9786e163547383481d735907d71
6
+ metadata.gz: 532b7f9a7673e7da7a2463424c0bb6ddd57a8a5ae5376aeec4b372a62b00b23cce4f4b78494624cf05df8f9127f5e57cd0153d4d56e341501dff252da0707429
7
+ data.tar.gz: ce59a7eb71dbf17b4f624861f03b642e0ce638c8d9b3ef4a23c089caccd637c498ad91637e682c0df83a6f3f8e299d602dab9f806a0d01b77c304fbdceb0cee0
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- bandwidth-sdk (14.1.0)
4
+ bandwidth-sdk (14.1.1)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart
7
7
  marcel
@@ -24,7 +24,7 @@ GEM
24
24
  multipart-post (~> 2.0)
25
25
  faraday-net_http (3.4.0)
26
26
  net-http (>= 0.5.0)
27
- json (2.10.1)
27
+ json (2.10.2)
28
28
  logger (1.6.6)
29
29
  marcel (1.0.4)
30
30
  method_source (1.1.0)
@@ -71,7 +71,7 @@ GEM
71
71
  rubocop-ast (>= 1.28.0, < 2.0)
72
72
  ruby-progressbar (~> 1.7)
73
73
  unicode-display_width (>= 2.4.0, < 3.0)
74
- rubocop-ast (1.38.0)
74
+ rubocop-ast (1.39.0)
75
75
  parser (>= 3.3.1.0)
76
76
  ruby-progressbar (1.13.0)
77
77
  simplecov (0.21.2)
@@ -81,7 +81,7 @@ GEM
81
81
  simplecov-html (0.13.1)
82
82
  simplecov_json_formatter (0.1.4)
83
83
  unicode-display_width (2.6.0)
84
- uri (1.0.2)
84
+ uri (1.0.3)
85
85
 
86
86
  PLATFORMS
87
87
  ruby
data/bandwidth.yml CHANGED
@@ -3801,6 +3801,8 @@ components:
3801
3801
  $ref: '#/components/schemas/diversion'
3802
3802
  stirShaken:
3803
3803
  $ref: '#/components/schemas/stirShaken'
3804
+ uui:
3805
+ $ref: '#/components/schemas/uui'
3804
3806
  machineDetectionCompleteCallback:
3805
3807
  type: object
3806
3808
  description: >-
@@ -4435,6 +4437,15 @@ components:
4435
4437
  type: string
4436
4438
  description: (optional) A unique origination identifier.
4437
4439
  example: 99759086-1335-11ed-9bcf-5f7d464e91af
4440
+ uui:
4441
+ type: string
4442
+ description: >-
4443
+ The value of the `User-To-User` header to send within the initial
4444
+ `INVITE`. Must include the encoding parameter as specified in RFC 7433.
4445
+ Only `base64`, `jwt` and `hex` encoding are currently allowed. This
4446
+ value, including the encoding specifier, may not exceed 256 characters.
4447
+ example: bXktdXVp
4448
+ maxLength: 256
4438
4449
  codeRequest:
4439
4450
  type: object
4440
4451
  properties:
@@ -11053,6 +11053,6 @@
11053
11053
  ]
11054
11054
  }
11055
11055
  },
11056
- "timestamp": 1739909356
11056
+ "timestamp": 1742321864
11057
11057
  }
11058
11058
  }
data/coverage/index.html CHANGED
@@ -13,7 +13,7 @@
13
13
  <img src="./assets/0.13.1/loading.gif" alt="loading"/>
14
14
  </div>
15
15
  <div id="wrapper" class="hide">
16
- <div class="timestamp">Generated <abbr class="timeago" title="2025-02-18T20:09:16+00:00">2025-02-18T20:09:16+00:00</abbr></div>
16
+ <div class="timestamp">Generated <abbr class="timeago" title="2025-03-18T18:17:44+00:00">2025-03-18T18:17:44+00:00</abbr></div>
17
17
  <ul class="group_tabs"></ul>
18
18
 
19
19
  <div id="content">
@@ -72249,7 +72249,7 @@
72249
72249
 
72250
72250
 
72251
72251
 
72252
- <code class="ruby"> VERSION = &#39;14.1.0&#39;</code>
72252
+ <code class="ruby"> VERSION = &#39;14.1.1&#39;</code>
72253
72253
  </li>
72254
72254
  </div>
72255
72255
 
@@ -16,6 +16,7 @@
16
16
  | **start_time** | **Time** | Time the call was started, in ISO 8601 format. | [optional] |
17
17
  | **diversion** | [**Diversion**](Diversion.md) | | [optional] |
18
18
  | **stir_shaken** | [**StirShaken**](StirShaken.md) | | [optional] |
19
+ | **uui** | **String** | The value of the &#x60;User-To-User&#x60; header to send within the initial &#x60;INVITE&#x60;. Must include the encoding parameter as specified in RFC 7433. Only &#x60;base64&#x60;, &#x60;jwt&#x60; and &#x60;hex&#x60; encoding are currently allowed. This value, including the encoding specifier, may not exceed 256 characters. | [optional] |
19
20
 
20
21
  ## Example
21
22
 
@@ -34,7 +35,8 @@ instance = Bandwidth::InitiateCallback.new(
34
35
  call_url: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
35
36
  start_time: 2022-06-17T22:19:40.375Z,
36
37
  diversion: null,
37
- stir_shaken: null
38
+ stir_shaken: null,
39
+ uui: bXktdXVp
38
40
  )
39
41
  ```
40
42
 
@@ -49,6 +49,9 @@ module Bandwidth
49
49
 
50
50
  attr_accessor :stir_shaken
51
51
 
52
+ # The value of the `User-To-User` header to send within the initial `INVITE`. Must include the encoding parameter as specified in RFC 7433. Only `base64`, `jwt` and `hex` encoding are currently allowed. This value, including the encoding specifier, may not exceed 256 characters.
53
+ attr_accessor :uui
54
+
52
55
  class EnumAttributeValidator
53
56
  attr_reader :datatype
54
57
  attr_reader :allowable_values
@@ -85,7 +88,8 @@ module Bandwidth
85
88
  :'call_url' => :'callUrl',
86
89
  :'start_time' => :'startTime',
87
90
  :'diversion' => :'diversion',
88
- :'stir_shaken' => :'stirShaken'
91
+ :'stir_shaken' => :'stirShaken',
92
+ :'uui' => :'uui'
89
93
  }
90
94
  end
91
95
 
@@ -108,7 +112,8 @@ module Bandwidth
108
112
  :'call_url' => :'String',
109
113
  :'start_time' => :'Time',
110
114
  :'diversion' => :'Diversion',
111
- :'stir_shaken' => :'StirShaken'
115
+ :'stir_shaken' => :'StirShaken',
116
+ :'uui' => :'String'
112
117
  }
113
118
  end
114
119
 
@@ -180,6 +185,10 @@ module Bandwidth
180
185
  if attributes.key?(:'stir_shaken')
181
186
  self.stir_shaken = attributes[:'stir_shaken']
182
187
  end
188
+
189
+ if attributes.key?(:'uui')
190
+ self.uui = attributes[:'uui']
191
+ end
183
192
  end
184
193
 
185
194
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -187,6 +196,10 @@ module Bandwidth
187
196
  def list_invalid_properties
188
197
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
189
198
  invalid_properties = Array.new
199
+ if !@uui.nil? && @uui.to_s.length > 256
200
+ invalid_properties.push('invalid value for "uui", the character length must be smaller than or equal to 256.')
201
+ end
202
+
190
203
  invalid_properties
191
204
  end
192
205
 
@@ -194,9 +207,24 @@ module Bandwidth
194
207
  # @return true if the model is valid
195
208
  def valid?
196
209
  warn '[DEPRECATED] the `valid?` method is obsolete'
210
+ return false if !@uui.nil? && @uui.to_s.length > 256
197
211
  true
198
212
  end
199
213
 
214
+ # Custom attribute writer method with validation
215
+ # @param [Object] uui Value to be assigned
216
+ def uui=(uui)
217
+ if uui.nil?
218
+ fail ArgumentError, 'uui cannot be nil'
219
+ end
220
+
221
+ if uui.to_s.length > 256
222
+ fail ArgumentError, 'invalid value for "uui", the character length must be smaller than or equal to 256.'
223
+ end
224
+
225
+ @uui = uui
226
+ end
227
+
200
228
  # Checks equality by comparing each attribute.
201
229
  # @param [Object] Object to be compared
202
230
  def ==(o)
@@ -213,7 +241,8 @@ module Bandwidth
213
241
  call_url == o.call_url &&
214
242
  start_time == o.start_time &&
215
243
  diversion == o.diversion &&
216
- stir_shaken == o.stir_shaken
244
+ stir_shaken == o.stir_shaken &&
245
+ uui == o.uui
217
246
  end
218
247
 
219
248
  # @see the `==` method
@@ -225,7 +254,7 @@ module Bandwidth
225
254
  # Calculates hash code according to all attributes.
226
255
  # @return [Integer] Hash code
227
256
  def hash
228
- [event_type, event_time, account_id, application_id, from, to, direction, call_id, call_url, start_time, diversion, stir_shaken].hash
257
+ [event_type, event_time, account_id, application_id, from, to, direction, call_id, call_url, start_time, diversion, stir_shaken, uui].hash
229
258
  end
230
259
 
231
260
  # Builds the object from hash
@@ -11,5 +11,5 @@ Generator version: 7.8.0
11
11
  =end
12
12
 
13
13
  module Bandwidth
14
- VERSION = '14.1.0'
14
+ VERSION = '14.1.1'
15
15
  end
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: 14.1.0
4
+ version: 14.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Bandwidth
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-02-18 00:00:00.000000000 Z
11
+ date: 2025-03-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -178,11 +178,7 @@ files:
178
178
  - docs/CreateCallResponse.md
179
179
  - docs/CreateLookupResponse.md
180
180
  - docs/CreateMessageRequestError.md
181
- - docs/CreateParticipantRequest.md
182
- - docs/CreateParticipantResponse.md
183
181
  - docs/DeferredResult.md
184
- - docs/DeviceApiVersionEnum.md
185
- - docs/DisconenctCallback.md
186
182
  - docs/DisconnectCallback.md
187
183
  - docs/Diversion.md
188
184
  - docs/DtmfCallback.md
@@ -190,10 +186,7 @@ files:
190
186
  - docs/FailureWebhook.md
191
187
  - docs/FieldError.md
192
188
  - docs/FileFormatEnum.md
193
- - docs/ForbiddenRequest.md
194
189
  - docs/GatherCallback.md
195
- - docs/InboundMessageCallback.md
196
- - docs/InboundMessageCallbackMessage.md
197
190
  - docs/InitiateCallback.md
198
191
  - docs/LinksObject.md
199
192
  - docs/ListMessageDirectionEnum.md
@@ -212,14 +205,8 @@ files:
212
205
  - docs/Message.md
213
206
  - docs/MessageCallback.md
214
207
  - docs/MessageCallbackMessage.md
215
- - docs/MessageDeliveredCallback.md
216
- - docs/MessageDeliveredCallbackMessage.md
217
208
  - docs/MessageDirectionEnum.md
218
- - docs/MessageFailedCallback.md
219
- - docs/MessageFailedCallbackMessage.md
220
209
  - docs/MessageRequest.md
221
- - docs/MessageSendingCallback.md
222
- - docs/MessageSendingCallbackMessage.md
223
210
  - docs/MessageStatusEnum.md
224
211
  - docs/MessageTypeEnum.md
225
212
  - docs/MessagesApi.md
@@ -231,12 +218,8 @@ files:
231
218
  - docs/MfaUnauthorizedRequestError.md
232
219
  - docs/OptInWorkflow.md
233
220
  - docs/PageInfo.md
234
- - docs/Participant.md
235
- - docs/ParticipantSubscription.md
236
- - docs/ParticipantsApi.md
237
221
  - docs/PhoneNumberLookupApi.md
238
222
  - docs/PriorityEnum.md
239
- - docs/PublishPermissionsEnum.md
240
223
  - docs/RecordingAvailableCallback.md
241
224
  - docs/RecordingCompleteCallback.md
242
225
  - docs/RecordingStateEnum.md
@@ -245,12 +228,8 @@ files:
245
228
  - docs/RecordingsApi.md
246
229
  - docs/RedirectCallback.md
247
230
  - docs/RedirectMethodEnum.md
248
- - docs/RequestError.md
249
- - docs/Session.md
250
- - docs/SessionsApi.md
251
231
  - docs/StatisticsApi.md
252
232
  - docs/StirShaken.md
253
- - docs/Subscriptions.md
254
233
  - docs/Tag.md
255
234
  - docs/TelephoneNumber.md
256
235
  - docs/TfvBasicAuthentication.md
@@ -265,13 +244,10 @@ files:
265
244
  - docs/TranscribeRecording.md
266
245
  - docs/Transcription.md
267
246
  - docs/TranscriptionAvailableCallback.md
268
- - docs/TranscriptionList.md
269
- - docs/TranscriptionMetadata.md
270
247
  - docs/TranscriptionsApi.md
271
248
  - docs/TransferAnswerCallback.md
272
249
  - docs/TransferCompleteCallback.md
273
250
  - docs/TransferDisconnectCallback.md
274
- - docs/UnauthorizedRequest.md
275
251
  - docs/UpdateCall.md
276
252
  - docs/UpdateCallRecording.md
277
253
  - docs/UpdateConference.md
@@ -541,64 +517,64 @@ summary: Bandwidth Ruby SDK
541
517
  test_files:
542
518
  - spec/call_utils.rb
543
519
  - spec/fixtures/ruby_cat.jpeg
544
- - spec/smoke/conferences_api_spec.rb
545
- - spec/smoke/calls_api_spec.rb
546
- - spec/smoke/recordings_api_spec.rb
547
- - spec/smoke/statistics_api_spec.rb
548
- - spec/smoke/toll_free_verification_api_spec.rb
549
- - spec/smoke/messages_api_spec.rb
550
520
  - spec/smoke/transcriptions_api_spec.rb
551
- - spec/smoke/media_api_spec.rb
552
521
  - spec/smoke/mfa_api_spec.rb
522
+ - spec/smoke/media_api_spec.rb
553
523
  - spec/smoke/phone_number_lookup_api_spec.rb
524
+ - spec/smoke/statistics_api_spec.rb
525
+ - spec/smoke/messages_api_spec.rb
526
+ - spec/smoke/calls_api_spec.rb
527
+ - spec/smoke/conferences_api_spec.rb
528
+ - spec/smoke/toll_free_verification_api_spec.rb
529
+ - spec/smoke/recordings_api_spec.rb
554
530
  - spec/spec_helper.rb
555
- - spec/unit/api/conferences_api_spec.rb
556
- - spec/unit/api/calls_api_spec.rb
557
- - spec/unit/api/recordings_api_spec.rb
558
- - spec/unit/api/statistics_api_spec.rb
559
- - spec/unit/api/toll_free_verification_api_spec.rb
560
- - spec/unit/api/messages_api_spec.rb
561
- - spec/unit/api/transcriptions_api_spec.rb
562
- - spec/unit/api/media_api_spec.rb
563
- - spec/unit/api/mfa_api_spec.rb
564
- - spec/unit/api/phone_number_lookup_api_spec.rb
531
+ - spec/unit/models/verify_code_request_spec.rb
532
+ - spec/unit/models/message_spec.rb
565
533
  - spec/unit/models/call_state_enum_spec.rb
566
534
  - spec/unit/models/bxml/nestable_verb_spec.rb
567
- - spec/unit/models/bxml/verb_spec.rb
568
535
  - spec/unit/models/bxml/bxml_spec.rb
569
- - spec/unit/models/bxml/verbs/transfer_spec.rb
570
- - spec/unit/models/bxml/verbs/stop_stream_spec.rb
571
- - spec/unit/models/bxml/verbs/start_gather_spec.rb
536
+ - spec/unit/models/bxml/response_spec.rb
537
+ - spec/unit/models/bxml/verb_spec.rb
538
+ - spec/unit/models/bxml/verbs/ring_spec.rb
572
539
  - spec/unit/models/bxml/verbs/start_recording_spec.rb
573
- - spec/unit/models/bxml/verbs/bridge_spec.rb
574
- - spec/unit/models/bxml/verbs/hangup_spec.rb
575
- - spec/unit/models/bxml/verbs/start_transcription_spec.rb
540
+ - spec/unit/models/bxml/verbs/tag_spec.rb
576
541
  - spec/unit/models/bxml/verbs/forward_spec.rb
577
- - spec/unit/models/bxml/verbs/play_audio_spec.rb
578
542
  - spec/unit/models/bxml/verbs/sip_uri_spec.rb
579
- - spec/unit/models/bxml/verbs/custom_param_spec.rb
580
- - spec/unit/models/bxml/verbs/resume_recording_spec.rb
581
- - spec/unit/models/bxml/verbs/conference_spec.rb
582
- - spec/unit/models/bxml/verbs/phone_number_spec.rb
583
- - spec/unit/models/bxml/verbs/stop_gather_spec.rb
584
- - spec/unit/models/bxml/verbs/start_stream_spec.rb
543
+ - spec/unit/models/bxml/verbs/record_spec.rb
544
+ - spec/unit/models/bxml/verbs/speak_sentence_spec.rb
585
545
  - spec/unit/models/bxml/verbs/send_dtmf_spec.rb
586
- - spec/unit/models/bxml/verbs/ring_spec.rb
587
- - spec/unit/models/bxml/verbs/gather_spec.rb
546
+ - spec/unit/models/bxml/verbs/phone_number_spec.rb
588
547
  - spec/unit/models/bxml/verbs/pause_spec.rb
589
- - spec/unit/models/bxml/verbs/tag_spec.rb
548
+ - spec/unit/models/bxml/verbs/transfer_spec.rb
549
+ - spec/unit/models/bxml/verbs/start_transcription_spec.rb
550
+ - spec/unit/models/bxml/verbs/resume_recording_spec.rb
590
551
  - spec/unit/models/bxml/verbs/stop_recording_spec.rb
591
- - spec/unit/models/bxml/verbs/speak_sentence_spec.rb
592
- - spec/unit/models/bxml/verbs/record_spec.rb
593
552
  - spec/unit/models/bxml/verbs/pause_recording_spec.rb
594
- - spec/unit/models/bxml/verbs/stream_param_spec.rb
595
553
  - spec/unit/models/bxml/verbs/redirect_spec.rb
554
+ - spec/unit/models/bxml/verbs/custom_param_spec.rb
555
+ - spec/unit/models/bxml/verbs/stop_stream_spec.rb
556
+ - spec/unit/models/bxml/verbs/conference_spec.rb
557
+ - spec/unit/models/bxml/verbs/gather_spec.rb
558
+ - spec/unit/models/bxml/verbs/play_audio_spec.rb
596
559
  - spec/unit/models/bxml/verbs/stop_transcription_spec.rb
597
- - spec/unit/models/bxml/response_spec.rb
598
- - spec/unit/models/message_spec.rb
599
- - spec/unit/models/verify_code_request_spec.rb
560
+ - spec/unit/models/bxml/verbs/bridge_spec.rb
561
+ - spec/unit/models/bxml/verbs/start_gather_spec.rb
562
+ - spec/unit/models/bxml/verbs/start_stream_spec.rb
563
+ - spec/unit/models/bxml/verbs/stream_param_spec.rb
564
+ - spec/unit/models/bxml/verbs/hangup_spec.rb
565
+ - spec/unit/models/bxml/verbs/stop_gather_spec.rb
600
566
  - spec/unit/models/call_state_spec.rb
601
567
  - spec/unit/models/deferred_result_spec.rb
568
+ - spec/unit/api/transcriptions_api_spec.rb
569
+ - spec/unit/api/mfa_api_spec.rb
570
+ - spec/unit/api/media_api_spec.rb
571
+ - spec/unit/api/phone_number_lookup_api_spec.rb
572
+ - spec/unit/api/statistics_api_spec.rb
573
+ - spec/unit/api/messages_api_spec.rb
574
+ - spec/unit/api/calls_api_spec.rb
575
+ - spec/unit/api/conferences_api_spec.rb
576
+ - spec/unit/api/toll_free_verification_api_spec.rb
577
+ - spec/unit/api/recordings_api_spec.rb
578
+ - spec/unit/client/api_client_spec.rb
602
579
  - spec/unit/client/configuration_spec.rb
603
580
  - spec/unit/client/api_error_spec.rb
604
- - spec/unit/client/api_client_spec.rb
@@ -1,24 +0,0 @@
1
- # Bandwidth::CreateParticipantRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **callback_url** | **String** | Full callback url to use for notifications about this participant. | [optional] |
8
- | **publish_permissions** | [**Array&lt;PublishPermissionsEnum&gt;**](PublishPermissionsEnum.md) | Defines if this participant can publish audio or video. | [optional] |
9
- | **tag** | **String** | User defined tag to associate with the participant. | [optional] |
10
- | **device_api_version** | [**DeviceApiVersionEnum**](DeviceApiVersionEnum.md) | | [optional][default to &#39;V3&#39;] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'bandwidth-sdk'
16
-
17
- instance = Bandwidth::CreateParticipantRequest.new(
18
- callback_url: https://example.com/callback,
19
- publish_permissions: [&quot;VIDEO&quot;,&quot;AUDIO&quot;],
20
- tag: participant1,
21
- device_api_version: null
22
- )
23
- ```
24
-
@@ -1,20 +0,0 @@
1
- # Bandwidth::CreateParticipantResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **participant** | [**Participant**](Participant.md) | | [optional] |
8
- | **token** | **String** | Auth token for the returned participant. This should be passed to the participant so that they can connect to the platform. | [optional] |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'bandwidth-sdk'
14
-
15
- instance = Bandwidth::CreateParticipantResponse.new(
16
- participant: null,
17
- token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwiaWF0IjoxNTE2MjM5MDIyfQ.L8i6g3PfcHlioHCCPURC9pmXT7gdJpx3kOoyAfNUwCc
18
- )
19
- ```
20
-
@@ -1,15 +0,0 @@
1
- # Bandwidth::DeviceApiVersionEnum
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'bandwidth-sdk'
12
-
13
- instance = Bandwidth::DeviceApiVersionEnum.new()
14
- ```
15
-
@@ -1,50 +0,0 @@
1
- # Bandwidth::DisconenctCallback
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
8
- | **event_time** | **String** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] |
9
- | **account_id** | **String** | The user account associated with the call. | [optional] |
10
- | **application_id** | **String** | The id of the application associated with the call. | [optional] |
11
- | **from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] |
12
- | **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
13
- | **call_id** | **String** | The call id associated with the event. | [optional] |
14
- | **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] |
15
- | **call_url** | **String** | The URL of the call associated with the event. | [optional] |
16
- | **enqueued_time** | **Time** | (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. | [optional] |
17
- | **start_time** | **Time** | Time the call was started, in ISO 8601 format. | [optional] |
18
- | **answer_time** | **Time** | Time the call was answered, in ISO 8601 format. | [optional] |
19
- | **end_time** | **Time** | The time that the recording ended in ISO-8601 format | [optional] |
20
- | **cause** | **String** | Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown. | [optional] |
21
- | **error_message** | **String** | Text explaining the reason that caused the call to fail in case of errors. | [optional] |
22
- | **error_id** | **String** | Bandwidth&#39;s internal id that references the error event. | [optional] |
23
- | **tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] |
24
-
25
- ## Example
26
-
27
- ```ruby
28
- require 'bandwidth-sdk'
29
-
30
- instance = Bandwidth::DisconenctCallback.new(
31
- event_type: bridgeComplete,
32
- event_time: null,
33
- account_id: 920012,
34
- application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
35
- from: +15555555555,
36
- to: +15555555555,
37
- call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
38
- direction: null,
39
- call_url: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
40
- enqueued_time: 2022-06-17T22:20Z,
41
- start_time: 2022-06-17T22:19:40.375Z,
42
- answer_time: 2022-06-17T22:20Z,
43
- end_time: 2022-06-17T22:20Z,
44
- cause: busy,
45
- error_message: Call c-2a913f94-6a486f3a-3cae-4034-bcc3-f0c9fa77ca2f is already bridged with another call,
46
- error_id: 4642074b-7b58-478b-96e4-3a60955c6765,
47
- tag: exampleTag
48
- )
49
- ```
50
-
@@ -1,18 +0,0 @@
1
- # Bandwidth::ForbiddenRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **message** | **String** | The message containing the reason behind the request being forbidden. | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'bandwidth-sdk'
13
-
14
- instance = Bandwidth::ForbiddenRequest.new(
15
- message: Missing Authentication Token
16
- )
17
- ```
18
-
@@ -1,26 +0,0 @@
1
- # Bandwidth::InboundMessageCallback
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **time** | **Time** | | |
8
- | **type** | **String** | | |
9
- | **to** | **String** | | |
10
- | **description** | **String** | | |
11
- | **message** | [**InboundMessageCallbackMessage**](InboundMessageCallbackMessage.md) | | |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'bandwidth-sdk'
17
-
18
- instance = Bandwidth::InboundMessageCallback.new(
19
- time: 2016-09-14T18:20:16Z,
20
- type: message-received,
21
- to: +15552223333,
22
- description: Incoming message received,
23
- message: null
24
- )
25
- ```
26
-
@@ -1,40 +0,0 @@
1
- # Bandwidth::InboundMessageCallbackMessage
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | | |
8
- | **owner** | **String** | | |
9
- | **application_id** | **String** | | |
10
- | **time** | **Time** | | |
11
- | **segment_count** | **Integer** | | |
12
- | **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | |
13
- | **to** | **Array&lt;String&gt;** | | |
14
- | **from** | **String** | | |
15
- | **text** | **String** | | |
16
- | **tag** | **String** | | [optional] |
17
- | **media** | **Array&lt;String&gt;** | | [optional] |
18
- | **priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] |
19
-
20
- ## Example
21
-
22
- ```ruby
23
- require 'bandwidth-sdk'
24
-
25
- instance = Bandwidth::InboundMessageCallbackMessage.new(
26
- id: 1661365814859loidf7mcwd4qacn7,
27
- owner: +15553332222,
28
- application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
29
- time: 2016-09-14T18:20:16Z,
30
- segment_count: 1,
31
- direction: null,
32
- to: [&quot;+15552223333&quot;],
33
- from: +15553332222,
34
- text: Hello world,
35
- tag: custom string,
36
- media: [&quot;https://dev.bandwidth.com/images/bandwidth-logo.png&quot;,&quot;https://dev.bandwidth.com/images/github_logo.png&quot;],
37
- priority: null
38
- )
39
- ```
40
-
@@ -1,26 +0,0 @@
1
- # Bandwidth::MessageDeliveredCallback
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **time** | **Time** | | |
8
- | **type** | **String** | | |
9
- | **to** | **String** | | |
10
- | **description** | **String** | | |
11
- | **message** | [**MessageDeliveredCallbackMessage**](MessageDeliveredCallbackMessage.md) | | |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'bandwidth-sdk'
17
-
18
- instance = Bandwidth::MessageDeliveredCallback.new(
19
- time: 2016-09-14T18:20:16Z,
20
- type: message-delivered,
21
- to: +15552223333,
22
- description: Message delivered to carrier.,
23
- message: null
24
- )
25
- ```
26
-