twilio-ruby 5.52.0 → 5.56.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.
Files changed (48) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop_todo.yml +7 -7
  3. data/.travis.yml +22 -28
  4. data/CHANGES.md +85 -0
  5. data/README.md +10 -2
  6. data/lib/twilio-ruby.rb +5 -15
  7. data/lib/twilio-ruby/framework/{domain.rb → rest/domain.rb} +0 -0
  8. data/lib/twilio-ruby/framework/{error.rb → rest/error.rb} +0 -0
  9. data/lib/twilio-ruby/framework/{helper.rb → rest/helper.rb} +0 -0
  10. data/lib/twilio-ruby/framework/{obsolete_client.rb → rest/obsolete_client.rb} +0 -0
  11. data/lib/twilio-ruby/framework/{page.rb → rest/page.rb} +0 -0
  12. data/lib/twilio-ruby/framework/{resource.rb → rest/resource.rb} +0 -0
  13. data/lib/twilio-ruby/framework/{version.rb → rest/version.rb} +0 -0
  14. data/lib/twilio-ruby/http.rb +5 -0
  15. data/lib/twilio-ruby/http/http_client.rb +14 -2
  16. data/lib/twilio-ruby/rest.rb +13 -0
  17. data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb +23 -23
  18. data/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb +5 -5
  19. data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +8 -7
  20. data/lib/twilio-ruby/rest/api/v2010/account/message.rb +2 -2
  21. data/lib/twilio-ruby/rest/bulkexports/v1/export.rb +0 -8
  22. data/lib/twilio-ruby/rest/bulkexports/v1/export/day.rb +0 -8
  23. data/lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb +0 -6
  24. data/lib/twilio-ruby/rest/bulkexports/v1/export/job.rb +0 -8
  25. data/lib/twilio-ruby/rest/bulkexports/v1/export_configuration.rb +0 -8
  26. data/lib/twilio-ruby/rest/client.rb +7 -0
  27. data/lib/twilio-ruby/rest/conversations/v1/conversation.rb +7 -0
  28. data/lib/twilio-ruby/rest/conversations/v1/service/conversation.rb +7 -0
  29. data/lib/twilio-ruby/rest/events/v1/event_type.rb +12 -5
  30. data/lib/twilio-ruby/rest/events/v1/sink.rb +41 -5
  31. data/lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb +28 -22
  32. data/lib/twilio-ruby/rest/frontline_api.rb +47 -0
  33. data/lib/twilio-ruby/rest/frontline_api/v1.rb +45 -0
  34. data/lib/twilio-ruby/rest/frontline_api/v1/user.rb +233 -0
  35. data/lib/twilio-ruby/rest/messaging/v1/external_campaign.rb +7 -0
  36. data/lib/twilio-ruby/rest/messaging/v1/service.rb +8 -2
  37. data/lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb +178 -18
  38. data/lib/twilio-ruby/rest/studio/v1/flow/execution.rb +1 -1
  39. data/lib/twilio-ruby/rest/studio/v2/flow/execution.rb +1 -1
  40. data/lib/twilio-ruby/rest/supersim/v1/sim.rb +30 -1
  41. data/lib/twilio-ruby/rest/supersim/v1/sim/billing_period.rb +231 -0
  42. data/lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb +16 -7
  43. data/lib/twilio-ruby/rest/verify/v2/service/entity/challenge/notification.rb +6 -7
  44. data/lib/twilio-ruby/rest/verify/v2/service/entity/new_factor.rb +43 -18
  45. data/lib/twilio-ruby/rest/video/v1/composition.rb +0 -8
  46. data/lib/twilio-ruby/rest/video/v1/composition_hook.rb +0 -8
  47. data/lib/twilio-ruby/version.rb +1 -1
  48. metadata +15 -9
@@ -107,8 +107,8 @@ module Twilio
107
107
  # `POST`.
108
108
  # @param [Array[String]] conference_status_callback_event The conference state
109
109
  # changes that should generate a call to `conference_status_callback`. Can be:
110
- # `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`, and `announcement`.
111
- # Separate multiple values with a space. Defaults to `start end`.
110
+ # `start`, `end`, `join`, `leave`, `mute`, `hold`, `modify`, `speaker`, and
111
+ # `announcement`. Separate multiple values with a space. Defaults to `start end`.
112
112
  # @param [String] recording_channels The recording channels for the final
113
113
  # recording. Can be: `mono` or `dual` and the default is `mono`.
114
114
  # @param [String] recording_status_callback The URL that we should call using the
@@ -130,13 +130,14 @@ module Twilio
130
130
  # `POST` and defaults to `POST`.
131
131
  # @param [Array[String]] recording_status_callback_event The recording state
132
132
  # changes that should generate a call to `recording_status_callback`. Can be:
133
- # `in-progress`, `completed`, and `failed`. Separate multiple values with a space.
134
- # The default value is `in-progress completed failed`.
133
+ # `started`, `in-progress`, `paused`, `resumed`, `stopped`, `completed`, `failed`,
134
+ # and `absent`. Separate multiple values with a space, ex: `'in-progress completed
135
+ # failed'`.
135
136
  # @param [Array[String]] conference_recording_status_callback_event The conference
136
137
  # recording state changes that generate a call to
137
- # `conference_recording_status_callback`. Can be: `in-progress`, `completed`, and
138
- # `failed`. Separate multiple values with a space. The default value is
139
- # `in-progress completed failed`.
138
+ # `conference_recording_status_callback`. Can be: `in-progress`, `completed`,
139
+ # `failed`, and `absent`. Separate multiple values with a space, ex: `'in-progress
140
+ # completed failed'`
140
141
  # @param [Boolean] coaching Whether the participant is coaching another call. Can
141
142
  # be: `true` or `false`. If not present, defaults to `false` unless
142
143
  # `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined.
@@ -330,7 +330,7 @@ module Twilio
330
330
  # @param [String] body The text of the message you want to send. Can be up to
331
331
  # 1,600 characters long.
332
332
  # @return [MessageInstance] Updated MessageInstance
333
- def update(body: nil)
333
+ def update(body: :unset)
334
334
  data = Twilio::Values.of({'Body' => body, })
335
335
 
336
336
  payload = @version.update('POST', @uri, data: data)
@@ -580,7 +580,7 @@ module Twilio
580
580
  # @param [String] body The text of the message you want to send. Can be up to
581
581
  # 1,600 characters long.
582
582
  # @return [MessageInstance] Updated MessageInstance
583
- def update(body: nil)
583
+ def update(body: :unset)
584
584
  context.update(body: body, )
585
585
  end
586
586
 
@@ -10,8 +10,6 @@ module Twilio
10
10
  module REST
11
11
  class Bulkexports < Domain
12
12
  class V1 < Version
13
- ##
14
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
15
13
  class ExportList < ListResource
16
14
  ##
17
15
  # Initialize the ExportList
@@ -50,8 +48,6 @@ module Twilio
50
48
  end
51
49
  end
52
50
 
53
- ##
54
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
55
51
  class ExportPage < Page
56
52
  ##
57
53
  # Initialize the ExportPage
@@ -81,8 +77,6 @@ module Twilio
81
77
  end
82
78
  end
83
79
 
84
- ##
85
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
86
80
  class ExportContext < InstanceContext
87
81
  ##
88
82
  # Initialize the ExportContext
@@ -156,8 +150,6 @@ module Twilio
156
150
  end
157
151
  end
158
152
 
159
- ##
160
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
161
153
  class ExportInstance < InstanceResource
162
154
  ##
163
155
  # Initialize the ExportInstance
@@ -11,8 +11,6 @@ module Twilio
11
11
  class Bulkexports < Domain
12
12
  class V1 < Version
13
13
  class ExportContext < InstanceContext
14
- ##
15
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
16
14
  class DayList < ListResource
17
15
  ##
18
16
  # Initialize the DayList
@@ -115,8 +113,6 @@ module Twilio
115
113
  end
116
114
  end
117
115
 
118
- ##
119
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
120
116
  class DayPage < Page
121
117
  ##
122
118
  # Initialize the DayPage
@@ -146,8 +142,6 @@ module Twilio
146
142
  end
147
143
  end
148
144
 
149
- ##
150
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
151
145
  class DayContext < InstanceContext
152
146
  ##
153
147
  # Initialize the DayContext
@@ -189,8 +183,6 @@ module Twilio
189
183
  end
190
184
  end
191
185
 
192
- ##
193
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
194
186
  class DayInstance < InstanceResource
195
187
  ##
196
188
  # Initialize the DayInstance
@@ -11,8 +11,6 @@ module Twilio
11
11
  class Bulkexports < Domain
12
12
  class V1 < Version
13
13
  class ExportContext < InstanceContext
14
- ##
15
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
16
14
  class ExportCustomJobList < ListResource
17
15
  ##
18
16
  # Initialize the ExportCustomJobList
@@ -147,8 +145,6 @@ module Twilio
147
145
  end
148
146
  end
149
147
 
150
- ##
151
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
152
148
  class ExportCustomJobPage < Page
153
149
  ##
154
150
  # Initialize the ExportCustomJobPage
@@ -178,8 +174,6 @@ module Twilio
178
174
  end
179
175
  end
180
176
 
181
- ##
182
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
183
177
  class ExportCustomJobInstance < InstanceResource
184
178
  ##
185
179
  # Initialize the ExportCustomJobInstance
@@ -11,8 +11,6 @@ module Twilio
11
11
  class Bulkexports < Domain
12
12
  class V1 < Version
13
13
  class ExportList < ListResource
14
- ##
15
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
16
14
  class JobList < ListResource
17
15
  ##
18
16
  # Initialize the JobList
@@ -32,8 +30,6 @@ module Twilio
32
30
  end
33
31
  end
34
32
 
35
- ##
36
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
37
33
  class JobPage < Page
38
34
  ##
39
35
  # Initialize the JobPage
@@ -63,8 +59,6 @@ module Twilio
63
59
  end
64
60
  end
65
61
 
66
- ##
67
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
68
62
  class JobContext < InstanceContext
69
63
  ##
70
64
  # Initialize the JobContext
@@ -111,8 +105,6 @@ module Twilio
111
105
  end
112
106
  end
113
107
 
114
- ##
115
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
116
108
  class JobInstance < InstanceResource
117
109
  ##
118
110
  # Initialize the JobInstance
@@ -10,8 +10,6 @@ module Twilio
10
10
  module REST
11
11
  class Bulkexports < Domain
12
12
  class V1 < Version
13
- ##
14
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
15
13
  class ExportConfigurationList < ListResource
16
14
  ##
17
15
  # Initialize the ExportConfigurationList
@@ -31,8 +29,6 @@ module Twilio
31
29
  end
32
30
  end
33
31
 
34
- ##
35
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
36
32
  class ExportConfigurationPage < Page
37
33
  ##
38
34
  # Initialize the ExportConfigurationPage
@@ -62,8 +58,6 @@ module Twilio
62
58
  end
63
59
  end
64
60
 
65
- ##
66
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
67
61
  class ExportConfigurationContext < InstanceContext
68
62
  ##
69
63
  # Initialize the ExportConfigurationContext
@@ -125,8 +119,6 @@ module Twilio
125
119
  end
126
120
  end
127
121
 
128
- ##
129
- # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
130
122
  class ExportConfigurationInstance < InstanceResource
131
123
  ##
132
124
  # Initialize the ExportConfigurationInstance
@@ -37,6 +37,7 @@ module Twilio
37
37
  @events = nil
38
38
  @fax = nil
39
39
  @flex_api = nil
40
+ @frontline_api = nil
40
41
  @insights = nil
41
42
  @ip_messaging = nil
42
43
  @lookups = nil
@@ -206,6 +207,12 @@ module Twilio
206
207
  @flex_api ||= FlexApi.new self
207
208
  end
208
209
 
210
+ ##
211
+ # Access the FrontlineApi Twilio Domain
212
+ def frontline_api
213
+ @frontline_api ||= FrontlineApi.new self
214
+ end
215
+
209
216
  ##
210
217
  # Access the Insights Twilio Domain
211
218
  def insights
@@ -362,6 +362,7 @@ module Twilio
362
362
  'timers' => payload['timers'],
363
363
  'url' => payload['url'],
364
364
  'links' => payload['links'],
365
+ 'bindings' => payload['bindings'],
365
366
  }
366
367
 
367
368
  # Context
@@ -458,6 +459,12 @@ module Twilio
458
459
  @properties['links']
459
460
  end
460
461
 
462
+ ##
463
+ # @return [Hash] The bindings
464
+ def bindings
465
+ @properties['bindings']
466
+ end
467
+
461
468
  ##
462
469
  # Update the ConversationInstance
463
470
  # @param [String] friendly_name The human-readable name of this conversation,
@@ -394,6 +394,7 @@ module Twilio
394
394
  'timers' => payload['timers'],
395
395
  'url' => payload['url'],
396
396
  'links' => payload['links'],
397
+ 'bindings' => payload['bindings'],
397
398
  }
398
399
 
399
400
  # Context
@@ -490,6 +491,12 @@ module Twilio
490
491
  @properties['links']
491
492
  end
492
493
 
494
+ ##
495
+ # @return [Hash] The bindings
496
+ def bindings
497
+ @properties['bindings']
498
+ end
499
+
493
500
  ##
494
501
  # Update the ConversationInstance
495
502
  # @param [String] friendly_name The human-readable name of this conversation,
@@ -29,6 +29,8 @@ module Twilio
29
29
  # Lists EventTypeInstance 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 [String] schema_id A string parameter filtering the results to return
33
+ # only the Event Types using a given schema.
32
34
  # @param [Integer] limit Upper limit for the number of records to return. stream()
33
35
  # guarantees to never return more than limit. Default is no limit
34
36
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -36,14 +38,16 @@ module Twilio
36
38
  # but a limit is defined, stream() will attempt to read the limit with the most
37
39
  # efficient page size, i.e. min(limit, 1000)
38
40
  # @return [Array] Array of up to limit results
39
- def list(limit: nil, page_size: nil)
40
- self.stream(limit: limit, page_size: page_size).entries
41
+ def list(schema_id: :unset, limit: nil, page_size: nil)
42
+ self.stream(schema_id: schema_id, limit: limit, page_size: page_size).entries
41
43
  end
42
44
 
43
45
  ##
44
46
  # Streams EventTypeInstance records from the API as an Enumerable.
45
47
  # This operation lazily loads records as efficiently as possible until the limit
46
48
  # is reached.
49
+ # @param [String] schema_id A string parameter filtering the results to return
50
+ # only the Event Types using a given schema.
47
51
  # @param [Integer] limit Upper limit for the number of records to return. stream()
48
52
  # guarantees to never return more than limit. Default is no limit.
49
53
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -51,10 +55,10 @@ module Twilio
51
55
  # but a limit is defined, stream() will attempt to read the limit with the most
52
56
  # efficient page size, i.e. min(limit, 1000)
53
57
  # @return [Enumerable] Enumerable that will yield up to limit results
54
- def stream(limit: nil, page_size: nil)
58
+ def stream(schema_id: :unset, limit: nil, page_size: nil)
55
59
  limits = @version.read_limits(limit, page_size)
56
60
 
57
- page = self.page(page_size: limits[:page_size], )
61
+ page = self.page(schema_id: schema_id, page_size: limits[:page_size], )
58
62
 
59
63
  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
60
64
  end
@@ -76,12 +80,15 @@ module Twilio
76
80
  ##
77
81
  # Retrieve a single page of EventTypeInstance records from the API.
78
82
  # Request is executed immediately.
83
+ # @param [String] schema_id A string parameter filtering the results to return
84
+ # only the Event Types using a given schema.
79
85
  # @param [String] page_token PageToken provided by the API
80
86
  # @param [Integer] page_number Page Number, this value is simply for client state
81
87
  # @param [Integer] page_size Number of records to return, defaults to 50
82
88
  # @return [Page] Page of EventTypeInstance
83
- def page(page_token: :unset, page_number: :unset, page_size: :unset)
89
+ def page(schema_id: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
84
90
  params = Twilio::Values.of({
91
+ 'SchemaId' => schema_id,
85
92
  'PageToken' => page_token,
86
93
  'Page' => page_number,
87
94
  'PageSize' => page_size,
@@ -50,6 +50,10 @@ module Twilio
50
50
  # Lists SinkInstance records from the API as a list.
51
51
  # Unlike stream(), this operation is eager and will load `limit` records into
52
52
  # memory before returning.
53
+ # @param [Boolean] in_use A boolean query parameter filtering the results to
54
+ # return sinks used/not used by a subscription.
55
+ # @param [String] status A String query parameter filtering the results by status
56
+ # `initialized`, `validating`, `active` or `failed`.
53
57
  # @param [Integer] limit Upper limit for the number of records to return. stream()
54
58
  # guarantees to never return more than limit. Default is no limit
55
59
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -57,14 +61,18 @@ module Twilio
57
61
  # but a limit is defined, stream() will attempt to read the limit with the most
58
62
  # efficient page size, i.e. min(limit, 1000)
59
63
  # @return [Array] Array of up to limit results
60
- def list(limit: nil, page_size: nil)
61
- self.stream(limit: limit, page_size: page_size).entries
64
+ def list(in_use: :unset, status: :unset, limit: nil, page_size: nil)
65
+ self.stream(in_use: in_use, status: status, limit: limit, page_size: page_size).entries
62
66
  end
63
67
 
64
68
  ##
65
69
  # Streams SinkInstance records from the API as an Enumerable.
66
70
  # This operation lazily loads records as efficiently as possible until the limit
67
71
  # is reached.
72
+ # @param [Boolean] in_use A boolean query parameter filtering the results to
73
+ # return sinks used/not used by a subscription.
74
+ # @param [String] status A String query parameter filtering the results by status
75
+ # `initialized`, `validating`, `active` or `failed`.
68
76
  # @param [Integer] limit Upper limit for the number of records to return. stream()
69
77
  # guarantees to never return more than limit. Default is no limit.
70
78
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -72,10 +80,10 @@ module Twilio
72
80
  # but a limit is defined, stream() will attempt to read the limit with the most
73
81
  # efficient page size, i.e. min(limit, 1000)
74
82
  # @return [Enumerable] Enumerable that will yield up to limit results
75
- def stream(limit: nil, page_size: nil)
83
+ def stream(in_use: :unset, status: :unset, limit: nil, page_size: nil)
76
84
  limits = @version.read_limits(limit, page_size)
77
85
 
78
- page = self.page(page_size: limits[:page_size], )
86
+ page = self.page(in_use: in_use, status: status, page_size: limits[:page_size], )
79
87
 
80
88
  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
81
89
  end
@@ -97,12 +105,18 @@ module Twilio
97
105
  ##
98
106
  # Retrieve a single page of SinkInstance records from the API.
99
107
  # Request is executed immediately.
108
+ # @param [Boolean] in_use A boolean query parameter filtering the results to
109
+ # return sinks used/not used by a subscription.
110
+ # @param [String] status A String query parameter filtering the results by status
111
+ # `initialized`, `validating`, `active` or `failed`.
100
112
  # @param [String] page_token PageToken provided by the API
101
113
  # @param [Integer] page_number Page Number, this value is simply for client state
102
114
  # @param [Integer] page_size Number of records to return, defaults to 50
103
115
  # @return [Page] Page of SinkInstance
104
- def page(page_token: :unset, page_number: :unset, page_size: :unset)
116
+ def page(in_use: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
105
117
  params = Twilio::Values.of({
118
+ 'InUse' => in_use,
119
+ 'Status' => status,
106
120
  'PageToken' => page_token,
107
121
  'Page' => page_number,
108
122
  'PageSize' => page_size,
@@ -200,6 +214,19 @@ module Twilio
200
214
  @version.delete('DELETE', @uri)
201
215
  end
202
216
 
217
+ ##
218
+ # Update the SinkInstance
219
+ # @param [String] description A human readable description for the Sink **This
220
+ # value should not contain PII.**
221
+ # @return [SinkInstance] Updated SinkInstance
222
+ def update(description: nil)
223
+ data = Twilio::Values.of({'Description' => description, })
224
+
225
+ payload = @version.update('POST', @uri, data: data)
226
+
227
+ SinkInstance.new(@version, payload, sid: @solution[:sid], )
228
+ end
229
+
203
230
  ##
204
231
  # Access the sink_test
205
232
  # @return [SinkTestList]
@@ -348,6 +375,15 @@ module Twilio
348
375
  context.delete
349
376
  end
350
377
 
378
+ ##
379
+ # Update the SinkInstance
380
+ # @param [String] description A human readable description for the Sink **This
381
+ # value should not contain PII.**
382
+ # @return [SinkInstance] Updated SinkInstance
383
+ def update(description: nil)
384
+ context.update(description: description, )
385
+ end
386
+
351
387
  ##
352
388
  # Access the sink_test
353
389
  # @return [sink_test] sink_test
@@ -119,8 +119,10 @@ module Twilio
119
119
  # `facebook`, `sms`, `whatsapp`, `line` or `custom`.
120
120
  # @param [String] contact_identity The channel contact's Identity.
121
121
  # @param [Boolean] enabled Whether the new Flex Flow is enabled.
122
- # @param [flex_flow.IntegrationType] integration_type The integration type. Can
123
- # be: `studio`, `external`, or `task`.
122
+ # @param [flex_flow.IntegrationType] integration_type The software that will
123
+ # handle inbound messages. {Integration
124
+ # Type}[https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types]
125
+ # can be: `studio`, `external`, or `task`.
124
126
  # @param [String] integration_flow_sid The SID of the Studio Flow. Required when
125
127
  # `integrationType` is `studio`.
126
128
  # @param [String] integration_url The URL of the external webhook. Required when
@@ -129,9 +131,9 @@ module Twilio
129
131
  # Required when `integrationType` is `task`.
130
132
  # @param [String] integration_workflow_sid The Workflow SID for a new Task.
131
133
  # Required when `integrationType` is `task`.
132
- # @param [String] integration_channel The Task Channel for the TaskRouter Task
133
- # that will be created. Applicable and required when integrationType is `task`.
134
- # Set to `sms` for SMS, and to `chat` otherwise. The default value is `default`
134
+ # @param [String] integration_channel The Task Channel SID (TCXXXX) or unique name
135
+ # (e.g., `sms`) to use for the Task that will be created. Applicable and required
136
+ # when `integrationType` is `task`. The default value is `default`.
135
137
  # @param [String] integration_timeout The Task timeout in seconds for a new Task.
136
138
  # Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`,
137
139
  # not applicable otherwise.
@@ -150,8 +152,8 @@ module Twilio
150
152
  # will remove active Proxy sessions if the associated Task is deleted outside of
151
153
  # the Flex UI. Defaults to `false`.
152
154
  # @param [String] integration_retry_count The number of times to retry the webhook
153
- # if the first attempt fails. Can be an integer between 0 and 3 (included),
154
- # default is 0. Optional when integrationType is `external`, not applicable
155
+ # if the first attempt fails. Can be an integer between 0 and 3 (inclusive),
156
+ # default is 3. Optional when `integrationType` is `external`, not applicable
155
157
  # otherwise.
156
158
  # @return [FlexFlowInstance] Created FlexFlowInstance
157
159
  def create(friendly_name: nil, chat_service_sid: nil, channel_type: nil, contact_identity: :unset, enabled: :unset, integration_type: :unset, integration_flow_sid: :unset, integration_url: :unset, integration_workspace_sid: :unset, integration_workflow_sid: :unset, integration_channel: :unset, integration_timeout: :unset, integration_priority: :unset, integration_creation_on_message: :unset, long_lived: :unset, janitor_enabled: :unset, integration_retry_count: :unset)
@@ -248,8 +250,10 @@ module Twilio
248
250
  # `facebook`, `sms`, `whatsapp`, `line` or `custom`.
249
251
  # @param [String] contact_identity The channel contact's Identity.
250
252
  # @param [Boolean] enabled Whether the new Flex Flow is enabled.
251
- # @param [flex_flow.IntegrationType] integration_type The integration type. Can
252
- # be: `studio`, `external`, or `task`.
253
+ # @param [flex_flow.IntegrationType] integration_type The software that will
254
+ # handle inbound messages. {Integration
255
+ # Type}[https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types]
256
+ # can be: `studio`, `external`, or `task`.
253
257
  # @param [String] integration_flow_sid The SID of the Studio Flow. Required when
254
258
  # `integrationType` is `studio`.
255
259
  # @param [String] integration_url The URL of the external webhook. Required when
@@ -258,9 +262,9 @@ module Twilio
258
262
  # Required when `integrationType` is `task`.
259
263
  # @param [String] integration_workflow_sid The Workflow SID for a new Task.
260
264
  # Required when `integrationType` is `task`.
261
- # @param [String] integration_channel The Task Channel for the TaskRouter Task
262
- # that will be created. Applicable and required when integrationType is `task`.
263
- # Set to `sms` for SMS, and to `chat` otherwise. The default value is `default`
265
+ # @param [String] integration_channel The Task Channel SID (TCXXXX) or unique name
266
+ # (e.g., `sms`) to use for the Task that will be created. Applicable and required
267
+ # when `integrationType` is `task`. The default value is `default`.
264
268
  # @param [String] integration_timeout The Task timeout in seconds for a new Task.
265
269
  # Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`,
266
270
  # not applicable otherwise.
@@ -279,8 +283,8 @@ module Twilio
279
283
  # will remove active Proxy sessions if the associated Task is deleted outside of
280
284
  # the Flex UI. Defaults to `false`.
281
285
  # @param [String] integration_retry_count The number of times to retry the webhook
282
- # if the first attempt fails. Can be an integer between 0 and 3 (included),
283
- # default is 0. Optional when integrationType is `external`, not applicable
286
+ # if the first attempt fails. Can be an integer between 0 and 3 (inclusive),
287
+ # default is 3. Optional when `integrationType` is `external`, not applicable
284
288
  # otherwise.
285
289
  # @return [FlexFlowInstance] Updated FlexFlowInstance
286
290
  def update(friendly_name: :unset, chat_service_sid: :unset, channel_type: :unset, contact_identity: :unset, enabled: :unset, integration_type: :unset, integration_flow_sid: :unset, integration_url: :unset, integration_workspace_sid: :unset, integration_workflow_sid: :unset, integration_channel: :unset, integration_timeout: :unset, integration_priority: :unset, integration_creation_on_message: :unset, long_lived: :unset, janitor_enabled: :unset, integration_retry_count: :unset)
@@ -430,7 +434,7 @@ module Twilio
430
434
  end
431
435
 
432
436
  ##
433
- # @return [flex_flow.IntegrationType] The integration type
437
+ # @return [flex_flow.IntegrationType] The software that will handle inbound messages.
434
438
  def integration_type
435
439
  @properties['integration_type']
436
440
  end
@@ -475,8 +479,10 @@ module Twilio
475
479
  # `facebook`, `sms`, `whatsapp`, `line` or `custom`.
476
480
  # @param [String] contact_identity The channel contact's Identity.
477
481
  # @param [Boolean] enabled Whether the new Flex Flow is enabled.
478
- # @param [flex_flow.IntegrationType] integration_type The integration type. Can
479
- # be: `studio`, `external`, or `task`.
482
+ # @param [flex_flow.IntegrationType] integration_type The software that will
483
+ # handle inbound messages. {Integration
484
+ # Type}[https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types]
485
+ # can be: `studio`, `external`, or `task`.
480
486
  # @param [String] integration_flow_sid The SID of the Studio Flow. Required when
481
487
  # `integrationType` is `studio`.
482
488
  # @param [String] integration_url The URL of the external webhook. Required when
@@ -485,9 +491,9 @@ module Twilio
485
491
  # Required when `integrationType` is `task`.
486
492
  # @param [String] integration_workflow_sid The Workflow SID for a new Task.
487
493
  # Required when `integrationType` is `task`.
488
- # @param [String] integration_channel The Task Channel for the TaskRouter Task
489
- # that will be created. Applicable and required when integrationType is `task`.
490
- # Set to `sms` for SMS, and to `chat` otherwise. The default value is `default`
494
+ # @param [String] integration_channel The Task Channel SID (TCXXXX) or unique name
495
+ # (e.g., `sms`) to use for the Task that will be created. Applicable and required
496
+ # when `integrationType` is `task`. The default value is `default`.
491
497
  # @param [String] integration_timeout The Task timeout in seconds for a new Task.
492
498
  # Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`,
493
499
  # not applicable otherwise.
@@ -506,8 +512,8 @@ module Twilio
506
512
  # will remove active Proxy sessions if the associated Task is deleted outside of
507
513
  # the Flex UI. Defaults to `false`.
508
514
  # @param [String] integration_retry_count The number of times to retry the webhook
509
- # if the first attempt fails. Can be an integer between 0 and 3 (included),
510
- # default is 0. Optional when integrationType is `external`, not applicable
515
+ # if the first attempt fails. Can be an integer between 0 and 3 (inclusive),
516
+ # default is 3. Optional when `integrationType` is `external`, not applicable
511
517
  # otherwise.
512
518
  # @return [FlexFlowInstance] Updated FlexFlowInstance
513
519
  def update(friendly_name: :unset, chat_service_sid: :unset, channel_type: :unset, contact_identity: :unset, enabled: :unset, integration_type: :unset, integration_flow_sid: :unset, integration_url: :unset, integration_workspace_sid: :unset, integration_workflow_sid: :unset, integration_channel: :unset, integration_timeout: :unset, integration_priority: :unset, integration_creation_on_message: :unset, long_lived: :unset, janitor_enabled: :unset, integration_retry_count: :unset)