twilio-ruby 5.9.0 → 5.10.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 (112) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGES.md +12 -0
  3. data/README.md +2 -2
  4. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb +36 -24
  5. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/mobile.rb +34 -25
  6. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number/toll_free.rb +30 -21
  7. data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb +1 -1
  8. data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb +10 -4
  9. data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +2 -2
  10. data/lib/twilio-ruby/rest/api/v2010/account/key.rb +2 -4
  11. data/lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb +1 -1
  12. data/lib/twilio-ruby/rest/api/v2010/account/message.rb +6 -4
  13. data/lib/twilio-ruby/rest/api/v2010/account/new_key.rb +6 -7
  14. data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb +1 -1
  15. data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb +1 -1
  16. data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb +12 -4
  17. data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb +11 -6
  18. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb +10 -8
  19. data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb +10 -8
  20. data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb +11 -9
  21. data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb +0 -1
  22. data/lib/twilio-ruby/rest/api/v2010/account/sip.rb +2 -1
  23. data/lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb +9 -6
  24. data/lib/twilio-ruby/rest/api/v2010/account/usage/record.rb +9 -3
  25. data/lib/twilio-ruby/rest/api/v2010/account.rb +13 -9
  26. data/lib/twilio-ruby/rest/chat/v1/credential.rb +42 -24
  27. data/lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb +38 -18
  28. data/lib/twilio-ruby/rest/chat/v1/service/channel/member.rb +60 -24
  29. data/lib/twilio-ruby/rest/chat/v1/service/channel/message.rb +28 -18
  30. data/lib/twilio-ruby/rest/chat/v1/service/channel.rb +33 -24
  31. data/lib/twilio-ruby/rest/chat/v1/service/role.rb +26 -16
  32. data/lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb +4 -2
  33. data/lib/twilio-ruby/rest/chat/v1/service/user.rb +43 -24
  34. data/lib/twilio-ruby/rest/chat/v1/service.rb +74 -44
  35. data/lib/twilio-ruby/rest/chat/v2/credential.rb +61 -27
  36. data/lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb +41 -18
  37. data/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb +43 -25
  38. data/lib/twilio-ruby/rest/chat/v2/service/channel/message.rb +76 -37
  39. data/lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb +432 -0
  40. data/lib/twilio-ruby/rest/chat/v2/service/channel.rb +90 -35
  41. data/lib/twilio-ruby/rest/chat/v2/service/role.rb +23 -16
  42. data/lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb +4 -2
  43. data/lib/twilio-ruby/rest/chat/v2/service/user.rb +43 -25
  44. data/lib/twilio-ruby/rest/chat/v2/service.rb +93 -53
  45. data/lib/twilio-ruby/rest/chat.rb +4 -2
  46. data/lib/twilio-ruby/rest/ip_messaging/v1/credential.rb +42 -24
  47. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb +38 -18
  48. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb +60 -24
  49. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb +28 -18
  50. data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb +33 -24
  51. data/lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb +26 -16
  52. data/lib/twilio-ruby/rest/ip_messaging/v1/service/user/user_channel.rb +4 -2
  53. data/lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb +43 -24
  54. data/lib/twilio-ruby/rest/ip_messaging/v1/service.rb +74 -44
  55. data/lib/twilio-ruby/rest/ip_messaging/v2/credential.rb +61 -27
  56. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb +41 -18
  57. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/member.rb +43 -25
  58. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb +76 -37
  59. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb +432 -0
  60. data/lib/twilio-ruby/rest/ip_messaging/v2/service/channel.rb +90 -35
  61. data/lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb +23 -16
  62. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user/user_channel.rb +4 -2
  63. data/lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb +43 -25
  64. data/lib/twilio-ruby/rest/ip_messaging/v2/service.rb +93 -53
  65. data/lib/twilio-ruby/rest/ip_messaging.rb +4 -2
  66. data/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb +12 -11
  67. data/lib/twilio-ruby/rest/monitor/v1/event.rb +11 -11
  68. data/lib/twilio-ruby/rest/monitor.rb +1 -1
  69. data/lib/twilio-ruby/rest/notify/v1/credential.rb +47 -22
  70. data/lib/twilio-ruby/rest/notify/v1/service/binding.rb +59 -26
  71. data/lib/twilio-ruby/rest/notify/v1/service/notification.rb +104 -29
  72. data/lib/twilio-ruby/rest/notify/v1/service.rb +86 -48
  73. data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb +2 -2
  74. data/lib/twilio-ruby/rest/preview/marketplace.rb +13 -13
  75. data/lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb +22 -16
  76. data/lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb +21 -15
  77. data/lib/twilio-ruby/rest/preview/understand/assistant/intent/field.rb +17 -14
  78. data/lib/twilio-ruby/rest/preview/understand/assistant/intent/sample.rb +36 -25
  79. data/lib/twilio-ruby/rest/preview/understand/assistant/intent.rb +21 -15
  80. data/lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb +19 -13
  81. data/lib/twilio-ruby/rest/preview/understand/assistant/query.rb +42 -28
  82. data/lib/twilio-ruby/rest/preview/understand/assistant.rb +39 -21
  83. data/lib/twilio-ruby/rest/preview.rb +10 -9
  84. data/lib/twilio-ruby/rest/pricing/v1/messaging/country.rb +5 -5
  85. data/lib/twilio-ruby/rest/pricing/v1/phone_number/country.rb +4 -4
  86. data/lib/twilio-ruby/rest/pricing/v1/voice/country.rb +3 -3
  87. data/lib/twilio-ruby/rest/pricing/v1/voice/number.rb +5 -5
  88. data/lib/twilio-ruby/rest/sync/v1/service/document.rb +12 -13
  89. data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb +28 -22
  90. data/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb +7 -5
  91. data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb +31 -14
  92. data/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb +3 -3
  93. data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb +2 -2
  94. data/lib/twilio-ruby/rest/sync/v1/service.rb +24 -27
  95. data/lib/twilio-ruby/rest/video/v1/composition.rb +1 -1
  96. data/lib/twilio-ruby/rest/video/v1/recording.rb +45 -31
  97. data/lib/twilio-ruby/rest/video/v1/room/recording.rb +1 -1
  98. data/lib/twilio-ruby/rest/video/v1/room/room_participant.rb +18 -6
  99. data/lib/twilio-ruby/rest/video/v1.rb +13 -12
  100. data/lib/twilio-ruby/rest/video.rb +9 -8
  101. data/lib/twilio-ruby/rest/wireless/v1/command.rb +43 -33
  102. data/lib/twilio-ruby/rest/wireless/v1/rate_plan.rb +48 -35
  103. data/lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb +21 -23
  104. data/lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb +32 -22
  105. data/lib/twilio-ruby/rest/wireless/v1/sim.rb +121 -70
  106. data/lib/twilio-ruby/rest/wireless.rb +6 -3
  107. data/lib/twilio-ruby/version.rb +1 -1
  108. data/spec/integration/chat/v2/service/channel/webhook_spec.rb +307 -0
  109. data/spec/integration/chat/v2/service/channel_spec.rb +4 -0
  110. data/spec/integration/ip_messaging/v2/service/channel/webhook_spec.rb +307 -0
  111. data/spec/integration/ip_messaging/v2/service/channel_spec.rb +4 -0
  112. metadata +9 -3
@@ -31,11 +31,10 @@ module Twilio
31
31
  ##
32
32
  # Retrieve a single page of DocumentInstance records from the API.
33
33
  # Request is executed immediately.
34
- # @param [String] unique_name (optional) Human-readable name for this document
35
- # @param [Hash] data (optional) JSON data to be stored in this document
36
- # @param [String] ttl (optional) Time-to-live of this Document in seconds,
37
- # defaults to no expiration. In the range [1, 31 536 000 (1 year)], or 0 for
38
- # infinity.
34
+ # @param [String] unique_name Human-readable name for this document
35
+ # @param [Hash] data JSON data to be stored in this document
36
+ # @param [String] ttl Time-to-live of this Document in seconds, defaults to no
37
+ # expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity.
39
38
  # @return [DocumentInstance] Newly created DocumentInstance
40
39
  def create(unique_name: :unset, data: :unset, ttl: :unset)
41
40
  data = Twilio::Values.of({
@@ -217,10 +216,10 @@ module Twilio
217
216
 
218
217
  ##
219
218
  # Update the DocumentInstance
220
- # @param [Hash] data (optional) Contains an arbitrary JSON object to be stored in
221
- # this Document. Serialized to string to respect HTTP form input, up to 16KB.
222
- # @param [String] ttl (optional) New time-to-live of this Document in seconds. In
223
- # the range [1, 31 536 000 (1 year)], or 0 for infinity.
219
+ # @param [Hash] data Contains an arbitrary JSON object to be stored in this
220
+ # Document. Serialized to string to respect HTTP form input, up to 16KB.
221
+ # @param [String] ttl New time-to-live of this Document in seconds. In the range
222
+ # [1, 31 536 000 (1 year)], or 0 for infinity.
224
223
  # @return [DocumentInstance] Updated DocumentInstance
225
224
  def update(data: :unset, ttl: :unset)
226
225
  data = Twilio::Values.of({'Data' => Twilio.serialize_object(data), 'Ttl' => ttl, })
@@ -398,10 +397,10 @@ module Twilio
398
397
 
399
398
  ##
400
399
  # Update the DocumentInstance
401
- # @param [Hash] data (optional) Contains an arbitrary JSON object to be stored in
402
- # this Document. Serialized to string to respect HTTP form input, up to 16KB.
403
- # @param [String] ttl (optional) New time-to-live of this Document in seconds. In
404
- # the range [1, 31 536 000 (1 year)], or 0 for infinity.
400
+ # @param [Hash] data Contains an arbitrary JSON object to be stored in this
401
+ # Document. Serialized to string to respect HTTP form input, up to 16KB.
402
+ # @param [String] ttl New time-to-live of this Document in seconds. In the range
403
+ # [1, 31 536 000 (1 year)], or 0 for infinity.
405
404
  # @return [DocumentInstance] Updated DocumentInstance
406
405
  def update(data: :unset, ttl: :unset)
407
406
  context.update(data: data, ttl: ttl, )
@@ -34,9 +34,10 @@ module Twilio
34
34
  ##
35
35
  # Retrieve a single page of SyncListItemInstance records from the API.
36
36
  # Request is executed immediately.
37
- # @param [Hash] data The data
38
- # @param [String] ttl (optional) Time-to-live of this item in seconds, defaults to
39
- # no expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity. Upon
37
+ # @param [Hash] data Contains arbitrary user-defined, schema-less data that this
38
+ # List Item stores, represented by a JSON object, up to 16KB.
39
+ # @param [String] ttl Time-to-live of this item in seconds, defaults to no
40
+ # expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity. Upon
40
41
  # expiry, the list item will be cleaned up at least in a matter of hours, and
41
42
  # often within seconds, making this a good tool for garbage management.
42
43
  # @return [SyncListItemInstance] Newly created SyncListItemInstance
@@ -61,11 +62,10 @@ module Twilio
61
62
  # Lists SyncListItemInstance records from the API as a list.
62
63
  # Unlike stream(), this operation is eager and will load `limit` records into
63
64
  # memory before returning.
64
- # @param [sync_list_item.QueryResultOrder] order (optional) A string; `asc` or
65
- # `desc`
66
- # @param [String] from (optional) An integer representing Item index offset
67
- # (inclusive). If not present, query is performed from the start or end, depending
68
- # on the Order query parameter.
65
+ # @param [sync_list_item.QueryResultOrder] order A string; `asc` or `desc`
66
+ # @param [String] from An integer representing Item index offset (inclusive). If
67
+ # not present, query is performed from the start or end, depending on the Order
68
+ # query parameter.
69
69
  # @param [sync_list_item.QueryFromBoundType] bounds The bounds
70
70
  # @param [Integer] limit Upper limit for the number of records to return. stream()
71
71
  # guarantees to never return more than limit. Default is no limit
@@ -82,11 +82,10 @@ module Twilio
82
82
  # Streams SyncListItemInstance records from the API as an Enumerable.
83
83
  # This operation lazily loads records as efficiently as possible until the limit
84
84
  # is reached.
85
- # @param [sync_list_item.QueryResultOrder] order (optional) A string; `asc` or
86
- # `desc`
87
- # @param [String] from (optional) An integer representing Item index offset
88
- # (inclusive). If not present, query is performed from the start or end, depending
89
- # on the Order query parameter.
85
+ # @param [sync_list_item.QueryResultOrder] order A string; `asc` or `desc`
86
+ # @param [String] from An integer representing Item index offset (inclusive). If
87
+ # not present, query is performed from the start or end, depending on the Order
88
+ # query parameter.
90
89
  # @param [sync_list_item.QueryFromBoundType] bounds The bounds
91
90
  # @param [Integer] limit Upper limit for the number of records to return. stream()
92
91
  # guarantees to never return more than limit. Default is no limit.
@@ -120,11 +119,10 @@ module Twilio
120
119
  ##
121
120
  # Retrieve a single page of SyncListItemInstance records from the API.
122
121
  # Request is executed immediately.
123
- # @param [sync_list_item.QueryResultOrder] order (optional) A string; `asc` or
124
- # `desc`
125
- # @param [String] from (optional) An integer representing Item index offset
126
- # (inclusive). If not present, query is performed from the start or end, depending
127
- # on the Order query parameter.
122
+ # @param [sync_list_item.QueryResultOrder] order A string; `asc` or `desc`
123
+ # @param [String] from An integer representing Item index offset (inclusive). If
124
+ # not present, query is performed from the start or end, depending on the Order
125
+ # query parameter.
128
126
  # @param [sync_list_item.QueryFromBoundType] bounds The bounds
129
127
  # @param [String] page_token PageToken provided by the API
130
128
  # @param [Integer] page_number Page Number, this value is simply for client state
@@ -251,8 +249,12 @@ module Twilio
251
249
 
252
250
  ##
253
251
  # Update the SyncListItemInstance
254
- # @param [Hash] data The data
255
- # @param [String] ttl The ttl
252
+ # @param [Hash] data Contains arbitrary user-defined, schema-less data that this
253
+ # List Item stores, represented by a JSON object, up to 16KB.
254
+ # @param [String] ttl Time-to-live of this item in seconds, defaults to no
255
+ # expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity. Upon
256
+ # expiry, the list item will be cleaned up at least in a matter of hours, and
257
+ # often within seconds, making this a good tool for garbage management.
256
258
  # @return [SyncListItemInstance] Updated SyncListItemInstance
257
259
  def update(data: :unset, ttl: :unset)
258
260
  data = Twilio::Values.of({'Data' => Twilio.serialize_object(data), 'Ttl' => ttl, })
@@ -418,8 +420,12 @@ module Twilio
418
420
 
419
421
  ##
420
422
  # Update the SyncListItemInstance
421
- # @param [Hash] data The data
422
- # @param [String] ttl The ttl
423
+ # @param [Hash] data Contains arbitrary user-defined, schema-less data that this
424
+ # List Item stores, represented by a JSON object, up to 16KB.
425
+ # @param [String] ttl Time-to-live of this item in seconds, defaults to no
426
+ # expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity. Upon
427
+ # expiry, the list item will be cleaned up at least in a matter of hours, and
428
+ # often within seconds, making this a good tool for garbage management.
423
429
  # @return [SyncListItemInstance] Updated SyncListItemInstance
424
430
  def update(data: :unset, ttl: :unset)
425
431
  context.update(data: data, ttl: ttl, )
@@ -31,9 +31,9 @@ module Twilio
31
31
  ##
32
32
  # Retrieve a single page of SyncListInstance records from the API.
33
33
  # Request is executed immediately.
34
- # @param [String] unique_name (optional) Human-readable name for this list
35
- # @param [String] ttl (optional) Time-to-live of this List in seconds, defaults to
36
- # no expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity.
34
+ # @param [String] unique_name Human-readable name for this list
35
+ # @param [String] ttl Time-to-live of this List in seconds, defaults to no
36
+ # expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity.
37
37
  # @return [SyncListInstance] Newly created SyncListInstance
38
38
  def create(unique_name: :unset, ttl: :unset)
39
39
  data = Twilio::Values.of({'UniqueName' => unique_name, 'Ttl' => ttl, })
@@ -212,7 +212,8 @@ module Twilio
212
212
 
213
213
  ##
214
214
  # Update the SyncListInstance
215
- # @param [String] ttl The ttl
215
+ # @param [String] ttl Time-to-live of this List in seconds, defaults to no
216
+ # expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity.
216
217
  # @return [SyncListInstance] Updated SyncListInstance
217
218
  def update(ttl: :unset)
218
219
  data = Twilio::Values.of({'Ttl' => ttl, })
@@ -405,7 +406,8 @@ module Twilio
405
406
 
406
407
  ##
407
408
  # Update the SyncListInstance
408
- # @param [String] ttl The ttl
409
+ # @param [String] ttl Time-to-live of this List in seconds, defaults to no
410
+ # expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity.
409
411
  # @return [SyncListInstance] Updated SyncListInstance
410
412
  def update(ttl: :unset)
411
413
  context.update(ttl: ttl, )
@@ -34,10 +34,12 @@ 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 key
38
- # @param [Hash] data The data
39
- # @param [String] ttl (optional) Time-to-live of this Map in seconds, defaults to
40
- # no expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity.
37
+ # @param [String] key The unique user-defined key of this Map Item. Up to 256
38
+ # characters long.
39
+ # @param [Hash] data Contains arbitrary user-defined, schema-less data that this
40
+ # Map Item stores, represented by a JSON object, up to 16KB.
41
+ # @param [String] ttl Time-to-live of this Map in seconds, defaults to no
42
+ # expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity.
41
43
  # @return [SyncMapItemInstance] Newly created SyncMapItemInstance
42
44
  def create(key: nil, data: nil, ttl: :unset)
43
45
  data = Twilio::Values.of({'Key' => key, 'Data' => Twilio.serialize_object(data), 'Ttl' => ttl, })
@@ -60,8 +62,13 @@ module Twilio
60
62
  # Lists SyncMapItemInstance records from the API as a list.
61
63
  # Unlike stream(), this operation is eager and will load `limit` records into
62
64
  # memory before returning.
63
- # @param [sync_map_item.QueryResultOrder] order The order
64
- # @param [String] from The from
65
+ # @param [sync_map_item.QueryResultOrder] order A string; asc or desc. Map Items
66
+ # are [ordered
67
+ # lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item
68
+ # key.
69
+ # @param [String] from The Item key offset (including the specified key). If not
70
+ # present, query is performed from the start or end, depending on the Order query
71
+ # parameter.
65
72
  # @param [sync_map_item.QueryFromBoundType] bounds The bounds
66
73
  # @param [Integer] limit Upper limit for the number of records to return. stream()
67
74
  # guarantees to never return more than limit. Default is no limit
@@ -78,8 +85,13 @@ module Twilio
78
85
  # Streams SyncMapItemInstance records from the API as an Enumerable.
79
86
  # This operation lazily loads records as efficiently as possible until the limit
80
87
  # is reached.
81
- # @param [sync_map_item.QueryResultOrder] order The order
82
- # @param [String] from The from
88
+ # @param [sync_map_item.QueryResultOrder] order A string; asc or desc. Map Items
89
+ # are [ordered
90
+ # lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item
91
+ # key.
92
+ # @param [String] from The Item key offset (including the specified key). If not
93
+ # present, query is performed from the start or end, depending on the Order query
94
+ # parameter.
83
95
  # @param [sync_map_item.QueryFromBoundType] bounds The bounds
84
96
  # @param [Integer] limit Upper limit for the number of records to return. stream()
85
97
  # guarantees to never return more than limit. Default is no limit.
@@ -113,8 +125,13 @@ module Twilio
113
125
  ##
114
126
  # Retrieve a single page of SyncMapItemInstance records from the API.
115
127
  # Request is executed immediately.
116
- # @param [sync_map_item.QueryResultOrder] order The order
117
- # @param [String] from The from
128
+ # @param [sync_map_item.QueryResultOrder] order A string; asc or desc. Map Items
129
+ # are [ordered
130
+ # lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item
131
+ # key.
132
+ # @param [String] from The Item key offset (including the specified key). If not
133
+ # present, query is performed from the start or end, depending on the Order query
134
+ # parameter.
118
135
  # @param [sync_map_item.QueryFromBoundType] bounds The bounds
119
136
  # @param [String] page_token PageToken provided by the API
120
137
  # @param [Integer] page_number Page Number, this value is simply for client state
@@ -241,8 +258,8 @@ module Twilio
241
258
 
242
259
  ##
243
260
  # Update the SyncMapItemInstance
244
- # @param [Hash] data (optional) Contains an arbitrary JSON object to be stored in
245
- # this Map Item. Serialized to string to respect HTTP form input, up to 16KB.
261
+ # @param [Hash] data Contains an arbitrary JSON object to be stored in this Map
262
+ # Item. Serialized to string to respect HTTP form input, up to 16KB.
246
263
  # @param [String] ttl New time-to-live of this Map in seconds. In the range [1, 31
247
264
  # 536 000 (1 year)], or 0 for infinity.
248
265
  # @return [SyncMapItemInstance] Updated SyncMapItemInstance
@@ -406,8 +423,8 @@ module Twilio
406
423
 
407
424
  ##
408
425
  # Update the SyncMapItemInstance
409
- # @param [Hash] data (optional) Contains an arbitrary JSON object to be stored in
410
- # this Map Item. Serialized to string to respect HTTP form input, up to 16KB.
426
+ # @param [Hash] data Contains an arbitrary JSON object to be stored in this Map
427
+ # Item. Serialized to string to respect HTTP form input, up to 16KB.
411
428
  # @param [String] ttl New time-to-live of this Map in seconds. In the range [1, 31
412
429
  # 536 000 (1 year)], or 0 for infinity.
413
430
  # @return [SyncMapItemInstance] Updated SyncMapItemInstance
@@ -31,9 +31,9 @@ module Twilio
31
31
  ##
32
32
  # Retrieve a single page of SyncMapInstance records from the API.
33
33
  # Request is executed immediately.
34
- # @param [String] unique_name (optional) Human-readable name for this map
35
- # @param [String] ttl (optional) Time-to-live of this Map in seconds, defaults to
36
- # no expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity.
34
+ # @param [String] unique_name Human-readable name for this map
35
+ # @param [String] ttl Time-to-live of this Map in seconds, defaults to no
36
+ # expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity.
37
37
  # @return [SyncMapInstance] Newly created SyncMapInstance
38
38
  def create(unique_name: :unset, ttl: :unset)
39
39
  data = Twilio::Values.of({'UniqueName' => unique_name, 'Ttl' => ttl, })
@@ -33,8 +33,8 @@ module Twilio
33
33
  # Request is executed immediately.
34
34
  # @param [String] unique_name The unique and addressable name of this Stream.
35
35
  # Optional, up to 256 characters long.
36
- # @param [String] ttl (optional) Time-to-live of this Stream in seconds, defaults
37
- # to no expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity.
36
+ # @param [String] ttl Time-to-live of this Stream in seconds, defaults to no
37
+ # expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity.
38
38
  # @return [SyncStreamInstance] Newly created SyncStreamInstance
39
39
  def create(unique_name: :unset, ttl: :unset)
40
40
  data = Twilio::Values.of({'UniqueName' => unique_name, 'Ttl' => ttl, })
@@ -28,15 +28,14 @@ module Twilio
28
28
  ##
29
29
  # Retrieve a single page of ServiceInstance records from the API.
30
30
  # Request is executed immediately.
31
- # @param [String] friendly_name (optional) Human-readable name for this service
32
- # instance
33
- # @param [String] webhook_url (optional) A URL that will receive event updates
34
- # when objects are manipulated.
35
- # @param [Boolean] reachability_webhooks_enabled (optional) `true` or `false` -
36
- # controls whether this instance fires webhooks when client endpoints connect to
37
- # Sync Defaults to false.
38
- # @param [Boolean] acl_enabled (optional) `true` or `false` - determines whether
39
- # token identities must be granted access to Sync objects via the [Permissions
31
+ # @param [String] friendly_name Human-readable name for this service instance
32
+ # @param [String] webhook_url A URL that will receive event updates when objects
33
+ # are manipulated.
34
+ # @param [Boolean] reachability_webhooks_enabled `true` or `false` - controls
35
+ # whether this instance fires webhooks when client endpoints connect to Sync
36
+ # Defaults to false.
37
+ # @param [Boolean] acl_enabled `true` or `false` - determines whether token
38
+ # identities must be granted access to Sync objects via the [Permissions
40
39
  # API](https://www.twilio.com/docs/api/sync/rest/sync-rest-api-permissions) in
41
40
  # this Service.
42
41
  # @return [ServiceInstance] Newly created ServiceInstance
@@ -223,15 +222,14 @@ module Twilio
223
222
 
224
223
  ##
225
224
  # Update the ServiceInstance
226
- # @param [String] webhook_url (optional) A URL that will receive event updates
227
- # when objects are manipulated.
228
- # @param [String] friendly_name (optional) Human-readable name for this service
229
- # instance
230
- # @param [Boolean] reachability_webhooks_enabled (optional) True or false -
231
- # controls whether this instance fires webhooks when client endpoints connect to
232
- # Sync Defaults to false.
233
- # @param [Boolean] acl_enabled (optional) `true` or `false` - determines whether
234
- # token identities must be granted access to Sync objects via the [Permissions
225
+ # @param [String] webhook_url A URL that will receive event updates when objects
226
+ # are manipulated.
227
+ # @param [String] friendly_name Human-readable name for this service instance
228
+ # @param [Boolean] reachability_webhooks_enabled True or false - controls whether
229
+ # this instance fires webhooks when client endpoints connect to Sync Defaults to
230
+ # false.
231
+ # @param [Boolean] acl_enabled `true` or `false` - determines whether token
232
+ # identities must be granted access to Sync objects via the [Permissions
235
233
  # API](https://www.twilio.com/docs/api/sync/rest/sync-rest-api-permissions) in
236
234
  # this Service.
237
235
  # @return [ServiceInstance] Updated ServiceInstance
@@ -457,15 +455,14 @@ module Twilio
457
455
 
458
456
  ##
459
457
  # Update the ServiceInstance
460
- # @param [String] webhook_url (optional) A URL that will receive event updates
461
- # when objects are manipulated.
462
- # @param [String] friendly_name (optional) Human-readable name for this service
463
- # instance
464
- # @param [Boolean] reachability_webhooks_enabled (optional) True or false -
465
- # controls whether this instance fires webhooks when client endpoints connect to
466
- # Sync Defaults to false.
467
- # @param [Boolean] acl_enabled (optional) `true` or `false` - determines whether
468
- # token identities must be granted access to Sync objects via the [Permissions
458
+ # @param [String] webhook_url A URL that will receive event updates when objects
459
+ # are manipulated.
460
+ # @param [String] friendly_name Human-readable name for this service instance
461
+ # @param [Boolean] reachability_webhooks_enabled True or false - controls whether
462
+ # this instance fires webhooks when client endpoints connect to Sync Defaults to
463
+ # false.
464
+ # @param [Boolean] acl_enabled `true` or `false` - determines whether token
465
+ # identities must be granted access to Sync objects via the [Permissions
469
466
  # API](https://www.twilio.com/docs/api/sync/rest/sync-rest-api-permissions) in
470
467
  # this Service.
471
468
  # @return [ServiceInstance] Updated ServiceInstance
@@ -283,7 +283,7 @@ module Twilio
283
283
  'trim' => payload['trim'],
284
284
  'format' => payload['format'],
285
285
  'bitrate' => payload['bitrate'].to_i,
286
- 'size' => payload['size'],
286
+ 'size' => payload['size'].to_i,
287
287
  'duration' => payload['duration'].to_i,
288
288
  'url' => payload['url'],
289
289
  'links' => payload['links'],
@@ -27,11 +27,15 @@ module Twilio
27
27
  # Lists RecordingInstance records from the API as a list.
28
28
  # Unlike stream(), this operation is eager and will load `limit` records into
29
29
  # memory before returning.
30
- # @param [recording.Status] status The status
31
- # @param [String] source_sid The source_sid
32
- # @param [String] grouping_sid The grouping_sid
33
- # @param [Time] date_created_after The date_created_after
34
- # @param [Time] date_created_before The date_created_before
30
+ # @param [recording.Status] status Only show Recordings with the given status.
31
+ # @param [String] source_sid Only show the Recordings with the given source Sid
32
+ # (you can use this to filter Recordings by `TrackSid` for Video Room Recordings.
33
+ # @param [String] grouping_sid Only show Recordings that have this GroupingSid,
34
+ # which may include a ParticipantSid and/or a RoomSid.
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-hh:mm`.
37
+ # @param [Time] date_created_before Only show Recordings that started before this
38
+ # this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
35
39
  # @param [Integer] limit Upper limit for the number of records to return. stream()
36
40
  # guarantees to never return more than limit. Default is no limit
37
41
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -55,11 +59,15 @@ module Twilio
55
59
  # Streams RecordingInstance records from the API as an Enumerable.
56
60
  # This operation lazily loads records as efficiently as possible until the limit
57
61
  # is reached.
58
- # @param [recording.Status] status The status
59
- # @param [String] source_sid The source_sid
60
- # @param [String] grouping_sid The grouping_sid
61
- # @param [Time] date_created_after The date_created_after
62
- # @param [Time] date_created_before The date_created_before
62
+ # @param [recording.Status] status Only show Recordings with the given status.
63
+ # @param [String] source_sid Only show the Recordings with the given source Sid
64
+ # (you can use this to filter Recordings by `TrackSid` for Video Room Recordings.
65
+ # @param [String] grouping_sid Only show Recordings that have this GroupingSid,
66
+ # which may include a ParticipantSid and/or a RoomSid.
67
+ # @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-hh:mm`.
69
+ # @param [Time] date_created_before Only show Recordings that started before this
70
+ # this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
63
71
  # @param [Integer] limit Upper limit for the number of records to return. stream()
64
72
  # guarantees to never return more than limit. Default is no limit.
65
73
  # @param [Integer] page_size Number of records to fetch per request, when
@@ -99,11 +107,15 @@ module Twilio
99
107
  ##
100
108
  # Retrieve a single page of RecordingInstance records from the API.
101
109
  # Request is executed immediately.
102
- # @param [recording.Status] status The status
103
- # @param [String] source_sid The source_sid
104
- # @param [String] grouping_sid The grouping_sid
105
- # @param [Time] date_created_after The date_created_after
106
- # @param [Time] date_created_before The date_created_before
110
+ # @param [recording.Status] status Only show Recordings with the given status.
111
+ # @param [String] source_sid Only show the Recordings with the given source Sid
112
+ # (you can use this to filter Recordings by `TrackSid` for Video Room Recordings.
113
+ # @param [String] grouping_sid Only show Recordings that have this GroupingSid,
114
+ # which may include a ParticipantSid and/or a RoomSid.
115
+ # @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-hh:mm`.
117
+ # @param [Time] date_created_before Only show Recordings that started before this
118
+ # this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
107
119
  # @param [String] page_token PageToken provided by the API
108
120
  # @param [Integer] page_number Page Number, this value is simply for client state
109
121
  # @param [Integer] page_size Number of records to return, defaults to 50
@@ -180,7 +192,8 @@ module Twilio
180
192
  ##
181
193
  # Initialize the RecordingContext
182
194
  # @param [Version] version Version that contains the resource
183
- # @param [String] sid The sid
195
+ # @param [String] sid The Recording Sid that uniquely identifies the Recording to
196
+ # fetch.
184
197
  # @return [RecordingContext] RecordingContext
185
198
  def initialize(version, sid)
186
199
  super(version)
@@ -225,7 +238,8 @@ module Twilio
225
238
  # Initialize the RecordingInstance
226
239
  # @param [Version] version Version that contains the resource
227
240
  # @param [Hash] payload payload that contains response from Twilio
228
- # @param [String] sid The sid
241
+ # @param [String] sid The Recording Sid that uniquely identifies the Recording to
242
+ # fetch.
229
243
  # @return [RecordingInstance] RecordingInstance
230
244
  def initialize(version, payload, sid: nil)
231
245
  super(version)
@@ -237,7 +251,7 @@ module Twilio
237
251
  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
238
252
  'sid' => payload['sid'],
239
253
  'source_sid' => payload['source_sid'],
240
- 'size' => payload['size'],
254
+ 'size' => payload['size'].to_i,
241
255
  'url' => payload['url'],
242
256
  'type' => payload['type'],
243
257
  'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
@@ -265,79 +279,79 @@ module Twilio
265
279
  end
266
280
 
267
281
  ##
268
- # @return [String] The account_sid
282
+ # @return [String] Twilio Account SID.
269
283
  def account_sid
270
284
  @properties['account_sid']
271
285
  end
272
286
 
273
287
  ##
274
- # @return [recording.Status] The status
288
+ # @return [recording.Status] The status of the Recording.
275
289
  def status
276
290
  @properties['status']
277
291
  end
278
292
 
279
293
  ##
280
- # @return [Time] The date_created
294
+ # @return [Time] Date when the media recording began writing.
281
295
  def date_created
282
296
  @properties['date_created']
283
297
  end
284
298
 
285
299
  ##
286
- # @return [String] The sid
300
+ # @return [String] A 34-character string that uniquely identifies this Recording.
287
301
  def sid
288
302
  @properties['sid']
289
303
  end
290
304
 
291
305
  ##
292
- # @return [String] The source_sid
306
+ # @return [String] A 34-character string that uniquely identifies the source of this Recording.
293
307
  def source_sid
294
308
  @properties['source_sid']
295
309
  end
296
310
 
297
311
  ##
298
- # @return [String] The size
312
+ # @return [String] Size of the recorded track, in bytes.
299
313
  def size
300
314
  @properties['size']
301
315
  end
302
316
 
303
317
  ##
304
- # @return [String] The url
318
+ # @return [String] The absolute URL for this resource.
305
319
  def url
306
320
  @properties['url']
307
321
  end
308
322
 
309
323
  ##
310
- # @return [recording.Type] The type
324
+ # @return [recording.Type] Indicates the media type for this recording.
311
325
  def type
312
326
  @properties['type']
313
327
  end
314
328
 
315
329
  ##
316
- # @return [String] The duration
330
+ # @return [String] Duration of the Recording in seconds.
317
331
  def duration
318
332
  @properties['duration']
319
333
  end
320
334
 
321
335
  ##
322
- # @return [recording.Format] The container_format
336
+ # @return [recording.Format] The file format for this Recording.
323
337
  def container_format
324
338
  @properties['container_format']
325
339
  end
326
340
 
327
341
  ##
328
- # @return [recording.Codec] The codec
342
+ # @return [recording.Codec] The codec used to encode the track.
329
343
  def codec
330
344
  @properties['codec']
331
345
  end
332
346
 
333
347
  ##
334
- # @return [Hash] The grouping_sids
348
+ # @return [Hash] A list of Sids related to this Recording.
335
349
  def grouping_sids
336
350
  @properties['grouping_sids']
337
351
  end
338
352
 
339
353
  ##
340
- # @return [String] The track_name
354
+ # @return [String] The name that was given to the source track of this recording.
341
355
  def track_name
342
356
  @properties['track_name']
343
357
  end