twilio-ruby 5.25.4 → 5.26.0

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

@@ -17,8 +17,9 @@ module Twilio
             ##
             # Initialize the DocumentList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The unique SID identifier of the Service Instance
-            #   that hosts this Document.
+            # @param [String] service_sid The SID of the [Sync
+            #   Service](https://www.twilio.com/docs/sync/api/service) the resource is
+            #   associated with.
             # @return [DocumentList] DocumentList
             def initialize(version, service_sid: nil)
               super(version)
@@ -31,10 +32,15 @@ module Twilio
             ##
             # Retrieve a single page of DocumentInstance records from the API.
             # Request is executed immediately.
-            # @param [String] unique_name Human-readable name for this document
-            # @param [Hash] data JSON data to be stored in this document
-            # @param [String] ttl Time-to-live of this Document 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 Sync Document
+            # @param [Hash] data A JSON string that represents an arbitrary, schema-less
+            #   object that the Sync Document stores. Can be up to 16KB in length.
+            # @param [String] ttl How long, in seconds, before the Sync Document expires and
+            #   is deleted (the Sync Document's time-to-live). Can be an integer from 0 to
+            #   31,536,000 (1 year). The default value is `0`, which means the Sync Document
+            #   does not expire. The Sync Document might not be deleted immediately after it
+            #   expires.
             # @return [DocumentInstance] Newly created DocumentInstance
             def create(unique_name: :unset, data: :unset, ttl: :unset)
               data = Twilio::Values.of({
@@ -178,8 +184,10 @@ module Twilio
             ##
             # Initialize the DocumentContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @param [String] sid The sid
+            # @param [String] service_sid The SID of the [Sync
+            #   Service](https://www.twilio.com/docs/sync/api/service) with the Document
+            #   resource to fetch.
+            # @param [String] sid The SID of the Document resource to fetch.
             # @return [DocumentContext] DocumentContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -209,17 +217,19 @@ module Twilio
 
             ##
             # Deletes the DocumentInstance
-            # @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 DocumentInstance
-            # @param [Hash] data Contains an arbitrary JSON object to be stored in this
-            #   Document. Serialized to string to respect HTTP form input, up to 16KB.
-            # @param [String] ttl New time-to-live of this Document in seconds. In the range
-            #   [1, 31 536 000 (1 year)], or 0 for infinity.
+            # @param [Hash] data A JSON string that represents an arbitrary, schema-less
+            #   object that the Sync Document stores. Can be up to 16KB in length.
+            # @param [String] ttl How long, in seconds, before the Sync Document 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 Document resource does not expire. The
+            #   Document resource might not be deleted immediately after it expires.
             # @return [DocumentInstance] Updated DocumentInstance
             def update(data: :unset, ttl: :unset)
               data = Twilio::Values.of({'Data' => Twilio.serialize_object(data), 'Ttl' => ttl, })
@@ -277,9 +287,10 @@ module Twilio
             # Initialize the DocumentInstance
             # @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 Document.
-            # @param [String] sid The sid
+            # @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 Document resource to fetch.
             # @return [DocumentInstance] DocumentInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -317,73 +328,73 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique 34-character SID identifier of the Document.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The unique and addressable name of this Document.
+            # @return [String] An application-defined string that uniquely identifies the resource
             def unique_name
               @properties['unique_name']
             end
 
             ##
-            # @return [String] The unique SID identifier of the Twilio Account.
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The unique SID identifier of the Service Instance that hosts this Document.
+            # @return [String] The SID of the Sync Service that the resource is associated with
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The absolute URL for this Document.
+            # @return [String] The absolute URL of the Document resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] A dictionary of URL links to nested resources of this Document.
+            # @return [String] The URLs of resources related to the Sync Document
             def links
               @properties['links']
             end
 
             ##
-            # @return [String] Contains the current revision of this Document, represented by a string identifier.
+            # @return [String] The current revision of the Sync Document, represented by a string identifier
             def revision
               @properties['revision']
             end
 
             ##
-            # @return [Hash] Contains arbitrary user-defined, schema-less data that this Document stores, represented by a JSON object, up to 16KB.
+            # @return [Hash] An arbitrary, schema-less object that the Sync Document stores
             def data
               @properties['data']
             end
 
             ##
-            # @return [Time] Contains the date this Document expires and gets deleted automatically.
+            # @return [Time] The ISO 8601 date and time in GMT when the Sync Document expires
             def date_expires
               @properties['date_expires']
             end
 
             ##
-            # @return [Time] The date this Document was created, given in UTC ISO 8601 format.
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] Specifies the date this Document was last updated, given in UTC ISO 8601 format.
+            # @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] The identity of the Document creator.
+            # @return [String] The identity of the Sync Document's creator
             def created_by
               @properties['created_by']
             end
@@ -397,17 +408,19 @@ module Twilio
 
             ##
             # Deletes the DocumentInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
             # Update the DocumentInstance
-            # @param [Hash] data Contains an arbitrary JSON object to be stored in this
-            #   Document. Serialized to string to respect HTTP form input, up to 16KB.
-            # @param [String] ttl New time-to-live of this Document in seconds. In the range
-            #   [1, 31 536 000 (1 year)], or 0 for infinity.
+            # @param [Hash] data A JSON string that represents an arbitrary, schema-less
+            #   object that the Sync Document stores. Can be up to 16KB in length.
+            # @param [String] ttl How long, in seconds, before the Sync Document 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 Document resource does not expire. The
+            #   Document resource might not be deleted immediately after it expires.
             # @return [DocumentInstance] Updated DocumentInstance
             def update(data: :unset, ttl: :unset)
               context.update(data: data, ttl: ttl, )

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

@@ -18,10 +18,11 @@ module Twilio
               ##
               # Initialize the DocumentPermissionList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The unique SID identifier of the Sync Service
-              #   Instance.
-              # @param [String] document_sid The unique SID identifier of the Sync Document 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] document_sid The SID of the Sync Document to which the Document
+              #   Permission applies.
               # @return [DocumentPermissionList] DocumentPermissionList
               def initialize(version, service_sid: nil, document_sid: nil)
                 super(version)
@@ -162,12 +163,14 @@ module Twilio
               ##
               # Initialize the DocumentPermissionContext
               # @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] document_sid Identifier of the Sync Document. 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 Document
+              #   Permission resource to fetch.
+              # @param [String] document_sid The SID of the Sync Document with the Document
+              #   Permission resource to fetch. Can be the Document resource's `sid` or its
+              #   `unique_name`.
+              # @param [String] identity The application-defined string that uniquely identifies
+              #   the User's Document Permission resource to fetch.
               # @return [DocumentPermissionContext] DocumentPermissionContext
               def initialize(version, service_sid, document_sid, identity)
                 super(version)
@@ -200,19 +203,16 @@ module Twilio
 
               ##
               # Deletes the DocumentPermissionInstance
-              # @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 DocumentPermissionInstance
-              # @param [Boolean] read Boolean flag specifying whether the identity can read the
-              #   Sync Document.
-              # @param [Boolean] write Boolean flag specifying whether the identity can update
-              #   the Sync Document.
-              # @param [Boolean] manage Boolean flag specifying whether the identity can delete
-              #   the Sync Document.
+              # @param [Boolean] read Whether the identity can read the Sync Document.
+              # @param [Boolean] write Whether the identity can update the Sync Document.
+              # @param [Boolean] manage Whether the identity can delete the Sync Document.
               # @return [DocumentPermissionInstance] Updated DocumentPermissionInstance
               def update(read: nil, write: nil, manage: nil)
                 data = Twilio::Values.of({'Read' => read, 'Write' => write, 'Manage' => manage, })
@@ -254,12 +254,13 @@ module Twilio
               # Initialize the DocumentPermissionInstance
               # @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] document_sid The unique SID identifier of the Sync Document 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] document_sid The SID of the Sync Document to which the Document
+              #   Permission applies.
+              # @param [String] identity The application-defined string that uniquely identifies
+              #   the User's Document Permission resource to fetch.
               # @return [DocumentPermissionInstance] DocumentPermissionInstance
               def initialize(version, payload, service_sid: nil, document_sid: nil, identity: nil)
                 super(version)
@@ -302,49 +303,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 Document SID.
+              # @return [String] The Sync Document SID
               def document_sid
                 @properties['document_sid']
               end
 
               ##
-              # @return [String] Identity of the user to whom the Sync Document 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 Document Permission.
+              # @return [String] The absolute URL of the Sync Document Permission resource
               def url
                 @properties['url']
               end
@@ -358,19 +359,16 @@ module Twilio
 
               ##
               # Deletes the DocumentPermissionInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end
 
               ##
               # Update the DocumentPermissionInstance
-              # @param [Boolean] read Boolean flag specifying whether the identity can read the
-              #   Sync Document.
-              # @param [Boolean] write Boolean flag specifying whether the identity can update
-              #   the Sync Document.
-              # @param [Boolean] manage Boolean flag specifying whether the identity can delete
-              #   the Sync Document.
+              # @param [Boolean] read Whether the identity can read the Sync Document.
+              # @param [Boolean] write Whether the identity can update the Sync Document.
+              # @param [Boolean] manage Whether the identity can delete the Sync Document.
               # @return [DocumentPermissionInstance] Updated DocumentPermissionInstance
               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_list.rb

@@ -17,8 +17,9 @@ module Twilio
             ##
             # Initialize the SyncListList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The unique SID identifier of the Service Instance
-            #   that hosts this List object.
+            # @param [String] service_sid The SID of the [Sync
+            #   Service](https://www.twilio.com/docs/sync/api/service) the resource is
+            #   associated with.
             # @return [SyncListList] SyncListList
             def initialize(version, service_sid: nil)
               super(version)
@@ -31,11 +32,16 @@ module Twilio
             ##
             # Retrieve a single page of SyncListInstance records from the API.
             # Request is executed immediately.
-            # @param [String] unique_name Human-readable name for this list
+            # @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 Alias for collection_ttl. If both are provided, this value
             #   is ignored.
-            # @param [String] collection_ttl 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.
+            # @param [String] collection_ttl How long, in seconds, before the Sync List
+            #   expires (time-to-live) and is deleted.  Can be an integer from 0 to 31,536,000
+            #   (1 year). The default value is `0`, which means the Sync List does not expire.
+            #   The Sync List might not be deleted immediately after it expires.
             # @return [SyncListInstance] Newly created SyncListInstance
             def create(unique_name: :unset, ttl: :unset, collection_ttl: :unset)
               data = Twilio::Values.of({
@@ -179,8 +185,10 @@ module Twilio
             ##
             # Initialize the SyncListContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @param [String] sid The sid
+            # @param [String] service_sid The SID of the [Sync
+            #   Service](https://www.twilio.com/docs/sync/api/service) with the Sync List
+            #   resource to fetch.
+            # @param [String] sid The SID of the Sync List resource to fetch.
             # @return [SyncListContext] SyncListContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -211,17 +219,19 @@ module Twilio
 
             ##
             # Deletes the SyncListInstance
-            # @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 SyncListInstance
-            # @param [String] ttl Alias for collection_ttl. If both are provided, this value
-            #   is ignored.
-            # @param [String] collection_ttl 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.
+            # @param [String] ttl An alias for `collection_ttl`. If both are provided, this
+            #   value is ignored.
+            # @param [String] collection_ttl How long, in seconds, before the Sync List
+            #   expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1
+            #   year). The default value is `0`, which means the Sync List does not expire. The
+            #   Sync List might not be deleted immediately after it expires.
             # @return [SyncListInstance] Updated SyncListInstance
             def update(ttl: :unset, collection_ttl: :unset)
               data = Twilio::Values.of({'Ttl' => ttl, 'CollectionTtl' => collection_ttl, })
@@ -301,9 +311,10 @@ 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 unique SID identifier of the Service Instance
-            #   that hosts this List object.
-            # @param [String] sid The sid
+            # @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 Sync List resource to fetch.
             # @return [SyncListInstance] SyncListInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -340,67 +351,67 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique 34-character SID identifier of the List.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The unique and addressable name of this List.
+            # @return [String] An application-defined string that uniquely identifies the resource
             def unique_name
               @properties['unique_name']
             end
 
             ##
-            # @return [String] The unique SID identifier of the Twilio Account.
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The unique SID identifier of the Service Instance that hosts this List object.
+            # @return [String] The SID of the Sync Service that the resource is associated with
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The absolute URL for this List.
+            # @return [String] The absolute URL of the Sync List resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] A dictionary of URL links to nested resources of this List.
+            # @return [String] The URLs of the Sync List's nested resources
             def links
               @properties['links']
             end
 
             ##
-            # @return [String] Contains the current revision of this List, represented by a string identifier.
+            # @return [String] The current revision of the Sync List, represented as a string
             def revision
               @properties['revision']
             end
 
             ##
-            # @return [Time] Contains the date this List expires and gets deleted automatically.
+            # @return [Time] The ISO 8601 date and time in GMT when the Sync List expires
             def date_expires
               @properties['date_expires']
             end
 
             ##
-            # @return [Time] The date this List was created, given in UTC ISO 8601 format.
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] Specifies the date this List was last updated, given in UTC ISO 8601 format.
+            # @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] The identity of the List creator.
+            # @return [String] The identity of the Sync List's creator
             def created_by
               @properties['created_by']
             end
@@ -414,17 +425,19 @@ module Twilio
 
             ##
             # Deletes the SyncListInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
             # Update the SyncListInstance
-            # @param [String] ttl Alias for collection_ttl. If both are provided, this value
-            #   is ignored.
-            # @param [String] collection_ttl 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.
+            # @param [String] ttl An alias for `collection_ttl`. If both are provided, this
+            #   value is ignored.
+            # @param [String] collection_ttl How long, in seconds, before the Sync List
+            #   expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1
+            #   year). The default value is `0`, which means the Sync List does not expire. The
+            #   Sync List might not be deleted immediately after it expires.
             # @return [SyncListInstance] Updated SyncListInstance
             def update(ttl: :unset, collection_ttl: :unset)
               context.update(ttl: ttl, collection_ttl: collection_ttl, )