channel.rb in twilio-ruby-5.0.0

- old
+ new

@@ -99,17 +99,10 @@
 
             ##
             # When passed a block, yields ChannelInstance records from the API.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [channel.ChannelType] type The type
-            # @param [Integer] limit Upper limit for the number of records to return.                  stream()
-            #  guarantees to never return more than limit.                  Default is no limit
-            # @param [Integer] page_size Number of records to fetch per request, when                       not set will use
-            #  the default value of 50 records.                      If no page_size is defined
-            #                       but a limit is defined, stream() will attempt to read the
-            #                       limit with the most efficient page size, i.e. min(limit, 1000)
             def each
               limits = @version.read_limits
 
               page = self.page(
                   page_size: limits[:page_size],
@@ -167,11 +160,10 @@
             ##
             # Initialize the ChannelPage
             # @param [Version] version Version that contains the resource
             # @param [Response] response Response from the API
             # @param [Hash] solution Path solution for the resource
-            # @param [String] service_sid The service_sid
             # @return [ChannelPage] ChannelPage
             def initialize(version, response, solution)
               super(version, response)
 
               # Path Solution
@@ -274,12 +266,12 @@
               )
             end
 
             ##
             # Access the members
-            # @return [MemberList] if a(n) MemberList object was created.
-            # @return [MemberContext] if a(n) MemberContext object was created.
+            # @return [MemberList]
+            # @return [MemberContext] if sid was passed.
             def members(sid=:unset)
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
                 return MemberContext.new(
@@ -301,12 +293,12 @@
               @members
             end
 
             ##
             # Access the messages
-            # @return [MessageList] if a(n) MessageList object was created.
-            # @return [MessageContext] if a(n) MessageContext object was created.
+            # @return [MessageList]
+            # @return [MessageContext] if sid was passed.
             def messages(sid=:unset)
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
                 return MessageContext.new(
@@ -328,12 +320,12 @@
               @messages
             end
 
             ##
             # Access the invites
-            # @return [InviteList] if a(n) InviteList object was created.
-            # @return [InviteContext] if a(n) InviteContext object was created.
+            # @return [InviteList]
+            # @return [InviteContext] if sid was passed.
             def invites(sid=:unset)
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
                 return InviteContext.new(
@@ -401,11 +393,10 @@
             end
 
             ##
             # Generate an instance context for the instance, the context is capable of
             # performing various actions.  All instance actions are proxied to the context
-            # @param [Version] version Version that contains the resource
             # @return [ChannelContext] ChannelContext for this ChannelInstance
             def context
               unless @instance_context
                 @instance_context = ChannelContext.new(
                     @version,
@@ -414,61 +405,89 @@
                 )
               end
               @instance_context
             end
 
+            ##
+            # @return [String] The sid
             def sid
               @properties['sid']
             end
 
+            ##
+            # @return [String] The account_sid
             def account_sid
               @properties['account_sid']
             end
 
+            ##
+            # @return [String] The service_sid
             def service_sid
               @properties['service_sid']
             end
 
+            ##
+            # @return [String] The friendly_name
             def friendly_name
               @properties['friendly_name']
             end
 
+            ##
+            # @return [String] The unique_name
             def unique_name
               @properties['unique_name']
             end
 
+            ##
+            # @return [String] The attributes
             def attributes
               @properties['attributes']
             end
 
+            ##
+            # @return [channel.ChannelType] The type
             def type
               @properties['type']
             end
 
+            ##
+            # @return [Time] The date_created
             def date_created
               @properties['date_created']
             end
 
+            ##
+            # @return [Time] The date_updated
             def date_updated
               @properties['date_updated']
             end
 
+            ##
+            # @return [String] The created_by
             def created_by
               @properties['created_by']
             end
 
+            ##
+            # @return [String] The members_count
             def members_count
               @properties['members_count']
             end
 
+            ##
+            # @return [String] The messages_count
             def messages_count
               @properties['messages_count']
             end
 
+            ##
+            # @return [String] The url
             def url
               @properties['url']
             end
 
+            ##
+            # @return [String] The links
             def links
               @properties['links']
             end
 
             ##
\ No newline at end of file