twilio-ruby 5.6.0 → 5.33.0

data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_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 SyncListItemList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] list_sid The list_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] list_sid The SID of the Sync List that contains the List Item.
               # @return [SyncListItemList] SyncListItemList
               def initialize(version, service_sid: nil, list_sid: nil)
                 super(version)
@@ -30,11 +34,29 @@ module Twilio
               ##
               # Retrieve a single page of SyncListItemInstance records from the API.
               # Request is executed immediately.
-              # @param [Hash] data The data
-              # @param [String] ttl The ttl
+              # @param [Hash] data A JSON string that represents an arbitrary, schema-less
+              #   object that the List Item stores. Can be up to 16KB in length.
+              # @param [String] ttl An alias for `item_ttl`. If both parameters are provided,
+              #   this value is ignored.
+              # @param [String] item_ttl How long, in seconds, before the List Item 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 List Item does not expire. The List
+              #   Item will be deleted automatically after it expires, but there can be a delay
+              #   between the expiration time and the resources's deletion.
+              # @param [String] collection_ttl How long, in seconds, before the List Item's
+              #   parent 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 parent Sync
+              #   List does not expire. The Sync List will be deleted automatically after it
+              #   expires, but there can be a delay between the expiration time and the
+              #   resources's deletion.
               # @return [SyncListItemInstance] Newly created SyncListItemInstance
-              def create(data: nil, ttl: :unset)
-                data = Twilio::Values.of({'Data' => Twilio.serialize_object(data), 'Ttl' => ttl})
+              def create(data: nil, ttl: :unset, item_ttl: :unset, collection_ttl: :unset)
+                data = Twilio::Values.of({
+                    'Data' => Twilio.serialize_object(data),
+                    'Ttl' => ttl,
+                    'ItemTtl' => item_ttl,
+                    'CollectionTtl' => collection_ttl,
+                })
 
                 payload = @version.create(
                     'POST',
@@ -54,9 +76,15 @@ module Twilio
               # Lists SyncListItemInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [sync_list_item.QueryResultOrder] order The order
-              # @param [String] from The from
-              # @param [sync_list_item.QueryFromBoundType] bounds The bounds
+              # @param [sync_list_item.QueryResultOrder] order How to order the List Items
+              #   returned by their `index` value. Can be: `asc` (ascending) or `desc`
+              #   (descending) and the default is ascending.
+              # @param [String] from The `index` of the first Sync List Item resource to read.
+              #   See also `bounds`.
+              # @param [sync_list_item.QueryFromBoundType] bounds Whether to include the List
+              #   Item referenced by the `from` parameter. Can be: `inclusive` to include the List
+              #   Item referenced by the `from` parameter or `exclusive` to start with the next
+              #   List Item. The default value is `inclusive`.
               # @param [Integer] limit Upper limit for the number of records to return. stream()
               #    guarantees to never return more than limit.  Default is no limit
               # @param [Integer] page_size Number of records to fetch per request, when
@@ -72,9 +100,15 @@ module Twilio
               # Streams SyncListItemInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [sync_list_item.QueryResultOrder] order The order
-              # @param [String] from The from
-              # @param [sync_list_item.QueryFromBoundType] bounds The bounds
+              # @param [sync_list_item.QueryResultOrder] order How to order the List Items
+              #   returned by their `index` value. Can be: `asc` (ascending) or `desc`
+              #   (descending) and the default is ascending.
+              # @param [String] from The `index` of the first Sync List Item resource to read.
+              #   See also `bounds`.
+              # @param [sync_list_item.QueryFromBoundType] bounds Whether to include the List
+              #   Item referenced by the `from` parameter. Can be: `inclusive` to include the List
+              #   Item referenced by the `from` parameter or `exclusive` to start with the next
+              #   List Item. The default value is `inclusive`.
               # @param [Integer] limit Upper limit for the number of records to return. stream()
               #    guarantees to never return more than limit. Default is no limit.
               # @param [Integer] page_size Number of records to fetch per request, when
@@ -85,7 +119,7 @@ module Twilio
               def stream(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(order: order, from: from, bounds: bounds, page_size: limits[:page_size])
+                page = self.page(order: order, from: from, bounds: bounds, page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -97,7 +131,7 @@ module Twilio
               def each
                 limits = @version.read_limits
 
-                page = self.page(page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page,
                                 limit: limits[:limit],
@@ -107,9 +141,15 @@ module Twilio
               ##
               # Retrieve a single page of SyncListItemInstance records from the API.
               # Request is executed immediately.
-              # @param [sync_list_item.QueryResultOrder] order The order
-              # @param [String] from The from
-              # @param [sync_list_item.QueryFromBoundType] bounds The bounds
+              # @param [sync_list_item.QueryResultOrder] order How to order the List Items
+              #   returned by their `index` value. Can be: `asc` (ascending) or `desc`
+              #   (descending) and the default is ascending.
+              # @param [String] from The `index` of the first Sync List Item resource to read.
+              #   See also `bounds`.
+              # @param [sync_list_item.QueryFromBoundType] bounds Whether to include the List
+              #   Item referenced by the `from` parameter. Can be: `inclusive` to include the List
+              #   Item referenced by the `from` parameter or `exclusive` to start with the next
+              #   List Item. The default value is `inclusive`.
               # @param [String] page_token PageToken provided by the API
               # @param [Integer] page_number Page Number, this value is simply for client state
               # @param [Integer] page_size Number of records to return, defaults to 50
@@ -193,15 +233,18 @@ module Twilio
               ##
               # Initialize the SyncListItemContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] list_sid The list_sid
-              # @param [String] index The index
+              # @param [String] service_sid The SID of the [Sync
+              #   Service](https://www.twilio.com/docs/sync/api/service) with the Sync List Item
+              #   resource to fetch.
+              # @param [String] list_sid The SID of the Sync List with the Sync List Item
+              #   resource to fetch. Can be the Sync List resource's `sid` or its `unique_name`.
+              # @param [String] index The index of the Sync List Item resource to fetch.
               # @return [SyncListItemContext] SyncListItemContext
               def initialize(version, service_sid, list_sid, index)
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, list_sid: list_sid, index: index}
+                @solution = {service_sid: service_sid, list_sid: list_sid, index: index, }
                 @uri = "/Services/#{@solution[:service_sid]}/Lists/#{@solution[:list_sid]}/Items/#{@solution[:index]}"
               end
 
@@ -228,18 +271,36 @@ module Twilio
 
               ##
               # Deletes the SyncListItemInstance
-              # @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 SyncListItemInstance
-              # @param [Hash] data The data
-              # @param [String] ttl The ttl
+              # @param [Hash] data A JSON string that represents an arbitrary, schema-less
+              #   object that the List Item stores. Can be up to 16KB in length.
+              # @param [String] ttl An alias for `item_ttl`. If both parameters are provided,
+              #   this value is ignored.
+              # @param [String] item_ttl How long, in seconds, before the List Item 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 List Item does not expire. The List
+              #   Item will be deleted automatically after it expires, but there can be a delay
+              #   between the expiration time and the resources's deletion.
+              # @param [String] collection_ttl How long, in seconds, before the List Item's
+              #   parent 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 parent Sync
+              #   List does not expire. The Sync List will be deleted automatically after it
+              #   expires, but there can be a delay between the expiration time and the
+              #   resources's deletion.
               # @return [SyncListItemInstance] Updated SyncListItemInstance
-              def update(data: :unset, ttl: :unset)
-                data = Twilio::Values.of({'Data' => Twilio.serialize_object(data), 'Ttl' => ttl})
+              def update(data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset)
+                data = Twilio::Values.of({
+                    'Data' => Twilio.serialize_object(data),
+                    'Ttl' => ttl,
+                    'ItemTtl' => item_ttl,
+                    'CollectionTtl' => collection_ttl,
+                })
 
                 payload = @version.update(
                     'POST',
@@ -262,6 +323,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Sync.V1.SyncListItemContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Sync.V1.SyncListItemContext #{context}>"
+              end
             end
 
             ##
@@ -271,9 +339,11 @@ module Twilio
               # Initialize the SyncListItemInstance
               # @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] list_sid The list_sid
-              # @param [String] index The index
+              # @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] list_sid The SID of the Sync List that contains the List Item.
+              # @param [String] index The index of the Sync List Item resource to fetch.
               # @return [SyncListItemInstance] SyncListItemInstance
               def initialize(version, payload, service_sid: nil, list_sid: nil, index: nil)
                 super(version)
@@ -319,67 +389,67 @@ module Twilio
               end
 
               ##
-              # @return [String] The index
+              # @return [String] The automatically generated index of the List Item
               def index
                 @properties['index']
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The service_sid
+              # @return [String] The SID of the Sync Service that the resource is associated with
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] The list_sid
+              # @return [String] The SID of the Sync List that contains the List Item
               def list_sid
                 @properties['list_sid']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the List Item resource
               def url
                 @properties['url']
               end
 
               ##
-              # @return [String] The revision
+              # @return [String] The current revision of the item, represented as a string
               def revision
                 @properties['revision']
               end
 
               ##
-              # @return [Hash] The data
+              # @return [Hash] An arbitrary, schema-less object that the List Item stores
               def data
                 @properties['data']
               end
 
               ##
-              # @return [Time] The date_expires
+              # @return [Time] The ISO 8601 date and time in GMT when the List Item expires
               def date_expires
                 @properties['date_expires']
               end
 
               ##
-              # @return [Time] The date_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_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] The created_by
+              # @return [String] The identity of the List Item's creator
               def created_by
                 @properties['created_by']
               end
@@ -393,18 +463,31 @@ module Twilio
 
               ##
               # Deletes the SyncListItemInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end
 
               ##
               # Update the SyncListItemInstance
-              # @param [Hash] data The data
-              # @param [String] ttl The ttl
+              # @param [Hash] data A JSON string that represents an arbitrary, schema-less
+              #   object that the List Item stores. Can be up to 16KB in length.
+              # @param [String] ttl An alias for `item_ttl`. If both parameters are provided,
+              #   this value is ignored.
+              # @param [String] item_ttl How long, in seconds, before the List Item 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 List Item does not expire. The List
+              #   Item will be deleted automatically after it expires, but there can be a delay
+              #   between the expiration time and the resources's deletion.
+              # @param [String] collection_ttl How long, in seconds, before the List Item's
+              #   parent 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 parent Sync
+              #   List does not expire. The Sync List will be deleted automatically after it
+              #   expires, but there can be a delay between the expiration time and the
+              #   resources's deletion.
               # @return [SyncListItemInstance] Updated SyncListItemInstance
-              def update(data: :unset, ttl: :unset)
-                context.update(data: data, ttl: ttl)
+              def update(data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset)
+                context.update(data: data, ttl: ttl, item_ttl: item_ttl, collection_ttl: collection_ttl, )
               end
 
               ##

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
@@ -16,10 +18,11 @@ module Twilio
               ##
               # Initialize the SyncListPermissionList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The unique SID identifier of the Sync Service
-              #   Instance.
-              # @param [String] list_sid The unique SID identifier of the Sync List 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] list_sid The SID of the Sync List to which the Permission
+              #   applies.
               # @return [SyncListPermissionList] SyncListPermissionList
               def initialize(version, service_sid: nil, list_sid: nil)
                 super(version)
@@ -58,7 +61,7 @@ module Twilio
               def stream(limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -70,7 +73,7 @@ module Twilio
               def each
                 limits = @version.read_limits
 
-                page = self.page(page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page,
                                 limit: limits[:limit],
@@ -160,17 +163,19 @@ module Twilio
               ##
               # Initialize the SyncListPermissionContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @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
-              #   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 List
+              #   Permission resource to fetch.
+              # @param [String] list_sid The SID of the Sync List with the Sync List Permission
+              #   resource to fetch. Can be the Sync List resource's `sid` or its `unique_name`.
+              # @param [String] identity The application-defined string that uniquely identifies
+              #   the User's Sync List Permission resource to fetch.
               # @return [SyncListPermissionContext] SyncListPermissionContext
               def initialize(version, service_sid, list_sid, identity)
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, list_sid: list_sid, identity: identity}
+                @solution = {service_sid: service_sid, list_sid: list_sid, identity: identity, }
                 @uri = "/Services/#{@solution[:service_sid]}/Lists/#{@solution[:list_sid]}/Permissions/#{@solution[:identity]}"
               end
 
@@ -197,22 +202,22 @@ module Twilio
 
               ##
               # Deletes the SyncListPermissionInstance
-              # @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 SyncListPermissionInstance
-              # @param [Boolean] read Boolean flag specifying whether the identity can read the
-              #   Sync List.
-              # @param [Boolean] write Boolean flag specifying whether the identity can create,
-              #   update and delete Items of the Sync List.
-              # @param [Boolean] manage Boolean flag specifying whether the identity can delete
-              #   the Sync List.
+              # @param [Boolean] read Whether the identity can read the Sync List and its Items.
+              #   Default value is `false`.
+              # @param [Boolean] write Whether the identity can create, update, and delete Items
+              #   in the Sync List. Default value is `false`.
+              # @param [Boolean] manage Whether the identity can delete the Sync List. Default
+              #   value is `false`.
               # @return [SyncListPermissionInstance] Updated SyncListPermissionInstance
               def update(read: nil, write: nil, manage: nil)
-                data = Twilio::Values.of({'Read' => read, 'Write' => write, 'Manage' => manage})
+                data = Twilio::Values.of({'Read' => read, 'Write' => write, 'Manage' => manage, })
 
                 payload = @version.update(
                     'POST',
@@ -235,6 +240,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Sync.V1.SyncListPermissionContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Sync.V1.SyncListPermissionContext #{context}>"
+              end
             end
 
             ##
@@ -244,12 +256,13 @@ module Twilio
               # Initialize the SyncListPermissionInstance
               # @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] list_sid The unique SID identifier of the Sync List 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] list_sid The SID of the Sync List to which the Permission
+              #   applies.
+              # @param [String] identity The application-defined string that uniquely identifies
+              #   the User's Sync List Permission resource to fetch.
               # @return [SyncListPermissionInstance] SyncListPermissionInstance
               def initialize(version, payload, service_sid: nil, list_sid: nil, identity: nil)
                 super(version)
@@ -292,49 +305,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 List SID.
+              # @return [String] The SID of the Sync List to which the Permission applies
               def list_sid
                 @properties['list_sid']
               end
 
               ##
-              # @return [String] Identity of the user to whom the Sync List Permission applies.
+              # @return [String] The identity of the user to whom the Sync List 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 List Permission.
+              # @return [String] The absolute URL of the Sync List Permission resource
               def url
                 @properties['url']
               end
@@ -348,22 +361,22 @@ module Twilio
 
               ##
               # Deletes the SyncListPermissionInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end
 
               ##
               # Update the SyncListPermissionInstance
-              # @param [Boolean] read Boolean flag specifying whether the identity can read the
-              #   Sync List.
-              # @param [Boolean] write Boolean flag specifying whether the identity can create,
-              #   update and delete Items of the Sync List.
-              # @param [Boolean] manage Boolean flag specifying whether the identity can delete
-              #   the Sync List.
+              # @param [Boolean] read Whether the identity can read the Sync List and its Items.
+              #   Default value is `false`.
+              # @param [Boolean] write Whether the identity can create, update, and delete Items
+              #   in the Sync List. Default value is `false`.
+              # @param [Boolean] manage Whether the identity can delete the Sync List. Default
+              #   value is `false`.
               # @return [SyncListPermissionInstance] Updated SyncListPermissionInstance
               def update(read: nil, write: nil, manage: nil)
-                context.update(read: read, write: write, manage: manage)
+                context.update(read: read, write: write, manage: manage, )
               end
 
               ##