twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,13 +3,13 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
     class Sync < Domain
       class V1 < Version
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ServiceList < ListResource
           ##
           # Initialize the ServiceList
@@ -24,28 +24,46 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of ServiceInstance records from the API.
-          # Request is executed immediately.
-          # @param [String] friendly_name The friendly_name
-          # @param [String] webhook_url The webhook_url
-          # @param [Boolean] reachability_webhooks_enabled The reachability_webhooks_enabled
-          # @param [Boolean] acl_enabled The acl_enabled
-          # @return [ServiceInstance] Newly created ServiceInstance
-          def create(friendly_name: :unset, webhook_url: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset)
+          # 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.
+          # @param [Boolean] reachability_webhooks_enabled Whether the service instance
+          #   should call `webhook_url` when client endpoints connect to Sync. The default is
+          #   `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.
+          # @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
+          #   after disconnection. When `true`, intervening reconnections can prevent the
+          #   `endpoint_disconnected` event.
+          # @param [String] reachability_debouncing_window The reachability event delay in
+          #   milliseconds if `reachability_debouncing_enabled` = `true`.  Must be between
+          #   1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after
+          #   the last running client disconnects, and a Sync identity is declared offline,
+          #   before the `webhook_url` is called if all endpoints remain offline. A
+          #   reconnection from the same identity by any endpoint during this interval
+          #   prevents the call to `webhook_url`.
+          # @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] 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,
                 'WebhookUrl' => webhook_url,
                 'ReachabilityWebhooksEnabled' => reachability_webhooks_enabled,
                 'AclEnabled' => acl_enabled,
+                'ReachabilityDebouncingEnabled' => reachability_debouncing_enabled,
+                'ReachabilityDebouncingWindow' => reachability_debouncing_window,
+                'WebhooksFromRestEnabled' => webhooks_from_rest_enabled,
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
-            ServiceInstance.new(@version, payload)
+            ServiceInstance.new(@version, payload, )
           end
 
           ##
@@ -77,7 +95,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 +107,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 +127,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
 
@@ -137,8 +153,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ServicePage < Page
           ##
           # Initialize the ServicePage
@@ -158,7 +172,7 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [ServiceInstance] ServiceInstance
           def get_instance(payload)
-            ServiceInstance.new(@version, payload)
+            ServiceInstance.new(@version, payload, )
           end
 
           ##
@@ -168,19 +182,17 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ServiceContext < InstanceContext
           ##
           # Initialize the ServiceContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The sid
+          # @param [String] sid The SID of the Service resource to fetch.
           # @return [ServiceContext] ServiceContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
-            @solution = {sid: sid}
+            @solution = {sid: sid, }
             @uri = "/Services/#{@solution[:sid]}"
 
             # Dependents
@@ -191,49 +203,62 @@ module Twilio
           end
 
           ##
-          # Fetch a ServiceInstance
+          # Fetch the ServiceInstance
           # @return [ServiceInstance] Fetched ServiceInstance
           def fetch
-            params = Twilio::Values.of({})
+            payload = @version.fetch('GET', @uri)
 
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
-
-            ServiceInstance.new(@version, payload, sid: @solution[:sid])
+            ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Deletes the ServiceInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # Delete the ServiceInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
           # Update the ServiceInstance
-          # @param [String] webhook_url The webhook_url
-          # @param [String] friendly_name The friendly_name
-          # @param [Boolean] reachability_webhooks_enabled The reachability_webhooks_enabled
-          # @param [Boolean] acl_enabled The acl_enabled
+          # @param [String] webhook_url The URL we should call when Sync objects are
+          #   manipulated.
+          # @param [String] friendly_name A string that you assign to describe the resource.
+          # @param [Boolean] reachability_webhooks_enabled Whether the service instance
+          #   should call `webhook_url` when client endpoints connect to Sync. The default is
+          #   `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.
+          # @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
+          #   after disconnection. When `true`, intervening reconnections can prevent the
+          #   `endpoint_disconnected` event.
+          # @param [String] reachability_debouncing_window The reachability event delay in
+          #   milliseconds if `reachability_debouncing_enabled` = `true`.  Must be between
+          #   1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after
+          #   the last running client disconnects, and a Sync identity is declared offline,
+          #   before the webhook is called if all endpoints remain offline. A reconnection
+          #   from the same identity by any endpoint during this interval prevents the webhook
+          #   from being called.
+          # @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] Updated ServiceInstance
-          def update(webhook_url: :unset, friendly_name: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset)
+          def update(webhook_url: :unset, friendly_name: :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({
                 'WebhookUrl' => webhook_url,
                 'FriendlyName' => friendly_name,
                 'ReachabilityWebhooksEnabled' => reachability_webhooks_enabled,
                 'AclEnabled' => acl_enabled,
+                'ReachabilityDebouncingEnabled' => reachability_debouncing_enabled,
+                'ReachabilityDebouncingWindow' => reachability_debouncing_window,
+                '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])
+            ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
@@ -244,11 +269,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return DocumentContext.new(@version, @solution[:sid], sid)
+              return DocumentContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @documents
-              @documents = DocumentList.new(@version, service_sid: @solution[:sid])
+              @documents = DocumentList.new(@version, service_sid: @solution[:sid], )
             end
 
             @documents
@@ -262,11 +287,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return SyncListContext.new(@version, @solution[:sid], sid)
+              return SyncListContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @sync_lists
-              @sync_lists = SyncListList.new(@version, service_sid: @solution[:sid])
+              @sync_lists = SyncListList.new(@version, service_sid: @solution[:sid], )
             end
 
             @sync_lists
@@ -280,11 +305,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return SyncMapContext.new(@version, @solution[:sid], sid)
+              return SyncMapContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @sync_maps
-              @sync_maps = SyncMapList.new(@version, service_sid: @solution[:sid])
+              @sync_maps = SyncMapList.new(@version, service_sid: @solution[:sid], )
             end
 
             @sync_maps
@@ -298,11 +323,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return SyncStreamContext.new(@version, @solution[:sid], sid)
+              return SyncStreamContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @sync_streams
-              @sync_streams = SyncStreamList.new(@version, service_sid: @solution[:sid])
+              @sync_streams = SyncStreamList.new(@version, service_sid: @solution[:sid], )
             end
 
             @sync_streams
@@ -314,16 +339,21 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Sync.V1.ServiceContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Sync.V1.ServiceContext #{context}>"
+          end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ServiceInstance < InstanceResource
           ##
           # Initialize the ServiceInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The sid
+          # @param [String] sid The SID of the Service resource to fetch.
           # @return [ServiceInstance] ServiceInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -338,14 +368,17 @@ module Twilio
                 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                 'url' => payload['url'],
                 'webhook_url' => payload['webhook_url'],
+                'webhooks_from_rest_enabled' => payload['webhooks_from_rest_enabled'],
                 'reachability_webhooks_enabled' => payload['reachability_webhooks_enabled'],
                 'acl_enabled' => payload['acl_enabled'],
+                'reachability_debouncing_enabled' => payload['reachability_debouncing_enabled'],
+                'reachability_debouncing_window' => payload['reachability_debouncing_window'].to_i,
                 'links' => payload['links'],
             }
 
             # Context
             @instance_context = nil
-            @params = {'sid' => sid || @properties['sid']}
+            @params = {'sid' => sid || @properties['sid'], }
           end
 
           ##
@@ -354,104 +387,145 @@ module Twilio
           # @return [ServiceContext] ServiceContext for this ServiceInstance
           def context
             unless @instance_context
-              @instance_context = ServiceContext.new(@version, @params['sid'])
+              @instance_context = ServiceContext.new(@version, @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 friendly_name
+          # @return [String] The string that you assigned to describe the resource
           def friendly_name
             @properties['friendly_name']
           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 url
+          # @return [String] The absolute URL of the Service resource
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The webhook_url
+          # @return [String] The URL we call when Sync objects are manipulated
           def webhook_url
             @properties['webhook_url']
           end
 
           ##
-          # @return [Boolean] The reachability_webhooks_enabled
+          # @return [Boolean] Whether the Service instance should call webhook_url when the REST API is used to update Sync objects
+          def webhooks_from_rest_enabled
+            @properties['webhooks_from_rest_enabled']
+          end
+
+          ##
+          # @return [Boolean] Whether the service instance calls webhook_url when client endpoints connect to Sync
           def reachability_webhooks_enabled
             @properties['reachability_webhooks_enabled']
           end
 
           ##
-          # @return [Boolean] The acl_enabled
+          # @return [Boolean] Whether token identities in the Service must be granted access to Sync objects by using the Permissions resource
           def acl_enabled
             @properties['acl_enabled']
           end
 
           ##
-          # @return [String] The links
+          # @return [Boolean] Whether every endpoint_disconnected event occurs after a configurable delay
+          def reachability_debouncing_enabled
+            @properties['reachability_debouncing_enabled']
+          end
+
+          ##
+          # @return [String] The reachability event delay in milliseconds
+          def reachability_debouncing_window
+            @properties['reachability_debouncing_window']
+          end
+
+          ##
+          # @return [String] The URLs of related resources
           def links
             @properties['links']
           end
 
           ##
-          # Fetch a ServiceInstance
+          # Fetch the ServiceInstance
           # @return [ServiceInstance] Fetched ServiceInstance
           def fetch
             context.fetch
           end
 
           ##
-          # Deletes the ServiceInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # Delete the ServiceInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end
 
           ##
           # Update the ServiceInstance
-          # @param [String] webhook_url The webhook_url
-          # @param [String] friendly_name The friendly_name
-          # @param [Boolean] reachability_webhooks_enabled The reachability_webhooks_enabled
-          # @param [Boolean] acl_enabled The acl_enabled
+          # @param [String] webhook_url The URL we should call when Sync objects are
+          #   manipulated.
+          # @param [String] friendly_name A string that you assign to describe the resource.
+          # @param [Boolean] reachability_webhooks_enabled Whether the service instance
+          #   should call `webhook_url` when client endpoints connect to Sync. The default is
+          #   `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.
+          # @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
+          #   after disconnection. When `true`, intervening reconnections can prevent the
+          #   `endpoint_disconnected` event.
+          # @param [String] reachability_debouncing_window The reachability event delay in
+          #   milliseconds if `reachability_debouncing_enabled` = `true`.  Must be between
+          #   1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after
+          #   the last running client disconnects, and a Sync identity is declared offline,
+          #   before the webhook is called if all endpoints remain offline. A reconnection
+          #   from the same identity by any endpoint during this interval prevents the webhook
+          #   from being called.
+          # @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] Updated ServiceInstance
-          def update(webhook_url: :unset, friendly_name: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset)
+          def update(webhook_url: :unset, friendly_name: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset, reachability_debouncing_enabled: :unset, reachability_debouncing_window: :unset, webhooks_from_rest_enabled: :unset)
             context.update(
                 webhook_url: webhook_url,
                 friendly_name: friendly_name,
                 reachability_webhooks_enabled: reachability_webhooks_enabled,
                 acl_enabled: acl_enabled,
+                reachability_debouncing_enabled: reachability_debouncing_enabled,
+                reachability_debouncing_window: reachability_debouncing_window,
+                webhooks_from_rest_enabled: webhooks_from_rest_enabled,
             )
           end
 

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -17,16 +19,17 @@ module Twilio
         end
 
         ##
-        # @param [String] sid The sid
+        # @param [String] sid The SID of the Service resource to fetch.
         # @return [Twilio::REST::Sync::V1::ServiceContext] if sid was passed.
         # @return [Twilio::REST::Sync::V1::ServiceList]
         def services(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @services ||= ServiceList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @services ||= ServiceList.new self
           else
-            ServiceContext.new(self, sid)
+              ServiceContext.new(self, sid)
           end
         end
 

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -27,7 +29,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The sid
+      # @param [String] sid The unique string that we created to identify the Service
+      #   resource.
       # @return [Twilio::REST::Sync::V1::ServiceInstance] if sid was passed.
       # @return [Twilio::REST::Sync::V1::ServiceList]
       def services(sid=:unset)