twilio-ruby 5.31.1 → 5.54.0

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

@@ -11,14 +11,12 @@ module Twilio
     class Sync < Domain
       class V1 < Version
         class ServiceContext < InstanceContext
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class SyncListList < ListResource
             ##
             # Initialize the SyncListList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The SID of the [Sync
-            #   Service](https://www.twilio.com/docs/sync/api/service) the resource is
+            # @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)
@@ -30,20 +28,17 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of SyncListInstance records from the API.
-            # Request is executed immediately.
+            # Create the SyncListInstance
             # @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 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 will be deleted automatically after it expires, but there can be a
-            #   delay between the expiration time and the resources's deletion.
-            # @return [SyncListInstance] Newly created SyncListInstance
+            # @param [String] collection_ttl How long, {in
+            #   seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+            #   the Sync List expires (time-to-live) and is deleted.
+            # @return [SyncListInstance] Created SyncListInstance
             def create(unique_name: :unset, ttl: :unset, collection_ttl: :unset)
               data = Twilio::Values.of({
                   'UniqueName' => unique_name,
@@ -51,11 +46,7 @@ module Twilio
                   'CollectionTtl' => collection_ttl,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               SyncListInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
@@ -121,11 +112,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               SyncListPage.new(@version, response, @solution)
             end
 
@@ -149,8 +138,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class SyncListPage < Page
             ##
             # Initialize the SyncListPage
@@ -180,16 +167,15 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class SyncListContext < InstanceContext
             ##
             # Initialize the SyncListContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The SID of the [Sync
-            #   Service](https://www.twilio.com/docs/sync/api/service) with the Sync List
+            # @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.
+            # @param [String] sid The SID of the Sync List resource to fetch. Can be the Sync
+            #   List resource's `sid` or its `unique_name`.
             # @return [SyncListContext] SyncListContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -204,45 +190,33 @@ module Twilio
             end
 
             ##
-            # Fetch a SyncListInstance
+            # Fetch the SyncListInstance
             # @return [SyncListInstance] Fetched SyncListInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               SyncListInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the SyncListInstance
+            # Delete the SyncListInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
             # Update the SyncListInstance
             # @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 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}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+            #   the Sync List expires (time-to-live) and is deleted.
             # @return [SyncListInstance] Updated SyncListInstance
             def update(ttl: :unset, collection_ttl: :unset)
               data = Twilio::Values.of({'Ttl' => ttl, 'CollectionTtl' => collection_ttl, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               SyncListInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
@@ -306,17 +280,16 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class SyncListInstance < InstanceResource
             ##
             # 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 SID of the [Sync
-            #   Service](https://www.twilio.com/docs/sync/api/service) the resource is
+            # @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.
+            # @param [String] sid The SID of the Sync List resource to fetch. Can be the Sync
+            #   List resource's `sid` or its `unique_name`.
             # @return [SyncListInstance] SyncListInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -419,14 +392,14 @@ module Twilio
             end
 
             ##
-            # Fetch a SyncListInstance
+            # Fetch the SyncListInstance
             # @return [SyncListInstance] Fetched SyncListInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the SyncListInstance
+            # Delete the SyncListInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
@@ -436,11 +409,9 @@ module Twilio
             # Update the SyncListInstance
             # @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 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}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+            #   the Sync List expires (time-to-live) and is deleted.
             # @return [SyncListInstance] Updated SyncListInstance
             def update(ttl: :unset, collection_ttl: :unset)
               context.update(ttl: ttl, collection_ttl: collection_ttl, )

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

@@ -12,14 +12,12 @@ module Twilio
       class V1 < Version
         class ServiceContext < InstanceContext
           class SyncListContext < InstanceContext
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class SyncListItemList < ListResource
               ##
               # Initialize the SyncListItemList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The SID of the [Sync
-              #   Service](https://www.twilio.com/docs/sync/api/service) the resource is
+              # @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
@@ -32,24 +30,18 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of SyncListItemInstance records from the API.
-              # Request is executed immediately.
+              # Create the SyncListItemInstance
               # @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.
+              #   object that the List 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, 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
+              # @param [String] item_ttl How long, {in
+              #   seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+              #   the List 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 List Item's parent Sync List expires (time-to-live) and is deleted.
+              # @return [SyncListItemInstance] Created SyncListItemInstance
               def create(data: nil, ttl: :unset, item_ttl: :unset, collection_ttl: :unset)
                 data = Twilio::Values.of({
                     'Data' => Twilio.serialize_object(data),
@@ -58,11 +50,7 @@ module Twilio
                     'CollectionTtl' => collection_ttl,
                 })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 SyncListItemInstance.new(
                     @version,
@@ -163,11 +151,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 SyncListItemPage.new(@version, response, @solution)
               end
 
@@ -191,8 +177,6 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class SyncListItemPage < Page
               ##
               # Initialize the SyncListItemPage
@@ -227,14 +211,12 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class SyncListItemContext < InstanceContext
               ##
               # Initialize the SyncListItemContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The SID of the [Sync
-              #   Service](https://www.twilio.com/docs/sync/api/service) with the Sync List Item
+              # @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`.
@@ -249,16 +231,10 @@ module Twilio
               end
 
               ##
-              # Fetch a SyncListItemInstance
+              # Fetch the SyncListItemInstance
               # @return [SyncListItemInstance] Fetched SyncListItemInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 SyncListItemInstance.new(
                     @version,
@@ -270,43 +246,47 @@ module Twilio
               end
 
               ##
-              # Deletes the SyncListItemInstance
+              # Delete the SyncListItemInstance
+              # @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
-                @version.delete('delete', @uri)
+              def delete(if_match: :unset)
+                headers = Twilio::Values.of({'If-Match' => if_match, })
+
+                 @version.delete('DELETE', @uri, headers: headers)
               end
 
               ##
               # Update the SyncListItemInstance
               # @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.
+              #   object that the List 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, 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.
+              # @param [String] item_ttl How long, {in
+              #   seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+              #   the List 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 List Item's parent Sync List expires (time-to-live) and is deleted. This
+              #   parameter can only be used when the List 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 [SyncListItemInstance] Updated SyncListItemInstance
-              def update(data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset)
+              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)
 
                 SyncListItemInstance.new(
                     @version,
@@ -332,15 +312,13 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class SyncListItemInstance < InstanceResource
               ##
               # 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 SID of the [Sync
-              #   Service](https://www.twilio.com/docs/sync/api/service) the resource is
+              # @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.
@@ -455,39 +433,50 @@ module Twilio
               end
 
               ##
-              # Fetch a SyncListItemInstance
+              # Fetch the SyncListItemInstance
               # @return [SyncListItemInstance] Fetched SyncListItemInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the SyncListItemInstance
+              # Delete the SyncListItemInstance
+              # @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
-                context.delete
+              def delete(if_match: :unset)
+                context.delete(if_match: if_match, )
               end
 
               ##
               # Update the SyncListItemInstance
               # @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.
+              #   object that the List 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, 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.
+              # @param [String] item_ttl How long, {in
+              #   seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+              #   the List 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 List Item's parent Sync List expires (time-to-live) and is deleted. This
+              #   parameter can only be used when the List 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 [SyncListItemInstance] Updated SyncListItemInstance
-              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, )
+              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
 
               ##