twilio-ruby 5.8.0 → 5.8.1

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

@@ -30,9 +30,16 @@ module Twilio
                 # Lists YearlyInstance records from the API as a list.
                 # Unlike stream(), this operation is eager and will load `limit` records into
                 # memory before returning.
-                # @param [yearly.Category] category The category
-                # @param [Date] start_date The start_date
-                # @param [Date] end_date The end_date
+                # @param [yearly.Category] category Only include usage of this [usage
+                #   category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
+                # @param [Date] start_date Only include usage that has occurred on or after this
+                #   date.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
+                #   also specify offsets to today.  For example, `StartDate=-30days` will make
+                #   `StartDate` be 30 days before today.
+                # @param [Date] end_date Only include usage that has occurred on or before this
+                #   date.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
+                #   also specify offsets to today.  For example, `EndDate=+30days` will make
+                #   `EndDate` be 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
@@ -54,9 +61,16 @@ module Twilio
                 # Streams YearlyInstance records from the API as an Enumerable.
                 # This operation lazily loads records as efficiently as possible until the limit
                 # is reached.
-                # @param [yearly.Category] category The category
-                # @param [Date] start_date The start_date
-                # @param [Date] end_date The end_date
+                # @param [yearly.Category] category Only include usage of this [usage
+                #   category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
+                # @param [Date] start_date Only include usage that has occurred on or after this
+                #   date.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
+                #   also specify offsets to today.  For example, `StartDate=-30days` will make
+                #   `StartDate` be 30 days before today.
+                # @param [Date] end_date Only include usage that has occurred on or before this
+                #   date.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
+                #   also specify offsets to today.  For example, `EndDate=+30days` will make
+                #   `EndDate` be 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
@@ -94,9 +108,16 @@ module Twilio
                 ##
                 # Retrieve a single page of YearlyInstance records from the API.
                 # Request is executed immediately.
-                # @param [yearly.Category] category The category
-                # @param [Date] start_date The start_date
-                # @param [Date] end_date The end_date
+                # @param [yearly.Category] category Only include usage of this [usage
+                #   category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
+                # @param [Date] start_date Only include usage that has occurred on or after this
+                #   date.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
+                #   also specify offsets to today.  For example, `StartDate=-30days` will make
+                #   `StartDate` be 30 days before today.
+                # @param [Date] end_date Only include usage that has occurred on or before this
+                #   date.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
+                #   also specify offsets to today.  For example, `EndDate=+30days` will make
+                #   `EndDate` be 30 days from today.
                 # @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
@@ -198,7 +219,7 @@ module Twilio
                 end
 
                 ##
-                # @return [String] The account_sid
+                # @return [String] The Account that accrued the usage.
                 def account_sid
                   @properties['account_sid']
                 end
@@ -210,73 +231,73 @@ module Twilio
                 end
 
                 ##
-                # @return [yearly.Category] The category
+                # @return [yearly.Category] The category of usage.
                 def category
                   @properties['category']
                 end
 
                 ##
-                # @return [String] The count
+                # @return [String] The number of usage events.
                 def count
                   @properties['count']
                 end
 
                 ##
-                # @return [String] The count_unit
+                # @return [String] The units in which Count is measured.
                 def count_unit
                   @properties['count_unit']
                 end
 
                 ##
-                # @return [String] The description
+                # @return [String] A human-readable description of the usage category.
                 def description
                   @properties['description']
                 end
 
                 ##
-                # @return [Date] The end_date
+                # @return [Date] The last date for which usage is included in this UsageRecord, formatted as YYYY-MM-DD.
                 def end_date
                   @properties['end_date']
                 end
 
                 ##
-                # @return [String] The price
+                # @return [String] The total price of the usage, in the currency associated with the account.
                 def price
                   @properties['price']
                 end
 
                 ##
-                # @return [String] The price_unit
+                # @return [String] The currency in which Price is measured, in ISO 4127 format.
                 def price_unit
                   @properties['price_unit']
                 end
 
                 ##
-                # @return [Date] The start_date
+                # @return [Date] The first date for which usage is included in this UsageRecord, formatted as YYYY-MM-DD.
                 def start_date
                   @properties['start_date']
                 end
 
                 ##
-                # @return [String] The subresource_uris
+                # @return [String] Subresource Uris for this UsageRecord.
                 def subresource_uris
                   @properties['subresource_uris']
                 end
 
                 ##
-                # @return [String] The uri
+                # @return [String] The URI that returns only this UsageRecord, relative to https://api.
                 def uri
                   @properties['uri']
                 end
 
                 ##
-                # @return [String] The usage
+                # @return [String] The amount of billed usage.
                 def usage
                   @properties['usage']
                 end
 
                 ##
-                # @return [String] The usage_unit
+                # @return [String] The units in which Usage is measured.
                 def usage_unit
                   @properties['usage_unit']
                 end

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

@@ -30,9 +30,16 @@ module Twilio
                 # Lists YesterdayInstance records from the API as a list.
                 # Unlike stream(), this operation is eager and will load `limit` records into
                 # memory before returning.
-                # @param [yesterday.Category] category The category
-                # @param [Date] start_date The start_date
-                # @param [Date] end_date The end_date
+                # @param [yesterday.Category] category Only include usage of this [usage
+                #   category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
+                # @param [Date] start_date Only include usage that has occurred on or after this
+                #   date.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
+                #   also specify offsets to today.  For example, `StartDate=-30days` will make
+                #   `StartDate` be 30 days before today.
+                # @param [Date] end_date Only include usage that has occurred on or before this
+                #   date.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
+                #   also specify offsets to today.  For example, `EndDate=+30days` will make
+                #   `EndDate` be 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
@@ -54,9 +61,16 @@ module Twilio
                 # Streams YesterdayInstance records from the API as an Enumerable.
                 # This operation lazily loads records as efficiently as possible until the limit
                 # is reached.
-                # @param [yesterday.Category] category The category
-                # @param [Date] start_date The start_date
-                # @param [Date] end_date The end_date
+                # @param [yesterday.Category] category Only include usage of this [usage
+                #   category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
+                # @param [Date] start_date Only include usage that has occurred on or after this
+                #   date.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
+                #   also specify offsets to today.  For example, `StartDate=-30days` will make
+                #   `StartDate` be 30 days before today.
+                # @param [Date] end_date Only include usage that has occurred on or before this
+                #   date.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
+                #   also specify offsets to today.  For example, `EndDate=+30days` will make
+                #   `EndDate` be 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
@@ -94,9 +108,16 @@ module Twilio
                 ##
                 # Retrieve a single page of YesterdayInstance records from the API.
                 # Request is executed immediately.
-                # @param [yesterday.Category] category The category
-                # @param [Date] start_date The start_date
-                # @param [Date] end_date The end_date
+                # @param [yesterday.Category] category Only include usage of this [usage
+                #   category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
+                # @param [Date] start_date Only include usage that has occurred on or after this
+                #   date.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
+                #   also specify offsets to today.  For example, `StartDate=-30days` will make
+                #   `StartDate` be 30 days before today.
+                # @param [Date] end_date Only include usage that has occurred on or before this
+                #   date.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
+                #   also specify offsets to today.  For example, `EndDate=+30days` will make
+                #   `EndDate` be 30 days from today.
                 # @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
@@ -198,7 +219,7 @@ module Twilio
                 end
 
                 ##
-                # @return [String] The account_sid
+                # @return [String] The Account that accrued the usage.
                 def account_sid
                   @properties['account_sid']
                 end
@@ -210,73 +231,73 @@ module Twilio
                 end
 
                 ##
-                # @return [yesterday.Category] The category
+                # @return [yesterday.Category] The category of usage.
                 def category
                   @properties['category']
                 end
 
                 ##
-                # @return [String] The count
+                # @return [String] The number of usage events.
                 def count
                   @properties['count']
                 end
 
                 ##
-                # @return [String] The count_unit
+                # @return [String] The units in which Count is measured.
                 def count_unit
                   @properties['count_unit']
                 end
 
                 ##
-                # @return [String] The description
+                # @return [String] A human-readable description of the usage category.
                 def description
                   @properties['description']
                 end
 
                 ##
-                # @return [Date] The end_date
+                # @return [Date] The last date for which usage is included in this UsageRecord, formatted as YYYY-MM-DD.
                 def end_date
                   @properties['end_date']
                 end
 
                 ##
-                # @return [String] The price
+                # @return [String] The total price of the usage, in the currency associated with the account.
                 def price
                   @properties['price']
                 end
 
                 ##
-                # @return [String] The price_unit
+                # @return [String] The currency in which Price is measured, in ISO 4127 format.
                 def price_unit
                   @properties['price_unit']
                 end
 
                 ##
-                # @return [Date] The start_date
+                # @return [Date] The first date for which usage is included in this UsageRecord, formatted as YYYY-MM-DD.
                 def start_date
                   @properties['start_date']
                 end
 
                 ##
-                # @return [String] The subresource_uris
+                # @return [String] Subresource Uris for this UsageRecord.
                 def subresource_uris
                   @properties['subresource_uris']
                 end
 
                 ##
-                # @return [String] The uri
+                # @return [String] The URI that returns only this UsageRecord, relative to https://api.
                 def uri
                   @properties['uri']
                 end
 
                 ##
-                # @return [String] The usage
+                # @return [String] The amount of billed usage.
                 def usage
                   @properties['usage']
                 end
 
                 ##
-                # @return [String] The usage_unit
+                # @return [String] The units in which Usage is measured.
                 def usage_unit
                   @properties['usage_unit']
                 end

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

@@ -30,20 +30,26 @@ module Twilio
               # Request is executed immediately.
               # @param [String] callback_url Twilio will make a request to this url when the
               #   trigger fires.
-              # @param [String] trigger_value The value at which the trigger will fire.  Must be
-              #   a positive numeric value.
-              # @param [trigger.UsageCategory] usage_category The usage category the trigger
-              #   watches
-              # @param [String] callback_method The HTTP method Twilio will use when making a
-              #   request to the CallbackUrl.  GET or POST.
-              # @param [String] friendly_name A user-specified, human-readable name for the
-              #   trigger.
+              # @param [String] trigger_value The trigger will fire when usage reaches this
+              #   value.  For convenience, you can use an offset like `+30`, which tells Twilio to
+              #   create the UsageTrigger with its TriggerValue 30 units higher than the current
+              #   usage. (just be sure to urlencode the `+` as `%2B`).
+              # @param [trigger.UsageCategory] usage_category The trigger will watch this usage
+              #   category.  One of the supported [usage
+              #   categories](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
+              # @param [String] callback_method Twilio will use this HTTP method when making a
+              #   request to the CallbackUrl.  `GET` or `POST`.  The default is `POST`.
+              # @param [String] friendly_name A human readable description of the new trigger. 
+              #   Maximum 64 characters.
               # @param [trigger.Recurring] recurring How this trigger recurs. Empty for
               #   non-recurring triggers. One of `daily`, `monthly`, or `yearly` for recurring
               #   triggers.  A trigger will only fire once during each recurring period. 
               #   Recurring periods are in GMT.
-              # @param [trigger.TriggerField] trigger_by The field in the UsageRecord that fires
-              #   the trigger. One of `count`, `usage`, or `price`
+              # @param [trigger.TriggerField] trigger_by The field in the
+              #   [UsageRecord](https://www.twilio.com/docs/api/rest/usage-records) that will fire
+              #   the trigger.  One of `count`, `usage`, or `price` as described in the
+              #   [UsageRecords
+              #   documentation](https://www.twilio.com/docs/api/rest/usage-records#usage-count-price).  The default is `usage`.
               # @return [TriggerInstance] Newly created TriggerInstance
               def create(callback_url: nil, trigger_value: nil, usage_category: nil, callback_method: :unset, friendly_name: :unset, recurring: :unset, trigger_by: :unset)
                 data = Twilio::Values.of({
@@ -70,11 +76,15 @@ module Twilio
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
               # @param [trigger.Recurring] recurring Only show UsageTriggers that count over
-              #   this interval. One of daily, monthly, or yearly
+              #   this interval.  One of `daily`, `monthly`, or `yearly`.  To retrieve
+              #   non-recurring triggers, leave this empty or use `alltime`.
               # @param [trigger.TriggerField] trigger_by Only show UsageTriggers that trigger by
-              #   this field in the UsagRecord
+              #   this field in the UsageRecord.  Must be one of: `count`, `usage`, or `price` as
+              #   described in the [UsageRecords
+              #   documentation](https://www.twilio.com/docs/api/rest/usage-records#usage-count-price).
               # @param [trigger.UsageCategory] usage_category Only show UsageTriggers that watch
-              #   this usage category
+              #   this usage category.  Must be one of the supported [usage
+              #   categories](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
               # @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
@@ -97,11 +107,15 @@ module Twilio
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
               # @param [trigger.Recurring] recurring Only show UsageTriggers that count over
-              #   this interval. One of daily, monthly, or yearly
+              #   this interval.  One of `daily`, `monthly`, or `yearly`.  To retrieve
+              #   non-recurring triggers, leave this empty or use `alltime`.
               # @param [trigger.TriggerField] trigger_by Only show UsageTriggers that trigger by
-              #   this field in the UsagRecord
+              #   this field in the UsageRecord.  Must be one of: `count`, `usage`, or `price` as
+              #   described in the [UsageRecords
+              #   documentation](https://www.twilio.com/docs/api/rest/usage-records#usage-count-price).
               # @param [trigger.UsageCategory] usage_category Only show UsageTriggers that watch
-              #   this usage category
+              #   this usage category.  Must be one of the supported [usage
+              #   categories](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
               # @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
@@ -140,11 +154,15 @@ module Twilio
               # Retrieve a single page of TriggerInstance records from the API.
               # Request is executed immediately.
               # @param [trigger.Recurring] recurring Only show UsageTriggers that count over
-              #   this interval. One of daily, monthly, or yearly
+              #   this interval.  One of `daily`, `monthly`, or `yearly`.  To retrieve
+              #   non-recurring triggers, leave this empty or use `alltime`.
               # @param [trigger.TriggerField] trigger_by Only show UsageTriggers that trigger by
-              #   this field in the UsagRecord
+              #   this field in the UsageRecord.  Must be one of: `count`, `usage`, or `price` as
+              #   described in the [UsageRecords
+              #   documentation](https://www.twilio.com/docs/api/rest/usage-records#usage-count-price).
               # @param [trigger.UsageCategory] usage_category Only show UsageTriggers that watch
-              #   this usage category
+              #   this usage category.  Must be one of the supported [usage
+              #   categories](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
               # @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
@@ -248,7 +266,7 @@ module Twilio
               ##
               # Update the TriggerInstance
               # @param [String] callback_method The HTTP method Twilio will use when making a
-              #   request to the CallbackUrl.  GET or POST.
+              #   request to the CallbackUrl.  `GET` or `POST`.
               # @param [String] callback_url Twilio will make a request to this url when the
               #   trigger fires.
               # @param [String] friendly_name A user-specified, human-readable name for the
@@ -439,7 +457,7 @@ module Twilio
               ##
               # Update the TriggerInstance
               # @param [String] callback_method The HTTP method Twilio will use when making a
-              #   request to the CallbackUrl.  GET or POST.
+              #   request to the CallbackUrl.  `GET` or `POST`.
               # @param [String] callback_url Twilio will make a request to this url when the
               #   trigger fires.
               # @param [String] friendly_name A user-specified, human-readable name for the

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

@@ -260,7 +260,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The sid
+      # @param [String] sid A 34 character string that uniquely identifies this API Key.
+      #    You will use this as the basic-auth `user` when authenticating to the API.
       # @return [Twilio::REST::Api::V2010::AccountContext::KeyInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::KeyList]
       def keys(sid=:unset)

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

@@ -27,7 +27,9 @@ module Twilio
       end
 
       ##
-      # @param [String] phone_number The phone_number
+      # @param [String] phone_number The phone number, in
+      #   [E.164](https://www.twilio.com/docs/api/rest/response#phone-numbers) format
+      #   (i.e. "+1").
       # @return [Twilio::REST::Lookups::V1::PhoneNumberInstance] if phone_number was passed.
       # @return [Twilio::REST::Lookups::V1::PhoneNumberList]
       def phone_numbers(phone_number=:unset)

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

@@ -72,9 +72,22 @@ module Twilio
 
           ##
           # Fetch a PhoneNumberInstance
-          # @param [String] country_code The country_code
-          # @param [String] type The type
-          # @param [String] add_ons The add_ons
+          # @param [String] country_code Optional [ISO country
+          #   code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the phone number. This
+          #   is used to specify the country when the number is provided in a national format.
+          # @param [String] type Indicates the type of information you would like returned
+          #   with your request. Possible values are `carrier` or `caller-name`. If not
+          #   specified, the default is null.  Carrier information costs $0.005 per phone
+          #   number looked up.  Caller Name information costs $0.01 per phone number looked
+          #   up, and is currently ONLY available in the US.  You can retrieve both types of
+          #   information by including two `Type` arguments or making two separate requests.
+          # @param [String] add_ons Indicates the particular Add-on you would like to use to
+          #   get more information. Possible values are the *Add-on Unique Names* of Add-ons
+          #   installed on your account. You can specify multiple instances of this parameter
+          #   to invoke different Add-ons. See [Add-ons
+          #   documentation](https://www.twilio.com/docs/api/addons) for information on
+          #   installing Add-ons. Add-on pricing is available in your list of Installed
+          #   Add-ons in the Console.
           # @param [Hash] add_ons_data The add_ons_data
           # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
           def fetch(country_code: :unset, type: :unset, add_ons: :unset, add_ons_data: :unset)
@@ -140,25 +153,25 @@ module Twilio
           end
 
           ##
-          # @return [String] The caller_name
+          # @return [String] String indicating the name of the owner of the phone number.
           def caller_name
             @properties['caller_name']
           end
 
           ##
-          # @return [String] The country_code
+          # @return [String] The ISO country code for the phone number.
           def country_code
             @properties['country_code']
           end
 
           ##
-          # @return [String] The phone_number
+          # @return [String] The phone number, in E.
           def phone_number
             @properties['phone_number']
           end
 
           ##
-          # @return [String] The national_format
+          # @return [String] The phone number, in national format.
           def national_format
             @properties['national_format']
           end
@@ -170,7 +183,7 @@ module Twilio
           end
 
           ##
-          # @return [Hash] The add_ons
+          # @return [Hash] Results of any Add-ons you have specified using the AddOn parameter in the request, as a JSON dictionary.
           def add_ons
             @properties['add_ons']
           end
@@ -183,9 +196,22 @@ module Twilio
 
           ##
           # Fetch a PhoneNumberInstance
-          # @param [String] country_code The country_code
-          # @param [String] type The type
-          # @param [String] add_ons The add_ons
+          # @param [String] country_code Optional [ISO country
+          #   code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the phone number. This
+          #   is used to specify the country when the number is provided in a national format.
+          # @param [String] type Indicates the type of information you would like returned
+          #   with your request. Possible values are `carrier` or `caller-name`. If not
+          #   specified, the default is null.  Carrier information costs $0.005 per phone
+          #   number looked up.  Caller Name information costs $0.01 per phone number looked
+          #   up, and is currently ONLY available in the US.  You can retrieve both types of
+          #   information by including two `Type` arguments or making two separate requests.
+          # @param [String] add_ons Indicates the particular Add-on you would like to use to
+          #   get more information. Possible values are the *Add-on Unique Names* of Add-ons
+          #   installed on your account. You can specify multiple instances of this parameter
+          #   to invoke different Add-ons. See [Add-ons
+          #   documentation](https://www.twilio.com/docs/api/addons) for information on
+          #   installing Add-ons. Add-on pricing is available in your list of Installed
+          #   Add-ons in the Console.
           # @param [Hash] add_ons_data The add_ons_data
           # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
           def fetch(country_code: :unset, type: :unset, add_ons: :unset, add_ons_data: :unset)