twilio-ruby 5.8.1 → 5.9.0

data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -160,7 +162,8 @@ module Twilio
               ##
               # Initialize the SyncListPermissionContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
+              # @param [String] service_sid Identifier of the Sync Service Instance. Either a
+              #   SID or 'default'.
               # @param [String] list_sid Identifier of the Sync List. Either a SID or a unique
               #   name.
               # @param [String] identity Arbitrary string identifier representing a user

data/lib/twilio-ruby/rest/sync/v1/service/sync_list.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -15,7 +17,8 @@ module Twilio
             ##
             # Initialize the SyncListList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The unique SID identifier of the Service Instance
+            #   that hosts this List object.
             # @return [SyncListList] SyncListList
             def initialize(version, service_sid: nil)
               super(version)
@@ -28,8 +31,9 @@ module Twilio
             ##
             # Retrieve a single page of SyncListInstance records from the API.
             # Request is executed immediately.
-            # @param [String] unique_name The unique_name
-            # @param [String] ttl The ttl
+            # @param [String] unique_name (optional) Human-readable name for this list
+            # @param [String] ttl (optional) Time-to-live of this List in seconds, defaults to
+            #   no expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity.
             # @return [SyncListInstance] Newly created SyncListInstance
             def create(unique_name: :unset, ttl: :unset)
               data = Twilio::Values.of({'UniqueName' => unique_name, 'Ttl' => ttl, })
@@ -281,7 +285,8 @@ module Twilio
             # Initialize the SyncListInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The unique SID identifier of the Service Instance
+            #   that hosts this List object.
             # @param [String] sid The sid
             # @return [SyncListInstance] SyncListInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
@@ -319,67 +324,67 @@ module Twilio
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique 34-character SID identifier of the List.
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The unique_name
+            # @return [String] The unique and addressable name of this List.
             def unique_name
               @properties['unique_name']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The unique SID identifier of the Twilio Account.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The service_sid
+            # @return [String] The unique SID identifier of the Service Instance that hosts this List object.
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL for this List.
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] A dictionary of URL links to nested resources of this List.
             def links
               @properties['links']
             end
 
             ##
-            # @return [String] The revision
+            # @return [String] Contains the current revision of this List, represented by a string identifier.
             def revision
               @properties['revision']
             end
 
             ##
-            # @return [Time] The date_expires
+            # @return [Time] Contains the date this List expires and gets deleted automatically.
             def date_expires
               @properties['date_expires']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The date this List was created, given in UTC ISO 8601 format.
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] Specifies the date this List was last updated, given in UTC ISO 8601 format.
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The created_by
+            # @return [String] The identity of the List creator.
             def created_by
               @properties['created_by']
             end

data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -16,8 +18,10 @@ module Twilio
               ##
               # Initialize the SyncMapItemList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] map_sid The map_sid
+              # @param [String] service_sid The unique SID identifier of the Service Instance
+              #   that hosts this Map object.
+              # @param [String] map_sid The unique 34-character SID identifier of the Map
+              #   containing this Item.
               # @return [SyncMapItemList] SyncMapItemList
               def initialize(version, service_sid: nil, map_sid: nil)
                 super(version)
@@ -32,7 +36,8 @@ module Twilio
               # Request is executed immediately.
               # @param [String] key The key
               # @param [Hash] data The data
-              # @param [String] ttl The ttl
+              # @param [String] ttl (optional) Time-to-live of this Map in seconds, defaults to
+              #   no expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity.
               # @return [SyncMapItemInstance] Newly created SyncMapItemInstance
               def create(key: nil, data: nil, ttl: :unset)
                 data = Twilio::Values.of({'Key' => key, 'Data' => Twilio.serialize_object(data), 'Ttl' => ttl, })
@@ -236,8 +241,10 @@ module Twilio
 
               ##
               # Update the SyncMapItemInstance
-              # @param [Hash] data The data
-              # @param [String] ttl The ttl
+              # @param [Hash] data (optional) Contains an arbitrary JSON object to be stored in
+              #   this Map Item. Serialized to string to respect HTTP form input, up to 16KB.
+              # @param [String] ttl New time-to-live of this Map in seconds. In the range [1, 31
+              #   536 000 (1 year)], or 0 for infinity.
               # @return [SyncMapItemInstance] Updated SyncMapItemInstance
               def update(data: :unset, ttl: :unset)
                 data = Twilio::Values.of({'Data' => Twilio.serialize_object(data), 'Ttl' => ttl, })
@@ -272,8 +279,10 @@ module Twilio
               # Initialize the SyncMapItemInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] service_sid The service_sid
-              # @param [String] map_sid The map_sid
+              # @param [String] service_sid The unique SID identifier of the Service Instance
+              #   that hosts this Map object.
+              # @param [String] map_sid The unique 34-character SID identifier of the Map
+              #   containing this Item.
               # @param [String] key The key
               # @return [SyncMapItemInstance] SyncMapItemInstance
               def initialize(version, payload, service_sid: nil, map_sid: nil, key: nil)
@@ -316,67 +325,67 @@ module Twilio
               end
 
               ##
-              # @return [String] The key
+              # @return [String] The unique user-defined key of this Map Item.
               def key
                 @properties['key']
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The unique SID identifier of the Twilio Account.
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The service_sid
+              # @return [String] The unique SID identifier of the Service Instance that hosts this Map object.
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] The map_sid
+              # @return [String] The unique 34-character SID identifier of the Map containing this Item.
               def map_sid
                 @properties['map_sid']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL for this Map.
               def url
                 @properties['url']
               end
 
               ##
-              # @return [String] The revision
+              # @return [String] Contains the current revision of this Map, represented by a string identifier.
               def revision
                 @properties['revision']
               end
 
               ##
-              # @return [Hash] The data
+              # @return [Hash] Contains arbitrary user-defined, schema-less data that this Map Item stores, represented by a JSON object, up to 16KB.
               def data
                 @properties['data']
               end
 
               ##
-              # @return [Time] The date_expires
+              # @return [Time] Contains the date this Map expires and gets deleted automatically.
               def date_expires
                 @properties['date_expires']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The date this Map was created, given in UTC ISO 8601 format.
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date_updated
+              # @return [Time] Specifies the date this Map was last updated, given in UTC ISO 8601 format.
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The created_by
+              # @return [String] The identity of the Map creator.
               def created_by
                 @properties['created_by']
               end
@@ -397,8 +406,10 @@ module Twilio
 
               ##
               # Update the SyncMapItemInstance
-              # @param [Hash] data The data
-              # @param [String] ttl The ttl
+              # @param [Hash] data (optional) Contains an arbitrary JSON object to be stored in
+              #   this Map Item. Serialized to string to respect HTTP form input, up to 16KB.
+              # @param [String] ttl New time-to-live of this Map in seconds. In the range [1, 31
+              #   536 000 (1 year)], or 0 for infinity.
               # @return [SyncMapItemInstance] Updated SyncMapItemInstance
               def update(data: :unset, ttl: :unset)
                 context.update(data: data, ttl: ttl, )

data/lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -160,7 +162,8 @@ module Twilio
               ##
               # Initialize the SyncMapPermissionContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
+              # @param [String] service_sid Identifier of the Sync Service Instance. Either a
+              #   SID or 'default'.
               # @param [String] map_sid Identifier of the Sync Map. Either a SID or a unique
               #   name.
               # @param [String] identity Arbitrary string identifier representing a user

data/lib/twilio-ruby/rest/sync/v1/service/sync_map.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -15,7 +17,8 @@ module Twilio
             ##
             # Initialize the SyncMapList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The unique SID identifier of the Service Instance
+            #   that hosts this Map object.
             # @return [SyncMapList] SyncMapList
             def initialize(version, service_sid: nil)
               super(version)
@@ -28,8 +31,9 @@ module Twilio
             ##
             # Retrieve a single page of SyncMapInstance records from the API.
             # Request is executed immediately.
-            # @param [String] unique_name The unique_name
-            # @param [String] ttl The ttl
+            # @param [String] unique_name (optional) Human-readable name for this map
+            # @param [String] ttl (optional) Time-to-live of this Map in seconds, defaults to
+            #   no expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity.
             # @return [SyncMapInstance] Newly created SyncMapInstance
             def create(unique_name: :unset, ttl: :unset)
               data = Twilio::Values.of({'UniqueName' => unique_name, 'Ttl' => ttl, })
@@ -208,7 +212,8 @@ module Twilio
 
             ##
             # Update the SyncMapInstance
-            # @param [String] ttl The ttl
+            # @param [String] ttl New time-to-live of this Map in seconds. In the range [1, 31
+            #   536 000 (1 year)], or 0 for infinity.
             # @return [SyncMapInstance] Updated SyncMapInstance
             def update(ttl: :unset)
               data = Twilio::Values.of({'Ttl' => ttl, })
@@ -281,7 +286,8 @@ module Twilio
             # Initialize the SyncMapInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The unique SID identifier of the Service Instance
+            #   that hosts this Map object.
             # @param [String] sid The sid
             # @return [SyncMapInstance] SyncMapInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
@@ -319,67 +325,67 @@ module Twilio
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique 34-character SID identifier of the Map.
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The unique_name
+            # @return [String] The unique and addressable name of this Map.
             def unique_name
               @properties['unique_name']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The unique SID identifier of the Twilio Account.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The service_sid
+            # @return [String] The unique SID identifier of the Service Instance that hosts this Map object.
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL for this Map.
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] A dictionary of URL links to nested resources of this Map.
             def links
               @properties['links']
             end
 
             ##
-            # @return [String] The revision
+            # @return [String] Contains the current revision of this Map, represented by a string identifier.
             def revision
               @properties['revision']
             end
 
             ##
-            # @return [Time] The date_expires
+            # @return [Time] Contains the date this Map expires and gets deleted automatically.
             def date_expires
               @properties['date_expires']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The date this Map was created, given in UTC ISO 8601 format.
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] Specifies the date this Map was last updated, given in UTC ISO 8601 format.
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The created_by
+            # @return [String] The identity of the Map creator.
             def created_by
               @properties['created_by']
             end
@@ -400,7 +406,8 @@ module Twilio
 
             ##
             # Update the SyncMapInstance
-            # @param [String] ttl The ttl
+            # @param [String] ttl New time-to-live of this Map in seconds. In the range [1, 31
+            #   536 000 (1 year)], or 0 for infinity.
             # @return [SyncMapInstance] Updated SyncMapInstance
             def update(ttl: :unset)
               context.update(ttl: ttl, )

data/lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -16,8 +18,10 @@ module Twilio
               ##
               # Initialize the StreamMessageList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The unique SID identifier of the Service Instance.
-              # @param [String] stream_sid The unique 34-character SID identifier of the Stream.
+              # @param [String] service_sid The unique SID identifier of the Service Instance
+              #   that hosts this Message Stream.
+              # @param [String] stream_sid The unique 34-character SID identifier of the Message
+              #   Stream.
               # @return [StreamMessageList] StreamMessageList
               def initialize(version, service_sid: nil, stream_sid: nil)
                 super(version)
@@ -100,8 +104,10 @@ module Twilio
               # Initialize the StreamMessageInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] service_sid The unique SID identifier of the Service Instance.
-              # @param [String] stream_sid The unique 34-character SID identifier of the Stream.
+              # @param [String] service_sid The unique SID identifier of the Service Instance
+              #   that hosts this Message Stream.
+              # @param [String] stream_sid The unique 34-character SID identifier of the Message
+              #   Stream.
               # @return [StreamMessageInstance] StreamMessageInstance
               def initialize(version, payload, service_sid: nil, stream_sid: nil)
                 super(version)