twilio-ruby 5.0.0.rc26 → 5.0.0

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

@@ -70,12 +70,6 @@ module Twilio
               # When passed a block, yields IpAccessControlListInstance 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,8 +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 A 34 character string that uniquely identifies this
-              #   resource.
               # @return [IpAccessControlListPage] IpAccessControlListPage
               def initialize(version, response, solution)
                 super(version, response)
@@ -263,8 +255,8 @@ module Twilio
 
               ##
               # Access the ip_addresses
-              # @return [IpAddressList] if a(n) IpAddressList object was created.
-              # @return [IpAddressContext] if a(n) IpAddressContext object was created.
+              # @return [IpAddressList]
+              # @return [IpAddressContext] if sid was passed.
               def ip_addresses(sid=:unset)
                 raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -331,7 +323,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 [IpAccessControlListContext] IpAccessControlListContext for this IpAccessControlListInstance
               def context
                 unless @instance_context
@@ -344,30 +335,44 @@ module Twilio
                 @instance_context
               end
 
+              ##
+              # @return [String] A string that uniquely identifies this resource
               def sid
                 @properties['sid']
               end
 
+              ##
+              # @return [String] The unique sid that identifies this account
               def account_sid
                 @properties['account_sid']
               end
 
+              ##
+              # @return [String] A human readable description of this resource
               def friendly_name
                 @properties['friendly_name']
               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 subresource_uris
               def subresource_uris
                 @properties['subresource_uris']
               end
 
+              ##
+              # @return [String] The URI for this resource
               def uri
                 @properties['uri']
               end

data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb

@@ -72,12 +72,6 @@ module Twilio
                 # When passed a block, yields IpAddressInstance 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
 
@@ -163,8 +157,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] ip_access_control_list_sid The ip_access_control_list_sid
                 # @return [IpAddressPage] IpAddressPage
                 def initialize(version, response, solution)
                   super(version, response)
@@ -311,7 +303,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 [IpAddressContext] IpAddressContext for this IpAddressInstance
                 def context
                   unless @instance_context
@@ -325,34 +316,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 [String] The ip_address
                 def ip_address
                   @properties['ip_address']
                 end
 
+                ##
+                # @return [String] The ip_access_control_list_sid
                 def ip_access_control_list_sid
                   @properties['ip_access_control_list_sid']
                 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/token.rb

@@ -63,8 +63,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 created this
-            #   Token.
             # @return [TokenPage] TokenPage
             def initialize(version, response, solution)
               super(version, response)
@@ -115,30 +113,44 @@ module Twilio
               }
             end
 
+            ##
+            # @return [String] The unique sid that identifies this account
             def account_sid
               @properties['account_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] An array representing the ephemeral credentials
             def ice_servers
               @properties['ice_servers']
             end
 
+            ##
+            # @return [String] The temporary password used for authenticating
             def password
               @properties['password']
             end
 
+            ##
+            # @return [String] The duration in seconds the credentials are valid
             def ttl
               @properties['ttl']
             end
 
+            ##
+            # @return [String] The temporary username that uniquely identifies a Token.
             def username
               @properties['username']
             end

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

@@ -69,12 +69,6 @@ module Twilio
             # When passed a block, yields TranscriptionInstance 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 The unique id of the Account responsible for this
-            #   transcription.
             # @return [TranscriptionPage] TranscriptionPage
             def initialize(version, response, solution)
               super(version, response)
@@ -256,7 +248,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 [TranscriptionContext] TranscriptionContext for this TranscriptionInstance
             def context
               unless @instance_context
@@ -269,54 +260,80 @@ module Twilio
               @instance_context
             end
 
+            ##
+            # @return [String] The unique sid that identifies this account
             def account_sid
               @properties['account_sid']
             end
 
+            ##
+            # @return [String] The api_version
             def api_version
               @properties['api_version']
             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 duration of the transcribed audio, in seconds.
             def duration
               @properties['duration']
             end
 
+            ##
+            # @return [String] The charge for this transcription
             def price
               @properties['price']
             end
 
+            ##
+            # @return [String] The currency in which Price is measured
             def price_unit
               @properties['price_unit']
             end
 
+            ##
+            # @return [String] The string that uniquely identifies the recording
             def recording_sid
               @properties['recording_sid']
             end
 
+            ##
+            # @return [String] A string that uniquely identifies this transcription
             def sid
               @properties['sid']
             end
 
+            ##
+            # @return [transcription.Status] The status of the transcription
             def status
               @properties['status']
             end
 
+            ##
+            # @return [String] The text content of the transcription.
             def transcription_text
               @properties['transcription_text']
             end
 
+            ##
+            # @return [String] The type
             def type
               @properties['type']
             end
 
+            ##
+            # @return [String] The URI for this resource
             def uri
               @properties['uri']
             end

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

@@ -31,8 +31,8 @@ module Twilio
 
             ##
             # Access the records
-            # @return [RecordList] if a(n) RecordList object was created.
-            # @return [RecordContext] if a(n) RecordContext object was created.
+            # @return [RecordList]
+            # @return [RecordContext]
             def records
               @records ||= RecordList.new(
                   @version,
@@ -43,8 +43,8 @@ module Twilio
             ##
             # Access the triggers
             # @param [String] sid The usage-trigger Sid that uniquely identifies this resource
-            # @return [TriggerList] if a(n) TriggerList object was created.
-            # @return [TriggerContext] if a(n) TriggerContext object was created.
+            # @return [TriggerList]
+            # @return [TriggerContext] if sid was passed.
             def triggers(sid=:unset)
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
@@ -75,8 +75,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 [UsagePage] UsagePage
             def initialize(version, response, solution)
               super(version, response)

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

@@ -104,21 +104,6 @@ module Twilio
               # When passed a block, yields RecordInstance records from the API.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [yesterday.Category] category Only include usage of a given category
-              # @param [Date] start_date Only include usage that has occurred on or after this
-              #   date. Format is YYYY-MM-DD in GTM. As a convenience, you can also specify
-              #   offsets to today, for example, StartDate=-30days, which will make StartDate 30
-              #   days before today
-              # @param [Date] end_date Only include usage that has occurred on or after this
-              #   date. Format is YYYY-MM-DD in GTM. As a convenience, you can also specify
-              #   offsets to today, for example, EndDate=+30days, which will make EndDate 30 days
-              #   from today
-              # @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
 
@@ -179,8 +164,8 @@ module Twilio
 
               ##
               # Access the all_time
-              # @return [AllTimeList] if a(n) AllTimeList object was created.
-              # @return [AllTimeContext] if a(n) AllTimeContext object was created.
+              # @return [AllTimeList]
+              # @return [AllTimeContext]
               def all_time
                 @all_time ||= AllTimeList.new(
                     @version,
@@ -190,8 +175,8 @@ module Twilio
 
               ##
               # Access the daily
-              # @return [DailyList] if a(n) DailyList object was created.
-              # @return [DailyContext] if a(n) DailyContext object was created.
+              # @return [DailyList]
+              # @return [DailyContext]
               def daily
                 @daily ||= DailyList.new(
                     @version,
@@ -201,8 +186,8 @@ module Twilio
 
               ##
               # Access the last_month
-              # @return [LastMonthList] if a(n) LastMonthList object was created.
-              # @return [LastMonthContext] if a(n) LastMonthContext object was created.
+              # @return [LastMonthList]
+              # @return [LastMonthContext]
               def last_month
                 @last_month ||= LastMonthList.new(
                     @version,
@@ -212,8 +197,8 @@ module Twilio
 
               ##
               # Access the monthly
-              # @return [MonthlyList] if a(n) MonthlyList object was created.
-              # @return [MonthlyContext] if a(n) MonthlyContext object was created.
+              # @return [MonthlyList]
+              # @return [MonthlyContext]
               def monthly
                 @monthly ||= MonthlyList.new(
                     @version,
@@ -223,8 +208,8 @@ module Twilio
 
               ##
               # Access the this_month
-              # @return [ThisMonthList] if a(n) ThisMonthList object was created.
-              # @return [ThisMonthContext] if a(n) ThisMonthContext object was created.
+              # @return [ThisMonthList]
+              # @return [ThisMonthContext]
               def this_month
                 @this_month ||= ThisMonthList.new(
                     @version,
@@ -234,8 +219,8 @@ module Twilio
 
               ##
               # Access the today
-              # @return [TodayList] if a(n) TodayList object was created.
-              # @return [TodayContext] if a(n) TodayContext object was created.
+              # @return [TodayList]
+              # @return [TodayContext]
               def today
                 @today ||= TodayList.new(
                     @version,
@@ -245,8 +230,8 @@ module Twilio
 
               ##
               # Access the yearly
-              # @return [YearlyList] if a(n) YearlyList object was created.
-              # @return [YearlyContext] if a(n) YearlyContext object was created.
+              # @return [YearlyList]
+              # @return [YearlyContext]
               def yearly
                 @yearly ||= YearlyList.new(
                     @version,
@@ -256,8 +241,8 @@ module Twilio
 
               ##
               # Access the yesterday
-              # @return [YesterdayList] if a(n) YesterdayList object was created.
-              # @return [YesterdayContext] if a(n) YesterdayContext object was created.
+              # @return [YesterdayList]
+              # @return [YesterdayContext]
               def yesterday
                 @yesterday ||= YesterdayList.new(
                     @version,
@@ -278,8 +263,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 [RecordPage] RecordPage
               def initialize(version, response, solution)
                 super(version, response)
@@ -337,58 +320,86 @@ module Twilio
                 }
               end
 
+              ##
+              # @return [String] The Account that accrued the usage
               def account_sid
                 @properties['account_sid']
               end
 
+              ##
+              # @return [String] The api_version
               def api_version
                 @properties['api_version']
               end
 
+              ##
+              # @return [yesterday.Category] The category of usage
               def category
                 @properties['category']
               end
 
+              ##
+              # @return [String] The number of usage events (e.g. the number of calls).
               def count
                 @properties['count']
               end
 
+              ##
+              # @return [String] The unit in which `Count` is measured
               def count_unit
                 @properties['count_unit']
               end
 
+              ##
+              # @return [String] A human-readable description of the usage category.
               def description
                 @properties['description']
               end
 
+              ##
+              # @return [Date] The last date usage is included in this record
               def end_date
                 @properties['end_date']
               end
 
+              ##
+              # @return [String] The total price of the usage
               def price
                 @properties['price']
               end
 
+              ##
+              # @return [String] The currency in which `Price` is measured
               def price_unit
                 @properties['price_unit']
               end
 
+              ##
+              # @return [Date] The first date usage is included in this record
               def start_date
                 @properties['start_date']
               end
 
+              ##
+              # @return [String] Subresources Uris for this UsageRecord
               def subresource_uris
                 @properties['subresource_uris']
               end
 
+              ##
+              # @return [String] The URI for this resource
               def uri
                 @properties['uri']
               end
 
+              ##
+              # @return [String] The amount of usage
               def usage
                 @properties['usage']
               end
 
+              ##
+              # @return [String] The units in which `Usage` is measured
               def usage_unit
                 @properties['usage_unit']
               end