twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -10,14 +12,15 @@ module Twilio
       class V1 < Version
         class ServiceContext < InstanceContext
           class SyncStreamContext < InstanceContext
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class StreamMessageList < ListResource
               ##
               # Initialize the StreamMessageList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The unique SID identifier of the Service Instance.
-              # @param [String] stream_sid The unique 34-character SID identifier of the Stream.
+              # @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] stream_sid The unique string that we created to identify the
+              #   Sync Stream resource.
               # @return [StreamMessageList] StreamMessageList
               def initialize(version, service_sid: nil, stream_sid: nil)
                 super(version)
@@ -28,19 +31,14 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of StreamMessageInstance records from the API.
-              # Request is executed immediately.
-              # @param [Hash] data The body of the Stream Message. Arbitrary JSON object,
-              #   maximum size 4KB.
-              # @return [StreamMessageInstance] Newly created StreamMessageInstance
+              # Create the StreamMessageInstance
+              # @param [Hash] data A JSON string that represents an arbitrary, schema-less
+              #   object that makes up the Stream Message body. Can be up to 4 KiB in length.
+              # @return [StreamMessageInstance] Created StreamMessageInstance
               def create(data: nil)
-                data = Twilio::Values.of({'Data' => Twilio.serialize_object(data)})
+                data = Twilio::Values.of({'Data' => Twilio.serialize_object(data), })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 StreamMessageInstance.new(
                     @version,
@@ -57,8 +55,6 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class StreamMessagePage < Page
               ##
               # Initialize the StreamMessagePage
@@ -93,31 +89,32 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class StreamMessageInstance < InstanceResource
               ##
               # Initialize the StreamMessageInstance
               # @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 Service Instance.
-              # @param [String] stream_sid The unique 34-character SID identifier of the Stream.
+              # @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] stream_sid The unique string that we created to identify the
+              #   Sync Stream resource.
               # @return [StreamMessageInstance] StreamMessageInstance
               def initialize(version, payload, service_sid: nil, stream_sid: nil)
                 super(version)
 
                 # Marshaled Properties
-                @properties = {'sid' => payload['sid'], 'data' => payload['data']}
+                @properties = {'sid' => payload['sid'], 'data' => payload['data'], }
               end
 
               ##
-              # @return [String] Stream Message SID.
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [Hash] Stream Message body.
+              # @return [Hash] Stream Message body
               def data
                 @properties['data']
               end

data/lib/twilio-ruby/rest/sync/v1/service/sync_stream.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 SyncStreamList < ListResource
             ##
             # Initialize the SyncStreamList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The unique SID identifier of the Service Instance.
+            # @param [String] service_sid The SID of the {Sync
+            #   Service}[https://www.twilio.com/docs/sync/api/service] the resource is
+            #   associated with.
             # @return [SyncStreamList] SyncStreamList
             def initialize(version, service_sid: nil)
               super(version)
@@ -26,23 +28,21 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of SyncStreamInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] unique_name The unique and addressable name of this Stream.
-            #   Optional, up to 256 characters long.
-            # @param [String] ttl Optional time-to-live of this Stream in seconds. In the
-            #   range [1, 31 536 000 (1 year)], or 0 for infinity.
-            # @return [SyncStreamInstance] Newly created SyncStreamInstance
+            # Create the SyncStreamInstance
+            # @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 How long, {in
+            #   seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+            #   the Stream expires and is deleted (time-to-live).
+            # @return [SyncStreamInstance] Created SyncStreamInstance
             def create(unique_name: :unset, ttl: :unset)
-              data = Twilio::Values.of({'UniqueName' => unique_name, 'Ttl' => ttl})
+              data = Twilio::Values.of({'UniqueName' => unique_name, 'Ttl' => ttl, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
-              SyncStreamInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              SyncStreamInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -74,7 +74,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
@@ -86,7 +86,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],
@@ -106,11 +106,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               SyncStreamPage.new(@version, response, @solution)
             end
 
@@ -134,8 +132,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class SyncStreamPage < Page
             ##
             # Initialize the SyncStreamPage
@@ -155,7 +151,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [SyncStreamInstance] SyncStreamInstance
             def get_instance(payload)
-              SyncStreamInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              SyncStreamInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -165,20 +161,20 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class SyncStreamContext < InstanceContext
             ##
             # Initialize the SyncStreamContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @param [String] sid Identifier of the Stream. Either a SID or a unique name.
+            # @param [String] service_sid The SID of the {Sync
+            #   Service}[https://www.twilio.com/docs/sync/api/service] with the Sync Stream
+            #   resource to fetch.
+            # @param [String] sid The SID of the Stream resource to fetch.
             # @return [SyncStreamContext] SyncStreamContext
             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]}/Streams/#{@solution[:sid]}"
 
               # Dependents
@@ -186,42 +182,43 @@ module Twilio
             end
 
             ##
-            # Fetch a SyncStreamInstance
+            # Fetch the SyncStreamInstance
             # @return [SyncStreamInstance] Fetched SyncStreamInstance
             def fetch
-              params = Twilio::Values.of({})
+              payload = @version.fetch('GET', @uri)
 
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
+              SyncStreamInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+                  sid: @solution[:sid],
               )
-
-              SyncStreamInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
             end
 
             ##
-            # Deletes the SyncStreamInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the SyncStreamInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
             # Update the SyncStreamInstance
-            # @param [String] ttl Time-to-live of this Stream in seconds. In the range [1, 31
-            #   536 000 (1 year)], or 0 for infinity.
+            # @param [String] ttl How long, {in
+            #   seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+            #   the Stream expires and is deleted (time-to-live).
             # @return [SyncStreamInstance] Updated SyncStreamInstance
             def update(ttl: :unset)
-              data = Twilio::Values.of({'Ttl' => ttl})
+              data = Twilio::Values.of({'Ttl' => ttl, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
-              SyncStreamInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              SyncStreamInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+                  sid: @solution[:sid],
+              )
             end
 
             ##
@@ -246,17 +243,24 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Sync.V1.SyncStreamContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Sync.V1.SyncStreamContext #{context}>"
+            end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class SyncStreamInstance < InstanceResource
             ##
             # Initialize the SyncStreamInstance
             # @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 Service Instance.
-            # @param [String] sid Identifier of the Stream. Either a SID or a unique name.
+            # @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 Stream resource to fetch.
             # @return [SyncStreamInstance] SyncStreamInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -277,7 +281,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
 
             ##
@@ -286,92 +290,93 @@ module Twilio
             # @return [SyncStreamContext] SyncStreamContext for this SyncStreamInstance
             def context
               unless @instance_context
-                @instance_context = SyncStreamContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = SyncStreamContext.new(@version, @params['service_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] Stream SID.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] Stream unique name.
+            # @return [String] An application-defined string that uniquely identifies the resource
             def unique_name
               @properties['unique_name']
             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] 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] URL of this Stream.
+            # @return [String] The absolute URL of the Message Stream resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] Nested resource URLs.
+            # @return [String] The URLs of the Stream's nested resources
             def links
               @properties['links']
             end
 
             ##
-            # @return [Time] The date this Stream expires.
+            # @return [Time] The ISO 8601 date and time in GMT when the Message Stream expires
             def date_expires
               @properties['date_expires']
             end
 
             ##
-            # @return [Time] The date this Stream was 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 this Stream was 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] Identity of the Stream creator.
+            # @return [String] The Identity of the Stream's creator
             def created_by
               @properties['created_by']
             end
 
             ##
-            # Fetch a SyncStreamInstance
+            # Fetch the SyncStreamInstance
             # @return [SyncStreamInstance] Fetched SyncStreamInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the SyncStreamInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the SyncStreamInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
             # Update the SyncStreamInstance
-            # @param [String] ttl Time-to-live of this Stream in seconds. In the range [1, 31
-            #   536 000 (1 year)], or 0 for infinity.
+            # @param [String] ttl How long, {in
+            #   seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+            #   the Stream expires and is deleted (time-to-live).
             # @return [SyncStreamInstance] Updated SyncStreamInstance
             def update(ttl: :unset)
-              context.update(ttl: ttl)
+              context.update(ttl: ttl, )
             end
 
             ##