lib/twilio-ruby/rest/events/v1/sink.rb in twilio-ruby-5.40.0 vs lib/twilio-ruby/rest/events/v1/sink.rb in twilio-ruby-5.40.1

@@ -25,13 +25,14 @@
             @uri = "/Sinks"
           end
 
           ##
           # Create the SinkInstance
-          # @param [String] description The description
-          # @param [Hash] sink_configuration The sink_configuration
-          # @param [sink.SinkType] sink_type The sink_type
+          # @param [String] description A human readable description for the Sink
+          # @param [Hash] sink_configuration The information required for Twilio to connect
+          #   to the provided Sink encoded as JSON.
+          # @param [sink.SinkType] sink_type The Sink type. Can only be "kinesis" currently.
           # @return [SinkInstance] Created SinkInstance
           def create(description: nil, sink_configuration: nil, sink_type: nil)
             data = Twilio::Values.of({
                 'Description' => description,
                 'SinkConfiguration' => Twilio.serialize_object(sink_configuration),
@@ -165,11 +166,11 @@
         # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [e-mail].
         class SinkContext < InstanceContext
           ##
           # Initialize the SinkContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The sid
+          # @param [String] sid A 34 character string that uniquely identifies this Sink.
           # @return [SinkContext] SinkContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
@@ -241,11 +242,11 @@
         class SinkInstance < InstanceResource
           ##
           # Initialize the SinkInstance
           # @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 A 34 character string that uniquely identifies this Sink.
           # @return [SinkInstance] SinkInstance
           def initialize(version, payload, sid: nil)
             super(version)
 
             # Marshaled Properties
@@ -276,58 +277,58 @@
             end
             @instance_context
           end
 
           ##
-          # @return [Time] The date_created
+          # @return [Time] The date this Sink was created
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [Time] The date_updated
+          # @return [Time] The date this Sink was updated
           def date_updated
             @properties['date_updated']
           end
 
           ##
-          # @return [String] The description
+          # @return [String] Sink Description
           def description
             @properties['description']
           end
 
           ##
-          # @return [String] The sid
+          # @return [String] A string that uniquely identifies this Sink.
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [Hash] The sink_configuration
+          # @return [Hash] JSON Sink configuration.
           def sink_configuration
             @properties['sink_configuration']
           end
 
           ##
-          # @return [sink.SinkType] The sink_type
+          # @return [sink.SinkType] Sink type.
           def sink_type
             @properties['sink_type']
           end
 
           ##
-          # @return [sink.Status] The status
+          # @return [sink.Status] The Status of this Sink
           def status
             @properties['status']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The URL of this resource.
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] Nested resource URLs.
           def links
             @properties['links']
           end
 
           ##
\ No newline at end of file