twilio-ruby 5.31.1 → 5.46.1

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

@@ -26,8 +26,7 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of ServiceInstance records from the API.
-          # Request is executed immediately.
+          # Create the ServiceInstance
           # @param [String] friendly_name A string that you assign to describe the resource.
           # @param [String] webhook_url The URL we should call when Sync objects are
           #   manipulated.
@@ -36,7 +35,7 @@ module Twilio
           #   `false`.
           # @param [Boolean] acl_enabled Whether token identities in the Service must be
           #   granted access to Sync objects by using the
-          #   [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource.
+          #   {Permissions}[https://www.twilio.com/docs/sync/api/sync-permissions] resource.
           # @param [Boolean] reachability_debouncing_enabled Whether every
           #   `endpoint_disconnected` event should occur after a configurable delay. The
           #   default is `false`, where the `endpoint_disconnected` event occurs immediately
@@ -52,7 +51,7 @@ module Twilio
           # @param [Boolean] webhooks_from_rest_enabled Whether the Service instance should
           #   call `webhook_url` when the REST API is used to update Sync objects. The default
           #   is `false`.
-          # @return [ServiceInstance] Newly created ServiceInstance
+          # @return [ServiceInstance] Created ServiceInstance
           def create(friendly_name: :unset, webhook_url: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset, reachability_debouncing_enabled: :unset, reachability_debouncing_window: :unset, webhooks_from_rest_enabled: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
@@ -64,11 +63,7 @@ module Twilio
                 'WebhooksFromRestEnabled' => webhooks_from_rest_enabled,
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             ServiceInstance.new(@version, payload, )
           end
@@ -134,11 +129,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             ServicePage.new(@version, response, @solution)
           end
 
@@ -216,25 +209,19 @@ module Twilio
           end
 
           ##
-          # Fetch a ServiceInstance
+          # Fetch the ServiceInstance
           # @return [ServiceInstance] Fetched ServiceInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Deletes the ServiceInstance
+          # Delete the ServiceInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
@@ -247,7 +234,7 @@ module Twilio
           #   `false`.
           # @param [Boolean] acl_enabled Whether token identities in the Service must be
           #   granted access to Sync objects by using the
-          #   [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource.
+          #   {Permissions}[https://www.twilio.com/docs/sync/api/sync-permissions] resource.
           # @param [Boolean] reachability_debouncing_enabled Whether every
           #   `endpoint_disconnected` event should occur after a configurable delay. The
           #   default is `false`, where the `endpoint_disconnected` event occurs immediately
@@ -275,11 +262,7 @@ module Twilio
                 'WebhooksFromRestEnabled' => webhooks_from_rest_enabled,
             })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
 
             ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
@@ -502,14 +485,14 @@ module Twilio
           end
 
           ##
-          # Fetch a ServiceInstance
+          # Fetch the ServiceInstance
           # @return [ServiceInstance] Fetched ServiceInstance
           def fetch
             context.fetch
           end
 
           ##
-          # Deletes the ServiceInstance
+          # Delete the ServiceInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
@@ -525,7 +508,7 @@ module Twilio
           #   `false`.
           # @param [Boolean] acl_enabled Whether token identities in the Service must be
           #   granted access to Sync objects by using the
-          #   [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource.
+          #   {Permissions}[https://www.twilio.com/docs/sync/api/sync-permissions] resource.
           # @param [Boolean] reachability_debouncing_enabled Whether every
           #   `endpoint_disconnected` event should occur after a configurable delay. The
           #   default is `false`, where the `endpoint_disconnected` event occurs immediately

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

@@ -17,8 +17,8 @@ module Twilio
             ##
             # Initialize the DocumentList
             # @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 [DocumentList] DocumentList
             def initialize(version, service_sid: nil)
@@ -30,19 +30,18 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of DocumentInstance records from the API.
-            # Request is executed immediately.
+            # Create the DocumentInstance
             # @param [String] unique_name An application-defined string that uniquely
             #   identifies the Sync Document
             # @param [Hash] data A JSON string that represents an arbitrary, schema-less
-            #   object that the Sync Document stores. Can be up to 16KB in length.
+            #   object that the Sync Document stores. Can be up to 16 KiB in length.
             # @param [String] ttl How long, in seconds, before the Sync Document expires and
             #   is deleted (the Sync Document's time-to-live). Can be an integer from 0 to
             #   31,536,000 (1 year). The default value is `0`, which means the Sync Document
             #   does not expire. The Sync Document will be deleted automatically after it
             #   expires, but there can be a delay between the expiration time and the
             #   resources's deletion.
-            # @return [DocumentInstance] Newly created DocumentInstance
+            # @return [DocumentInstance] Created DocumentInstance
             def create(unique_name: :unset, data: :unset, ttl: :unset)
               data = Twilio::Values.of({
                   'UniqueName' => unique_name,
@@ -50,11 +49,7 @@ module Twilio
                   'Ttl' => ttl,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               DocumentInstance.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)
+
               DocumentPage.new(@version, response, @solution)
             end
 
@@ -185,10 +178,11 @@ module Twilio
             ##
             # Initialize the DocumentContext
             # @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 Document
+            # @param [String] service_sid The SID of the {Sync
+            #   Service}[https://www.twilio.com/docs/sync/api/service] with the Document
             #   resource to fetch.
-            # @param [String] sid The SID of the Document resource to fetch.
+            # @param [String] sid The SID of the Document resource to fetch. Can be the
+            #   Document resource's `sid` or its `unique_name`.
             # @return [DocumentContext] DocumentContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -202,45 +196,40 @@ module Twilio
             end
 
             ##
-            # Fetch a DocumentInstance
+            # Fetch the DocumentInstance
             # @return [DocumentInstance] Fetched DocumentInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               DocumentInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the DocumentInstance
+            # Delete the DocumentInstance
+            # @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 DocumentInstance
             # @param [Hash] data A JSON string that represents an arbitrary, schema-less
-            #   object that the Sync Document stores. Can be up to 16KB in length.
+            #   object that the Sync Document stores. Can be up to 16 KiB in length.
             # @param [String] ttl How long, in seconds, before the Sync Document expires and
             #   is deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The
             #   default value is `0`, which means the Document resource does not expire. The
             #   Document resource 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 [DocumentInstance] Updated DocumentInstance
-            def update(data: :unset, ttl: :unset)
+            def update(data: :unset, ttl: :unset, if_match: :unset)
               data = Twilio::Values.of({'Data' => Twilio.serialize_object(data), 'Ttl' => 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)
 
               DocumentInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
@@ -289,10 +278,11 @@ module Twilio
             # Initialize the DocumentInstance
             # @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 Document resource to fetch.
+            # @param [String] sid The SID of the Document resource to fetch. Can be the
+            #   Document resource's `sid` or its `unique_name`.
             # @return [DocumentInstance] DocumentInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -402,31 +392,33 @@ module Twilio
             end
 
             ##
-            # Fetch a DocumentInstance
+            # Fetch the DocumentInstance
             # @return [DocumentInstance] Fetched DocumentInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the DocumentInstance
+            # Delete the DocumentInstance
+            # @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 DocumentInstance
             # @param [Hash] data A JSON string that represents an arbitrary, schema-less
-            #   object that the Sync Document stores. Can be up to 16KB in length.
+            #   object that the Sync Document stores. Can be up to 16 KiB in length.
             # @param [String] ttl How long, in seconds, before the Sync Document expires and
             #   is deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The
             #   default value is `0`, which means the Document resource does not expire. The
             #   Document resource 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 [DocumentInstance] Updated DocumentInstance
-            def update(data: :unset, ttl: :unset)
-              context.update(data: data, ttl: ttl, )
+            def update(data: :unset, ttl: :unset, if_match: :unset)
+              context.update(data: data, ttl: ttl, if_match: if_match, )
             end
 
             ##

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

@@ -18,8 +18,8 @@ module Twilio
               ##
               # Initialize the DocumentPermissionList
               # @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] document_sid The SID of the Sync Document to which the Document
               #   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)
+
                 DocumentPermissionPage.new(@version, response, @solution)
               end
 
@@ -163,8 +161,8 @@ module Twilio
               ##
               # Initialize the DocumentPermissionContext
               # @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 Document
+              # @param [String] service_sid The SID of the {Sync
+              #   Service}[https://www.twilio.com/docs/sync/api/service] with the Document
               #   Permission resource to fetch.
               # @param [String] document_sid The SID of the Sync Document with the Document
               #   Permission resource to fetch. Can be the Document resource's `sid` or its
@@ -181,16 +179,10 @@ module Twilio
               end
 
               ##
-              # Fetch a DocumentPermissionInstance
+              # Fetch the DocumentPermissionInstance
               # @return [DocumentPermissionInstance] Fetched DocumentPermissionInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 DocumentPermissionInstance.new(
                     @version,
@@ -202,10 +194,10 @@ module Twilio
               end
 
               ##
-              # Deletes the DocumentPermissionInstance
+              # Delete the DocumentPermissionInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -220,11 +212,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)
 
                 DocumentPermissionInstance.new(
                     @version,
@@ -257,8 +245,8 @@ module Twilio
               # Initialize the DocumentPermissionInstance
               # @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] document_sid The SID of the Sync Document to which the Document
               #   Permission applies.
@@ -354,14 +342,14 @@ module Twilio
               end
 
               ##
-              # Fetch a DocumentPermissionInstance
+              # Fetch the DocumentPermissionInstance
               # @return [DocumentPermissionInstance] Fetched DocumentPermissionInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the DocumentPermissionInstance
+              # Delete the DocumentPermissionInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete

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

@@ -17,8 +17,8 @@ module Twilio
             ##
             # 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,8 +30,7 @@ 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
@@ -43,7 +42,7 @@ module Twilio
             #   (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
+            # @return [SyncListInstance] Created SyncListInstance
             def create(unique_name: :unset, ttl: :unset, collection_ttl: :unset)
               data = Twilio::Values.of({
                   'UniqueName' => unique_name,
@@ -51,11 +50,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 +116,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
 
@@ -186,10 +179,11 @@ module Twilio
             ##
             # 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,25 +198,19 @@ 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
 
             ##
@@ -238,11 +226,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)
 
               SyncListInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
@@ -313,10 +297,11 @@ module Twilio
             # 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 +404,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