twilio-ruby 5.25.4 → 5.26.0

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

@@ -18,10 +18,10 @@ module Twilio
               ##
               # Initialize the SyncMapPermissionList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The unique SID identifier of the Sync Service
-              #   Instance.
-              # @param [String] map_sid The unique SID identifier of the Sync Map to which the
-              #   Permission applies.
+              # @param [String] service_sid The SID of the [Sync
+              #   Service](https://www.twilio.com/docs/sync/api/service) the resource is
+              #   associated with.
+              # @param [String] map_sid The SID of the Sync Map to which the Permission applies.
               # @return [SyncMapPermissionList] SyncMapPermissionList
               def initialize(version, service_sid: nil, map_sid: nil)
                 super(version)
@@ -162,12 +162,13 @@ module Twilio
               ##
               # Initialize the SyncMapPermissionContext
               # @param [Version] version Version that contains the resource
-              # @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
-              #   associated with an FPA token, assigned by the developer.
+              # @param [String] service_sid The SID of the [Sync
+              #   Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map
+              #   Permission resource to fetch. Can be the Service's `sid` value or `default`.
+              # @param [String] map_sid The SID of the Sync Map with the Sync Map Permission
+              #   resource to fetch. Can be the Sync Map's `sid` or its `unique_name`.
+              # @param [String] identity The application-defined string that uniquely identifies
+              #   the User's Sync Map Permission resource to fetch.
               # @return [SyncMapPermissionContext] SyncMapPermissionContext
               def initialize(version, service_sid, map_sid, identity)
                 super(version)
@@ -200,19 +201,17 @@ module Twilio
 
               ##
               # Deletes the SyncMapPermissionInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 @version.delete('delete', @uri)
               end
 
               ##
               # Update the SyncMapPermissionInstance
-              # @param [Boolean] read Boolean flag specifying whether the identity can read the
-              #   Sync Map.
-              # @param [Boolean] write Boolean flag specifying whether the identity can create,
-              #   update and delete Items of the Sync Map.
-              # @param [Boolean] manage Boolean flag specifying whether the identity can delete
-              #   the Sync Map.
+              # @param [Boolean] read Whether the identity can read the Sync Map and its Items.
+              # @param [Boolean] write Whether the identity can create, update and delete Items
+              #   of the Sync Map.
+              # @param [Boolean] manage Whether the identity can delete the Sync Map.
               # @return [SyncMapPermissionInstance] Updated SyncMapPermissionInstance
               def update(read: nil, write: nil, manage: nil)
                 data = Twilio::Values.of({'Read' => read, 'Write' => write, 'Manage' => manage, })
@@ -254,12 +253,12 @@ module Twilio
               # Initialize the SyncMapPermissionInstance
               # @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 Sync Service
-              #   Instance.
-              # @param [String] map_sid The unique SID identifier of the Sync Map to which the
-              #   Permission applies.
-              # @param [String] identity Arbitrary string identifier representing a user
-              #   associated with an FPA token, assigned by the developer.
+              # @param [String] service_sid The SID of the [Sync
+              #   Service](https://www.twilio.com/docs/sync/api/service) the resource is
+              #   associated with.
+              # @param [String] map_sid The SID of the Sync Map to which the Permission applies.
+              # @param [String] identity The application-defined string that uniquely identifies
+              #   the User's Sync Map Permission resource to fetch.
               # @return [SyncMapPermissionInstance] SyncMapPermissionInstance
               def initialize(version, payload, service_sid: nil, map_sid: nil, identity: nil)
                 super(version)
@@ -302,49 +301,49 @@ module Twilio
               end
 
               ##
-              # @return [String] Twilio Account SID.
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] Sync Service Instance SID.
+              # @return [String] The SID of the Sync Service that the resource is associated with
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] Sync Map SID.
+              # @return [String] Sync Map SID
               def map_sid
                 @properties['map_sid']
               end
 
               ##
-              # @return [String] Identity of the user to whom the Sync Map Permission applies.
+              # @return [String] The identity of the user to whom the Sync Document Permission applies
               def identity
                 @properties['identity']
               end
 
               ##
-              # @return [Boolean] Read access.
+              # @return [Boolean] Read access
               def read
                 @properties['read']
               end
 
               ##
-              # @return [Boolean] Write access.
+              # @return [Boolean] Write access
               def write
                 @properties['write']
               end
 
               ##
-              # @return [Boolean] Manage access.
+              # @return [Boolean] Manage access
               def manage
                 @properties['manage']
               end
 
               ##
-              # @return [String] URL of this Sync Map Permission.
+              # @return [String] The absolute URL of the Sync Map Permission resource
               def url
                 @properties['url']
               end
@@ -358,19 +357,17 @@ module Twilio
 
               ##
               # Deletes the SyncMapPermissionInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end
 
               ##
               # Update the SyncMapPermissionInstance
-              # @param [Boolean] read Boolean flag specifying whether the identity can read the
-              #   Sync Map.
-              # @param [Boolean] write Boolean flag specifying whether the identity can create,
-              #   update and delete Items of the Sync Map.
-              # @param [Boolean] manage Boolean flag specifying whether the identity can delete
-              #   the Sync Map.
+              # @param [Boolean] read Whether the identity can read the Sync Map and its Items.
+              # @param [Boolean] write Whether the identity can create, update and delete Items
+              #   of the Sync Map.
+              # @param [Boolean] manage Whether the identity can delete the Sync Map.
               # @return [SyncMapPermissionInstance] Updated SyncMapPermissionInstance
               def update(read: nil, write: nil, manage: nil)
                 context.update(read: read, write: write, manage: manage, )

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

@@ -17,8 +17,9 @@ module Twilio
             ##
             # Initialize the SyncStreamList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The unique SID identifier of the Service Instance
-            #   that hosts this Message Stream.
+            # @param [String] service_sid The SID of the [Sync
+            #   Service](https://www.twilio.com/docs/sync/api/service) the resource is
+            #   associated with.
             # @return [SyncStreamList] SyncStreamList
             def initialize(version, service_sid: nil)
               super(version)
@@ -31,10 +32,14 @@ module Twilio
             ##
             # Retrieve a single page of SyncStreamInstance records from the API.
             # Request is executed immediately.
-            # @param [String] unique_name The unique and addressable name of this Stream.
-            #   Optional, up to 320 characters long.
-            # @param [String] ttl Time-to-live of this Stream in seconds, defaults to no
-            #   expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity.
+            # @param [String] unique_name An application-defined string that uniquely
+            #   identifies the resource. This value must be unique within its Service and it can
+            #   be up to 320 characters long. The `unique_name` value can be used as an
+            #   alternative to the `sid` in the URL path to address the resource.
+            # @param [String] ttl How long, in seconds, before the Stream expires and is
+            #   deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The
+            #   default value is `0`, which means the Stream does not expire. The Stream might
+            #   not be deleted immediately after it expires.
             # @return [SyncStreamInstance] Newly created SyncStreamInstance
             def create(unique_name: :unset, ttl: :unset)
               data = Twilio::Values.of({'UniqueName' => unique_name, 'Ttl' => ttl, })
@@ -174,9 +179,10 @@ module Twilio
             ##
             # Initialize the SyncStreamContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid Identifier of the Service Instance. Either a SID or
-            #   'default'.
-            # @param [String] sid Identifier of the Stream. Either a SID or a unique name.
+            # @param [String] service_sid The SID of the [Sync
+            #   Service](https://www.twilio.com/docs/sync/api/service) with the Sync Stream
+            #   resource to fetch.
+            # @param [String] sid The SID of the Stream resource to fetch.
             # @return [SyncStreamContext] SyncStreamContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -211,15 +217,17 @@ module Twilio
 
             ##
             # Deletes the SyncStreamInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
 
             ##
             # Update the SyncStreamInstance
-            # @param [String] ttl New time-to-live of this Stream in seconds. In the range [1,
-            #   31 536 000 (1 year)], or 0 for infinity.
+            # @param [String] ttl How long, in seconds, before the Stream expires and is
+            #   deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The
+            #   default value is `0`, which means the Stream does not expire. The Sync Map might
+            #   not be deleted immediately after it expires.
             # @return [SyncStreamInstance] Updated SyncStreamInstance
             def update(ttl: :unset)
               data = Twilio::Values.of({'Ttl' => ttl, })
@@ -276,9 +284,10 @@ module Twilio
             # Initialize the SyncStreamInstance
             # @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
-            #   that hosts this Message Stream.
-            # @param [String] sid Identifier of the Stream. Either a SID or a unique name.
+            # @param [String] service_sid The SID of the [Sync
+            #   Service](https://www.twilio.com/docs/sync/api/service) the resource is
+            #   associated with.
+            # @param [String] sid The SID of the Stream resource to fetch.
             # @return [SyncStreamInstance] SyncStreamInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -314,61 +323,61 @@ module Twilio
             end
 
             ##
-            # @return [String] Stream SID.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] Stream unique name.
+            # @return [String] An application-defined string that uniquely identifies the resource
             def unique_name
               @properties['unique_name']
             end
 
             ##
-            # @return [String] Twilio Account SID.
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] Service Instance SID.
+            # @return [String] The SID of the Sync Service that the resource is associated with
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] URL of this Stream.
+            # @return [String] The absolute URL of the Message Stream resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] Nested resource URLs.
+            # @return [String] The URLs of the Stream's nested resources
             def links
               @properties['links']
             end
 
             ##
-            # @return [Time] The date this Stream expires.
+            # @return [Time] The ISO 8601 date and time in GMT when the Message Stream expires
             def date_expires
               @properties['date_expires']
             end
 
             ##
-            # @return [Time] The date this Stream was created.
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date this Stream was updated.
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] Identity of the Stream creator.
+            # @return [String] The Identity of the Stream's creator
             def created_by
               @properties['created_by']
             end
@@ -382,15 +391,17 @@ module Twilio
 
             ##
             # Deletes the SyncStreamInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
             # Update the SyncStreamInstance
-            # @param [String] ttl New time-to-live of this Stream in seconds. In the range [1,
-            #   31 536 000 (1 year)], or 0 for infinity.
+            # @param [String] ttl How long, in seconds, before the Stream expires and is
+            #   deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The
+            #   default value is `0`, which means the Stream does not expire. The Sync Map might
+            #   not be deleted immediately after it expires.
             # @return [SyncStreamInstance] Updated SyncStreamInstance
             def update(ttl: :unset)
               context.update(ttl: ttl, )

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

@@ -18,10 +18,11 @@ 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
-              #   that hosts this Message Stream.
-              # @param [String] stream_sid The unique 34-character SID identifier of the Message
-              #   Stream.
+              # @param [String] service_sid The SID of the [Sync
+              #   Service](https://www.twilio.com/docs/sync/api/service) the resource is
+              #   associated with.
+              # @param [String] stream_sid The unique string that we created to identify the
+              #   Sync Stream resource.
               # @return [StreamMessageList] StreamMessageList
               def initialize(version, service_sid: nil, stream_sid: nil)
                 super(version)
@@ -34,8 +35,8 @@ module Twilio
               ##
               # Retrieve a single page of StreamMessageInstance records from the API.
               # Request is executed immediately.
-              # @param [Hash] data The body of the Stream Message. Arbitrary JSON object,
-              #   maximum size 4KB.
+              # @param [Hash] data A JSON string that represents an arbitrary, schema-less
+              #   object that makes up the Stream Message body. Can be up to 4KB in length.
               # @return [StreamMessageInstance] Newly created StreamMessageInstance
               def create(data: nil)
                 data = Twilio::Values.of({'Data' => Twilio.serialize_object(data), })
@@ -104,10 +105,11 @@ 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
-              #   that hosts this Message Stream.
-              # @param [String] stream_sid The unique 34-character SID identifier of the Message
-              #   Stream.
+              # @param [String] service_sid The SID of the [Sync
+              #   Service](https://www.twilio.com/docs/sync/api/service) the resource is
+              #   associated with.
+              # @param [String] stream_sid The unique string that we created to identify the
+              #   Sync Stream resource.
               # @return [StreamMessageInstance] StreamMessageInstance
               def initialize(version, payload, service_sid: nil, stream_sid: nil)
                 super(version)
@@ -117,13 +119,13 @@ module Twilio
               end
 
               ##
-              # @return [String] Stream Message SID.
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [Hash] Stream Message body.
+              # @return [Hash] Stream Message body
               def data
                 @properties['data']
               end

data/lib/twilio-ruby/rest/taskrouter/v1/workspace.rb

@@ -289,7 +289,7 @@ module Twilio
 
           ##
           # Deletes the WorkspaceInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             @version.delete('delete', @uri)
           end
@@ -640,7 +640,7 @@ module Twilio
 
           ##
           # Deletes the WorkspaceInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb

@@ -249,7 +249,7 @@ module Twilio
 
             ##
             # Deletes the ActivityInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -377,7 +377,7 @@ module Twilio
 
             ##
             # Deletes the ActivityInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb

@@ -353,7 +353,7 @@ module Twilio
 
             ##
             # Deletes the TaskInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -601,7 +601,7 @@ module Twilio
 
             ##
             # Deletes the TaskInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb

@@ -233,7 +233,7 @@ module Twilio
 
             ##
             # Deletes the TaskChannelInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -374,7 +374,7 @@ module Twilio
 
             ##
             # Deletes the TaskChannelInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end