twilio-ruby 5.0.0.rc26 → 5.0.0

data/lib/twilio-ruby/rest/api/v2010/account/new_signing_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 [NewSigningKeyPage] NewSigningKeyPage
             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

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

@@ -33,7 +33,7 @@ module Twilio
             # @param [String] log Only show notifications for this log level
             # @param [Time] message_date_before Filter by date
             # @param [Time] message_date Filter by date
-            # @param [Time] message_date_after: Filter by date
+            # @param [Time] message_date_after Filter by 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
@@ -59,7 +59,7 @@ module Twilio
             # @param [String] log Only show notifications for this log level
             # @param [Time] message_date_before Filter by date
             # @param [Time] message_date Filter by date
-            # @param [Time] message_date_after: Filter by date
+            # @param [Time] message_date_after Filter by 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
@@ -85,16 +85,6 @@ module Twilio
             # When passed a block, yields NotificationInstance records from the API.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] log Only show notifications for this log level
-            # @param [Time] message_date_before Filter by date
-            # @param [Time] message_date Filter by date
-            # @param [Time] message_date_after: Filter by 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
 
@@ -113,7 +103,7 @@ module Twilio
             # @param [String] log Only show notifications for this log level
             # @param [Time] message_date_before Filter by date
             # @param [Time] message_date Filter by date
-            # @param [Time] message_date_after: Filter by date
+            # @param [Time] message_date_after Filter by date
             # @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
@@ -162,8 +152,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
-            #   notification.
             # @return [NotificationPage] NotificationPage
             def initialize(version, response, solution)
               super(version, response)
@@ -288,7 +276,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 [NotificationContext] NotificationContext for this NotificationInstance
             def context
               unless @instance_context
@@ -301,70 +288,104 @@ 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 in use
             def api_version
               @properties['api_version']
             end
 
+            ##
+            # @return [String] The string that uniquely identifies the call
             def call_sid
               @properties['call_sid']
             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] A unique error code corresponding to the notification
             def error_code
               @properties['error_code']
             end
 
+            ##
+            # @return [String] An integer log level
             def log
               @properties['log']
             end
 
+            ##
+            # @return [Time] The date the notification was generated
             def message_date
               @properties['message_date']
             end
 
+            ##
+            # @return [String] The text of the notification.
             def message_text
               @properties['message_text']
             end
 
+            ##
+            # @return [String] A URL for more information about the error code
             def more_info
               @properties['more_info']
             end
 
+            ##
+            # @return [String] HTTP method used with the request url
             def request_method
               @properties['request_method']
             end
 
+            ##
+            # @return [String] URL of the resource that generated the notification
             def request_url
               @properties['request_url']
             end
 
+            ##
+            # @return [String] Twilio-generated HTTP variables sent to the server
             def request_variables
               @properties['request_variables']
             end
 
+            ##
+            # @return [String] The HTTP body returned by your server.
             def response_body
               @properties['response_body']
             end
 
+            ##
+            # @return [String] The HTTP headers returned by your server.
             def response_headers
               @properties['response_headers']
             end
 
+            ##
+            # @return [String] A string that uniquely identifies this notification
             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/outgoing_caller_id.rb

@@ -81,16 +81,6 @@ module Twilio
             # When passed a block, yields OutgoingCallerIdInstance records from the API.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] phone_number Only show the caller id resource that exactly
-            #   matches this phone number
-            # @param [String] friendly_name Only show the caller id resource that exactly
-            #   matches this name
-            # @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
 
@@ -156,8 +146,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
-            #   Caller Id.
             # @return [OutgoingCallerIdPage] OutgoingCallerIdPage
             def initialize(version, response, solution)
               super(version, response)
@@ -297,7 +285,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 [OutgoingCallerIdContext] OutgoingCallerIdContext for this OutgoingCallerIdInstance
             def context
               unless @instance_context
@@ -310,30 +297,44 @@ module Twilio
               @instance_context
             end
 
+            ##
+            # @return [String] A string that uniquely identifies this outgoing-caller-ids
             def sid
               @properties['sid']
             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] A human readable description for this resource
             def friendly_name
               @properties['friendly_name']
             end
 
+            ##
+            # @return [String] The unique sid that identifies this account
             def account_sid
               @properties['account_sid']
             end
 
+            ##
+            # @return [String] The incoming phone number
             def phone_number
               @properties['phone_number']
             end
 
+            ##
+            # @return [String] The URI for this resource
             def uri
               @properties['uri']
             end

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

@@ -68,12 +68,6 @@ module Twilio
             # When passed a block, yields QueueInstance 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
 
@@ -159,7 +153,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
             # @return [QueuePage] QueuePage
             def initialize(version, response, solution)
               super(version, response)
@@ -263,8 +256,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 call_sid was passed.
             def members(call_sid=:unset)
               raise ArgumentError, 'call_sid cannot be nil' if call_sid.nil?
 
@@ -331,7 +324,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 [QueueContext] QueueContext for this QueueInstance
             def context
               unless @instance_context
@@ -344,38 +336,56 @@ module Twilio
               @instance_context
             end
 
+            ##
+            # @return [String] The account_sid
             def account_sid
               @properties['account_sid']
             end
 
+            ##
+            # @return [String] Average wait time of members in the queue
             def average_wait_time
               @properties['average_wait_time']
             end
 
+            ##
+            # @return [String] The count of calls currently in the queue.
             def current_size
               @properties['current_size']
             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] A user-provided string that identifies this queue.
             def friendly_name
               @properties['friendly_name']
             end
 
+            ##
+            # @return [String] The max number of calls allowed in the queue
             def max_size
               @properties['max_size']
             end
 
+            ##
+            # @return [String] A string that uniquely identifies this queue
             def sid
               @properties['sid']
             end
 
+            ##
+            # @return [String] The uri
             def uri
               @properties['uri']
             end

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

@@ -72,12 +72,6 @@ module Twilio
               # When passed a block, yields MemberInstance 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
 
@@ -137,9 +131,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] queue_sid A 34 character string that uniquely identifies this
-              #   queue.
               # @return [MemberPage] MemberPage
               def initialize(version, response, solution)
                 super(version, response)
@@ -277,7 +268,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 [MemberContext] MemberContext for this MemberInstance
               def context
                 unless @instance_context
@@ -291,22 +281,32 @@ module Twilio
                 @instance_context
               end
 
+              ##
+              # @return [String] Unique string that identifies this resource
               def call_sid
                 @properties['call_sid']
               end
 
+              ##
+              # @return [Time] The date the member was enqueued
               def date_enqueued
                 @properties['date_enqueued']
               end
 
+              ##
+              # @return [String] This member's current position in the queue.
               def position
                 @properties['position']
               end
 
+              ##
+              # @return [String] The uri
               def uri
                 @properties['uri']
               end
 
+              ##
+              # @return [String] The number of seconds the member has been in the queue.
               def wait_time
                 @properties['wait_time']
               end

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

@@ -32,7 +32,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 [String] call_sid Only show recordings made during the call given by the
             #   indicated sid
             # @param [Integer] limit Upper limit for the number of records to return. stream()
@@ -59,7 +59,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 [String] call_sid Only show recordings made during the call given by the
             #   indicated sid
             # @param [Integer] limit Upper limit for the number of records to return.                  stream()
@@ -87,17 +87,6 @@ module Twilio
             # When passed a block, yields RecordingInstance 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 [String] call_sid Only show recordings made during the call given by the
-            #   indicated sid
-            # @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
 
@@ -115,7 +104,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] call_sid Only show recordings made during the call given by the
             #   indicated sid
             # @param [String] page_token PageToken provided by the API
@@ -166,8 +155,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
-            #   recording.
             # @return [RecordingPage] RecordingPage
             def initialize(version, response, solution)
               super(version, response)
@@ -246,8 +233,8 @@ module Twilio
 
             ##
             # Access the transcriptions
-            # @return [TranscriptionList] if a(n) TranscriptionList object was created.
-            # @return [TranscriptionContext] if a(n) TranscriptionContext object was created.
+            # @return [TranscriptionList]
+            # @return [TranscriptionContext] if sid was passed.
             def transcriptions(sid=:unset)
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -273,8 +260,8 @@ module Twilio
 
             ##
             # Access the add_on_results
-            # @return [AddOnResultList] if a(n) AddOnResultList object was created.
-            # @return [AddOnResultContext] if a(n) AddOnResultContext object was created.
+            # @return [AddOnResultList]
+            # @return [AddOnResultContext] if sid was passed.
             def add_on_results(sid=:unset)
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -348,7 +335,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 [RecordingContext] RecordingContext for this RecordingInstance
             def context
               unless @instance_context
@@ -361,62 +347,92 @@ 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 API in use during the recording.
             def api_version
               @properties['api_version']
             end
 
+            ##
+            # @return [String] The call during which the recording was made.
             def call_sid
               @properties['call_sid']
             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 length of the recording, in seconds.
             def duration
               @properties['duration']
             end
 
+            ##
+            # @return [String] A string that uniquely identifies this recording
             def sid
               @properties['sid']
             end
 
+            ##
+            # @return [String] The price
             def price
               @properties['price']
             end
 
+            ##
+            # @return [String] The price_unit
             def price_unit
               @properties['price_unit']
             end
 
+            ##
+            # @return [transcription.Status] The status
             def status
               @properties['status']
             end
 
+            ##
+            # @return [String] The channels
             def channels
               @properties['channels']
             end
 
+            ##
+            # @return [recording.Source] The source
             def source
               @properties['source']
             end
 
+            ##
+            # @return [String] The URI for this resource
             def uri
               @properties['uri']
             end
 
+            ##
+            # @return [String] The type of encryption used for this resource.
             def encryption_type
               @properties['encryption_type']
             end
 
+            ##
+            # @return [Hash] The encryption_details
             def encryption_details
               @properties['encryption_details']
             end