twilio-ruby 5.0.0.rc26 → 5.0.0

data/lib/twilio-ruby/rest/chat/v1/service/user/user_channel.rb

@@ -71,12 +71,6 @@ module Twilio
               # When passed a block, yields UserChannelInstance records from the API.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @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
 
@@ -136,8 +130,6 @@ module Twilio
               # @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
-              # @param [String] user_sid The sid
               # @return [UserChannelPage] UserChannelPage
               def initialize(version, response, solution)
                 super(version, response)
@@ -190,34 +182,50 @@ module Twilio
                 }
               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 channel_sid
               def channel_sid
                 @properties['channel_sid']
               end
 
+              ##
+              # @return [String] The member_sid
               def member_sid
                 @properties['member_sid']
               end
 
+              ##
+              # @return [user_channel.ChannelStatus] The status
               def status
                 @properties['status']
               end
 
+              ##
+              # @return [String] The last_consumed_message_index
               def last_consumed_message_index
                 @properties['last_consumed_message_index']
               end
 
+              ##
+              # @return [String] The unread_messages_count
               def unread_messages_count
                 @properties['unread_messages_count']
               end
 
+              ##
+              # @return [String] The links
               def links
                 @properties['links']
               end

data/lib/twilio-ruby/rest/chat/v2.rb

@@ -17,6 +17,10 @@ module Twilio
           @services = nil
         end
 
+        ##
+        # @param [String] sid The sid
+        # @return [Twilio::REST::Chat::V2::CredentialInstance] if sid was passed.
+        # @return [Twilio::REST::Chat::V2::CredentialList]
         def credentials(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'
@@ -27,6 +31,10 @@ module Twilio
           end
         end
 
+        ##
+        # @param [String] sid The sid
+        # @return [Twilio::REST::Chat::V2::ServiceInstance] if sid was passed.
+        # @return [Twilio::REST::Chat::V2::ServiceList]
         def services(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'

data/lib/twilio-ruby/rest/chat/v2/credential.rb

@@ -64,12 +64,6 @@ module Twilio
           # When passed a block, yields CredentialInstance records from the API.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
-          # @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
 
@@ -303,7 +297,6 @@ module Twilio
           ##
           # 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 [CredentialContext] CredentialContext for this CredentialInstance
           def context
             unless @instance_context
@@ -315,34 +308,50 @@ module Twilio
             @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 friendly_name
           def friendly_name
             @properties['friendly_name']
           end
 
+          ##
+          # @return [credential.PushService] The type
           def type
             @properties['type']
           end
 
+          ##
+          # @return [String] The sandbox
           def sandbox
             @properties['sandbox']
           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 url
           def url
             @properties['url']
           end

data/lib/twilio-ruby/rest/chat/v2/service.rb

@@ -86,12 +86,6 @@ module Twilio
           # When passed a block, yields ServiceInstance records from the API.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
-          # @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
 
@@ -314,8 +308,8 @@ module Twilio
 
           ##
           # Access the channels
-          # @return [ChannelList] if a(n) ChannelList object was created.
-          # @return [ChannelContext] if a(n) ChannelContext object was created.
+          # @return [ChannelList]
+          # @return [ChannelContext] if sid was passed.
           def channels(sid=:unset)
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -339,8 +333,8 @@ module Twilio
 
           ##
           # Access the roles
-          # @return [RoleList] if a(n) RoleList object was created.
-          # @return [RoleContext] if a(n) RoleContext object was created.
+          # @return [RoleList]
+          # @return [RoleContext] if sid was passed.
           def roles(sid=:unset)
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -364,8 +358,8 @@ module Twilio
 
           ##
           # Access the users
-          # @return [UserList] if a(n) UserList object was created.
-          # @return [UserContext] if a(n) UserContext object was created.
+          # @return [UserList]
+          # @return [UserContext] if sid was passed.
           def users(sid=:unset)
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -439,7 +433,6 @@ module Twilio
           ##
           # 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 [ServiceContext] ServiceContext for this ServiceInstance
           def context
             unless @instance_context
@@ -451,82 +444,122 @@ module Twilio
             @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 friendly_name
           def friendly_name
             @properties['friendly_name']
           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 default_service_role_sid
           def default_service_role_sid
             @properties['default_service_role_sid']
           end
 
+          ##
+          # @return [String] The default_channel_role_sid
           def default_channel_role_sid
             @properties['default_channel_role_sid']
           end
 
+          ##
+          # @return [String] The default_channel_creator_role_sid
           def default_channel_creator_role_sid
             @properties['default_channel_creator_role_sid']
           end
 
+          ##
+          # @return [Boolean] The read_status_enabled
           def read_status_enabled
             @properties['read_status_enabled']
           end
 
+          ##
+          # @return [Boolean] The reachability_enabled
           def reachability_enabled
             @properties['reachability_enabled']
           end
 
+          ##
+          # @return [String] The typing_indicator_timeout
           def typing_indicator_timeout
             @properties['typing_indicator_timeout']
           end
 
+          ##
+          # @return [String] The consumption_report_interval
           def consumption_report_interval
             @properties['consumption_report_interval']
           end
 
+          ##
+          # @return [Hash] The limits
           def limits
             @properties['limits']
           end
 
+          ##
+          # @return [String] The pre_webhook_url
           def pre_webhook_url
             @properties['pre_webhook_url']
           end
 
+          ##
+          # @return [String] The post_webhook_url
           def post_webhook_url
             @properties['post_webhook_url']
           end
 
+          ##
+          # @return [String] The webhook_method
           def webhook_method
             @properties['webhook_method']
           end
 
+          ##
+          # @return [String] The webhook_filters
           def webhook_filters
             @properties['webhook_filters']
           end
 
+          ##
+          # @return [Hash] The notifications
           def notifications
             @properties['notifications']
           end
 
+          ##
+          # @return [String] The url
           def url
             @properties['url']
           end
 
+          ##
+          # @return [String] The links
           def links
             @properties['links']
           end

data/lib/twilio-ruby/rest/chat/v2/service/channel.rb

@@ -101,13 +101,6 @@ module Twilio
             # 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
 
@@ -169,7 +162,6 @@ module Twilio
             # @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)
@@ -276,8 +268,8 @@ module Twilio
 
             ##
             # 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?
 
@@ -303,8 +295,8 @@ module Twilio
 
             ##
             # 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?
 
@@ -330,8 +322,8 @@ module Twilio
 
             ##
             # 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?
 
@@ -403,7 +395,6 @@ module Twilio
             ##
             # 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
@@ -416,58 +407,86 @@ module Twilio
               @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