twilio-ruby 6.0.2 → 6.2.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 3d9c5df26cb77ec89ad4b30f0795bebdda2fd58b
4
- data.tar.gz: f7202d7dccdda6c2afb34035af67e3e69e802b75
3
+ metadata.gz: 0c3b2576c210dd02fdc994c2570cd5cc396180b0
4
+ data.tar.gz: e9ebd236423454df6e3149ef240763f5c91f07c3
5
5
  SHA512:
6
- metadata.gz: 69ecf3d3e407b6c49d7260c76540434695aba7fa314e97096e674a0fe0809ff093c9afa84c6ec073d1ec27fc950ca85c61f0c302021d19f97e93768a3d79a106
7
- data.tar.gz: 70c452e99c1fa6ce5cd7462cee39ee246634763f4ebc2fe82daf141ed31fad2e2f08124e883da8706f71127d42124127d97940d2e83bbc1ef185a470bc5c0272
6
+ metadata.gz: 5ed4d0dd63460c5b46894191c548dd09de759e3e4f0970c43b6f7bb2cd547847e3ee2e8034d6eedcc1cddb1dfe62689821f99626604acbfe1c5e026560a30a09
7
+ data.tar.gz: ae8e99cf0b83ee0f73c404f179edd80c91ade18bbf1694adf72f5ef1a91c1369cff7a0f76f69e5a269f52b519457cc65429996e4a4ae6087073ade8c3eb5fe09
data/CHANGES.md CHANGED
@@ -1,6 +1,31 @@
1
1
  twilio-ruby changelog
2
2
  =====================
3
3
 
4
+ [2023-06-28] Version 6.2.0
5
+ --------------------------
6
+ **Library - Fix**
7
+ - [PR #665](https://github.com/twilio/twilio-ruby/pull/665): #663 local jump error due to lack of block passing for recording list. Thanks to [@JYorston](https://github.com/JYorston)!
8
+
9
+ **Lookups**
10
+ - Add `reassigned_number` package to the lookup response
11
+
12
+ **Numbers**
13
+ - Add hosted_number_order under version `/v2`.
14
+ - Update properties in Porting and Bulk Porting APIs. **(breaking change)**
15
+ - Added bulk Portability API under version `/v1`.
16
+ - Added Portability API under version `/v1`.
17
+
18
+
19
+ [2023-06-15] Version 6.1.0
20
+ --------------------------
21
+ **Api**
22
+ - Added `content_sid` as conditional parameter
23
+ - Removed `content_sid` as optional field **(breaking change)**
24
+
25
+ **Insights**
26
+ - Added `annotation` to list summary output
27
+
28
+
4
29
  [2023-06-01] Version 6.0.2
5
30
  --------------------------
6
31
  **Api**
data/README.md CHANGED
@@ -39,13 +39,13 @@ This library supports the following Ruby implementations:
39
39
  To install using [Bundler][bundler] grab the latest stable version:
40
40
 
41
41
  ```ruby
42
- gem 'twilio-ruby', '~> 6.0.2'
42
+ gem 'twilio-ruby', '~> 6.2.0'
43
43
  ```
44
44
 
45
45
  To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
46
46
 
47
47
  ```bash
48
- gem install twilio-ruby -v 6.0.2
48
+ gem install twilio-ruby -v 6.2.0
49
49
  ```
50
50
 
51
51
  To build and install the development branch yourself from the latest source:
@@ -49,12 +49,12 @@ module Twilio
49
49
  # @param [ScheduleType] schedule_type
50
50
  # @param [Time] send_at The time that Twilio will send the message. Must be in ISO 8601 format.
51
51
  # @param [Boolean] send_as_mms If set to True, Twilio will deliver the message as a single MMS message, regardless of the presence of media.
52
- # @param [String] content_sid The SID of the Content object returned at Content API content create time (https://www.twilio.com/docs/content-api/create-and-send-your-first-content-api-template#create-a-template). If this parameter is not specified, then the Content API will not be utilized.
53
52
  # @param [String] content_variables Key-value pairs of variable names to substitution values, used alongside a content_sid. If not specified, Content API will default to the default variables defined at create time.
54
53
  # @param [String] from A Twilio phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, an [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), or a [Channel Endpoint address](https://www.twilio.com/docs/sms/channels#channel-addresses) that is enabled for the type of message you want to send. Phone numbers or [short codes](https://www.twilio.com/docs/sms/api/short-code) purchased from Twilio also work here. You cannot, for example, spoof messages from a private cell phone number. If you are using `messaging_service_sid`, this parameter must be empty.
55
54
  # @param [String] messaging_service_sid The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services#send-a-message-with-copilot) you want to associate with the Message. Set this parameter to use the [Messaging Service Settings and Copilot Features](https://www.twilio.com/console/sms/services) you have configured and leave the `from` parameter empty. When only this parameter is set, Twilio will use your enabled Copilot Features to select the `from` phone number for delivery.
56
55
  # @param [String] body The text of the message you want to send. Can be up to 1,600 characters in length.
57
56
  # @param [Array[String]] media_url The URL of the media to send with the message. The media can be of type `gif`, `png`, and `jpeg` and will be formatted correctly on the recipient's device. The media size limit is 5MB for supported file types (JPEG, PNG, GIF) and 500KB for [other types](https://www.twilio.com/docs/sms/accepted-mime-types) of accepted media. To send more than one image in the message body, provide multiple `media_url` parameters in the POST request. You can include up to 10 `media_url` parameters per message. You can send images in an SMS message in only the US and Canada.
57
+ # @param [String] content_sid The SID of the Content object returned at Content API content create time (https://www.twilio.com/docs/content-api/create-and-send-your-first-content-api-template#create-a-template). If this parameter is not specified, then the Content API will not be utilized.
58
58
  # @return [MessageInstance] Created MessageInstance
59
59
  def create(
60
60
  to: nil,
@@ -73,12 +73,12 @@ module Twilio
73
73
  schedule_type: :unset,
74
74
  send_at: :unset,
75
75
  send_as_mms: :unset,
76
- content_sid: :unset,
77
76
  content_variables: :unset,
78
77
  from: :unset,
79
78
  messaging_service_sid: :unset,
80
79
  body: :unset,
81
- media_url: :unset
80
+ media_url: :unset,
81
+ content_sid: :unset
82
82
  )
83
83
 
84
84
  data = Twilio::Values.of({
@@ -98,12 +98,12 @@ module Twilio
98
98
  'ScheduleType' => schedule_type,
99
99
  'SendAt' => Twilio.serialize_iso8601_datetime(send_at),
100
100
  'SendAsMms' => send_as_mms,
101
- 'ContentSid' => content_sid,
102
101
  'ContentVariables' => content_variables,
103
102
  'From' => from,
104
103
  'MessagingServiceSid' => messaging_service_sid,
105
104
  'Body' => body,
106
105
  'MediaUrl' => Twilio.serialize_list(media_url) { |e| e },
106
+ 'ContentSid' => content_sid,
107
107
  })
108
108
 
109
109
  payload = @version.create('POST', @uri, data: data)
@@ -75,11 +75,11 @@ module Twilio
75
75
  # Update the AnnotationInstance
76
76
  # @param [AnsweredBy] answered_by
77
77
  # @param [ConnectivityIssue] connectivity_issue
78
- # @param [String] quality_issues Specify if the call had any subjective quality issues. Possible values, one or more of: no_quality_issue, low_volume, choppy_robotic, echo, dtmf, latency, owa, static_noise. Use comma separated values to indicate multiple quality issues for the same call
79
- # @param [Boolean] spam Specify if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Is of type Boolean: true, false. Use true if the call was a spam call.
78
+ # @param [String] quality_issues Specify if the call had any subjective quality issues. Possible values, one or more of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`. Use comma separated values to indicate multiple quality issues for the same call.
79
+ # @param [Boolean] spam A boolean flag to indicate if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Use `true` if the call was a spam call.
80
80
  # @param [String] call_score Specify the call score. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].
81
- # @param [String] comment Specify any comments pertaining to the call. This of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don’t put any PII in here.
82
- # @param [String] incident Associate this call with an incident or support ticket. This is of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don’t put any PII in here.
81
+ # @param [String] comment Specify any comments pertaining to the call. `comment` has a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in the `comment`.
82
+ # @param [String] incident Associate this call with an incident or support ticket. The `incident` parameter is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in `incident`.
83
83
  # @return [AnnotationInstance] Updated AnnotationInstance
84
84
  def update(
85
85
  answered_by: :unset,
@@ -221,31 +221,31 @@ module Twilio
221
221
  end
222
222
 
223
223
  ##
224
- # @return [Array<String>] Specify if the call had any subjective quality issues. Possible values, one or more of: no_quality_issue, low_volume, choppy_robotic, echo, dtmf, latency, owa, static_noise. Use comma separated values to indicate multiple quality issues for the same call
224
+ # @return [Array<String>] Specifies if the call had any subjective quality issues. Possible values are one or more of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, or `static_noise`.
225
225
  def quality_issues
226
226
  @properties['quality_issues']
227
227
  end
228
228
 
229
229
  ##
230
- # @return [Boolean] Specify if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Is of type Boolean: true, false. Use true if the call was a spam call.
230
+ # @return [Boolean] Specifies if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Is of type Boolean: true, false. Use true if the call was a spam call.
231
231
  def spam
232
232
  @properties['spam']
233
233
  end
234
234
 
235
235
  ##
236
- # @return [String] Specify the call score. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].
236
+ # @return [String] Specifies the Call Score, if available. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].
237
237
  def call_score
238
238
  @properties['call_score']
239
239
  end
240
240
 
241
241
  ##
242
- # @return [String] Specify any comments pertaining to the call. This of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don’t put any PII in here.
242
+ # @return [String] Specifies any comments pertaining to the call. Twilio does not treat this field as PII, so no PII should be included in comments.
243
243
  def comment
244
244
  @properties['comment']
245
245
  end
246
246
 
247
247
  ##
248
- # @return [String] Associate this call with an incident or support ticket. This is of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don’t put any PII in here.
248
+ # @return [String] Incident or support ticket associated with this call. The `incident` property is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in `incident`.
249
249
  def incident
250
250
  @properties['incident']
251
251
  end
@@ -268,11 +268,11 @@ module Twilio
268
268
  # Update the AnnotationInstance
269
269
  # @param [AnsweredBy] answered_by
270
270
  # @param [ConnectivityIssue] connectivity_issue
271
- # @param [String] quality_issues Specify if the call had any subjective quality issues. Possible values, one or more of: no_quality_issue, low_volume, choppy_robotic, echo, dtmf, latency, owa, static_noise. Use comma separated values to indicate multiple quality issues for the same call
272
- # @param [Boolean] spam Specify if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Is of type Boolean: true, false. Use true if the call was a spam call.
271
+ # @param [String] quality_issues Specify if the call had any subjective quality issues. Possible values, one or more of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`. Use comma separated values to indicate multiple quality issues for the same call.
272
+ # @param [Boolean] spam A boolean flag to indicate if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Use `true` if the call was a spam call.
273
273
  # @param [String] call_score Specify the call score. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].
274
- # @param [String] comment Specify any comments pertaining to the call. This of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don’t put any PII in here.
275
- # @param [String] incident Associate this call with an incident or support ticket. This is of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don’t put any PII in here.
274
+ # @param [String] comment Specify any comments pertaining to the call. `comment` has a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in the `comment`.
275
+ # @param [String] incident Associate this call with an incident or support ticket. The `incident` parameter is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in `incident`.
276
276
  # @return [AnnotationInstance] Updated AnnotationInstance
277
277
  def update(
278
278
  answered_by: :unset,
@@ -45,7 +45,7 @@ module Twilio
45
45
  ##
46
46
  # Initialize the CallSummaryContext
47
47
  # @param [Version] version Version that contains the resource
48
- # @param [String] call_sid
48
+ # @param [String] call_sid The unique SID identifier of the Call.
49
49
  # @return [CallSummaryContext] CallSummaryContext
50
50
  def initialize(version, call_sid)
51
51
  super(version)
@@ -58,7 +58,7 @@ module Twilio
58
58
  end
59
59
  ##
60
60
  # Fetch the CallSummaryInstance
61
- # @param [ProcessingState] processing_state
61
+ # @param [ProcessingState] processing_state The Processing State of this Call Summary. One of `complete`, `partial` or `all`.
62
62
  # @return [CallSummaryInstance] Fetched CallSummaryInstance
63
63
  def fetch(
64
64
  processing_state: :unset
@@ -176,13 +176,13 @@ module Twilio
176
176
  end
177
177
 
178
178
  ##
179
- # @return [String]
179
+ # @return [String] The unique SID identifier of the Account.
180
180
  def account_sid
181
181
  @properties['account_sid']
182
182
  end
183
183
 
184
184
  ##
185
- # @return [String]
185
+ # @return [String] The unique SID identifier of the Call.
186
186
  def call_sid
187
187
  @properties['call_sid']
188
188
  end
@@ -212,110 +212,110 @@ module Twilio
212
212
  end
213
213
 
214
214
  ##
215
- # @return [Time]
215
+ # @return [Time] The time at which the Call was created, given in ISO 8601 format. Can be different from `start_time` in the event of queueing due to CPS
216
216
  def created_time
217
217
  @properties['created_time']
218
218
  end
219
219
 
220
220
  ##
221
- # @return [Time]
221
+ # @return [Time] The time at which the Call was started, given in ISO 8601 format.
222
222
  def start_time
223
223
  @properties['start_time']
224
224
  end
225
225
 
226
226
  ##
227
- # @return [Time]
227
+ # @return [Time] The time at which the Call was ended, given in ISO 8601 format.
228
228
  def end_time
229
229
  @properties['end_time']
230
230
  end
231
231
 
232
232
  ##
233
- # @return [String]
233
+ # @return [String] Duration between when the call was initiated and the call was ended
234
234
  def duration
235
235
  @properties['duration']
236
236
  end
237
237
 
238
238
  ##
239
- # @return [String]
239
+ # @return [String] Duration between when the call was answered and when it ended
240
240
  def connect_duration
241
241
  @properties['connect_duration']
242
242
  end
243
243
 
244
244
  ##
245
- # @return [Hash]
245
+ # @return [Hash] The calling party.
246
246
  def from
247
247
  @properties['from']
248
248
  end
249
249
 
250
250
  ##
251
- # @return [Hash]
251
+ # @return [Hash] The called party.
252
252
  def to
253
253
  @properties['to']
254
254
  end
255
255
 
256
256
  ##
257
- # @return [Hash]
257
+ # @return [Hash] Contains metrics and properties for the Twilio media gateway of a PSTN call.
258
258
  def carrier_edge
259
259
  @properties['carrier_edge']
260
260
  end
261
261
 
262
262
  ##
263
- # @return [Hash]
263
+ # @return [Hash] Contains metrics and properties for the Twilio media gateway of a Client call.
264
264
  def client_edge
265
265
  @properties['client_edge']
266
266
  end
267
267
 
268
268
  ##
269
- # @return [Hash]
269
+ # @return [Hash] Contains metrics and properties for the SDK sensor library for Client calls.
270
270
  def sdk_edge
271
271
  @properties['sdk_edge']
272
272
  end
273
273
 
274
274
  ##
275
- # @return [Hash]
275
+ # @return [Hash] Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.
276
276
  def sip_edge
277
277
  @properties['sip_edge']
278
278
  end
279
279
 
280
280
  ##
281
- # @return [Array<String>]
281
+ # @return [Array<String>] Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality.
282
282
  def tags
283
283
  @properties['tags']
284
284
  end
285
285
 
286
286
  ##
287
- # @return [String]
287
+ # @return [String] The URL of this resource.
288
288
  def url
289
289
  @properties['url']
290
290
  end
291
291
 
292
292
  ##
293
- # @return [Hash]
293
+ # @return [Hash] Attributes capturing call-flow-specific details.
294
294
  def attributes
295
295
  @properties['attributes']
296
296
  end
297
297
 
298
298
  ##
299
- # @return [Hash]
299
+ # @return [Hash] Contains edge-agnostic call-level details.
300
300
  def properties
301
301
  @properties['properties']
302
302
  end
303
303
 
304
304
  ##
305
- # @return [Hash]
305
+ # @return [Hash] Contains trusted communications details including Branded Call and verified caller ID.
306
306
  def trust
307
307
  @properties['trust']
308
308
  end
309
309
 
310
310
  ##
311
- # @return [Hash]
311
+ # @return [Hash] Programmatically labeled annotations for the Call. Developers can update the Call Summary records with Annotation during or after a Call. Annotations can be updated as long as the Call Summary record is addressable via the API.
312
312
  def annotation
313
313
  @properties['annotation']
314
314
  end
315
315
 
316
316
  ##
317
317
  # Fetch the CallSummaryInstance
318
- # @param [ProcessingState] processing_state
318
+ # @param [ProcessingState] processing_state The Processing State of this Call Summary. One of `complete`, `partial` or `all`.
319
319
  # @return [CallSummaryInstance] Fetched CallSummaryInstance
320
320
  def fetch(
321
321
  processing_state: :unset
@@ -36,7 +36,7 @@ module Twilio
36
36
  # Lists EventInstance records from the API as a list.
37
37
  # Unlike stream(), this operation is eager and will load `limit` records into
38
38
  # memory before returning.
39
- # @param [TwilioEdge] edge
39
+ # @param [TwilioEdge] edge The Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
40
40
  # @param [Integer] limit Upper limit for the number of records to return. stream()
41
41
  # guarantees to never return more than limit. Default is no limit
42
42
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -56,7 +56,7 @@ module Twilio
56
56
  # Streams Instance records from the API as an Enumerable.
57
57
  # This operation lazily loads records as efficiently as possible until the limit
58
58
  # is reached.
59
- # @param [TwilioEdge] edge
59
+ # @param [TwilioEdge] edge The Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
60
60
  # @param [Integer] limit Upper limit for the number of records to return. stream()
61
61
  # guarantees to never return more than limit. Default is no limit
62
62
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -91,7 +91,7 @@ module Twilio
91
91
  ##
92
92
  # Retrieve a single page of EventInstance records from the API.
93
93
  # Request is executed immediately.
94
- # @param [TwilioEdge] edge
94
+ # @param [TwilioEdge] edge The Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
95
95
  # @param [String] page_token PageToken provided by the API
96
96
  # @param [Integer] page_number Page Number, this value is simply for client state
97
97
  # @param [Integer] page_size Number of records to return, defaults to 50
@@ -191,19 +191,19 @@ module Twilio
191
191
 
192
192
 
193
193
  ##
194
- # @return [String]
194
+ # @return [String] Event time.
195
195
  def timestamp
196
196
  @properties['timestamp']
197
197
  end
198
198
 
199
199
  ##
200
- # @return [String]
200
+ # @return [String] The unique SID identifier of the Call.
201
201
  def call_sid
202
202
  @properties['call_sid']
203
203
  end
204
204
 
205
205
  ##
206
- # @return [String]
206
+ # @return [String] The unique SID identifier of the Account.
207
207
  def account_sid
208
208
  @properties['account_sid']
209
209
  end
@@ -215,7 +215,7 @@ module Twilio
215
215
  end
216
216
 
217
217
  ##
218
- # @return [String]
218
+ # @return [String] Event group.
219
219
  def group
220
220
  @properties['group']
221
221
  end
@@ -227,31 +227,31 @@ module Twilio
227
227
  end
228
228
 
229
229
  ##
230
- # @return [String]
230
+ # @return [String] Event name.
231
231
  def name
232
232
  @properties['name']
233
233
  end
234
234
 
235
235
  ##
236
- # @return [Hash]
236
+ # @return [Hash] Represents the connection between Twilio and our immediate carrier partners. The events here describe the call lifecycle as reported by Twilio's carrier media gateways.
237
237
  def carrier_edge
238
238
  @properties['carrier_edge']
239
239
  end
240
240
 
241
241
  ##
242
- # @return [Hash]
242
+ # @return [Hash] Represents the Twilio media gateway for SIP interface and SIP trunking calls. The events here describe the call lifecycle as reported by Twilio's public media gateways.
243
243
  def sip_edge
244
244
  @properties['sip_edge']
245
245
  end
246
246
 
247
247
  ##
248
- # @return [Hash]
248
+ # @return [Hash] Represents the Voice SDK running locally in the browser or in the Android/iOS application. The events here are emitted by the Voice SDK in response to certain call progress events, network changes, or call quality conditions.
249
249
  def sdk_edge
250
250
  @properties['sdk_edge']
251
251
  end
252
252
 
253
253
  ##
254
- # @return [Hash]
254
+ # @return [Hash] Represents the Twilio media gateway for Client calls. The events here describe the call lifecycle as reported by Twilio's Voice SDK media gateways.
255
255
  def client_edge
256
256
  @properties['client_edge']
257
257
  end
@@ -36,8 +36,8 @@ module Twilio
36
36
  # Lists MetricInstance records from the API as a list.
37
37
  # Unlike stream(), this operation is eager and will load `limit` records into
38
38
  # memory before returning.
39
- # @param [TwilioEdge] edge
40
- # @param [StreamDirection] direction
39
+ # @param [TwilioEdge] edge The Edge of this Metric. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
40
+ # @param [StreamDirection] direction The Direction of this Metric. One of `unknown`, `inbound`, `outbound` or `both`.
41
41
  # @param [Integer] limit Upper limit for the number of records to return. stream()
42
42
  # guarantees to never return more than limit. Default is no limit
43
43
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -58,8 +58,8 @@ module Twilio
58
58
  # Streams Instance records from the API as an Enumerable.
59
59
  # This operation lazily loads records as efficiently as possible until the limit
60
60
  # is reached.
61
- # @param [TwilioEdge] edge
62
- # @param [StreamDirection] direction
61
+ # @param [TwilioEdge] edge The Edge of this Metric. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
62
+ # @param [StreamDirection] direction The Direction of this Metric. One of `unknown`, `inbound`, `outbound` or `both`.
63
63
  # @param [Integer] limit Upper limit for the number of records to return. stream()
64
64
  # guarantees to never return more than limit. Default is no limit
65
65
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -95,8 +95,8 @@ module Twilio
95
95
  ##
96
96
  # Retrieve a single page of MetricInstance records from the API.
97
97
  # Request is executed immediately.
98
- # @param [TwilioEdge] edge
99
- # @param [StreamDirection] direction
98
+ # @param [TwilioEdge] edge The Edge of this Metric. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
99
+ # @param [StreamDirection] direction The Direction of this Metric. One of `unknown`, `inbound`, `outbound` or `both`.
100
100
  # @param [String] page_token PageToken provided by the API
101
101
  # @param [Integer] page_number Page Number, this value is simply for client state
102
102
  # @param [Integer] page_size Number of records to return, defaults to 50
@@ -196,19 +196,19 @@ module Twilio
196
196
 
197
197
 
198
198
  ##
199
- # @return [String]
199
+ # @return [String] Timestamp of metric sample. Samples are taken every 10 seconds and contain the metrics for the previous 10 seconds.
200
200
  def timestamp
201
201
  @properties['timestamp']
202
202
  end
203
203
 
204
204
  ##
205
- # @return [String]
205
+ # @return [String] The unique SID identifier of the Call.
206
206
  def call_sid
207
207
  @properties['call_sid']
208
208
  end
209
209
 
210
210
  ##
211
- # @return [String]
211
+ # @return [String] The unique SID identifier of the Account.
212
212
  def account_sid
213
213
  @properties['account_sid']
214
214
  end
@@ -226,25 +226,25 @@ module Twilio
226
226
  end
227
227
 
228
228
  ##
229
- # @return [Hash]
229
+ # @return [Hash] Contains metrics and properties for the Twilio media gateway of a PSTN call.
230
230
  def carrier_edge
231
231
  @properties['carrier_edge']
232
232
  end
233
233
 
234
234
  ##
235
- # @return [Hash]
235
+ # @return [Hash] Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.
236
236
  def sip_edge
237
237
  @properties['sip_edge']
238
238
  end
239
239
 
240
240
  ##
241
- # @return [Hash]
241
+ # @return [Hash] Contains metrics and properties for the SDK sensor library for Client calls.
242
242
  def sdk_edge
243
243
  @properties['sdk_edge']
244
244
  end
245
245
 
246
246
  ##
247
- # @return [Hash]
247
+ # @return [Hash] Contains metrics and properties for the Twilio media gateway of a Client call.
248
248
  def client_edge
249
249
  @properties['client_edge']
250
250
  end