twilio-ruby 5.0.0.rc26 → 5.0.0

data/lib/twilio-ruby/rest/api/v2010/account/key.rb

@@ -69,12 +69,6 @@ module Twilio
             # When passed a block, yields KeyInstance 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
 
@@ -134,8 +128,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] account_sid A 34 character string that uniquely identifies this
-            #   resource.
             # @return [KeyPage] KeyPage
             def initialize(version, response, solution)
               super(version, response)
@@ -270,7 +262,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 [KeyContext] KeyContext for this KeyInstance
             def context
               unless @instance_context
@@ -283,18 +274,26 @@ module Twilio
               @instance_context
             end
 
+            ##
+            # @return [String] The sid
             def sid
               @properties['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

data/lib/twilio-ruby/rest/api/v2010/account/message.rb

@@ -79,7 +79,7 @@ module Twilio
             # @param [String] from Only show messages from this phone number
             # @param [Time] date_sent_before Filter by date sent
             # @param [Time] date_sent Filter by date sent
-            # @param [Time] date_sent_after: Filter by date sent
+            # @param [Time] date_sent_after Filter by date sent
             # @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
@@ -107,7 +107,7 @@ module Twilio
             # @param [String] from Only show messages from this phone number
             # @param [Time] date_sent_before Filter by date sent
             # @param [Time] date_sent Filter by date sent
-            # @param [Time] date_sent_after: Filter by date sent
+            # @param [Time] date_sent_after Filter by date sent
             # @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
@@ -134,17 +134,6 @@ module Twilio
             # When passed a block, yields MessageInstance records from the API.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] to Filter by messages to this number
-            # @param [String] from Only show messages from this phone number
-            # @param [Time] date_sent_before Filter by date sent
-            # @param [Time] date_sent Filter by date sent
-            # @param [Time] date_sent_after: Filter by date sent
-            # @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
 
@@ -164,7 +153,7 @@ module Twilio
             # @param [String] from Only show messages from this phone number
             # @param [Time] date_sent_before Filter by date sent
             # @param [Time] date_sent Filter by date sent
-            # @param [Time] date_sent_after: Filter by date sent
+            # @param [Time] date_sent_after Filter by date sent
             # @param [String] page_token PageToken provided by the API
             # @param [Integer] page_number Page Number, this value is simply for client state
             # @param [Integer] page_size Number of records to return, defaults to 50
@@ -214,7 +203,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] account_sid The unique id of the Account that sent this message.
             # @return [MessagePage] MessagePage
             def initialize(version, response, solution)
               super(version, response)
@@ -316,8 +304,8 @@ module Twilio
 
             ##
             # Access the media
-            # @return [MediaList] if a(n) MediaList object was created.
-            # @return [MediaContext] if a(n) MediaContext object was created.
+            # @return [MediaList]
+            # @return [MediaContext] if sid was passed.
             def media(sid=:unset)
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -343,8 +331,8 @@ module Twilio
 
             ##
             # Access the feedback
-            # @return [FeedbackList] if a(n) FeedbackList object was created.
-            # @return [FeedbackContext] if a(n) FeedbackContext object was created.
+            # @return [FeedbackList]
+            # @return [FeedbackContext]
             def feedback
               unless @feedback
                 @feedback = FeedbackList.new(
@@ -411,7 +399,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 [MessageContext] MessageContext for this MessageInstance
             def context
               unless @instance_context
@@ -424,82 +411,122 @@ module Twilio
               @instance_context
             end
 
+            ##
+            # @return [String] The unique sid that identifies this account
             def account_sid
               @properties['account_sid']
             end
 
+            ##
+            # @return [String] The version of the Twilio API used to process the message.
             def api_version
               @properties['api_version']
             end
 
+            ##
+            # @return [String] The text body of the message. Up to 1600 characters long.
             def body
               @properties['body']
             end
 
+            ##
+            # @return [Time] The date this resource was created
             def date_created
               @properties['date_created']
             end
 
+            ##
+            # @return [Time] The date this resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
+            ##
+            # @return [Time] The date the message was sent
             def date_sent
               @properties['date_sent']
             end
 
+            ##
+            # @return [message.Direction] The direction of the message
             def direction
               @properties['direction']
             end
 
+            ##
+            # @return [String] The error code associated with the message
             def error_code
               @properties['error_code']
             end
 
+            ##
+            # @return [String] Human readable description of the ErrorCode
             def error_message
               @properties['error_message']
             end
 
+            ##
+            # @return [String] The phone number that initiated the message
             def from
               @properties['from']
             end
 
+            ##
+            # @return [String] The messaging_service_sid
             def messaging_service_sid
               @properties['messaging_service_sid']
             end
 
+            ##
+            # @return [String] Number of media files associated with the message
             def num_media
               @properties['num_media']
             end
 
+            ##
+            # @return [String] Indicates number of messages used to delivery the body
             def num_segments
               @properties['num_segments']
             end
 
+            ##
+            # @return [String] The amount billed for the message
             def price
               @properties['price']
             end
 
+            ##
+            # @return [String] The currency in which Price is measured
             def price_unit
               @properties['price_unit']
             end
 
+            ##
+            # @return [String] A string that uniquely identifies this message
             def sid
               @properties['sid']
             end
 
+            ##
+            # @return [message.Status] The status of this message
             def status
               @properties['status']
             end
 
+            ##
+            # @return [String] The URI for any subresources
             def subresource_uris
               @properties['subresource_uris']
             end
 
+            ##
+            # @return [String] The phone number that received the message
             def to
               @properties['to']
             end
 
+            ##
+            # @return [String] The URI for this resource
             def uri
               @properties['uri']
             end

data/lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb

@@ -65,8 +65,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] account_sid The account_sid
-              # @param [String] message_sid The message_sid
               # @return [FeedbackPage] FeedbackPage
               def initialize(version, response, solution)
                 super(version, response)
@@ -117,26 +115,38 @@ module Twilio
                 }
               end
 
+              ##
+              # @return [String] The account_sid
               def account_sid
                 @properties['account_sid']
               end
 
+              ##
+              # @return [String] The message_sid
               def message_sid
                 @properties['message_sid']
               end
 
+              ##
+              # @return [feedback.Outcome] The outcome
               def outcome
                 @properties['outcome']
               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 uri
               def uri
                 @properties['uri']
               end

data/lib/twilio-ruby/rest/api/v2010/account/message/media.rb

@@ -36,7 +36,7 @@ module Twilio
               # memory before returning.
               # @param [Time] date_created_before Filter by date created
               # @param [Time] date_created Filter by date created
-              # @param [Time] date_created_after: Filter by date created
+              # @param [Time] date_created_after Filter by date created
               # @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
@@ -60,7 +60,7 @@ module Twilio
               # is reached.
               # @param [Time] date_created_before Filter by date created
               # @param [Time] date_created Filter by date created
-              # @param [Time] date_created_after: Filter by date created
+              # @param [Time] date_created_after Filter by date created
               # @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
@@ -85,15 +85,6 @@ module Twilio
               # When passed a block, yields MediaInstance records from the API.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [Time] date_created_before Filter by date created
-              # @param [Time] date_created Filter by date created
-              # @param [Time] date_created_after: Filter by date created
-              # @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
 
@@ -111,7 +102,7 @@ module Twilio
               # Request is executed immediately.
               # @param [Time] date_created_before Filter by date created
               # @param [Time] date_created Filter by date created
-              # @param [Time] date_created_after: Filter by date created
+              # @param [Time] date_created_after Filter by date created
               # @param [String] page_token PageToken provided by the API
               # @param [Integer] page_number Page Number, this value is simply for client state
               # @param [Integer] page_size Number of records to return, defaults to 50
@@ -159,10 +150,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] account_sid The unique id of the Account responsible for this
-              #   media.
-              # @param [String] message_sid A 34 character string that uniquely identifies this
-              #   resource.
               # @return [MediaPage] MediaPage
               def initialize(version, response, solution)
                 super(version, response)
@@ -284,7 +271,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 [MediaContext] MediaContext for this MediaInstance
               def context
                 unless @instance_context
@@ -298,30 +284,44 @@ module Twilio
                 @instance_context
               end
 
+              ##
+              # @return [String] The unique sid that identifies this account
               def account_sid
                 @properties['account_sid']
               end
 
+              ##
+              # @return [String] The default mime-type of the media
               def content_type
                 @properties['content_type']
               end
 
+              ##
+              # @return [Time] The date this resource was created
               def date_created
                 @properties['date_created']
               end
 
+              ##
+              # @return [Time] The date this resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
+              ##
+              # @return [String] The unique id of the resource that created the media.
               def parent_sid
                 @properties['parent_sid']
               end
 
+              ##
+              # @return [String] A string that uniquely identifies this media
               def sid
                 @properties['sid']
               end
 
+              ##
+              # @return [String] The URI for this resource
               def uri
                 @properties['uri']
               end

data/lib/twilio-ruby/rest/api/v2010/account/new_key.rb

@@ -62,8 +62,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] account_sid A 34 character string that uniquely identifies this
-            #   resource.
             # @return [NewKeyPage] NewKeyPage
             def initialize(version, response, solution)
               super(version, response)
@@ -112,22 +110,32 @@ module Twilio
               }
             end
 
+            ##
+            # @return [String] The sid
             def sid
               @properties['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 secret
             def secret
               @properties['secret']
             end