twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_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 SyncListContext < InstanceContext
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class SyncListPermissionList < ListResource
               ##
               # Initialize the SyncListPermissionList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The unique SID identifier of the Sync Service
-              #   Instance.
-              # @param [String] list_sid The unique SID identifier of the Sync List 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] list_sid The SID of the Sync List to which the Permission
+              #   applies.
               # @return [SyncListPermissionList] SyncListPermissionList
               def initialize(version, service_sid: nil, list_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)
+
                 SyncListPermissionPage.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 SyncListPermissionPage < Page
               ##
               # Initialize the SyncListPermissionPage
@@ -154,37 +151,31 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class SyncListPermissionContext < InstanceContext
               ##
               # Initialize the SyncListPermissionContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] list_sid Identifier of the Sync List. 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 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`.
+              # @param [String] identity The application-defined string that uniquely identifies
+              #   the User's Sync List Permission resource to fetch.
               # @return [SyncListPermissionContext] SyncListPermissionContext
               def initialize(version, service_sid, list_sid, identity)
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, list_sid: list_sid, identity: identity}
+                @solution = {service_sid: service_sid, list_sid: list_sid, identity: identity, }
                 @uri = "/Services/#{@solution[:service_sid]}/Lists/#{@solution[:list_sid]}/Permissions/#{@solution[:identity]}"
               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,
@@ -196,29 +187,25 @@ module Twilio
               end
 
               ##
-              # Deletes the SyncListPermissionInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the SyncListPermissionInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
               # Update the SyncListPermissionInstance
-              # @param [Boolean] read Boolean flag specifying whether the identity can read the
-              #   Sync List.
-              # @param [Boolean] write Boolean flag specifying whether the identity can create,
-              #   update and delete Items of the Sync List.
-              # @param [Boolean] manage Boolean flag specifying whether the identity can delete
-              #   the Sync List.
+              # @param [Boolean] read Whether the identity can read the Sync List and its Items.
+              #   Default value is `false`.
+              # @param [Boolean] write Whether the identity can create, update, and delete Items
+              #   in the Sync List. Default value is `false`.
+              # @param [Boolean] manage Whether the identity can delete the Sync List. Default
+              #   value is `false`.
               # @return [SyncListPermissionInstance] Updated SyncListPermissionInstance
               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)
 
                 SyncListPermissionInstance.new(
                     @version,
@@ -235,21 +222,27 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Sync.V1.SyncListPermissionContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Sync.V1.SyncListPermissionContext #{context}>"
+              end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class SyncListPermissionInstance < InstanceResource
               ##
               # 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 unique SID identifier of the Sync Service
-              #   Instance.
-              # @param [String] list_sid The unique SID identifier of the Sync List 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] list_sid The SID of the Sync List to which the Permission
+              #   applies.
+              # @param [String] identity The application-defined string that uniquely identifies
+              #   the User's Sync List Permission resource to fetch.
               # @return [SyncListPermissionInstance] SyncListPermissionInstance
               def initialize(version, payload, service_sid: nil, list_sid: nil, identity: nil)
                 super(version)
@@ -292,78 +285,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 List SID.
+              # @return [String] The SID of the Sync List to which the Permission applies
               def list_sid
                 @properties['list_sid']
               end
 
               ##
-              # @return [String] Identity of the user to whom the Sync List Permission applies.
+              # @return [String] The identity of the user to whom the Sync List 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 List Permission.
+              # @return [String] The absolute URL of the Sync List Permission resource
               def url
                 @properties['url']
               end
 
               ##
-              # Fetch a SyncListPermissionInstance
+              # Fetch the SyncListPermissionInstance
               # @return [SyncListPermissionInstance] Fetched SyncListPermissionInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the SyncListPermissionInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the SyncListPermissionInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end
 
               ##
               # Update the SyncListPermissionInstance
-              # @param [Boolean] read Boolean flag specifying whether the identity can read the
-              #   Sync List.
-              # @param [Boolean] write Boolean flag specifying whether the identity can create,
-              #   update and delete Items of the Sync List.
-              # @param [Boolean] manage Boolean flag specifying whether the identity can delete
-              #   the Sync List.
+              # @param [Boolean] read Whether the identity can read the Sync List and its Items.
+              #   Default value is `false`.
+              # @param [Boolean] write Whether the identity can create, update, and delete Items
+              #   in the Sync List. Default value is `false`.
+              # @param [Boolean] manage Whether the identity can delete the Sync List. Default
+              #   value is `false`.
               # @return [SyncListPermissionInstance] Updated SyncListPermissionInstance
               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/sync_list.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 SyncListList < ListResource
             ##
             # Initialize the SyncListList
             # @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 [SyncListList] SyncListList
             def initialize(version, service_sid: nil)
               super(version)
@@ -26,21 +28,27 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of SyncListInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] unique_name The unique_name
-            # @param [String] ttl The ttl
-            # @return [SyncListInstance] Newly created SyncListInstance
-            def create(unique_name: :unset, ttl: :unset)
-              data = Twilio::Values.of({'UniqueName' => unique_name, 'Ttl' => ttl})
-
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+            # 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}[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,
+                  'Ttl' => ttl,
+                  'CollectionTtl' => collection_ttl,
+              })
+
+              payload = @version.create('POST', @uri, data: data)
 
-              SyncListInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              SyncListInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -72,7 +80,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
@@ -84,7 +92,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],
@@ -104,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
 
@@ -132,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
@@ -153,7 +157,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [SyncListInstance] SyncListInstance
             def get_instance(payload)
-              SyncListInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              SyncListInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -163,20 +167,21 @@ 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 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 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)
 
               # Path Solution
-              @solution = {service_sid: service_sid, sid: sid}
+              @solution = {service_sid: service_sid, sid: sid, }
               @uri = "/Services/#{@solution[:service_sid]}/Lists/#{@solution[:sid]}"
 
               # Dependents
@@ -185,41 +190,35 @@ 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])
+              SyncListInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the SyncListInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # 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 The ttl
+            # @param [String] ttl An alias for `collection_ttl`. If both are provided, this
+            #   value is ignored.
+            # @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)
-              data = Twilio::Values.of({'Ttl' => ttl})
+            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])
+              SyncListInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
@@ -230,7 +229,7 @@ module Twilio
               raise ArgumentError, 'index cannot be nil' if index.nil?
 
               if index != :unset
-                return SyncListItemContext.new(@version, @solution[:service_sid], @solution[:sid], index)
+                return SyncListItemContext.new(@version, @solution[:service_sid], @solution[:sid], index, )
               end
 
               unless @sync_list_items
@@ -252,7 +251,7 @@ module Twilio
               raise ArgumentError, 'identity cannot be nil' if identity.nil?
 
               if identity != :unset
-                return SyncListPermissionContext.new(@version, @solution[:service_sid], @solution[:sid], identity)
+                return SyncListPermissionContext.new(@version, @solution[:service_sid], @solution[:sid], identity, )
               end
 
               unless @sync_list_permissions
@@ -272,17 +271,25 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Sync.V1.SyncListContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Sync.V1.SyncListContext #{context}>"
+            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 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 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)
@@ -304,7 +311,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
 
             ##
@@ -313,97 +320,101 @@ module Twilio
             # @return [SyncListContext] SyncListContext for this SyncListInstance
             def context
               unless @instance_context
-                @instance_context = SyncListContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = SyncListContext.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 Sync List resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] The URLs of the Sync List's nested resources
             def links
               @properties['links']
             end
 
             ##
-            # @return [String] The revision
+            # @return [String] The current revision of the Sync List, represented as a string
             def revision
               @properties['revision']
             end
 
             ##
-            # @return [Time] The date_expires
+            # @return [Time] The ISO 8601 date and time in GMT when the Sync List 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 List's creator
             def created_by
               @properties['created_by']
             end
 
             ##
-            # Fetch a SyncListInstance
+            # Fetch the SyncListInstance
             # @return [SyncListInstance] Fetched SyncListInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the SyncListInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the SyncListInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
             # Update the SyncListInstance
-            # @param [String] ttl The ttl
+            # @param [String] ttl An alias for `collection_ttl`. If both are provided, this
+            #   value is ignored.
+            # @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)
-              context.update(ttl: ttl)
+            def update(ttl: :unset, collection_ttl: :unset)
+              context.update(ttl: ttl, collection_ttl: collection_ttl, )
             end
 
             ##