twilio-ruby 5.0.0.rc26 → 5.0.0

data/lib/twilio-ruby/rest/ip_messaging/v2/service/role.rb

@@ -95,12 +95,6 @@ module Twilio
             # When passed a block, yields RoleInstance 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
 
@@ -160,7 +154,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 [RolePage] RolePage
             def initialize(version, response, solution)
               super(version, response)
@@ -299,7 +292,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 [RoleContext] RoleContext for this RoleInstance
             def context
               unless @instance_context
@@ -312,38 +304,56 @@ 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 [role.RoleType] The type
             def type
               @properties['type']
             end
 
+            ##
+            # @return [String] The permissions
             def permissions
               @properties['permissions']
             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/ip_messaging/v2/service/user.rb

@@ -97,12 +97,6 @@ module Twilio
             # When passed a block, yields UserInstance 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
 
@@ -162,7 +156,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 [UserPage] UserPage
             def initialize(version, response, solution)
               super(version, response)
@@ -267,8 +260,8 @@ module Twilio
 
             ##
             # Access the user_channels
-            # @return [UserChannelList] if a(n) UserChannelList object was created.
-            # @return [UserChannelContext] if a(n) UserChannelContext object was created.
+            # @return [UserChannelList]
+            # @return [UserChannelContext]
             def user_channels
               unless @user_channels
                 @user_channels = UserChannelList.new(
@@ -329,7 +322,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 [UserContext] UserContext for this UserInstance
             def context
               unless @instance_context
@@ -342,58 +334,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 attributes
             def attributes
               @properties['attributes']
             end
 
+            ##
+            # @return [String] The friendly_name
             def friendly_name
               @properties['friendly_name']
             end
 
+            ##
+            # @return [String] The role_sid
             def role_sid
               @properties['role_sid']
             end
 
+            ##
+            # @return [String] The identity
             def identity
               @properties['identity']
             end
 
+            ##
+            # @return [Boolean] The is_online
             def is_online
               @properties['is_online']
             end
 
+            ##
+            # @return [Boolean] The is_notifiable
             def is_notifiable
               @properties['is_notifiable']
             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 joined_channels_count
             def joined_channels_count
               @properties['joined_channels_count']
             end
 
+            ##
+            # @return [String] The links
             def links
               @properties['links']
             end
 
+            ##
+            # @return [String] The url
             def url
               @properties['url']
             end

data/lib/twilio-ruby/rest/ip_messaging/v2/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/lookups.rb

@@ -26,6 +26,10 @@ module Twilio
         @v1 ||= V1.new self
       end
 
+      ##
+      # @param [String] phone_number The phone_number
+      # @return [Twilio::REST::Lookups::V1::PhoneNumberInstance] if phone_number was passed.
+      # @return [Twilio::REST::Lookups::V1::PhoneNumberList]
       def phone_numbers(phone_number=:unset)
         self.v1.phone_numbers(phone_number)
       end

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

@@ -16,13 +16,17 @@ module Twilio
           @phone_numbers = nil
         end
 
-        def phone_numbers(sid=:unset)
-          if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
+        ##
+        # @param [String] phone_number The phone_number
+        # @return [Twilio::REST::Lookups::V1::PhoneNumberInstance] if phone_number was passed.
+        # @return [Twilio::REST::Lookups::V1::PhoneNumberList]
+        def phone_numbers(phone_number=:unset)
+          if phone_number.nil?
+            raise ArgumentError, 'phone_number cannot be nil'
+          elsif phone_number == :unset
             @phone_numbers ||= PhoneNumberList.new self
           else
-            PhoneNumberContext.new(self, sid)
+            PhoneNumberContext.new(self, phone_number)
           end
         end
 

data/lib/twilio-ruby/rest/lookups/v1/phone_number.rb

@@ -142,7 +142,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 [PhoneNumberContext] PhoneNumberContext for this PhoneNumberInstance
           def context
             unless @instance_context
@@ -154,30 +153,44 @@ module Twilio
             @instance_context
           end
 
+          ##
+          # @return [String] The caller_name
           def caller_name
             @properties['caller_name']
           end
 
+          ##
+          # @return [String] The country_code
           def country_code
             @properties['country_code']
           end
 
+          ##
+          # @return [String] The phone_number
           def phone_number
             @properties['phone_number']
           end
 
+          ##
+          # @return [String] The national_format
           def national_format
             @properties['national_format']
           end
 
+          ##
+          # @return [String] The carrier
           def carrier
             @properties['carrier']
           end
 
+          ##
+          # @return [Hash] The add_ons
           def add_ons
             @properties['add_ons']
           end
 
+          ##
+          # @return [String] The url
           def url
             @properties['url']
           end

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

@@ -26,10 +26,18 @@ module Twilio
         @v1 ||= V1.new self
       end
 
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Monitor::V1::AlertInstance] if sid was passed.
+      # @return [Twilio::REST::Monitor::V1::AlertList]
       def alerts(sid=:unset)
         self.v1.alerts(sid)
       end
 
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Monitor::V1::EventInstance] if sid was passed.
+      # @return [Twilio::REST::Monitor::V1::EventList]
       def events(sid=:unset)
         self.v1.events(sid)
       end

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

@@ -17,6 +17,10 @@ module Twilio
           @events = nil
         end
 
+        ##
+        # @param [String] sid The sid
+        # @return [Twilio::REST::Monitor::V1::AlertInstance] if sid was passed.
+        # @return [Twilio::REST::Monitor::V1::AlertList]
         def alerts(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::Monitor::V1::EventInstance] if sid was passed.
+        # @return [Twilio::REST::Monitor::V1::EventList]
         def events(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'

data/lib/twilio-ruby/rest/monitor/v1/alert.rb

@@ -76,15 +76,6 @@ module Twilio
           # When passed a block, yields AlertInstance records from the API.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
-          # @param [String] log_level The log_level
-          # @param [Date] start_date The start_date
-          # @param [Date] end_date The end_date
-          # @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
 
@@ -267,7 +258,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 [AlertContext] AlertContext for this AlertInstance
           def context
             unless @instance_context
@@ -279,70 +269,104 @@ module Twilio
             @instance_context
           end
 
+          ##
+          # @return [String] The account_sid
           def account_sid
             @properties['account_sid']
           end
 
+          ##
+          # @return [String] The alert_text
           def alert_text
             @properties['alert_text']
           end
 
+          ##
+          # @return [String] The api_version
           def api_version
             @properties['api_version']
           end
 
+          ##
+          # @return [Time] The date_created
           def date_created
             @properties['date_created']
           end
 
+          ##
+          # @return [Time] The date_generated
           def date_generated
             @properties['date_generated']
           end
 
+          ##
+          # @return [Time] The date_updated
           def date_updated
             @properties['date_updated']
           end
 
+          ##
+          # @return [String] The error_code
           def error_code
             @properties['error_code']
           end
 
+          ##
+          # @return [String] The log_level
           def log_level
             @properties['log_level']
           end
 
+          ##
+          # @return [String] The more_info
           def more_info
             @properties['more_info']
           end
 
+          ##
+          # @return [String] The request_method
           def request_method
             @properties['request_method']
           end
 
+          ##
+          # @return [String] The request_url
           def request_url
             @properties['request_url']
           end
 
+          ##
+          # @return [String] The request_variables
           def request_variables
             @properties['request_variables']
           end
 
+          ##
+          # @return [String] The resource_sid
           def resource_sid
             @properties['resource_sid']
           end
 
+          ##
+          # @return [String] The response_body
           def response_body
             @properties['response_body']
           end
 
+          ##
+          # @return [String] The response_headers
           def response_headers
             @properties['response_headers']
           end
 
+          ##
+          # @return [String] The sid
           def sid
             @properties['sid']
           end
 
+          ##
+          # @return [String] The url
           def url
             @properties['url']
           end