twilio-ruby 5.18.0 → 5.19.0
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 +5 -5
- data/.travis.yml +0 -4
- data/CHANGES.md +20 -0
- data/LICENSE.md +1 -1
- data/README.md +2 -2
- data/lib/twilio-ruby/rest/accounts/v1/credential/aws.rb +21 -13
- data/lib/twilio-ruby/rest/accounts/v1/credential.rb +2 -1
- data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb +4 -4
- data/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb +6 -6
- data/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb +80 -70
- data/lib/twilio-ruby/rest/api/v2010/account/call.rb +204 -196
- data/lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb +59 -53
- data/lib/twilio-ruby/rest/api/v2010/account/conference.rb +69 -61
- data/lib/twilio-ruby/rest/api/v2010/account/message/media.rb +30 -25
- data/lib/twilio-ruby/rest/api/v2010/account/queue/member.rb +28 -16
- data/lib/twilio-ruby/rest/api/v2010/account/queue.rb +31 -20
- data/lib/twilio-ruby/rest/api/v2010/account/short_code.rb +54 -50
- data/lib/twilio-ruby/rest/api.rb +7 -6
- data/lib/twilio-ruby/rest/authy/v1.rb +15 -15
- data/lib/twilio-ruby/rest/authy.rb +8 -8
- data/lib/twilio-ruby/rest/client.rb +14 -6
- data/lib/twilio-ruby/rest/insights/v1/summary.rb +286 -0
- data/lib/twilio-ruby/rest/insights/v1.rb +43 -0
- data/lib/twilio-ruby/rest/insights.rb +46 -0
- data/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb +22 -14
- data/lib/twilio-ruby/rest/preview/marketplace.rb +13 -13
- data/lib/twilio-ruby/rest/preview.rb +8 -8
- data/lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb +5 -28
- data/lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb +5 -9
- data/lib/twilio-ruby/rest/proxy/v1/service/session.rb +5 -13
- data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +1 -1
- data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb +1 -1
- data/lib/twilio-ruby/rest/trunking/v1/trunk.rb +4 -2
- data/lib/twilio-ruby/rest/trunking/v1.rb +2 -1
- data/lib/twilio-ruby/rest/verify/v1/service/verification.rb +7 -0
- data/lib/twilio-ruby/rest/verify/v1/service/verification_check.rb +7 -4
- data/lib/twilio-ruby/rest/video/v1/composition.rb +25 -13
- data/lib/twilio-ruby/rest/video/v1/composition_hook.rb +69 -74
- data/lib/twilio-ruby/rest/video/v1/recording.rb +13 -7
- data/lib/twilio-ruby/rest/video/v1.rb +16 -16
- data/lib/twilio-ruby/rest/video.rb +9 -9
- data/lib/twilio-ruby/rest/voice/v1/voice_permission/bulk_country_update.rb +3 -3
- data/lib/twilio-ruby/rest/voice/v1/voice_permission/country/highrisk_special_prefix.rb +2 -2
- data/lib/twilio-ruby/rest/voice/v1/voice_permission/country.rb +20 -20
- data/lib/twilio-ruby/version.rb +1 -1
- data/spec/integration/api/v2010/account/sip/domain_spec.rb +8 -4
- data/spec/integration/insights/v1/summary_spec.rb +60 -0
- data/spec/integration/proxy/v1/service/phone_number_spec.rb +2 -2
- data/spec/integration/proxy/v1/service/session/interaction_spec.rb +1 -1
- data/spec/integration/proxy/v1/service/session/participant/message_interaction_spec.rb +2 -2
- data/spec/integration/proxy/v1/service/session/participant_spec.rb +66 -4
- data/spec/integration/proxy/v1/service/session_spec.rb +8 -8
- data/spec/integration/proxy/v1/service_spec.rb +3 -3
- data/spec/integration/trunking/v1/trunk_spec.rb +80 -0
- data/spec/integration/verify/v1/service/verification_spec.rb +10 -1
- data/twilio-ruby.gemspec +1 -2
- metadata +16 -6
@@ -34,7 +34,7 @@ module Twilio
|
|
34
34
|
##
|
35
35
|
# Retrieve a single page of SyncMapItemInstance records from the API.
|
36
36
|
# Request is executed immediately.
|
37
|
-
# @param [String] key The unique user-defined key of this Map Item. Up to
|
37
|
+
# @param [String] key The unique user-defined key of this Map Item. Up to 320
|
38
38
|
# characters long.
|
39
39
|
# @param [Hash] data Contains arbitrary user-defined, schema-less data that this
|
40
40
|
# Map Item stores, represented by a JSON object, up to 16KB.
|
@@ -32,7 +32,7 @@ module Twilio
|
|
32
32
|
# Retrieve a single page of SyncStreamInstance records from the API.
|
33
33
|
# Request is executed immediately.
|
34
34
|
# @param [String] unique_name The unique and addressable name of this Stream.
|
35
|
-
# Optional, up to
|
35
|
+
# Optional, up to 320 characters long.
|
36
36
|
# @param [String] ttl Time-to-live of this Stream in seconds, defaults to no
|
37
37
|
# expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity.
|
38
38
|
# @return [SyncStreamInstance] Newly created SyncStreamInstance
|
@@ -198,7 +198,8 @@ module Twilio
|
|
198
198
|
##
|
199
199
|
# Initialize the TrunkContext
|
200
200
|
# @param [Version] version Version that contains the resource
|
201
|
-
# @param [String] sid
|
201
|
+
# @param [String] sid A 34 character string that uniquely identifies the SIP Trunk
|
202
|
+
# in Twilio.
|
202
203
|
# @return [TrunkContext] TrunkContext
|
203
204
|
def initialize(version, sid)
|
204
205
|
super(version)
|
@@ -373,7 +374,8 @@ module Twilio
|
|
373
374
|
# Initialize the TrunkInstance
|
374
375
|
# @param [Version] version Version that contains the resource
|
375
376
|
# @param [Hash] payload payload that contains response from Twilio
|
376
|
-
# @param [String] sid
|
377
|
+
# @param [String] sid A 34 character string that uniquely identifies the SIP Trunk
|
378
|
+
# in Twilio.
|
377
379
|
# @return [TrunkInstance] TrunkInstance
|
378
380
|
def initialize(version, payload, sid: nil)
|
379
381
|
super(version)
|
@@ -19,7 +19,8 @@ module Twilio
|
|
19
19
|
end
|
20
20
|
|
21
21
|
##
|
22
|
-
# @param [String] sid
|
22
|
+
# @param [String] sid A 34 character string that uniquely identifies the SIP Trunk
|
23
|
+
# in Twilio.
|
23
24
|
# @return [Twilio::REST::Trunking::V1::TrunkContext] if sid was passed.
|
24
25
|
# @return [Twilio::REST::Trunking::V1::TrunkList]
|
25
26
|
def trunks(sid=:unset)
|
@@ -121,6 +121,7 @@ module Twilio
|
|
121
121
|
'channel' => payload['channel'],
|
122
122
|
'status' => payload['status'],
|
123
123
|
'valid' => payload['valid'],
|
124
|
+
'lookup' => payload['lookup'],
|
124
125
|
'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
|
125
126
|
'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
|
126
127
|
}
|
@@ -168,6 +169,12 @@ module Twilio
|
|
168
169
|
@properties['valid']
|
169
170
|
end
|
170
171
|
|
172
|
+
##
|
173
|
+
# @return [Hash] Info about the phone number
|
174
|
+
def lookup
|
175
|
+
@properties['lookup']
|
176
|
+
end
|
177
|
+
|
171
178
|
##
|
172
179
|
# @return [Time] The date this Verification was created
|
173
180
|
def date_created
|
@@ -31,10 +31,13 @@ module Twilio
|
|
31
31
|
# Retrieve a single page of VerificationCheckInstance records from the API.
|
32
32
|
# Request is executed immediately.
|
33
33
|
# @param [String] code The 4-10 character string being verified
|
34
|
-
# @param [String] to The To
|
34
|
+
# @param [String] to The To phone number of the phone being verified
|
35
|
+
# @param [String] verification_sid A SID that uniquely identifies this
|
36
|
+
# Verification Check, either this parameter or the To phone number must be
|
37
|
+
# specified
|
35
38
|
# @return [VerificationCheckInstance] Newly created VerificationCheckInstance
|
36
|
-
def create(code: nil, to: :unset)
|
37
|
-
data = Twilio::Values.of({'Code' => code, 'To' => to, })
|
39
|
+
def create(code: nil, to: :unset, verification_sid: :unset)
|
40
|
+
data = Twilio::Values.of({'Code' => code, 'To' => to, 'VerificationSid' => verification_sid, })
|
38
41
|
|
39
42
|
payload = @version.create(
|
40
43
|
'POST',
|
@@ -128,7 +131,7 @@ module Twilio
|
|
128
131
|
end
|
129
132
|
|
130
133
|
##
|
131
|
-
# @return [String] To
|
134
|
+
# @return [String] To phone number
|
132
135
|
def to
|
133
136
|
@properties['to']
|
134
137
|
end
|
@@ -30,10 +30,12 @@ module Twilio
|
|
30
30
|
# Unlike stream(), this operation is eager and will load `limit` records into
|
31
31
|
# memory before returning.
|
32
32
|
# @param [composition.Status] status Only show Compositions with the given status.
|
33
|
-
# @param [Time] date_created_after Only show Compositions
|
34
|
-
#
|
35
|
-
#
|
36
|
-
#
|
33
|
+
# @param [Time] date_created_after Only show Compositions created on or after this
|
34
|
+
# ISO8601 date-time with timezone, given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or
|
35
|
+
# `YYYY-MM-DDThh:mm:ssZ`.
|
36
|
+
# @param [Time] date_created_before Only show Compositions created before this
|
37
|
+
# ISO8601 date-time with timezone, given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or
|
38
|
+
# `YYYY-MM-DDThh:mm:ssZ`.
|
37
39
|
# @param [String] room_sid Only show Compositions with the given Room SID.
|
38
40
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
39
41
|
# guarantees to never return more than limit. Default is no limit
|
@@ -58,10 +60,12 @@ module Twilio
|
|
58
60
|
# This operation lazily loads records as efficiently as possible until the limit
|
59
61
|
# is reached.
|
60
62
|
# @param [composition.Status] status Only show Compositions with the given status.
|
61
|
-
# @param [Time] date_created_after Only show Compositions
|
62
|
-
#
|
63
|
-
#
|
64
|
-
#
|
63
|
+
# @param [Time] date_created_after Only show Compositions created on or after this
|
64
|
+
# ISO8601 date-time with timezone, given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or
|
65
|
+
# `YYYY-MM-DDThh:mm:ssZ`.
|
66
|
+
# @param [Time] date_created_before Only show Compositions created before this
|
67
|
+
# ISO8601 date-time with timezone, given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or
|
68
|
+
# `YYYY-MM-DDThh:mm:ssZ`.
|
65
69
|
# @param [String] room_sid Only show Compositions with the given Room SID.
|
66
70
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
67
71
|
# guarantees to never return more than limit. Default is no limit.
|
@@ -102,10 +106,12 @@ module Twilio
|
|
102
106
|
# Retrieve a single page of CompositionInstance records from the API.
|
103
107
|
# Request is executed immediately.
|
104
108
|
# @param [composition.Status] status Only show Compositions with the given status.
|
105
|
-
# @param [Time] date_created_after Only show Compositions
|
106
|
-
#
|
107
|
-
#
|
108
|
-
#
|
109
|
+
# @param [Time] date_created_after Only show Compositions created on or after this
|
110
|
+
# ISO8601 date-time with timezone, given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or
|
111
|
+
# `YYYY-MM-DDThh:mm:ssZ`.
|
112
|
+
# @param [Time] date_created_before Only show Compositions created before this
|
113
|
+
# ISO8601 date-time with timezone, given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or
|
114
|
+
# `YYYY-MM-DDThh:mm:ssZ`.
|
109
115
|
# @param [String] room_sid Only show Compositions with the given Room SID.
|
110
116
|
# @param [String] page_token PageToken provided by the API
|
111
117
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
@@ -152,6 +158,7 @@ module Twilio
|
|
152
158
|
# Layouts](#managing-video-layouts) below for further information.
|
153
159
|
# @param [String] audio_sources An array of audio sources to merge. All the
|
154
160
|
# specified sources must belong to the same Group Room. It can include:
|
161
|
+
#
|
155
162
|
# * Zero or more `RecordingTrackSid`
|
156
163
|
# * Zero or more `MediaTrackSid`
|
157
164
|
# * Zero or more `ParticipantSid`
|
@@ -162,23 +169,28 @@ module Twilio
|
|
162
169
|
# the Composition. Any new Composition shall include all audio sources specified
|
163
170
|
# in `AudioSources` except for the ones specified in `AudioSourcesExcluded`. This
|
164
171
|
# parameter may include:
|
172
|
+
#
|
165
173
|
# * Zero or more `RecordingTrackSid`
|
166
174
|
# * Zero or more `MediaTrackSid`
|
167
175
|
# * Zero or more `ParticipantSid`
|
168
176
|
# * Zero or more Track names. These can be specified using wildcards (e.g.
|
169
177
|
# `student*`)
|
170
|
-
# @param [String] resolution A string representing the
|
178
|
+
# @param [String] resolution A string representing the number of pixels for rows
|
171
179
|
# (width) and columns (height) of the generated composed video. This string must
|
172
180
|
# have the format `{width}x{height}`. This parameter must comply with the
|
173
181
|
# following constraints:
|
182
|
+
#
|
174
183
|
# * `width >= 16 && width <= 1280`
|
175
184
|
# * `height >= 16 && height <= 1280`
|
176
185
|
# * `width * height <= 921,600`
|
186
|
+
#
|
177
187
|
# Typical values are:
|
188
|
+
#
|
178
189
|
# * HD = `1280x720`
|
179
190
|
# * PAL = `1024x576`
|
180
191
|
# * VGA = `640x480`
|
181
192
|
# * CIF = `320x240`
|
193
|
+
#
|
182
194
|
# Note that the `Resolution` implicitly imposes an aspect ratio to the resulting
|
183
195
|
# composition. When the original video tracks get constrained by this aspect ratio
|
184
196
|
# they are scaled-down to fit. You can find detailed information in the [Managing
|
@@ -32,9 +32,11 @@ module Twilio
|
|
32
32
|
# @param [Boolean] enabled Only show Composition Hooks that are enabled or
|
33
33
|
# disabled.
|
34
34
|
# @param [Time] date_created_after Only show Composition Hooks created on or after
|
35
|
-
# this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss
|
35
|
+
# this ISO8601 date-time with timezone, given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or
|
36
|
+
# `YYYY-MM-DDThh:mm:ssZ`.
|
36
37
|
# @param [Time] date_created_before Only show Composition Hooks created before
|
37
|
-
# this
|
38
|
+
# this ISO8601 date-time with timezone, given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or
|
39
|
+
# `YYYY-MM-DDThh:mm:ssZ`.
|
38
40
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
39
41
|
# guarantees to never return more than limit. Default is no limit
|
40
42
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -59,9 +61,11 @@ module Twilio
|
|
59
61
|
# @param [Boolean] enabled Only show Composition Hooks that are enabled or
|
60
62
|
# disabled.
|
61
63
|
# @param [Time] date_created_after Only show Composition Hooks created on or after
|
62
|
-
# this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss
|
64
|
+
# this ISO8601 date-time with timezone, given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or
|
65
|
+
# `YYYY-MM-DDThh:mm:ssZ`.
|
63
66
|
# @param [Time] date_created_before Only show Composition Hooks created before
|
64
|
-
# this
|
67
|
+
# this ISO8601 date-time with timezone, given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or
|
68
|
+
# `YYYY-MM-DDThh:mm:ssZ`.
|
65
69
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
66
70
|
# guarantees to never return more than limit. Default is no limit.
|
67
71
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -102,9 +106,11 @@ module Twilio
|
|
102
106
|
# @param [Boolean] enabled Only show Composition Hooks that are enabled or
|
103
107
|
# disabled.
|
104
108
|
# @param [Time] date_created_after Only show Composition Hooks created on or after
|
105
|
-
# this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss
|
109
|
+
# this ISO8601 date-time with timezone, given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or
|
110
|
+
# `YYYY-MM-DDThh:mm:ssZ`.
|
106
111
|
# @param [Time] date_created_before Only show Composition Hooks created before
|
107
|
-
# this
|
112
|
+
# this ISO8601 date-time with timezone, given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or
|
113
|
+
# `YYYY-MM-DDThh:mm:ssZ`.
|
108
114
|
# @param [String] page_token PageToken provided by the API
|
109
115
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
110
116
|
# @param [Integer] page_size Number of records to return, defaults to 50
|
@@ -143,37 +149,40 @@ module Twilio
|
|
143
149
|
# Retrieve a single page of CompositionHookInstance records from the API.
|
144
150
|
# Request is executed immediately.
|
145
151
|
# @param [String] friendly_name Friendly name of the Composition Hook to be shown
|
146
|
-
# in the console.
|
147
|
-
# @param [Boolean] enabled
|
148
|
-
#
|
149
|
-
#
|
150
|
-
#
|
152
|
+
# in the console, must be unique per account and up to 100 characters.
|
153
|
+
# @param [Boolean] enabled Boolean flag indicating if the Composition Hook is
|
154
|
+
# active. Possible values are `true` or `false`. When `true`, the Composition Hook
|
155
|
+
# will be triggered for every completed Group Room on this account. When `false`,
|
156
|
+
# the Composition Hook never triggers.
|
151
157
|
# @param [Hash] video_layout A JSON object defining the video layout of the
|
152
158
|
# Composition Hook in terms of regions. See the section [Managing Video
|
153
159
|
# Layouts](#managing-video-layouts) below for further information.
|
154
160
|
# @param [String] audio_sources An array of audio sources to merge. All the
|
155
|
-
# specified sources must belong to the same Group Room. It can include
|
156
|
-
#
|
157
|
-
#
|
158
|
-
#
|
161
|
+
# specified sources must belong to the same Group Room. It can include zero or
|
162
|
+
# more Track names. These can be specified using wildcards (e.g. `student*`). The
|
163
|
+
# use of `[*]` has semantics "all if any" meaning zero or more (i.e. all)
|
164
|
+
# depending on whether the Group Room had audio tracks.
|
159
165
|
# @param [String] audio_sources_excluded An array of audio sources to exclude from
|
160
166
|
# the Composition Hook. Any new Composition triggered by the Composition Hook
|
161
167
|
# shall include all audio sources specified in `AudioSources` except for the ones
|
162
|
-
# specified in `AudioSourcesExcluded`. This parameter may include
|
163
|
-
#
|
164
|
-
#
|
165
|
-
# @param [String] resolution A string representing the numbers of pixels for rows
|
168
|
+
# specified in `AudioSourcesExcluded`. This parameter may include zero or more
|
169
|
+
# Track names. These can be specified using wildcards (e.g. `student*`).
|
170
|
+
# @param [String] resolution A string representing the number of pixels for rows
|
166
171
|
# (width) and columns (height) of the generated composed video. This string must
|
167
172
|
# have the format `{width}x{height}`. This parameter must comply with the
|
168
173
|
# following constraints:
|
174
|
+
#
|
169
175
|
# * `width >= 16 && width <= 1280`
|
170
176
|
# * `height >= 16 && height <= 1280`
|
171
177
|
# * `width * height <= 921,600`
|
178
|
+
#
|
172
179
|
# Typical values are:
|
180
|
+
#
|
173
181
|
# * HD = `1280x720`
|
174
182
|
# * PAL = `1024x576`
|
175
183
|
# * VGA = `640x480`
|
176
184
|
# * CIF = `320x240`
|
185
|
+
#
|
177
186
|
# Note that the `Resolution` implicitly imposes an aspect ratio to the resulting
|
178
187
|
# composition. When the original video tracks get constrained by this aspect ratio
|
179
188
|
# they are scaled-down to fit. You can find detailed information in the [Managing
|
@@ -299,25 +308,24 @@ module Twilio
|
|
299
308
|
##
|
300
309
|
# Update the CompositionHookInstance
|
301
310
|
# @param [String] friendly_name Friendly name of the Composition Hook to be shown
|
302
|
-
# in the console.
|
303
|
-
# @param [Boolean] enabled
|
304
|
-
#
|
305
|
-
#
|
306
|
-
#
|
311
|
+
# in the console, must be unique per account and up to 100 characters.
|
312
|
+
# @param [Boolean] enabled Boolean flag indicating if the Composition Hook is
|
313
|
+
# active. Possible values are `true` or `false`. When `true`, the Composition Hook
|
314
|
+
# will be triggered for every completed Group Room on this account. When `false`,
|
315
|
+
# the Composition Hook never triggers.
|
307
316
|
# @param [Hash] video_layout A JSON object defining the video layout of the
|
308
317
|
# Composition Hook in terms of regions. See the section [Managing Video
|
309
318
|
# Layouts](#managing-video-layouts) below for further information.
|
310
319
|
# @param [String] audio_sources An array of audio sources to merge. All the
|
311
|
-
# specified sources must belong to the same Group Room. It can include
|
312
|
-
#
|
313
|
-
#
|
314
|
-
#
|
320
|
+
# specified sources must belong to the same Group Room. It can include zero or
|
321
|
+
# more Track names. These can be specified using wildcards (e.g. `student*`). The
|
322
|
+
# use of `[*]` has semantics "all if any" meaning zero or more (i.e. all)
|
323
|
+
# depending on whether the Group Room had audio tracks.
|
315
324
|
# @param [String] audio_sources_excluded An array of audio sources to exclude from
|
316
325
|
# the Composition Hook. Any new Composition triggered by the Composition Hook
|
317
326
|
# shall include all audio sources specified in `AudioSources` except for the ones
|
318
|
-
# specified in `AudioSourcesExcluded`. This parameter may include
|
319
|
-
#
|
320
|
-
# `student*`)
|
327
|
+
# specified in `AudioSourcesExcluded`. This parameter may include zero or more
|
328
|
+
# Track names. These can be specified using wildcards (e.g. `student*`).
|
321
329
|
# @param [Boolean] trim When activated, clips all the intervals where there is no
|
322
330
|
# active media in the Compositions triggered by the Composition Hook. This results
|
323
331
|
# in shorter compositions in cases when the Room was created but no Participant
|
@@ -330,22 +338,16 @@ module Twilio
|
|
330
338
|
# `webm`. The use of `mp4` or `webm` makes mandatory the specification of
|
331
339
|
# `AudioSources` and/or one `VideoLayout` element containing a valid
|
332
340
|
# `video_sources` list, otherwise an error is fired. Defaults to `webm`.
|
333
|
-
# @param [String] resolution A string representing the
|
341
|
+
# @param [String] resolution A string representing the number of pixels for rows
|
334
342
|
# (width) and columns (height) of the generated composed video. This string must
|
335
343
|
# have the format `{width}x{height}`. This parameter must comply with the
|
336
|
-
# following constraints:
|
337
|
-
#
|
338
|
-
#
|
339
|
-
#
|
340
|
-
#
|
341
|
-
#
|
342
|
-
#
|
343
|
-
# * VGA = `640x480`
|
344
|
-
# * CIF = `320x240`
|
345
|
-
# Note that the `Resolution` implicitly imposes an aspect ratio to the resulting
|
346
|
-
# composition. When the original video tracks get constrained by this aspect ratio
|
347
|
-
# they are scaled-down to fit. You can find detailed information in the [Managing
|
348
|
-
# Video Layouts](#managing-video-layouts) section. Defaults to `640x480`.
|
344
|
+
# following constraints: `width >= 16 && width <= 1280`, `height >= 16 && height
|
345
|
+
# <= 1280`, `width * height <= 921,600`. Typical values are: HD = `1280x720`, PAL
|
346
|
+
# = `1024x576`, VGA = `640x480`, CIF = `320x240`. Note that the `Resolution`
|
347
|
+
# implicitly imposes an aspect ratio to the resulting composition. When the
|
348
|
+
# original video tracks get constrained by this aspect ratio they are scaled-down
|
349
|
+
# to fit. You can find detailed information in the [Managing Video
|
350
|
+
# Layouts](#managing-video-layouts) section. Defaults to `640x480`.
|
349
351
|
# @param [String] status_callback A URL that Twilio sends asynchronous webhook
|
350
352
|
# requests to on every composition event. If not provided, status callback events
|
351
353
|
# will not be dispatched.
|
@@ -444,7 +446,7 @@ module Twilio
|
|
444
446
|
end
|
445
447
|
|
446
448
|
##
|
447
|
-
# @return [Boolean] Boolean flag
|
449
|
+
# @return [Boolean] Boolean flag indicating if the Composition Hook is active.
|
448
450
|
def enabled
|
449
451
|
@properties['enabled']
|
450
452
|
end
|
@@ -504,13 +506,13 @@ module Twilio
|
|
504
506
|
end
|
505
507
|
|
506
508
|
##
|
507
|
-
# @return [String]
|
509
|
+
# @return [String] A URL that Twilio sends asynchronous webhook requests to on every composition event.
|
508
510
|
def status_callback
|
509
511
|
@properties['status_callback']
|
510
512
|
end
|
511
513
|
|
512
514
|
##
|
513
|
-
# @return [String]
|
515
|
+
# @return [String] HTTP method Twilio should use when requesting the above URL.
|
514
516
|
def status_callback_method
|
515
517
|
@properties['status_callback_method']
|
516
518
|
end
|
@@ -538,25 +540,24 @@ module Twilio
|
|
538
540
|
##
|
539
541
|
# Update the CompositionHookInstance
|
540
542
|
# @param [String] friendly_name Friendly name of the Composition Hook to be shown
|
541
|
-
# in the console.
|
542
|
-
# @param [Boolean] enabled
|
543
|
-
#
|
544
|
-
#
|
545
|
-
#
|
543
|
+
# in the console, must be unique per account and up to 100 characters.
|
544
|
+
# @param [Boolean] enabled Boolean flag indicating if the Composition Hook is
|
545
|
+
# active. Possible values are `true` or `false`. When `true`, the Composition Hook
|
546
|
+
# will be triggered for every completed Group Room on this account. When `false`,
|
547
|
+
# the Composition Hook never triggers.
|
546
548
|
# @param [Hash] video_layout A JSON object defining the video layout of the
|
547
549
|
# Composition Hook in terms of regions. See the section [Managing Video
|
548
550
|
# Layouts](#managing-video-layouts) below for further information.
|
549
551
|
# @param [String] audio_sources An array of audio sources to merge. All the
|
550
|
-
# specified sources must belong to the same Group Room. It can include
|
551
|
-
#
|
552
|
-
#
|
553
|
-
#
|
552
|
+
# specified sources must belong to the same Group Room. It can include zero or
|
553
|
+
# more Track names. These can be specified using wildcards (e.g. `student*`). The
|
554
|
+
# use of `[*]` has semantics "all if any" meaning zero or more (i.e. all)
|
555
|
+
# depending on whether the Group Room had audio tracks.
|
554
556
|
# @param [String] audio_sources_excluded An array of audio sources to exclude from
|
555
557
|
# the Composition Hook. Any new Composition triggered by the Composition Hook
|
556
558
|
# shall include all audio sources specified in `AudioSources` except for the ones
|
557
|
-
# specified in `AudioSourcesExcluded`. This parameter may include
|
558
|
-
#
|
559
|
-
# `student*`)
|
559
|
+
# specified in `AudioSourcesExcluded`. This parameter may include zero or more
|
560
|
+
# Track names. These can be specified using wildcards (e.g. `student*`).
|
560
561
|
# @param [Boolean] trim When activated, clips all the intervals where there is no
|
561
562
|
# active media in the Compositions triggered by the Composition Hook. This results
|
562
563
|
# in shorter compositions in cases when the Room was created but no Participant
|
@@ -569,22 +570,16 @@ module Twilio
|
|
569
570
|
# `webm`. The use of `mp4` or `webm` makes mandatory the specification of
|
570
571
|
# `AudioSources` and/or one `VideoLayout` element containing a valid
|
571
572
|
# `video_sources` list, otherwise an error is fired. Defaults to `webm`.
|
572
|
-
# @param [String] resolution A string representing the
|
573
|
+
# @param [String] resolution A string representing the number of pixels for rows
|
573
574
|
# (width) and columns (height) of the generated composed video. This string must
|
574
575
|
# have the format `{width}x{height}`. This parameter must comply with the
|
575
|
-
# following constraints:
|
576
|
-
#
|
577
|
-
#
|
578
|
-
#
|
579
|
-
#
|
580
|
-
#
|
581
|
-
#
|
582
|
-
# * VGA = `640x480`
|
583
|
-
# * CIF = `320x240`
|
584
|
-
# Note that the `Resolution` implicitly imposes an aspect ratio to the resulting
|
585
|
-
# composition. When the original video tracks get constrained by this aspect ratio
|
586
|
-
# they are scaled-down to fit. You can find detailed information in the [Managing
|
587
|
-
# Video Layouts](#managing-video-layouts) section. Defaults to `640x480`.
|
576
|
+
# following constraints: `width >= 16 && width <= 1280`, `height >= 16 && height
|
577
|
+
# <= 1280`, `width * height <= 921,600`. Typical values are: HD = `1280x720`, PAL
|
578
|
+
# = `1024x576`, VGA = `640x480`, CIF = `320x240`. Note that the `Resolution`
|
579
|
+
# implicitly imposes an aspect ratio to the resulting composition. When the
|
580
|
+
# original video tracks get constrained by this aspect ratio they are scaled-down
|
581
|
+
# to fit. You can find detailed information in the [Managing Video
|
582
|
+
# Layouts](#managing-video-layouts) section. Defaults to `640x480`.
|
588
583
|
# @param [String] status_callback A URL that Twilio sends asynchronous webhook
|
589
584
|
# requests to on every composition event. If not provided, status callback events
|
590
585
|
# will not be dispatched.
|
@@ -33,9 +33,11 @@ module Twilio
|
|
33
33
|
# @param [String] grouping_sid Only show Recordings that have this GroupingSid,
|
34
34
|
# which may include a ParticipantSid and/or a RoomSid.
|
35
35
|
# @param [Time] date_created_after Only show Recordings that started on or after
|
36
|
-
# this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss
|
36
|
+
# this ISO8601 date-time with timezone, given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or
|
37
|
+
# `YYYY-MM-DDThh:mm:ssZ`.
|
37
38
|
# @param [Time] date_created_before Only show Recordings that started before this
|
38
|
-
#
|
39
|
+
# ISO8601 date-time with timezone, given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or
|
40
|
+
# `YYYY-MM-DDThh:mm:ssZ`.
|
39
41
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
40
42
|
# guarantees to never return more than limit. Default is no limit
|
41
43
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -65,9 +67,11 @@ module Twilio
|
|
65
67
|
# @param [String] grouping_sid Only show Recordings that have this GroupingSid,
|
66
68
|
# which may include a ParticipantSid and/or a RoomSid.
|
67
69
|
# @param [Time] date_created_after Only show Recordings that started on or after
|
68
|
-
# this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss
|
70
|
+
# this ISO8601 date-time with timezone, given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or
|
71
|
+
# `YYYY-MM-DDThh:mm:ssZ`.
|
69
72
|
# @param [Time] date_created_before Only show Recordings that started before this
|
70
|
-
#
|
73
|
+
# ISO8601 date-time with timezone, given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or
|
74
|
+
# `YYYY-MM-DDThh:mm:ssZ`.
|
71
75
|
# @param [Integer] limit Upper limit for the number of records to return. stream()
|
72
76
|
# guarantees to never return more than limit. Default is no limit.
|
73
77
|
# @param [Integer] page_size Number of records to fetch per request, when
|
@@ -113,9 +117,11 @@ module Twilio
|
|
113
117
|
# @param [String] grouping_sid Only show Recordings that have this GroupingSid,
|
114
118
|
# which may include a ParticipantSid and/or a RoomSid.
|
115
119
|
# @param [Time] date_created_after Only show Recordings that started on or after
|
116
|
-
# this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss
|
120
|
+
# this ISO8601 date-time with timezone, given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or
|
121
|
+
# `YYYY-MM-DDThh:mm:ssZ`.
|
117
122
|
# @param [Time] date_created_before Only show Recordings that started before this
|
118
|
-
#
|
123
|
+
# ISO8601 date-time with timezone, given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or
|
124
|
+
# `YYYY-MM-DDThh:mm:ssZ`.
|
119
125
|
# @param [String] page_token PageToken provided by the API
|
120
126
|
# @param [Integer] page_number Page Number, this value is simply for client state
|
121
127
|
# @param [Integer] page_size Number of records to return, defaults to 50
|
@@ -358,7 +364,7 @@ module Twilio
|
|
358
364
|
end
|
359
365
|
|
360
366
|
##
|
361
|
-
# @return [String] Offset in
|
367
|
+
# @return [String] Offset in milliseconds for this track.
|
362
368
|
def offset
|
363
369
|
@properties['offset']
|
364
370
|
end
|