twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -10,16 +12,15 @@ module Twilio
       class V1 < Version
         class ServiceContext < InstanceContext
           class DocumentContext < InstanceContext
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class DocumentPermissionList < ListResource
               ##
               # Initialize the DocumentPermissionList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The unique SID identifier of the Sync Service
-              #   Instance.
-              # @param [String] document_sid The unique SID identifier of the Sync Document to
-              #   which the Permission applies.
+              # @param [String] service_sid The SID of the {Sync
+              #   Service}[https://www.twilio.com/docs/sync/api/service] the resource is
+              #   associated with.
+              # @param [String] document_sid The SID of the Sync Document to which the Document
+              #   Permission applies.
               # @return [DocumentPermissionList] DocumentPermissionList
               def initialize(version, service_sid: nil, document_sid: nil)
                 super(version)
@@ -58,7 +59,7 @@ module Twilio
               def stream(limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -70,7 +71,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],
@@ -90,11 +91,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
 
@@ -118,8 +117,6 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class DocumentPermissionPage < Page
               ##
               # Initialize the DocumentPermissionPage
@@ -154,37 +151,32 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class DocumentPermissionContext < InstanceContext
               ##
               # Initialize the DocumentPermissionContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] document_sid Identifier of the Sync Document. Either a SID or a
-              #   unique name.
-              # @param [String] identity Arbitrary string identifier representing a user
-              #   associated with an FPA token, assigned by the developer.
+              # @param [String] service_sid The SID of the {Sync
+              #   Service}[https://www.twilio.com/docs/sync/api/service] with the 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
+              #   `unique_name`.
+              # @param [String] identity The application-defined string that uniquely identifies
+              #   the User's Document Permission resource to fetch.
               # @return [DocumentPermissionContext] DocumentPermissionContext
               def initialize(version, service_sid, document_sid, identity)
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, document_sid: document_sid, identity: identity}
+                @solution = {service_sid: service_sid, document_sid: document_sid, identity: identity, }
                 @uri = "/Services/#{@solution[:service_sid]}/Documents/#{@solution[:document_sid]}/Permissions/#{@solution[:identity]}"
               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,
@@ -196,29 +188,25 @@ module Twilio
               end
 
               ##
-              # Deletes the DocumentPermissionInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the DocumentPermissionInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
               # Update the DocumentPermissionInstance
-              # @param [Boolean] read Boolean flag specifying whether the identity can read the
-              #   Sync Document.
-              # @param [Boolean] write Boolean flag specifying whether the identity can update
-              #   the Sync Document.
-              # @param [Boolean] manage Boolean flag specifying whether the identity can delete
-              #   the Sync Document.
+              # @param [Boolean] read Whether the identity can read the Sync Document. Default
+              #   value is `false`.
+              # @param [Boolean] write Whether the identity can update the Sync Document.
+              #   Default value is `false`.
+              # @param [Boolean] manage Whether the identity can delete the Sync Document.
+              #   Default value is `false`.
               # @return [DocumentPermissionInstance] Updated DocumentPermissionInstance
               def update(read: nil, write: nil, manage: nil)
-                data = Twilio::Values.of({'Read' => read, 'Write' => write, 'Manage' => manage})
+                data = Twilio::Values.of({'Read' => read, 'Write' => write, 'Manage' => manage, })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 DocumentPermissionInstance.new(
                     @version,
@@ -235,21 +223,27 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Sync.V1.DocumentPermissionContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Sync.V1.DocumentPermissionContext #{context}>"
+              end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class DocumentPermissionInstance < InstanceResource
               ##
               # 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 unique SID identifier of the Sync Service
-              #   Instance.
-              # @param [String] document_sid The unique SID identifier of the Sync Document to
-              #   which the Permission applies.
-              # @param [String] identity Arbitrary string identifier representing a user
-              #   associated with an FPA token, assigned by the developer.
+              # @param [String] service_sid The SID of the {Sync
+              #   Service}[https://www.twilio.com/docs/sync/api/service] the resource is
+              #   associated with.
+              # @param [String] document_sid The SID of the Sync Document to which the Document
+              #   Permission applies.
+              # @param [String] identity The application-defined string that uniquely identifies
+              #   the User's Document Permission resource to fetch.
               # @return [DocumentPermissionInstance] DocumentPermissionInstance
               def initialize(version, payload, service_sid: nil, document_sid: nil, identity: nil)
                 super(version)
@@ -292,78 +286,78 @@ module Twilio
               end
 
               ##
-              # @return [String] Twilio Account SID.
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] Sync Service Instance SID.
+              # @return [String] The SID of the Sync Service that the resource is associated with
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] Sync Document SID.
+              # @return [String] The Sync Document SID
               def document_sid
                 @properties['document_sid']
               end
 
               ##
-              # @return [String] Identity of the user to whom the Sync Document Permission applies.
+              # @return [String] The identity of the user to whom the Sync Document Permission applies
               def identity
                 @properties['identity']
               end
 
               ##
-              # @return [Boolean] Read access.
+              # @return [Boolean] Read access
               def read
                 @properties['read']
               end
 
               ##
-              # @return [Boolean] Write access.
+              # @return [Boolean] Write access
               def write
                 @properties['write']
               end
 
               ##
-              # @return [Boolean] Manage access.
+              # @return [Boolean] Manage access
               def manage
                 @properties['manage']
               end
 
               ##
-              # @return [String] URL of this Sync Document Permission.
+              # @return [String] The absolute URL of the Sync Document Permission resource
               def url
                 @properties['url']
               end
 
               ##
-              # Fetch a DocumentPermissionInstance
+              # Fetch the DocumentPermissionInstance
               # @return [DocumentPermissionInstance] Fetched DocumentPermissionInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the DocumentPermissionInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the DocumentPermissionInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end
 
               ##
               # Update the DocumentPermissionInstance
-              # @param [Boolean] read Boolean flag specifying whether the identity can read the
-              #   Sync Document.
-              # @param [Boolean] write Boolean flag specifying whether the identity can update
-              #   the Sync Document.
-              # @param [Boolean] manage Boolean flag specifying whether the identity can delete
-              #   the Sync Document.
+              # @param [Boolean] read Whether the identity can read the Sync Document. Default
+              #   value is `false`.
+              # @param [Boolean] write Whether the identity can update the Sync Document.
+              #   Default value is `false`.
+              # @param [Boolean] manage Whether the identity can delete the Sync Document.
+              #   Default value is `false`.
               # @return [DocumentPermissionInstance] Updated DocumentPermissionInstance
               def update(read: nil, write: nil, manage: nil)
-                context.update(read: read, write: write, manage: manage)
+                context.update(read: read, write: write, manage: manage, )
               end
 
               ##

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

@@ -3,19 +3,21 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
     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 DocumentList < ListResource
             ##
             # Initialize the DocumentList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
+            # @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)
               super(version)
@@ -26,12 +28,15 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of DocumentInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] unique_name The unique_name
-            # @param [Hash] data The data
-            # @param [String] ttl The ttl
-            # @return [DocumentInstance] Newly created DocumentInstance
+            # 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 16 KiB in length.
+            # @param [String] ttl How long, {in
+            #   seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+            #   the Sync Document expires and is deleted (the Sync Document's time-to-live).
+            # @return [DocumentInstance] Created DocumentInstance
             def create(unique_name: :unset, data: :unset, ttl: :unset)
               data = Twilio::Values.of({
                   'UniqueName' => unique_name,
@@ -39,13 +44,9 @@ 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])
+              DocumentInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -77,7 +78,7 @@ module Twilio
             def stream(limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -89,7 +90,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],
@@ -109,11 +110,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
 
@@ -137,8 +136,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class DocumentPage < Page
             ##
             # Initialize the DocumentPage
@@ -158,7 +155,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [DocumentInstance] DocumentInstance
             def get_instance(payload)
-              DocumentInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              DocumentInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -168,20 +165,21 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class DocumentContext < InstanceContext
             ##
             # Initialize the DocumentContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @param [String] sid The sid
+            # @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. Can be the
+            #   Document resource's `sid` or its `unique_name`.
             # @return [DocumentContext] DocumentContext
             def initialize(version, service_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {service_sid: service_sid, sid: sid}
+              @solution = {service_sid: service_sid, sid: sid, }
               @uri = "/Services/#{@solution[:service_sid]}/Documents/#{@solution[:sid]}"
 
               # Dependents
@@ -189,42 +187,37 @@ 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])
+              DocumentInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the DocumentInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the DocumentInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
             # Update the DocumentInstance
-            # @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 Sync Document stores. Can be up to 16 KiB in length.
+            # @param [String] ttl How long, {in
+            #   seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+            #   the Sync Document expires and is deleted (time-to-live).
+            # @param [String] if_match The If-Match HTTP request header
             # @return [DocumentInstance] Updated DocumentInstance
-            def update(data: :unset, ttl: :unset)
-              data = Twilio::Values.of({'Data' => Twilio.serialize_object(data), 'Ttl' => ttl})
+            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])
+              DocumentInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
@@ -235,7 +228,7 @@ module Twilio
               raise ArgumentError, 'identity cannot be nil' if identity.nil?
 
               if identity != :unset
-                return DocumentPermissionContext.new(@version, @solution[:service_sid], @solution[:sid], identity)
+                return DocumentPermissionContext.new(@version, @solution[:service_sid], @solution[:sid], identity, )
               end
 
               unless @document_permissions
@@ -255,17 +248,25 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Sync.V1.DocumentContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Sync.V1.DocumentContext #{context}>"
+            end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class DocumentInstance < InstanceResource
             ##
             # 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 service_sid
-            # @param [String] sid The 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] 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)
@@ -288,7 +289,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid']}
+              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -297,104 +298,108 @@ module Twilio
             # @return [DocumentContext] DocumentContext for this DocumentInstance
             def context
               unless @instance_context
-                @instance_context = DocumentContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = DocumentContext.new(@version, @params['service_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The unique_name
+            # @return [String] An application-defined string that uniquely identifies the resource
             def unique_name
               @properties['unique_name']
             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 url
+            # @return [String] The absolute URL of the Document resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] The URLs of resources related to the Sync Document
             def links
               @properties['links']
             end
 
             ##
-            # @return [String] The revision
+            # @return [String] The current revision of the Sync Document, represented by a string identifier
             def revision
               @properties['revision']
             end
 
             ##
-            # @return [Hash] The data
+            # @return [Hash] An arbitrary, schema-less object that the Sync Document stores
             def data
               @properties['data']
             end
 
             ##
-            # @return [Time] The date_expires
+            # @return [Time] The ISO 8601 date and time in GMT when the Sync Document 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 Sync Document's creator
             def created_by
               @properties['created_by']
             end
 
             ##
-            # Fetch a DocumentInstance
+            # Fetch the DocumentInstance
             # @return [DocumentInstance] Fetched DocumentInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the DocumentInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the DocumentInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
             # Update the DocumentInstance
-            # @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 Sync Document stores. Can be up to 16 KiB in length.
+            # @param [String] ttl How long, {in
+            #   seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+            #   the Sync Document expires and is deleted (time-to-live).
+            # @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
 
             ##