twilio-ruby 5.40.2 → 5.40.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGES.md +15 -0
- data/README.md +2 -2
- data/lib/twilio-ruby/framework/version.rb +2 -1
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb +12 -3
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/machine_to_machine.rb +12 -3
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/mobile.rb +12 -3
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/national.rb +12 -3
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/shared_cost.rb +12 -3
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/toll_free.rb +12 -3
- data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/voip.rb +12 -3
- data/lib/twilio-ruby/rest/api/v2010/account/call.rb +2 -1
- data/lib/twilio-ruby/rest/api/v2010/account/call/payment.rb +8 -2
- data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +5 -2
- data/lib/twilio-ruby/rest/api/v2010/account/message.rb +8 -1
- data/lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb +3 -1
- data/lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb +2 -1
- data/lib/twilio-ruby/rest/autopilot/v1/assistant/field_type/field_value.rb +8 -4
- data/lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb +11 -4
- data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb +13 -6
- data/lib/twilio-ruby/rest/conversations.rb +0 -16
- data/lib/twilio-ruby/rest/conversations/v1.rb +0 -24
- data/lib/twilio-ruby/rest/conversations/v1/configuration.rb +17 -7
- data/lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb +262 -0
- data/lib/twilio-ruby/rest/conversations/v1/conversation.rb +6 -6
- data/lib/twilio-ruby/rest/conversations/v1/conversation/message.rb +13 -10
- data/lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb +22 -16
- data/lib/twilio-ruby/rest/conversations/v1/conversation/participant.rb +42 -36
- data/lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb +14 -11
- data/lib/twilio-ruby/rest/conversations/v1/credential.rb +1 -1
- data/lib/twilio-ruby/rest/conversations/v1/role.rb +4 -2
- data/lib/twilio-ruby/rest/conversations/v1/service.rb +1 -1
- data/lib/twilio-ruby/rest/conversations/v1/service/binding.rb +28 -25
- data/lib/twilio-ruby/rest/conversations/v1/service/configuration.rb +30 -18
- data/lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb +315 -0
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation.rb +10 -10
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb +23 -20
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb +32 -26
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb +52 -46
- data/lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb +24 -21
- data/lib/twilio-ruby/rest/conversations/v1/service/role.rb +13 -11
- data/lib/twilio-ruby/rest/conversations/v1/service/user.rb +23 -23
- data/lib/twilio-ruby/rest/conversations/v1/user.rb +14 -14
- data/lib/twilio-ruby/rest/events.rb +10 -1
- data/lib/twilio-ruby/rest/events/v1.rb +17 -1
- data/lib/twilio-ruby/rest/events/v1/event_type.rb +8 -8
- data/lib/twilio-ruby/rest/events/v1/schema.rb +226 -0
- data/lib/twilio-ruby/rest/events/v1/schema/schema_version.rb +290 -0
- data/lib/twilio-ruby/rest/events/v1/subscription.rb +28 -8
- data/lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb +3 -109
- data/lib/twilio-ruby/rest/fax/v1/fax.rb +2 -1
- data/lib/twilio-ruby/rest/messaging/v1/service.rb +6 -3
- data/lib/twilio-ruby/rest/notify/v1/credential.rb +12 -6
- data/lib/twilio-ruby/rest/notify/v1/service/notification.rb +10 -2
- data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb +10 -5
- data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb +6 -3
- data/lib/twilio-ruby/rest/preview/trusted_comms/business/insights.rb +1 -4
- data/lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb +3 -1
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb +6 -2
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb +1 -4
- data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb +6 -2
- data/lib/twilio-ruby/rest/trunking/v1/trunk.rb +19 -26
- data/lib/twilio-ruby/rest/trunking/v1/trunk/ip_access_control_list.rb +2 -1
- data/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb +2 -1
- data/lib/twilio-ruby/rest/trunking/v1/trunk/recording.rb +201 -0
- data/lib/twilio-ruby/rest/verify/v2/service/verification.rb +3 -1
- data/lib/twilio-ruby/rest/video/v1/composition.rb +7 -3
- data/lib/twilio-ruby/rest/video/v1/composition_hook.rb +18 -9
- data/lib/twilio-ruby/rest/video/v1/room.rb +2 -1
- data/lib/twilio-ruby/rest/voice/v1/dialing_permissions.rb +1 -4
- data/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb +2 -1
- data/lib/twilio-ruby/version.rb +1 -1
- data/spec/framework/version_spec.rb +11 -0
- data/spec/integration/conversations/v1/{webhook_spec.rb → configuration/webhook_spec.rb} +12 -8
- data/spec/integration/conversations/v1/configuration_spec.rb +4 -2
- data/spec/integration/conversations/v1/{notification_spec.rb → service/configuration/notification_spec.rb} +12 -4
- data/spec/integration/events/v1/schema/schema_version_spec.rb +126 -0
- data/spec/integration/events/v1/schema_spec.rb +46 -0
- data/spec/integration/events/v1/subscription/subscribed_event_spec.rb +0 -121
- data/spec/integration/events/v1/subscription_spec.rb +38 -0
- data/spec/integration/trunking/v1/trunk/recording_spec.rb +79 -0
- metadata +17 -8
- data/lib/twilio-ruby/rest/conversations/v1/notification.rb +0 -310
- data/lib/twilio-ruby/rest/conversations/v1/webhook.rb +0 -262
@@ -17,8 +17,8 @@ module Twilio
|
|
17
17
|
##
|
18
18
|
# Initialize the ConversationList
|
19
19
|
# @param [Version] version Version that contains the resource
|
20
|
-
# @param [String] chat_service_sid The unique
|
21
|
-
# Service](https://www.twilio.com/docs/
|
20
|
+
# @param [String] chat_service_sid The unique ID of the [Conversation
|
21
|
+
# Service](https://www.twilio.com/docs/conversations/api/service-resource) this
|
22
22
|
# conversation belongs to.
|
23
23
|
# @return [ConversationList] ConversationList
|
24
24
|
def initialize(version, chat_service_sid: nil)
|
@@ -40,7 +40,7 @@ module Twilio
|
|
40
40
|
# store any data you wish. The string value must contain structurally valid JSON
|
41
41
|
# if specified. **Note** that if the attributes are not set "{}" will be
|
42
42
|
# returned.
|
43
|
-
# @param [String] messaging_service_sid The unique
|
43
|
+
# @param [String] messaging_service_sid The unique ID of the [Messaging
|
44
44
|
# Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs
|
45
45
|
# to.
|
46
46
|
# @param [Time] date_created The date that this resource was created.
|
@@ -224,7 +224,7 @@ module Twilio
|
|
224
224
|
# store any data you wish. The string value must contain structurally valid JSON
|
225
225
|
# if specified. **Note** that if the attributes are not set "{}" will be
|
226
226
|
# returned.
|
227
|
-
# @param [String] messaging_service_sid The unique
|
227
|
+
# @param [String] messaging_service_sid The unique ID of the [Messaging
|
228
228
|
# Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs
|
229
229
|
# to.
|
230
230
|
# @param [conversation.State] state Current state of this conversation. Can be
|
@@ -372,8 +372,8 @@ module Twilio
|
|
372
372
|
# Initialize the ConversationInstance
|
373
373
|
# @param [Version] version Version that contains the resource
|
374
374
|
# @param [Hash] payload payload that contains response from Twilio
|
375
|
-
# @param [String] chat_service_sid The unique
|
376
|
-
# Service](https://www.twilio.com/docs/
|
375
|
+
# @param [String] chat_service_sid The unique ID of the [Conversation
|
376
|
+
# Service](https://www.twilio.com/docs/conversations/api/service-resource) this
|
377
377
|
# conversation belongs to.
|
378
378
|
# @param [String] sid A 34 character string that uniquely identifies this
|
379
379
|
# resource. Can also be the `unique_name` of the Conversation.
|
@@ -415,19 +415,19 @@ module Twilio
|
|
415
415
|
end
|
416
416
|
|
417
417
|
##
|
418
|
-
# @return [String] The unique
|
418
|
+
# @return [String] The unique ID of the Account responsible for this conversation.
|
419
419
|
def account_sid
|
420
420
|
@properties['account_sid']
|
421
421
|
end
|
422
422
|
|
423
423
|
##
|
424
|
-
# @return [String] The unique
|
424
|
+
# @return [String] The unique ID of the Conversation Service this conversation belongs to.
|
425
425
|
def chat_service_sid
|
426
426
|
@properties['chat_service_sid']
|
427
427
|
end
|
428
428
|
|
429
429
|
##
|
430
|
-
# @return [String] The unique
|
430
|
+
# @return [String] The unique ID of the Messaging Service this conversation belongs to.
|
431
431
|
def messaging_service_sid
|
432
432
|
@properties['messaging_service_sid']
|
433
433
|
end
|
@@ -502,7 +502,7 @@ module Twilio
|
|
502
502
|
# store any data you wish. The string value must contain structurally valid JSON
|
503
503
|
# if specified. **Note** that if the attributes are not set "{}" will be
|
504
504
|
# returned.
|
505
|
-
# @param [String] messaging_service_sid The unique
|
505
|
+
# @param [String] messaging_service_sid The unique ID of the [Messaging
|
506
506
|
# Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs
|
507
507
|
# to.
|
508
508
|
# @param [conversation.State] state Current state of this conversation. Can be
|
@@ -18,11 +18,12 @@ module Twilio
|
|
18
18
|
##
|
19
19
|
# Initialize the MessageList
|
20
20
|
# @param [Version] version Version that contains the resource
|
21
|
-
# @param [String] chat_service_sid The SID of the [
|
22
|
-
# Service](https://www.twilio.com/docs/
|
23
|
-
# resource is associated with.
|
24
|
-
# @param [String] conversation_sid The unique
|
25
|
-
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
21
|
+
# @param [String] chat_service_sid The SID of the [Conversation
|
22
|
+
# Service](https://www.twilio.com/docs/conversations/api/service-resource) the
|
23
|
+
# Participant resource is associated with.
|
24
|
+
# @param [String] conversation_sid The unique ID of the
|
25
|
+
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
26
|
+
# for this message.
|
26
27
|
# @return [MessageList] MessageList
|
27
28
|
def initialize(version, chat_service_sid: nil, conversation_sid: nil)
|
28
29
|
super(version)
|
@@ -44,7 +45,7 @@ module Twilio
|
|
44
45
|
# @param [String] attributes A string metadata field you can use to store any data
|
45
46
|
# you wish. The string value must contain structurally valid JSON if specified.
|
46
47
|
# **Note** that if the attributes are not set "{}" will be returned.
|
47
|
-
# @param [String] media_sid The Media
|
48
|
+
# @param [String] media_sid The Media SID to be attached to the new Message.
|
48
49
|
# @param [message.WebhookEnabledType] x_twilio_webhook_enabled The
|
49
50
|
# X-Twilio-Webhook-Enabled HTTP request header
|
50
51
|
# @return [MessageInstance] Created MessageInstance
|
@@ -198,11 +199,12 @@ module Twilio
|
|
198
199
|
##
|
199
200
|
# Initialize the MessageContext
|
200
201
|
# @param [Version] version Version that contains the resource
|
201
|
-
# @param [String] chat_service_sid The SID of the [
|
202
|
-
# Service](https://www.twilio.com/docs/
|
203
|
-
# resource is associated with.
|
204
|
-
# @param [String] conversation_sid The unique
|
205
|
-
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
202
|
+
# @param [String] chat_service_sid The SID of the [Conversation
|
203
|
+
# Service](https://www.twilio.com/docs/conversations/api/service-resource) the
|
204
|
+
# Participant resource is associated with.
|
205
|
+
# @param [String] conversation_sid The unique ID of the
|
206
|
+
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
207
|
+
# for this message.
|
206
208
|
# @param [String] sid A 34 character string that uniquely identifies this
|
207
209
|
# resource.
|
208
210
|
# @return [MessageContext] MessageContext
|
@@ -330,11 +332,12 @@ module Twilio
|
|
330
332
|
# Initialize the MessageInstance
|
331
333
|
# @param [Version] version Version that contains the resource
|
332
334
|
# @param [Hash] payload payload that contains response from Twilio
|
333
|
-
# @param [String] chat_service_sid The SID of the [
|
334
|
-
# Service](https://www.twilio.com/docs/
|
335
|
-
# resource is associated with.
|
336
|
-
# @param [String] conversation_sid The unique
|
337
|
-
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
335
|
+
# @param [String] chat_service_sid The SID of the [Conversation
|
336
|
+
# Service](https://www.twilio.com/docs/conversations/api/service-resource) the
|
337
|
+
# Participant resource is associated with.
|
338
|
+
# @param [String] conversation_sid The unique ID of the
|
339
|
+
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
340
|
+
# for this message.
|
338
341
|
# @param [String] sid A 34 character string that uniquely identifies this
|
339
342
|
# resource.
|
340
343
|
# @return [MessageInstance] MessageInstance
|
@@ -386,19 +389,19 @@ module Twilio
|
|
386
389
|
end
|
387
390
|
|
388
391
|
##
|
389
|
-
# @return [String] The unique
|
392
|
+
# @return [String] The unique ID of the Account responsible for this message.
|
390
393
|
def account_sid
|
391
394
|
@properties['account_sid']
|
392
395
|
end
|
393
396
|
|
394
397
|
##
|
395
|
-
# @return [String] The SID of the
|
398
|
+
# @return [String] The SID of the Conversation Service that the resource is associated with.
|
396
399
|
def chat_service_sid
|
397
400
|
@properties['chat_service_sid']
|
398
401
|
end
|
399
402
|
|
400
403
|
##
|
401
|
-
# @return [String] The unique
|
404
|
+
# @return [String] The unique ID of the Conversation for this message.
|
402
405
|
def conversation_sid
|
403
406
|
@properties['conversation_sid']
|
404
407
|
end
|
@@ -440,7 +443,7 @@ module Twilio
|
|
440
443
|
end
|
441
444
|
|
442
445
|
##
|
443
|
-
# @return [String] The unique
|
446
|
+
# @return [String] The unique ID of messages's author participant.
|
444
447
|
def participant_sid
|
445
448
|
@properties['participant_sid']
|
446
449
|
end
|
@@ -19,13 +19,15 @@ module Twilio
|
|
19
19
|
##
|
20
20
|
# Initialize the DeliveryReceiptList
|
21
21
|
# @param [Version] version Version that contains the resource
|
22
|
-
# @param [String] chat_service_sid The SID of the [
|
23
|
-
# Service](https://www.twilio.com/docs/
|
24
|
-
# resource is associated with.
|
25
|
-
# @param [String] conversation_sid The unique
|
26
|
-
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
27
|
-
#
|
28
|
-
#
|
22
|
+
# @param [String] chat_service_sid The SID of the [Conversation
|
23
|
+
# Service](https://www.twilio.com/docs/conversations/api/service-resource) the
|
24
|
+
# Message resource is associated with.
|
25
|
+
# @param [String] conversation_sid The unique ID of the
|
26
|
+
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
27
|
+
# for this message.
|
28
|
+
# @param [String] message_sid The SID of the message within a
|
29
|
+
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
30
|
+
# the delivery receipt belongs to
|
29
31
|
# @return [DeliveryReceiptList] DeliveryReceiptList
|
30
32
|
def initialize(version, chat_service_sid: nil, conversation_sid: nil, message_sid: nil)
|
31
33
|
super(version)
|
@@ -169,13 +171,15 @@ module Twilio
|
|
169
171
|
##
|
170
172
|
# Initialize the DeliveryReceiptContext
|
171
173
|
# @param [Version] version Version that contains the resource
|
172
|
-
# @param [String] chat_service_sid The SID of the [
|
173
|
-
# Service](https://www.twilio.com/docs/
|
174
|
-
# resource is associated with.
|
175
|
-
# @param [String] conversation_sid The unique
|
176
|
-
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
177
|
-
#
|
178
|
-
#
|
174
|
+
# @param [String] chat_service_sid The SID of the [Conversation
|
175
|
+
# Service](https://www.twilio.com/docs/conversations/api/service-resource) the
|
176
|
+
# Message resource is associated with.
|
177
|
+
# @param [String] conversation_sid The unique ID of the
|
178
|
+
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
179
|
+
# for this message.
|
180
|
+
# @param [String] message_sid The SID of the message within a
|
181
|
+
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
182
|
+
# the delivery receipt belongs to.
|
179
183
|
# @param [String] sid A 34 character string that uniquely identifies this
|
180
184
|
# resource.
|
181
185
|
# @return [DeliveryReceiptContext] DeliveryReceiptContext
|
@@ -230,13 +234,15 @@ module Twilio
|
|
230
234
|
# Initialize the DeliveryReceiptInstance
|
231
235
|
# @param [Version] version Version that contains the resource
|
232
236
|
# @param [Hash] payload payload that contains response from Twilio
|
233
|
-
# @param [String] chat_service_sid The SID of the [
|
234
|
-
# Service](https://www.twilio.com/docs/
|
235
|
-
# resource is associated with.
|
236
|
-
# @param [String] conversation_sid The unique
|
237
|
-
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
238
|
-
#
|
239
|
-
#
|
237
|
+
# @param [String] chat_service_sid The SID of the [Conversation
|
238
|
+
# Service](https://www.twilio.com/docs/conversations/api/service-resource) the
|
239
|
+
# Message resource is associated with.
|
240
|
+
# @param [String] conversation_sid The unique ID of the
|
241
|
+
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
242
|
+
# for this message.
|
243
|
+
# @param [String] message_sid The SID of the message within a
|
244
|
+
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
245
|
+
# the delivery receipt belongs to
|
240
246
|
# @param [String] sid A 34 character string that uniquely identifies this
|
241
247
|
# resource.
|
242
248
|
# @return [DeliveryReceiptInstance] DeliveryReceiptInstance
|
@@ -287,25 +293,25 @@ module Twilio
|
|
287
293
|
end
|
288
294
|
|
289
295
|
##
|
290
|
-
# @return [String] The unique
|
296
|
+
# @return [String] The unique ID of the Account responsible for this participant.
|
291
297
|
def account_sid
|
292
298
|
@properties['account_sid']
|
293
299
|
end
|
294
300
|
|
295
301
|
##
|
296
|
-
# @return [String] The SID of the
|
302
|
+
# @return [String] The SID of the Conversation Service that the resource is associated with.
|
297
303
|
def chat_service_sid
|
298
304
|
@properties['chat_service_sid']
|
299
305
|
end
|
300
306
|
|
301
307
|
##
|
302
|
-
# @return [String] The unique
|
308
|
+
# @return [String] The unique ID of the Conversation for this message.
|
303
309
|
def conversation_sid
|
304
310
|
@properties['conversation_sid']
|
305
311
|
end
|
306
312
|
|
307
313
|
##
|
308
|
-
# @return [String] The
|
314
|
+
# @return [String] The SID of the message the delivery receipt belongs to
|
309
315
|
def message_sid
|
310
316
|
@properties['message_sid']
|
311
317
|
end
|
@@ -323,7 +329,7 @@ module Twilio
|
|
323
329
|
end
|
324
330
|
|
325
331
|
##
|
326
|
-
# @return [String] The unique
|
332
|
+
# @return [String] The unique ID of the participant the delivery receipt belongs to.
|
327
333
|
def participant_sid
|
328
334
|
@properties['participant_sid']
|
329
335
|
end
|
@@ -18,11 +18,12 @@ module Twilio
|
|
18
18
|
##
|
19
19
|
# Initialize the ParticipantList
|
20
20
|
# @param [Version] version Version that contains the resource
|
21
|
-
# @param [String] chat_service_sid The SID of the [
|
22
|
-
# Service](https://www.twilio.com/docs/
|
23
|
-
# resource is associated with.
|
24
|
-
# @param [String] conversation_sid The unique
|
25
|
-
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
21
|
+
# @param [String] chat_service_sid The SID of the [Conversation
|
22
|
+
# Service](https://www.twilio.com/docs/conversations/api/service-resource) the
|
23
|
+
# Participant resource is associated with.
|
24
|
+
# @param [String] conversation_sid The unique ID of the
|
25
|
+
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
26
|
+
# for this participant.
|
26
27
|
# @return [ParticipantList] ParticipantList
|
27
28
|
def initialize(version, chat_service_sid: nil, conversation_sid: nil)
|
28
29
|
super(version)
|
@@ -35,18 +36,19 @@ module Twilio
|
|
35
36
|
##
|
36
37
|
# Create the ParticipantInstance
|
37
38
|
# @param [String] identity A unique string identifier for the conversation
|
38
|
-
# participant as [
|
39
|
-
#
|
40
|
-
#
|
39
|
+
# participant as [Conversation
|
40
|
+
# User](https://www.twilio.com/docs/conversations/api/user-resource). This
|
41
|
+
# parameter is non-null if (and only if) the participant is using the Conversation
|
42
|
+
# SDK to communicate. Limited to 256 characters.
|
41
43
|
# @param [String] messaging_binding_address The address of the participant's
|
42
|
-
# device, e.g. a phone
|
43
|
-
#
|
44
|
-
#
|
45
|
-
#
|
44
|
+
# device, e.g. a phone or WhatsApp number. Together with the Proxy address, this
|
45
|
+
# determines a participant uniquely. This field (with proxy_address) is only null
|
46
|
+
# when the participant is interacting from an SDK endpoint (see the 'identity'
|
47
|
+
# field).
|
46
48
|
# @param [String] messaging_binding_proxy_address The address of the Twilio phone
|
47
|
-
# number (or WhatsApp number
|
48
|
-
#
|
49
|
-
#
|
49
|
+
# number (or WhatsApp number) that the participant is in contact with. This field,
|
50
|
+
# together with participant address, is only null when the participant is
|
51
|
+
# interacting from an SDK endpoint (see the 'identity' field).
|
50
52
|
# @param [Time] date_created The date that this resource was created.
|
51
53
|
# @param [Time] date_updated The date that this resource was last updated.
|
52
54
|
# @param [String] attributes An optional string metadata field you can use to
|
@@ -54,11 +56,11 @@ module Twilio
|
|
54
56
|
# if specified. **Note** that if the attributes are not set "{}" will be
|
55
57
|
# returned.
|
56
58
|
# @param [String] messaging_binding_projected_address The address of the Twilio
|
57
|
-
# phone number that is used in Group MMS. Communication mask for the
|
59
|
+
# phone number that is used in Group MMS. Communication mask for the Conversation
|
58
60
|
# participant with Identity.
|
59
|
-
# @param [String] role_sid The SID of
|
60
|
-
# [Role](https://www.twilio.com/docs/
|
61
|
-
# participant.
|
61
|
+
# @param [String] role_sid The SID of a conversation-level
|
62
|
+
# [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to
|
63
|
+
# the participant.
|
62
64
|
# @param [participant.WebhookEnabledType] x_twilio_webhook_enabled The
|
63
65
|
# X-Twilio-Webhook-Enabled HTTP request header
|
64
66
|
# @return [ParticipantInstance] Created ParticipantInstance
|
@@ -214,11 +216,12 @@ module Twilio
|
|
214
216
|
##
|
215
217
|
# Initialize the ParticipantContext
|
216
218
|
# @param [Version] version Version that contains the resource
|
217
|
-
# @param [String] chat_service_sid The SID of the [
|
218
|
-
# Service](https://www.twilio.com/docs/
|
219
|
-
# resource is associated with.
|
220
|
-
# @param [String] conversation_sid The unique
|
221
|
-
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
219
|
+
# @param [String] chat_service_sid The SID of the [Conversation
|
220
|
+
# Service](https://www.twilio.com/docs/conversations/api/service-resource) the
|
221
|
+
# Participant resource is associated with.
|
222
|
+
# @param [String] conversation_sid The unique ID of the
|
223
|
+
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
224
|
+
# for this participant.
|
222
225
|
# @param [String] sid A 34 character string that uniquely identifies this
|
223
226
|
# resource.
|
224
227
|
# @return [ParticipantContext] ParticipantContext
|
@@ -235,16 +238,17 @@ module Twilio
|
|
235
238
|
# @param [Time] date_created The date that this resource was created.
|
236
239
|
# @param [Time] date_updated The date that this resource was last updated.
|
237
240
|
# @param [String] identity A unique string identifier for the conversation
|
238
|
-
# participant as [
|
239
|
-
#
|
240
|
-
#
|
241
|
+
# participant as [Conversation
|
242
|
+
# User](https://www.twilio.com/docs/conversations/api/user-resource). This
|
243
|
+
# parameter is non-null if (and only if) the participant is using the Conversation
|
244
|
+
# SDK to communicate. Limited to 256 characters.
|
241
245
|
# @param [String] attributes An optional string metadata field you can use to
|
242
246
|
# store any data you wish. The string value must contain structurally valid JSON
|
243
247
|
# if specified. **Note** that if the attributes are not set "{}" will be
|
244
248
|
# returned.
|
245
|
-
# @param [String] role_sid The SID of
|
246
|
-
# [Role](https://www.twilio.com/docs/
|
247
|
-
# participant.
|
249
|
+
# @param [String] role_sid The SID of a conversation-level
|
250
|
+
# [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to
|
251
|
+
# the participant.
|
248
252
|
# @param [String] messaging_binding_proxy_address The address of the Twilio phone
|
249
253
|
# number that the participant is in contact with. 'null' value will remove it.
|
250
254
|
# @param [String] messaging_binding_projected_address The address of the Twilio
|
@@ -323,11 +327,12 @@ module Twilio
|
|
323
327
|
# Initialize the ParticipantInstance
|
324
328
|
# @param [Version] version Version that contains the resource
|
325
329
|
# @param [Hash] payload payload that contains response from Twilio
|
326
|
-
# @param [String] chat_service_sid The SID of the [
|
327
|
-
# Service](https://www.twilio.com/docs/
|
328
|
-
# resource is associated with.
|
329
|
-
# @param [String] conversation_sid The unique
|
330
|
-
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
330
|
+
# @param [String] chat_service_sid The SID of the [Conversation
|
331
|
+
# Service](https://www.twilio.com/docs/conversations/api/service-resource) the
|
332
|
+
# Participant resource is associated with.
|
333
|
+
# @param [String] conversation_sid The unique ID of the
|
334
|
+
# [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
|
335
|
+
# for this participant.
|
331
336
|
# @param [String] sid A 34 character string that uniquely identifies this
|
332
337
|
# resource.
|
333
338
|
# @return [ParticipantInstance] ParticipantInstance
|
@@ -375,19 +380,19 @@ module Twilio
|
|
375
380
|
end
|
376
381
|
|
377
382
|
##
|
378
|
-
# @return [String] The unique
|
383
|
+
# @return [String] The unique ID of the Account responsible for this participant.
|
379
384
|
def account_sid
|
380
385
|
@properties['account_sid']
|
381
386
|
end
|
382
387
|
|
383
388
|
##
|
384
|
-
# @return [String] The SID of the
|
389
|
+
# @return [String] The SID of the Conversation Service that the resource is associated with.
|
385
390
|
def chat_service_sid
|
386
391
|
@properties['chat_service_sid']
|
387
392
|
end
|
388
393
|
|
389
394
|
##
|
390
|
-
# @return [String] The unique
|
395
|
+
# @return [String] The unique ID of the Conversation for this participant.
|
391
396
|
def conversation_sid
|
392
397
|
@properties['conversation_sid']
|
393
398
|
end
|
@@ -399,7 +404,7 @@ module Twilio
|
|
399
404
|
end
|
400
405
|
|
401
406
|
##
|
402
|
-
# @return [String] A unique string identifier for the conversation participant as
|
407
|
+
# @return [String] A unique string identifier for the conversation participant as Conversation User.
|
403
408
|
def identity
|
404
409
|
@properties['identity']
|
405
410
|
end
|
@@ -417,7 +422,7 @@ module Twilio
|
|
417
422
|
end
|
418
423
|
|
419
424
|
##
|
420
|
-
# @return [String] The SID of
|
425
|
+
# @return [String] The SID of a conversation-level Role to assign to the participant
|
421
426
|
def role_sid
|
422
427
|
@properties['role_sid']
|
423
428
|
end
|
@@ -445,16 +450,17 @@ module Twilio
|
|
445
450
|
# @param [Time] date_created The date that this resource was created.
|
446
451
|
# @param [Time] date_updated The date that this resource was last updated.
|
447
452
|
# @param [String] identity A unique string identifier for the conversation
|
448
|
-
# participant as [
|
449
|
-
#
|
450
|
-
#
|
453
|
+
# participant as [Conversation
|
454
|
+
# User](https://www.twilio.com/docs/conversations/api/user-resource). This
|
455
|
+
# parameter is non-null if (and only if) the participant is using the Conversation
|
456
|
+
# SDK to communicate. Limited to 256 characters.
|
451
457
|
# @param [String] attributes An optional string metadata field you can use to
|
452
458
|
# store any data you wish. The string value must contain structurally valid JSON
|
453
459
|
# if specified. **Note** that if the attributes are not set "{}" will be
|
454
460
|
# returned.
|
455
|
-
# @param [String] role_sid The SID of
|
456
|
-
# [Role](https://www.twilio.com/docs/
|
457
|
-
# participant.
|
461
|
+
# @param [String] role_sid The SID of a conversation-level
|
462
|
+
# [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to
|
463
|
+
# the participant.
|
458
464
|
# @param [String] messaging_binding_proxy_address The address of the Twilio phone
|
459
465
|
# number that the participant is in contact with. 'null' value will remove it.
|
460
466
|
# @param [String] messaging_binding_projected_address The address of the Twilio
|