twilio-ruby 5.5.1 → 5.58.3

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
@@ -10,14 +12,14 @@ module Twilio
       class V1 < Version
         class ServiceContext < InstanceContext
           class SyncMapContext < InstanceContext
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class SyncMapItemList < ListResource
               ##
               # 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)
@@ -28,20 +30,30 @@ module Twilio
               end
 
               ##
-              # 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
-              # @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})
-
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+              # Create the SyncMapItemInstance
+              # @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 16 KiB 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}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+              #   the Map Item expires (time-to-live) and is deleted.
+              # @param [String] collection_ttl How long, {in
+              #   seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+              #   the Map Item's parent Sync Map expires (time-to-live) and is deleted.
+              # @return [SyncMapItemInstance] Created SyncMapItemInstance
+              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', @uri, data: data)
 
                 SyncMapItemInstance.new(
                     @version,
@@ -55,9 +67,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 +93,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 +114,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 +126,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 +136,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
@@ -124,11 +160,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 SyncMapItemPage.new(@version, response, @solution)
               end
 
@@ -152,8 +186,6 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class SyncMapItemPage < Page
               ##
               # Initialize the SyncMapItemPage
@@ -188,35 +220,30 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class SyncMapItemContext < InstanceContext
               ##
               # 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 resource'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
 
               ##
-              # Fetch a SyncMapItemInstance
+              # Fetch the SyncMapItemInstance
               # @return [SyncMapItemInstance] Fetched SyncMapItemInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 SyncMapItemInstance.new(
                     @version,
@@ -228,25 +255,47 @@ module Twilio
               end
 
               ##
-              # Deletes the SyncMapItemInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
-              def delete
-                @version.delete('delete', @uri)
+              # Delete the SyncMapItemInstance
+              # @param [String] if_match If provided, applies this mutation if (and only if) the
+              #   “revision” field of this {map item] matches the provided value. This matches the
+              #   semantics of (and is implemented with) the HTTP [If-Match
+              #   header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
+              # @return [Boolean] true if delete succeeds, false otherwise
+              def delete(if_match: :unset)
+                headers = Twilio::Values.of({'If-Match' => if_match, })
+
+                 @version.delete('DELETE', @uri, headers: headers)
               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 16 KiB 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}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+              #   the Map Item expires (time-to-live) and is deleted.
+              # @param [String] collection_ttl How long, {in
+              #   seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+              #   the Map Item's parent Sync Map expires (time-to-live) and is deleted. This
+              #   parameter can only be used when the Map Item's `data` or `ttl` is updated in the
+              #   same request.
+              # @param [String] if_match If provided, applies this mutation if (and only if) the
+              #   “revision” field of this {map item] matches the provided value. This matches the
+              #   semantics of (and is implemented with) the HTTP [If-Match
+              #   header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
               # @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, if_match: :unset)
+                data = Twilio::Values.of({
+                    'Data' => Twilio.serialize_object(data),
+                    'Ttl' => ttl,
+                    'ItemTtl' => item_ttl,
+                    'CollectionTtl' => collection_ttl,
+                })
+                headers = Twilio::Values.of({'If-Match' => if_match, })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data, headers: headers)
 
                 SyncMapItemInstance.new(
                     @version,
@@ -263,18 +312,25 @@ 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
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class SyncMapItemInstance < InstanceResource
               ##
               # 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 +352,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,92 +372,116 @@ 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
 
               ##
-              # Fetch a SyncMapItemInstance
+              # Fetch the SyncMapItemInstance
               # @return [SyncMapItemInstance] Fetched SyncMapItemInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the SyncMapItemInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
-              def delete
-                context.delete
+              # Delete the SyncMapItemInstance
+              # @param [String] if_match If provided, applies this mutation if (and only if) the
+              #   “revision” field of this {map item] matches the provided value. This matches the
+              #   semantics of (and is implemented with) the HTTP [If-Match
+              #   header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
+              # @return [Boolean] true if delete succeeds, false otherwise
+              def delete(if_match: :unset)
+                context.delete(if_match: if_match, )
               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 16 KiB 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}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+              #   the Map Item expires (time-to-live) and is deleted.
+              # @param [String] collection_ttl How long, {in
+              #   seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+              #   the Map Item's parent Sync Map expires (time-to-live) and is deleted. This
+              #   parameter can only be used when the Map Item's `data` or `ttl` is updated in the
+              #   same request.
+              # @param [String] if_match If provided, applies this mutation if (and only if) the
+              #   “revision” field of this {map item] matches the provided value. This matches the
+              #   semantics of (and is implemented with) the HTTP [If-Match
+              #   header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
               # @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, if_match: :unset)
+                context.update(
+                    data: data,
+                    ttl: ttl,
+                    item_ttl: item_ttl,
+                    collection_ttl: collection_ttl,
+                    if_match: if_match,
+                )
               end
 
               ##