twilio-ruby 5.48.0 → 5.49.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (70) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGES.md +21 -0
  3. data/README.md +2 -2
  4. data/lib/twilio-ruby/rest/api.rb +1 -1
  5. data/lib/twilio-ruby/rest/api/v2010.rb +5 -4
  6. data/lib/twilio-ruby/rest/api/v2010/account/call/event.rb +4 -4
  7. data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb +4 -4
  8. data/lib/twilio-ruby/rest/autopilot/v1.rb +5 -4
  9. data/lib/twilio-ruby/rest/bulkexports/v1.rb +10 -8
  10. data/lib/twilio-ruby/rest/chat/v1.rb +10 -8
  11. data/lib/twilio-ruby/rest/chat/v2.rb +10 -8
  12. data/lib/twilio-ruby/rest/client.rb +1 -1
  13. data/lib/twilio-ruby/rest/conversations/v1.rb +25 -20
  14. data/lib/twilio-ruby/rest/events/v1.rb +20 -16
  15. data/lib/twilio-ruby/rest/events/v1/event_type.rb +4 -4
  16. data/lib/twilio-ruby/rest/events/v1/schema.rb +4 -4
  17. data/lib/twilio-ruby/rest/events/v1/schema/schema_version.rb +4 -4
  18. data/lib/twilio-ruby/rest/events/v1/sink.rb +4 -4
  19. data/lib/twilio-ruby/rest/events/v1/sink/sink_test.rb +3 -3
  20. data/lib/twilio-ruby/rest/events/v1/sink/sink_validate.rb +3 -3
  21. data/lib/twilio-ruby/rest/events/v1/subscription.rb +4 -4
  22. data/lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb +3 -3
  23. data/lib/twilio-ruby/rest/fax/v1.rb +5 -4
  24. data/lib/twilio-ruby/rest/flex_api/v1.rb +15 -12
  25. data/lib/twilio-ruby/rest/insights.rb +1 -1
  26. data/lib/twilio-ruby/rest/insights/v1.rb +11 -9
  27. data/lib/twilio-ruby/rest/insights/v1/room.rb +55 -43
  28. data/lib/twilio-ruby/rest/insights/v1/room/participant.rb +22 -22
  29. data/lib/twilio-ruby/rest/ip_messaging/v1.rb +10 -8
  30. data/lib/twilio-ruby/rest/ip_messaging/v2.rb +10 -8
  31. data/lib/twilio-ruby/rest/lookups/v1.rb +5 -4
  32. data/lib/twilio-ruby/rest/messaging/v1.rb +10 -8
  33. data/lib/twilio-ruby/rest/monitor/v1.rb +10 -8
  34. data/lib/twilio-ruby/rest/notify/v1.rb +10 -8
  35. data/lib/twilio-ruby/rest/preview/bulk_exports.rb +10 -8
  36. data/lib/twilio-ruby/rest/preview/deployed_devices.rb +5 -4
  37. data/lib/twilio-ruby/rest/preview/hosted_numbers.rb +10 -8
  38. data/lib/twilio-ruby/rest/preview/marketplace.rb +10 -8
  39. data/lib/twilio-ruby/rest/preview/sync.rb +5 -4
  40. data/lib/twilio-ruby/rest/preview/trusted_comms.rb +5 -4
  41. data/lib/twilio-ruby/rest/preview/understand.rb +5 -4
  42. data/lib/twilio-ruby/rest/preview/wireless.rb +15 -12
  43. data/lib/twilio-ruby/rest/proxy/v1.rb +5 -4
  44. data/lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb +1 -1
  45. data/lib/twilio-ruby/rest/serverless/v1.rb +5 -4
  46. data/lib/twilio-ruby/rest/studio/v1.rb +5 -4
  47. data/lib/twilio-ruby/rest/studio/v2.rb +5 -4
  48. data/lib/twilio-ruby/rest/supersim/v1.rb +25 -20
  49. data/lib/twilio-ruby/rest/sync/v1.rb +5 -4
  50. data/lib/twilio-ruby/rest/sync/v1/service/document.rb +9 -16
  51. data/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb +9 -15
  52. data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +22 -33
  53. data/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb +9 -15
  54. data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +22 -35
  55. data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb +9 -15
  56. data/lib/twilio-ruby/rest/taskrouter/v1.rb +5 -4
  57. data/lib/twilio-ruby/rest/trunking/v1.rb +5 -4
  58. data/lib/twilio-ruby/rest/trusthub/v1.rb +35 -28
  59. data/lib/twilio-ruby/rest/verify/v2.rb +15 -12
  60. data/lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb +4 -3
  61. data/lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb +64 -13
  62. data/lib/twilio-ruby/rest/video/v1.rb +20 -16
  63. data/lib/twilio-ruby/rest/voice/v1.rb +20 -16
  64. data/lib/twilio-ruby/rest/wireless/v1.rb +15 -12
  65. data/lib/twilio-ruby/twiml/voice_response.rb +22 -0
  66. data/lib/twilio-ruby/version.rb +1 -1
  67. data/spec/integration/api/v2010/account/message_spec.rb +37 -0
  68. data/spec/integration/messaging/v1/brand_registration_spec.rb +2 -2
  69. data/spec/integration/verify/v2/service/entity/factor_spec.rb +3 -3
  70. metadata +2 -2
@@ -11,7 +11,7 @@ module Twilio
11
11
  class Events < Domain
12
12
  class V1 < Version
13
13
  ##
14
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
14
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
15
15
  class SchemaList < ListResource
16
16
  ##
17
17
  # Initialize the SchemaList
@@ -32,7 +32,7 @@ module Twilio
32
32
  end
33
33
 
34
34
  ##
35
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
35
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
36
36
  class SchemaPage < Page
37
37
  ##
38
38
  # Initialize the SchemaPage
@@ -63,7 +63,7 @@ module Twilio
63
63
  end
64
64
 
65
65
  ##
66
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
66
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
67
67
  class SchemaContext < InstanceContext
68
68
  ##
69
69
  # Initialize the SchemaContext
@@ -125,7 +125,7 @@ module Twilio
125
125
  end
126
126
 
127
127
  ##
128
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
128
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
129
129
  class SchemaInstance < InstanceResource
130
130
  ##
131
131
  # Initialize the SchemaInstance
@@ -12,7 +12,7 @@ module Twilio
12
12
  class V1 < Version
13
13
  class SchemaContext < InstanceContext
14
14
  ##
15
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
15
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
16
16
  class VersionList < ListResource
17
17
  ##
18
18
  # Initialize the VersionList
@@ -116,7 +116,7 @@ module Twilio
116
116
  end
117
117
 
118
118
  ##
119
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
119
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
120
120
  class VersionPage < Page
121
121
  ##
122
122
  # Initialize the VersionPage
@@ -147,7 +147,7 @@ module Twilio
147
147
  end
148
148
 
149
149
  ##
150
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
150
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
151
151
  class VersionContext < InstanceContext
152
152
  ##
153
153
  # Initialize the VersionContext
@@ -194,7 +194,7 @@ module Twilio
194
194
  end
195
195
 
196
196
  ##
197
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
197
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
198
198
  class VersionInstance < InstanceResource
199
199
  ##
200
200
  # Initialize the VersionInstance
@@ -11,7 +11,7 @@ module Twilio
11
11
  class Events < Domain
12
12
  class V1 < Version
13
13
  ##
14
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
14
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
15
15
  class SinkList < ListResource
16
16
  ##
17
17
  # Initialize the SinkList
@@ -134,7 +134,7 @@ module Twilio
134
134
  end
135
135
 
136
136
  ##
137
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
137
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
138
138
  class SinkPage < Page
139
139
  ##
140
140
  # Initialize the SinkPage
@@ -165,7 +165,7 @@ module Twilio
165
165
  end
166
166
 
167
167
  ##
168
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
168
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
169
169
  class SinkContext < InstanceContext
170
170
  ##
171
171
  # Initialize the SinkContext
@@ -240,7 +240,7 @@ module Twilio
240
240
  end
241
241
 
242
242
  ##
243
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
243
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
244
244
  class SinkInstance < InstanceResource
245
245
  ##
246
246
  # Initialize the SinkInstance
@@ -12,7 +12,7 @@ module Twilio
12
12
  class V1 < Version
13
13
  class SinkContext < InstanceContext
14
14
  ##
15
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
15
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
16
16
  class SinkTestList < ListResource
17
17
  ##
18
18
  # Initialize the SinkTestList
@@ -44,7 +44,7 @@ module Twilio
44
44
  end
45
45
 
46
46
  ##
47
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
47
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
48
48
  class SinkTestPage < Page
49
49
  ##
50
50
  # Initialize the SinkTestPage
@@ -75,7 +75,7 @@ module Twilio
75
75
  end
76
76
 
77
77
  ##
78
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
78
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
79
79
  class SinkTestInstance < InstanceResource
80
80
  ##
81
81
  # Initialize the SinkTestInstance
@@ -12,7 +12,7 @@ module Twilio
12
12
  class V1 < Version
13
13
  class SinkContext < InstanceContext
14
14
  ##
15
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
15
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
16
16
  class SinkValidateList < ListResource
17
17
  ##
18
18
  # Initialize the SinkValidateList
@@ -48,7 +48,7 @@ module Twilio
48
48
  end
49
49
 
50
50
  ##
51
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
51
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
52
52
  class SinkValidatePage < Page
53
53
  ##
54
54
  # Initialize the SinkValidatePage
@@ -79,7 +79,7 @@ module Twilio
79
79
  end
80
80
 
81
81
  ##
82
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
82
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
83
83
  class SinkValidateInstance < InstanceResource
84
84
  ##
85
85
  # Initialize the SinkValidateInstance
@@ -11,7 +11,7 @@ module Twilio
11
11
  class Events < Domain
12
12
  class V1 < Version
13
13
  ##
14
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
14
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
15
15
  class SubscriptionList < ListResource
16
16
  ##
17
17
  # Initialize the SubscriptionList
@@ -142,7 +142,7 @@ module Twilio
142
142
  end
143
143
 
144
144
  ##
145
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
145
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
146
146
  class SubscriptionPage < Page
147
147
  ##
148
148
  # Initialize the SubscriptionPage
@@ -173,7 +173,7 @@ module Twilio
173
173
  end
174
174
 
175
175
  ##
176
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
176
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
177
177
  class SubscriptionContext < InstanceContext
178
178
  ##
179
179
  # Initialize the SubscriptionContext
@@ -251,7 +251,7 @@ module Twilio
251
251
  end
252
252
 
253
253
  ##
254
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
254
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
255
255
  class SubscriptionInstance < InstanceResource
256
256
  ##
257
257
  # Initialize the SubscriptionInstance
@@ -12,7 +12,7 @@ module Twilio
12
12
  class V1 < Version
13
13
  class SubscriptionContext < InstanceContext
14
14
  ##
15
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
15
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
16
16
  class SubscribedEventList < ListResource
17
17
  ##
18
18
  # Initialize the SubscribedEventList
@@ -115,7 +115,7 @@ module Twilio
115
115
  end
116
116
 
117
117
  ##
118
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
118
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
119
119
  class SubscribedEventPage < Page
120
120
  ##
121
121
  # Initialize the SubscribedEventPage
@@ -146,7 +146,7 @@ module Twilio
146
146
  end
147
147
 
148
148
  ##
149
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
149
+ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
150
150
  class SubscribedEventInstance < InstanceResource
151
151
  ##
152
152
  # Initialize the SubscribedEventInstance
@@ -25,11 +25,12 @@ module Twilio
25
25
  # @return [Twilio::REST::Fax::V1::FaxList]
26
26
  def faxes(sid=:unset)
27
27
  if sid.nil?
28
- raise ArgumentError, 'sid cannot be nil'
29
- elsif sid == :unset
30
- @faxes ||= FaxList.new self
28
+ raise ArgumentError, 'sid cannot be nil'
29
+ end
30
+ if sid == :unset
31
+ @faxes ||= FaxList.new self
31
32
  else
32
- FaxContext.new(self, sid)
33
+ FaxContext.new(self, sid)
33
34
  end
34
35
  end
35
36
 
@@ -27,11 +27,12 @@ module Twilio
27
27
  # @return [Twilio::REST::Flex_api::V1::ChannelList]
28
28
  def channel(sid=:unset)
29
29
  if sid.nil?
30
- raise ArgumentError, 'sid cannot be nil'
31
- elsif sid == :unset
32
- @channel ||= ChannelList.new self
30
+ raise ArgumentError, 'sid cannot be nil'
31
+ end
32
+ if sid == :unset
33
+ @channel ||= ChannelList.new self
33
34
  else
34
- ChannelContext.new(self, sid)
35
+ ChannelContext.new(self, sid)
35
36
  end
36
37
  end
37
38
 
@@ -47,11 +48,12 @@ module Twilio
47
48
  # @return [Twilio::REST::Flex_api::V1::FlexFlowList]
48
49
  def flex_flow(sid=:unset)
49
50
  if sid.nil?
50
- raise ArgumentError, 'sid cannot be nil'
51
- elsif sid == :unset
52
- @flex_flow ||= FlexFlowList.new self
51
+ raise ArgumentError, 'sid cannot be nil'
52
+ end
53
+ if sid == :unset
54
+ @flex_flow ||= FlexFlowList.new self
53
55
  else
54
- FlexFlowContext.new(self, sid)
56
+ FlexFlowContext.new(self, sid)
55
57
  end
56
58
  end
57
59
 
@@ -61,11 +63,12 @@ module Twilio
61
63
  # @return [Twilio::REST::Flex_api::V1::WebChannelList]
62
64
  def web_channel(sid=:unset)
63
65
  if sid.nil?
64
- raise ArgumentError, 'sid cannot be nil'
65
- elsif sid == :unset
66
- @web_channel ||= WebChannelList.new self
66
+ raise ArgumentError, 'sid cannot be nil'
67
+ end
68
+ if sid == :unset
69
+ @web_channel ||= WebChannelList.new self
67
70
  else
68
- WebChannelContext.new(self, sid)
71
+ WebChannelContext.new(self, sid)
69
72
  end
70
73
  end
71
74
 
@@ -37,7 +37,7 @@ module Twilio
37
37
  end
38
38
 
39
39
  ##
40
- # @param [String] room_sid The room_sid
40
+ # @param [String] room_sid Unique identifier for the room.
41
41
  # @return [Twilio::REST::Insights::V1::RoomInstance] if room_sid was passed.
42
42
  # @return [Twilio::REST::Insights::V1::RoomList]
43
43
  def rooms(room_sid=:unset)
@@ -25,25 +25,27 @@ module Twilio
25
25
  # @return [Twilio::REST::Insights::V1::CallList]
26
26
  def calls(sid=:unset)
27
27
  if sid.nil?
28
- raise ArgumentError, 'sid cannot be nil'
29
- elsif sid == :unset
30
- @calls ||= CallList.new self
28
+ raise ArgumentError, 'sid cannot be nil'
29
+ end
30
+ if sid == :unset
31
+ @calls ||= CallList.new self
31
32
  else
32
- CallContext.new(self, sid)
33
+ CallContext.new(self, sid)
33
34
  end
34
35
  end
35
36
 
36
37
  ##
37
- # @param [String] room_sid The room_sid
38
+ # @param [String] room_sid The SID of the Room resource.
38
39
  # @return [Twilio::REST::Insights::V1::RoomContext] if room_sid was passed.
39
40
  # @return [Twilio::REST::Insights::V1::RoomList]
40
41
  def rooms(room_sid=:unset)
41
42
  if room_sid.nil?
42
- raise ArgumentError, 'room_sid cannot be nil'
43
- elsif room_sid == :unset
44
- @rooms ||= RoomList.new self
43
+ raise ArgumentError, 'room_sid cannot be nil'
44
+ end
45
+ if room_sid == :unset
46
+ @rooms ||= RoomList.new self
45
47
  else
46
- RoomContext.new(self, room_sid)
48
+ RoomContext.new(self, room_sid)
47
49
  end
48
50
  end
49
51
 
@@ -29,11 +29,15 @@ module Twilio
29
29
  # Lists RoomInstance records from the API as a list.
30
30
  # Unlike stream(), this operation is eager and will load `limit` records into
31
31
  # memory before returning.
32
- # @param [Array[room.RoomType]] room_type The room_type
33
- # @param [Array[room.Codec]] codec The codec
34
- # @param [String] room_name The room_name
35
- # @param [Time] created_after The created_after
36
- # @param [Time] created_before The created_before
32
+ # @param [Array[room.RoomType]] room_type Type of room. Can be `go`,
33
+ # `peer_to_peer`, `group`, or `group_small`.
34
+ # @param [Array[room.Codec]] codec Codecs used by participants in the room. Can be
35
+ # `VP8`, `H264`, or `VP9`.
36
+ # @param [String] room_name Room friendly name.
37
+ # @param [Time] created_after Only read rooms that started on or after this ISO
38
+ # 8601 timestamp.
39
+ # @param [Time] created_before Only read rooms that started before this ISO 8601
40
+ # timestamp.
37
41
  # @param [Integer] limit Upper limit for the number of records to return. stream()
38
42
  # guarantees to never return more than limit. Default is no limit
39
43
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -57,11 +61,15 @@ module Twilio
57
61
  # Streams RoomInstance records from the API as an Enumerable.
58
62
  # This operation lazily loads records as efficiently as possible until the limit
59
63
  # is reached.
60
- # @param [Array[room.RoomType]] room_type The room_type
61
- # @param [Array[room.Codec]] codec The codec
62
- # @param [String] room_name The room_name
63
- # @param [Time] created_after The created_after
64
- # @param [Time] created_before The created_before
64
+ # @param [Array[room.RoomType]] room_type Type of room. Can be `go`,
65
+ # `peer_to_peer`, `group`, or `group_small`.
66
+ # @param [Array[room.Codec]] codec Codecs used by participants in the room. Can be
67
+ # `VP8`, `H264`, or `VP9`.
68
+ # @param [String] room_name Room friendly name.
69
+ # @param [Time] created_after Only read rooms that started on or after this ISO
70
+ # 8601 timestamp.
71
+ # @param [Time] created_before Only read rooms that started before this ISO 8601
72
+ # timestamp.
65
73
  # @param [Integer] limit Upper limit for the number of records to return. stream()
66
74
  # guarantees to never return more than limit. Default is no limit.
67
75
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -101,11 +109,15 @@ module Twilio
101
109
  ##
102
110
  # Retrieve a single page of RoomInstance records from the API.
103
111
  # Request is executed immediately.
104
- # @param [Array[room.RoomType]] room_type The room_type
105
- # @param [Array[room.Codec]] codec The codec
106
- # @param [String] room_name The room_name
107
- # @param [Time] created_after The created_after
108
- # @param [Time] created_before The created_before
112
+ # @param [Array[room.RoomType]] room_type Type of room. Can be `go`,
113
+ # `peer_to_peer`, `group`, or `group_small`.
114
+ # @param [Array[room.Codec]] codec Codecs used by participants in the room. Can be
115
+ # `VP8`, `H264`, or `VP9`.
116
+ # @param [String] room_name Room friendly name.
117
+ # @param [Time] created_after Only read rooms that started on or after this ISO
118
+ # 8601 timestamp.
119
+ # @param [Time] created_before Only read rooms that started before this ISO 8601
120
+ # timestamp.
109
121
  # @param [String] page_token PageToken provided by the API
110
122
  # @param [Integer] page_number Page Number, this value is simply for client state
111
123
  # @param [Integer] page_size Number of records to return, defaults to 50
@@ -184,7 +196,7 @@ module Twilio
184
196
  ##
185
197
  # Initialize the RoomContext
186
198
  # @param [Version] version Version that contains the resource
187
- # @param [String] room_sid The room_sid
199
+ # @param [String] room_sid The SID of the Room resource.
188
200
  # @return [RoomContext] RoomContext
189
201
  def initialize(version, room_sid)
190
202
  super(version)
@@ -246,7 +258,7 @@ module Twilio
246
258
  # Initialize the RoomInstance
247
259
  # @param [Version] version Version that contains the resource
248
260
  # @param [Hash] payload payload that contains response from Twilio
249
- # @param [String] room_sid The room_sid
261
+ # @param [String] room_sid The SID of the Room resource.
250
262
  # @return [RoomInstance] RoomInstance
251
263
  def initialize(version, payload, room_sid: nil)
252
264
  super(version)
@@ -298,157 +310,157 @@ module Twilio
298
310
  end
299
311
 
300
312
  ##
301
- # @return [String] The account_sid
313
+ # @return [String] Account SID associated with this room.
302
314
  def account_sid
303
315
  @properties['account_sid']
304
316
  end
305
317
 
306
318
  ##
307
- # @return [String] The room_sid
319
+ # @return [String] Unique identifier for the room.
308
320
  def room_sid
309
321
  @properties['room_sid']
310
322
  end
311
323
 
312
324
  ##
313
- # @return [String] The room_name
325
+ # @return [String] room friendly name.
314
326
  def room_name
315
327
  @properties['room_name']
316
328
  end
317
329
 
318
330
  ##
319
- # @return [Time] The create_time
331
+ # @return [Time] Creation time of the room.
320
332
  def create_time
321
333
  @properties['create_time']
322
334
  end
323
335
 
324
336
  ##
325
- # @return [Time] The end_time
337
+ # @return [Time] End time for the room.
326
338
  def end_time
327
339
  @properties['end_time']
328
340
  end
329
341
 
330
342
  ##
331
- # @return [room.RoomType] The room_type
343
+ # @return [room.RoomType] Type of room.
332
344
  def room_type
333
345
  @properties['room_type']
334
346
  end
335
347
 
336
348
  ##
337
- # @return [room.RoomStatus] The room_status
349
+ # @return [room.RoomStatus] Status of the room.
338
350
  def room_status
339
351
  @properties['room_status']
340
352
  end
341
353
 
342
354
  ##
343
- # @return [String] The status_callback
355
+ # @return [String] Webhook provided for status callbacks.
344
356
  def status_callback
345
357
  @properties['status_callback']
346
358
  end
347
359
 
348
360
  ##
349
- # @return [String] The status_callback_method
361
+ # @return [String] HTTP method provided for status callback URL.
350
362
  def status_callback_method
351
363
  @properties['status_callback_method']
352
364
  end
353
365
 
354
366
  ##
355
- # @return [room.CreatedMethod] The created_method
367
+ # @return [room.CreatedMethod] How the room was created.
356
368
  def created_method
357
369
  @properties['created_method']
358
370
  end
359
371
 
360
372
  ##
361
- # @return [room.EndReason] The end_reason
373
+ # @return [room.EndReason] Reason the room ended.
362
374
  def end_reason
363
375
  @properties['end_reason']
364
376
  end
365
377
 
366
378
  ##
367
- # @return [String] The max_participants
379
+ # @return [String] Max number of total participants allowed by the application settings.
368
380
  def max_participants
369
381
  @properties['max_participants']
370
382
  end
371
383
 
372
384
  ##
373
- # @return [String] The unique_participants
385
+ # @return [String] Number of participants. May include duplicate identities for participants who left and rejoined.
374
386
  def unique_participants
375
387
  @properties['unique_participants']
376
388
  end
377
389
 
378
390
  ##
379
- # @return [String] The unique_participant_identities
391
+ # @return [String] Unique number of participant identities.
380
392
  def unique_participant_identities
381
393
  @properties['unique_participant_identities']
382
394
  end
383
395
 
384
396
  ##
385
- # @return [String] The concurrent_participants
397
+ # @return [String] Actual number of concurrent participants.
386
398
  def concurrent_participants
387
399
  @properties['concurrent_participants']
388
400
  end
389
401
 
390
402
  ##
391
- # @return [String] The max_concurrent_participants
403
+ # @return [String] Maximum number of participants allowed in the room at the same time allowed by the application settings.
392
404
  def max_concurrent_participants
393
405
  @properties['max_concurrent_participants']
394
406
  end
395
407
 
396
408
  ##
397
- # @return [Array[room.Codec]] The codecs
409
+ # @return [Array[room.Codec]] Codecs used by participants in the room.
398
410
  def codecs
399
411
  @properties['codecs']
400
412
  end
401
413
 
402
414
  ##
403
- # @return [room.TwilioRealm] The media_region
415
+ # @return [room.TwilioRealm] Region of Twilio media servers for the room.
404
416
  def media_region
405
417
  @properties['media_region']
406
418
  end
407
419
 
408
420
  ##
409
- # @return [String] The duration_sec
421
+ # @return [String] Total room duration from create time to end time.
410
422
  def duration_sec
411
423
  @properties['duration_sec']
412
424
  end
413
425
 
414
426
  ##
415
- # @return [String] The total_participant_duration_sec
427
+ # @return [String] Combined amount of participant time in the room.
416
428
  def total_participant_duration_sec
417
429
  @properties['total_participant_duration_sec']
418
430
  end
419
431
 
420
432
  ##
421
- # @return [String] The total_recording_duration_sec
433
+ # @return [String] Combined amount of recorded seconds for participants in the room.
422
434
  def total_recording_duration_sec
423
435
  @properties['total_recording_duration_sec']
424
436
  end
425
437
 
426
438
  ##
427
- # @return [room.ProcessingState] The processing_state
439
+ # @return [room.ProcessingState] Video Log Analyzer resource state. Will be either `in-progress` or `complete`.
428
440
  def processing_state
429
441
  @properties['processing_state']
430
442
  end
431
443
 
432
444
  ##
433
- # @return [Boolean] The recording_enabled
445
+ # @return [Boolean] Boolean indicating if recording is enabled for the room.
434
446
  def recording_enabled
435
447
  @properties['recording_enabled']
436
448
  end
437
449
 
438
450
  ##
439
- # @return [room.EdgeLocation] The edge_location
451
+ # @return [room.EdgeLocation] Edge location of Twilio media servers for the room.
440
452
  def edge_location
441
453
  @properties['edge_location']
442
454
  end
443
455
 
444
456
  ##
445
- # @return [String] The url
457
+ # @return [String] URL for the room resource.
446
458
  def url
447
459
  @properties['url']
448
460
  end
449
461
 
450
462
  ##
451
- # @return [String] The links
463
+ # @return [String] Room subresources.
452
464
  def links
453
465
  @properties['links']
454
466
  end