twilio-ruby 5.6.0 → 5.33.0

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 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 that contains the Map Item.
               # @return [SyncMapItemList] SyncMapItemList
               def initialize(version, service_sid: nil, map_sid: nil)
                 super(version)
@@ -30,12 +34,32 @@ module Twilio
               ##
               # Retrieve a single page of SyncMapItemInstance records from the API.
               # Request is executed immediately.
-              # @param [String] key The key
-              # @param [Hash] data The data
-              # @param [String] ttl The ttl
+              # @param [String] key The unique, user-defined key for the Map Item. Can be up to
+              #   320 characters long.
+              # @param [Hash] data A JSON string that represents an arbitrary, schema-less
+              #   object that the Map 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 Map 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 Map Item does not expire.  The Map
+              #   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 Map Item's
+              #   parent Sync Map 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
+              #   Map does not expire. The Sync Map will be deleted automatically after it
+              #   expires, but there can be a delay between the expiration time and the
+              #   resources's deletion.
               # @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})
+              def create(key: nil, data: nil, ttl: :unset, item_ttl: :unset, collection_ttl: :unset)
+                data = Twilio::Values.of({
+                    'Key' => key,
+                    'Data' => Twilio.serialize_object(data),
+                    'Ttl' => ttl,
+                    'ItemTtl' => item_ttl,
+                    'CollectionTtl' => collection_ttl,
+                })
 
                 payload = @version.create(
                     'POST',
@@ -55,9 +79,17 @@ module Twilio
               # Lists SyncMapItemInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [sync_map_item.QueryResultOrder] order The order
-              # @param [String] from The from
-              # @param [sync_map_item.QueryFromBoundType] bounds The bounds
+              # @param [sync_map_item.QueryResultOrder] order How to order the Map Items
+              #   returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending)
+              #   and the default is ascending. Map Items are [ordered
+              #   lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item
+              #   key.
+              # @param [String] from The `key` of the first Sync Map Item resource to read. See
+              #   also `bounds`.
+              # @param [sync_map_item.QueryFromBoundType] bounds Whether to include the Map Item
+              #   referenced by the `from` parameter. Can be: `inclusive` to include the Map Item
+              #   referenced by the `from` parameter or `exclusive` to start with the next Map
+              #   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
@@ -73,9 +105,17 @@ module Twilio
               # Streams SyncMapItemInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [sync_map_item.QueryResultOrder] order The order
-              # @param [String] from The from
-              # @param [sync_map_item.QueryFromBoundType] bounds The bounds
+              # @param [sync_map_item.QueryResultOrder] order How to order the Map Items
+              #   returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending)
+              #   and the default is ascending. Map Items are [ordered
+              #   lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item
+              #   key.
+              # @param [String] from The `key` of the first Sync Map Item resource to read. See
+              #   also `bounds`.
+              # @param [sync_map_item.QueryFromBoundType] bounds Whether to include the Map Item
+              #   referenced by the `from` parameter. Can be: `inclusive` to include the Map Item
+              #   referenced by the `from` parameter or `exclusive` to start with the next Map
+              #   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
@@ -86,7 +126,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
@@ -98,7 +138,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],
@@ -108,9 +148,17 @@ module Twilio
               ##
               # Retrieve a single page of SyncMapItemInstance records from the API.
               # Request is executed immediately.
-              # @param [sync_map_item.QueryResultOrder] order The order
-              # @param [String] from The from
-              # @param [sync_map_item.QueryFromBoundType] bounds The bounds
+              # @param [sync_map_item.QueryResultOrder] order How to order the Map Items
+              #   returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending)
+              #   and the default is ascending. Map Items are [ordered
+              #   lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item
+              #   key.
+              # @param [String] from The `key` of the first Sync Map Item resource to read. See
+              #   also `bounds`.
+              # @param [sync_map_item.QueryFromBoundType] bounds Whether to include the Map Item
+              #   referenced by the `from` parameter. Can be: `inclusive` to include the Map Item
+              #   referenced by the `from` parameter or `exclusive` to start with the next Map
+              #   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
@@ -194,15 +242,18 @@ module Twilio
               ##
               # Initialize the SyncMapItemContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] map_sid The map_sid
-              # @param [String] key The key
+              # @param [String] service_sid The SID of the [Sync
+              #   Service](https://www.twilio.com/docs/sync/api/service) with the Sync Map Item
+              #   resource to fetch.
+              # @param [String] map_sid The SID of the Sync Map with the Sync Map Item resource
+              #   to fetch. Can be the Sync Map's `sid` or its `unique_name`.
+              # @param [String] key The `key` value of the Sync Map Item resource to fetch.
               # @return [SyncMapItemContext] SyncMapItemContext
               def initialize(version, service_sid, map_sid, key)
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, map_sid: map_sid, key: key}
+                @solution = {service_sid: service_sid, map_sid: map_sid, key: key, }
                 @uri = "/Services/#{@solution[:service_sid]}/Maps/#{@solution[:map_sid]}/Items/#{@solution[:key]}"
               end
 
@@ -229,18 +280,37 @@ module Twilio
 
               ##
               # Deletes the SyncMapItemInstance
-              # @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 SyncMapItemInstance
-              # @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 Map 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 Map 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 Map Item does not expire. The Map 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 Map Item's
+              #   parent Sync Map 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
+              #   Map does not expire. This parameter can only be used when the Map Item's `data`
+              #   or `ttl` is updated in the same request. The Sync Map will be deleted
+              #   automatically after it expires, but there can be a delay between the expiration
+              #   time and the resources's deletion.
               # @return [SyncMapItemInstance] Updated SyncMapItemInstance
-              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',
@@ -263,6 +333,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Sync.V1.SyncMapItemContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Sync.V1.SyncMapItemContext #{context}>"
+              end
             end
 
             ##
@@ -272,9 +349,11 @@ 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] key The key
+              # @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 that contains the Map Item.
+              # @param [String] key The `key` value of the Sync Map Item resource to fetch.
               # @return [SyncMapItemInstance] SyncMapItemInstance
               def initialize(version, payload, service_sid: nil, map_sid: nil, key: nil)
                 super(version)
@@ -296,7 +375,7 @@ module Twilio
 
                 # Context
                 @instance_context = nil
-                @params = {'service_sid' => service_sid, 'map_sid' => map_sid, 'key' => key || @properties['key']}
+                @params = {'service_sid' => service_sid, 'map_sid' => map_sid, 'key' => key || @properties['key'], }
               end
 
               ##
@@ -316,67 +395,67 @@ module Twilio
               end
 
               ##
-              # @return [String] The key
+              # @return [String] The unique, user-defined key for the Map Item
               def key
                 @properties['key']
               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 map_sid
+              # @return [String] The SID of the Sync Map that contains the Map Item
               def map_sid
                 @properties['map_sid']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the Map Item resource
               def url
                 @properties['url']
               end
 
               ##
-              # @return [String] The revision
+              # @return [String] The current revision of the Map Item, represented as a string
               def revision
                 @properties['revision']
               end
 
               ##
-              # @return [Hash] The data
+              # @return [Hash] An arbitrary, schema-less object that the Map Item stores
               def data
                 @properties['data']
               end
 
               ##
-              # @return [Time] The date_expires
+              # @return [Time] The ISO 8601 date and time in GMT when the Map 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 Map Item's creator
               def created_by
                 @properties['created_by']
               end
@@ -390,18 +469,32 @@ module Twilio
 
               ##
               # Deletes the SyncMapItemInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end
 
               ##
               # Update the SyncMapItemInstance
-              # @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 Map 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 Map 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 Map Item does not expire. The Map 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 Map Item's
+              #   parent Sync Map 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
+              #   Map does not expire. This parameter can only be used when the Map Item's `data`
+              #   or `ttl` is updated in the same request. The Sync Map will be deleted
+              #   automatically after it expires, but there can be a delay between the expiration
+              #   time and the resources's deletion.
               # @return [SyncMapItemInstance] Updated SyncMapItemInstance
-              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_map/sync_map_permission.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -16,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)
@@ -58,7 +60,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 +72,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 +162,19 @@ module Twilio
               ##
               # Initialize the SyncMapPermissionContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @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)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, map_sid: map_sid, identity: identity}
+                @solution = {service_sid: service_sid, map_sid: map_sid, identity: identity, }
                 @uri = "/Services/#{@solution[:service_sid]}/Maps/#{@solution[:map_sid]}/Permissions/#{@solution[:identity]}"
               end
 
@@ -197,22 +201,22 @@ 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.
+              #   Default value is `false`.
+              # @param [Boolean] write Whether the identity can create, update, and delete Items
+              #   in the Sync Map. Default value is `false`.
+              # @param [Boolean] manage Whether the identity can delete the Sync Map. Default
+              #   value is `false`.
               # @return [SyncMapPermissionInstance] Updated SyncMapPermissionInstance
               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 +239,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Sync.V1.SyncMapPermissionContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Sync.V1.SyncMapPermissionContext #{context}>"
+              end
             end
 
             ##
@@ -244,12 +255,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)
@@ -292,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 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
@@ -348,22 +359,22 @@ 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.
+              #   Default value is `false`.
+              # @param [Boolean] write Whether the identity can create, update, and delete Items
+              #   in the Sync Map. Default value is `false`.
+              # @param [Boolean] manage Whether the identity can delete the Sync Map. Default
+              #   value is `false`.
               # @return [SyncMapPermissionInstance] Updated SyncMapPermissionInstance
               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
 
               ##