twilio-ruby 5.31.0 → 5.46.0

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

@@ -18,8 +18,8 @@ module Twilio
               ##
               # Initialize the SyncListPermissionList
               # @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 to which the Permission
               #   applies.
@@ -93,11 +93,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 SyncListPermissionPage.new(@version, response, @solution)
               end
 
@@ -163,8 +161,8 @@ module Twilio
               ##
               # Initialize the SyncListPermissionContext
               # @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
               #   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`.
@@ -180,16 +178,10 @@ module Twilio
               end
 
               ##
-              # Fetch a SyncListPermissionInstance
+              # Fetch the SyncListPermissionInstance
               # @return [SyncListPermissionInstance] Fetched SyncListPermissionInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 SyncListPermissionInstance.new(
                     @version,
@@ -201,10 +193,10 @@ module Twilio
               end
 
               ##
-              # Deletes the SyncListPermissionInstance
+              # Delete the SyncListPermissionInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -219,11 +211,7 @@ module Twilio
               def update(read: nil, write: nil, manage: nil)
                 data = Twilio::Values.of({'Read' => read, 'Write' => write, 'Manage' => manage, })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 SyncListPermissionInstance.new(
                     @version,
@@ -256,8 +244,8 @@ 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 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 to which the Permission
               #   applies.
@@ -353,14 +341,14 @@ module Twilio
               end
 
               ##
-              # Fetch a SyncListPermissionInstance
+              # Fetch the SyncListPermissionInstance
               # @return [SyncListPermissionInstance] Fetched SyncListPermissionInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the SyncListPermissionInstance
+              # Delete the SyncListPermissionInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete

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

@@ -17,8 +17,8 @@ module Twilio
             ##
             # Initialize the SyncMapList
             # @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 [SyncMapList] SyncMapList
             def initialize(version, service_sid: nil)
@@ -30,8 +30,7 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of SyncMapInstance records from the API.
-            # Request is executed immediately.
+            # Create the SyncMapInstance
             # @param [String] unique_name An application-defined string that uniquely
             #   identifies the resource. It can be used as an alternative to the `sid` in the
             #   URL path to address the resource.
@@ -42,7 +41,7 @@ module Twilio
             #   The default value is `0`, which means the 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 [SyncMapInstance] Newly created SyncMapInstance
+            # @return [SyncMapInstance] Created SyncMapInstance
             def create(unique_name: :unset, ttl: :unset, collection_ttl: :unset)
               data = Twilio::Values.of({
                   'UniqueName' => unique_name,
@@ -50,11 +49,7 @@ module Twilio
                   'CollectionTtl' => collection_ttl,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               SyncMapInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
@@ -120,11 +115,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               SyncMapPage.new(@version, response, @solution)
             end
 
@@ -185,10 +178,11 @@ module Twilio
             ##
             # Initialize the SyncMapContext
             # @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 Map
+            # @param [String] service_sid The SID of the {Sync
+            #   Service}[https://www.twilio.com/docs/sync/api/service] with the Sync Map
             #   resource to fetch.
-            # @param [String] sid The SID of the Sync Map resource to fetch.
+            # @param [String] sid The SID of the Sync Map resource to fetch. Can be the Sync
+            #   Map's `sid` or its `unique_name`.
             # @return [SyncMapContext] SyncMapContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -203,25 +197,19 @@ module Twilio
             end
 
             ##
-            # Fetch a SyncMapInstance
+            # Fetch the SyncMapInstance
             # @return [SyncMapInstance] Fetched SyncMapInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               SyncMapInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the SyncMapInstance
+            # Delete the SyncMapInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -237,11 +225,7 @@ module Twilio
             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)
 
               SyncMapInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
@@ -312,10 +296,11 @@ module Twilio
             # Initialize the SyncMapInstance
             # @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 Map resource to fetch.
+            # @param [String] sid The SID of the Sync Map resource to fetch. Can be the Sync
+            #   Map's `sid` or its `unique_name`.
             # @return [SyncMapInstance] SyncMapInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -418,14 +403,14 @@ module Twilio
             end
 
             ##
-            # Fetch a SyncMapInstance
+            # Fetch the SyncMapInstance
             # @return [SyncMapInstance] Fetched SyncMapInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the SyncMapInstance
+            # Delete the SyncMapInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete

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

@@ -18,8 +18,8 @@ module Twilio
               ##
               # Initialize the SyncMapItemList
               # @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] map_sid The SID of the Sync Map that contains the Map Item.
               # @return [SyncMapItemList] SyncMapItemList
@@ -32,12 +32,11 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of SyncMapItemInstance records from the API.
-              # Request is executed immediately.
+              # 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 16KB in length.
+              #   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, before the Map Item expires
@@ -51,7 +50,7 @@ module Twilio
               #   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
+              # @return [SyncMapItemInstance] Created SyncMapItemInstance
               def create(key: nil, data: nil, ttl: :unset, item_ttl: :unset, collection_ttl: :unset)
                 data = Twilio::Values.of({
                     'Key' => key,
@@ -61,11 +60,7 @@ module Twilio
                     'CollectionTtl' => collection_ttl,
                 })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 SyncMapItemInstance.new(
                     @version,
@@ -81,8 +76,8 @@ module Twilio
               # memory before returning.
               # @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
+              #   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`.
@@ -107,8 +102,8 @@ module Twilio
               # is reached.
               # @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
+              #   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`.
@@ -150,8 +145,8 @@ module Twilio
               # Request is executed immediately.
               # @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
+              #   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`.
@@ -172,11 +167,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
 
@@ -242,11 +235,11 @@ module Twilio
               ##
               # Initialize the SyncMapItemContext
               # @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 Map Item
+              # @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`.
+              #   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)
@@ -258,16 +251,10 @@ module Twilio
               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,
@@ -279,16 +266,19 @@ module Twilio
               end
 
               ##
-              # Deletes the SyncMapItemInstance
+              # Delete the SyncMapItemInstance
+              # @param [String] if_match The If-Match HTTP request header
               # @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 SyncMapItemInstance
               # @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.
+              #   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, before the Map Item expires
@@ -303,20 +293,18 @@ module Twilio
               #   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.
+              # @param [String] if_match The If-Match HTTP request header
               # @return [SyncMapItemInstance] Updated SyncMapItemInstance
-              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)
 
                 SyncMapItemInstance.new(
                     @version,
@@ -349,8 +337,8 @@ 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 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] 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.
@@ -461,23 +449,24 @@ module Twilio
               end
 
               ##
-              # Fetch a SyncMapItemInstance
+              # Fetch the SyncMapItemInstance
               # @return [SyncMapItemInstance] Fetched SyncMapItemInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the SyncMapItemInstance
+              # Delete the SyncMapItemInstance
+              # @param [String] if_match The If-Match HTTP request header
               # @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 SyncMapItemInstance
               # @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.
+              #   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, before the Map Item expires
@@ -492,9 +481,16 @@ module Twilio
               #   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.
+              # @param [String] if_match The If-Match HTTP request header
               # @return [SyncMapItemInstance] Updated SyncMapItemInstance
-              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
 
               ##