twilio-ruby 5.0.0.rc26 → 5.0.0

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

@@ -144,31 +144,6 @@ module Twilio
               # When passed a block, yields MobileInstance records from the API.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [String] area_code The area_code
-              # @param [String] contains The contains
-              # @param [Boolean] sms_enabled The sms_enabled
-              # @param [Boolean] mms_enabled The mms_enabled
-              # @param [Boolean] voice_enabled The voice_enabled
-              # @param [Boolean] exclude_all_address_required The exclude_all_address_required
-              # @param [Boolean] exclude_local_address_required The
-              #   exclude_local_address_required
-              # @param [Boolean] exclude_foreign_address_required The
-              #   exclude_foreign_address_required
-              # @param [Boolean] beta The beta
-              # @param [String] near_number The near_number
-              # @param [String] near_lat_long The near_lat_long
-              # @param [String] distance The distance
-              # @param [String] in_postal_code The in_postal_code
-              # @param [String] in_region The in_region
-              # @param [String] in_rate_center The in_rate_center
-              # @param [String] in_lata The in_lata
-              # @param [String] in_locality The in_locality
-              # @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
 
@@ -264,9 +239,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 34 character string that uniquely identifies
-              #   your account.
-              # @param [String] country_code The ISO Country code to lookup phone numbers for.
               # @return [MobilePage] MobilePage
               def initialize(version, response, solution)
                 super(version, response)
@@ -325,54 +297,80 @@ module Twilio
                 }
               end
 
+              ##
+              # @return [String] The friendly_name
               def friendly_name
                 @properties['friendly_name']
               end
 
+              ##
+              # @return [String] The phone_number
               def phone_number
                 @properties['phone_number']
               end
 
+              ##
+              # @return [String] The lata
               def lata
                 @properties['lata']
               end
 
+              ##
+              # @return [String] The locality
               def locality
                 @properties['locality']
               end
 
+              ##
+              # @return [String] The rate_center
               def rate_center
                 @properties['rate_center']
               end
 
+              ##
+              # @return [String] The latitude
               def latitude
                 @properties['latitude']
               end
 
+              ##
+              # @return [String] The longitude
               def longitude
                 @properties['longitude']
               end
 
+              ##
+              # @return [String] The region
               def region
                 @properties['region']
               end
 
+              ##
+              # @return [String] The postal_code
               def postal_code
                 @properties['postal_code']
               end
 
+              ##
+              # @return [String] The iso_country
               def iso_country
                 @properties['iso_country']
               end
 
+              ##
+              # @return [String] The address_requirements
               def address_requirements
                 @properties['address_requirements']
               end
 
+              ##
+              # @return [Boolean] The beta
               def beta
                 @properties['beta']
               end
 
+              ##
+              # @return [String] The capabilities
               def capabilities
                 @properties['capabilities']
               end

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

@@ -144,31 +144,6 @@ module Twilio
               # When passed a block, yields TollFreeInstance records from the API.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [String] area_code The area_code
-              # @param [String] contains The contains
-              # @param [Boolean] sms_enabled The sms_enabled
-              # @param [Boolean] mms_enabled The mms_enabled
-              # @param [Boolean] voice_enabled The voice_enabled
-              # @param [Boolean] exclude_all_address_required The exclude_all_address_required
-              # @param [Boolean] exclude_local_address_required The
-              #   exclude_local_address_required
-              # @param [Boolean] exclude_foreign_address_required The
-              #   exclude_foreign_address_required
-              # @param [Boolean] beta The beta
-              # @param [String] near_number The near_number
-              # @param [String] near_lat_long The near_lat_long
-              # @param [String] distance The distance
-              # @param [String] in_postal_code The in_postal_code
-              # @param [String] in_region The in_region
-              # @param [String] in_rate_center The in_rate_center
-              # @param [String] in_lata The in_lata
-              # @param [String] in_locality The in_locality
-              # @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
 
@@ -264,9 +239,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 34 character string that uniquely identifies
-              #   your account.
-              # @param [String] country_code The ISO Country code to lookup phone numbers for.
               # @return [TollFreePage] TollFreePage
               def initialize(version, response, solution)
                 super(version, response)
@@ -325,54 +297,80 @@ module Twilio
                 }
               end
 
+              ##
+              # @return [String] The friendly_name
               def friendly_name
                 @properties['friendly_name']
               end
 
+              ##
+              # @return [String] The phone_number
               def phone_number
                 @properties['phone_number']
               end
 
+              ##
+              # @return [String] The lata
               def lata
                 @properties['lata']
               end
 
+              ##
+              # @return [String] The locality
               def locality
                 @properties['locality']
               end
 
+              ##
+              # @return [String] The rate_center
               def rate_center
                 @properties['rate_center']
               end
 
+              ##
+              # @return [String] The latitude
               def latitude
                 @properties['latitude']
               end
 
+              ##
+              # @return [String] The longitude
               def longitude
                 @properties['longitude']
               end
 
+              ##
+              # @return [String] The region
               def region
                 @properties['region']
               end
 
+              ##
+              # @return [String] The postal_code
               def postal_code
                 @properties['postal_code']
               end
 
+              ##
+              # @return [String] The iso_country
               def iso_country
                 @properties['iso_country']
               end
 
+              ##
+              # @return [String] The address_requirements
               def address_requirements
                 @properties['address_requirements']
               end
 
+              ##
+              # @return [Boolean] The beta
               def beta
                 @properties['beta']
               end
 
+              ##
+              # @return [String] The capabilities
               def capabilities
                 @properties['capabilities']
               end

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

@@ -134,10 +134,10 @@ module Twilio
             # @param [feedback_summary.Status] status Only show calls currently in this status
             # @param [Time] start_time_before StartTime to filter on
             # @param [Time] start_time StartTime to filter on
-            # @param [Time] start_time_after: StartTime to filter on
+            # @param [Time] start_time_after StartTime to filter on
             # @param [Time] end_time_before EndTime to filter on
             # @param [Time] end_time EndTime to filter on
-            # @param [Time] end_time_after: EndTime to filter on
+            # @param [Time] end_time_after EndTime to filter on
             # @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
@@ -173,10 +173,10 @@ module Twilio
             # @param [feedback_summary.Status] status Only show calls currently in this status
             # @param [Time] start_time_before StartTime to filter on
             # @param [Time] start_time StartTime to filter on
-            # @param [Time] start_time_after: StartTime to filter on
+            # @param [Time] start_time_after StartTime to filter on
             # @param [Time] end_time_before EndTime to filter on
             # @param [Time] end_time EndTime to filter on
-            # @param [Time] end_time_after: EndTime to filter on
+            # @param [Time] end_time_after EndTime to filter on
             # @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
@@ -208,23 +208,6 @@ module Twilio
             # When passed a block, yields CallInstance records from the API.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] to Only show calls to this phone number or Client identifier
-            # @param [String] from Only show calls from this phone number or Client identifier
-            # @param [String] parent_call_sid Only show calls spawned by the call with this
-            #   Sid
-            # @param [feedback_summary.Status] status Only show calls currently in this status
-            # @param [Time] start_time_before StartTime to filter on
-            # @param [Time] start_time StartTime to filter on
-            # @param [Time] start_time_after: StartTime to filter on
-            # @param [Time] end_time_before EndTime to filter on
-            # @param [Time] end_time EndTime to filter on
-            # @param [Time] end_time_after: EndTime to filter on
-            # @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
 
@@ -247,10 +230,10 @@ module Twilio
             # @param [feedback_summary.Status] status Only show calls currently in this status
             # @param [Time] start_time_before StartTime to filter on
             # @param [Time] start_time StartTime to filter on
-            # @param [Time] start_time_after: StartTime to filter on
+            # @param [Time] start_time_after StartTime to filter on
             # @param [Time] end_time_before EndTime to filter on
             # @param [Time] end_time EndTime to filter on
-            # @param [Time] end_time_after: EndTime to filter on
+            # @param [Time] end_time_after EndTime to filter on
             # @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
@@ -295,8 +278,8 @@ module Twilio
             ##
             # Access the feedback_summaries
             # @param [String] sid The sid
-            # @return [FeedbackSummaryList] if a(n) FeedbackSummaryList object was created.
-            # @return [FeedbackSummaryContext] if a(n) FeedbackSummaryContext object was created.
+            # @return [FeedbackSummaryList]
+            # @return [FeedbackSummaryContext] if sid was passed.
             def feedback_summaries(sid=:unset)
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -327,8 +310,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
-            #   creating this Call
             # @return [CallPage] CallPage
             def initialize(version, response, solution)
               super(version, response)
@@ -452,8 +433,8 @@ module Twilio
 
             ##
             # Access the recordings
-            # @return [RecordingList] if a(n) RecordingList object was created.
-            # @return [RecordingContext] if a(n) RecordingContext object was created.
+            # @return [RecordingList]
+            # @return [RecordingContext] if sid was passed.
             def recordings(sid=:unset)
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -479,8 +460,8 @@ module Twilio
 
             ##
             # Access the notifications
-            # @return [NotificationList] if a(n) NotificationList object was created.
-            # @return [NotificationContext] if a(n) NotificationContext object was created.
+            # @return [NotificationList]
+            # @return [NotificationContext] if sid was passed.
             def notifications(sid=:unset)
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -506,8 +487,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
               FeedbackContext.new(
                   @version,
@@ -576,7 +557,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 [CallContext] CallContext for this CallInstance
             def context
               unless @instance_context
@@ -589,102 +569,152 @@ module Twilio
               @instance_context
             end
 
+            ##
+            # @return [String] The unique id of the Account responsible for creating this Call
             def account_sid
               @properties['account_sid']
             end
 
+            ##
+            # @return [String] The annotation provided for the Call
             def annotation
               @properties['annotation']
             end
 
+            ##
+            # @return [String] If this call was initiated with answering machine detection, either `human` or `machine`. Empty otherwise.
             def answered_by
               @properties['answered_by']
             end
 
+            ##
+            # @return [String] The API Version the Call was created through
             def api_version
               @properties['api_version']
             end
 
+            ##
+            # @return [String] If this call was an incoming call to a phone number with Caller ID Lookup enabled, the caller's name. Empty otherwise.
             def caller_name
               @properties['caller_name']
             end
 
+            ##
+            # @return [Time] The date that this resource was created
             def date_created
               @properties['date_created']
             end
 
+            ##
+            # @return [Time] The date that this resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
+            ##
+            # @return [String] A string describing the direction of the call. `inbound` for inbound calls, `outbound-api` for calls initiated via the REST API or `outbound-dial` for calls initiated by a `Dial` verb.
             def direction
               @properties['direction']
             end
 
+            ##
+            # @return [String] The duration
             def duration
               @properties['duration']
             end
 
+            ##
+            # @return [Time] The end time of the Call. Null if the call did not complete successfully.
             def end_time
               @properties['end_time']
             end
 
+            ##
+            # @return [String] If this Call was an incoming call forwarded from another number, the forwarding phone number (depends on carrier supporting forwarding). Empty otherwise.
             def forwarded_from
               @properties['forwarded_from']
             end
 
+            ##
+            # @return [String] The phone number, SIP address or Client identifier that made this Call. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`.
             def from
               @properties['from']
             end
 
+            ##
+            # @return [String] The phone number, SIP address or Client identifier that made this Call. Formatted for display.
             def from_formatted
               @properties['from_formatted']
             end
 
+            ##
+            # @return [String] A 34 character Group Sid associated with this Call. Empty if no Group is associated with the Call.
             def group_sid
               @properties['group_sid']
             end
 
+            ##
+            # @return [String] A 34 character string that uniquely identifies the Call that created this leg.
             def parent_call_sid
               @properties['parent_call_sid']
             end
 
+            ##
+            # @return [String] If the call was inbound, this is the Sid of the IncomingPhoneNumber that received the call. If the call was outbound, it is the Sid of the OutgoingCallerId from which the call was placed.
             def phone_number_sid
               @properties['phone_number_sid']
             end
 
+            ##
+            # @return [String] The charge for this call, in the currency associated with the account. Populated after the call is completed. May not be immediately available.
             def price
               @properties['price']
             end
 
+            ##
+            # @return [String] The currency in which `Price` is measured.
             def price_unit
               @properties['price_unit']
             end
 
+            ##
+            # @return [String] A 34 character string that uniquely identifies this resource.
             def sid
               @properties['sid']
             end
 
+            ##
+            # @return [Time] The start time of the Call. Null if the call has not yet been dialed.
             def start_time
               @properties['start_time']
             end
 
+            ##
+            # @return [feedback_summary.Status] The status
             def status
               @properties['status']
             end
 
+            ##
+            # @return [String] Call Instance Subresources
             def subresource_uris
               @properties['subresource_uris']
             end
 
+            ##
+            # @return [String] The phone number, SIP address or Client identifier that received this Call. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`.
             def to
               @properties['to']
             end
 
+            ##
+            # @return [String] The phone number, SIP address or Client identifier that received this Call. Formatted for display.
             def to_formatted
               @properties['to_formatted']
             end
 
+            ##
+            # @return [String] The URI for this resource, relative to `https://api.twilio.com`
             def uri
               @properties['uri']
             end