twilio-ruby 5.8.0 → 5.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f31420e85a848a70feecfe16755e650d9239765b
-  data.tar.gz: a8f8a197dd19c793eadc79f81457b1be96570756
+  metadata.gz: 96dfe1755e485568a5ae67471ebb9ca1cd4f7978
+  data.tar.gz: ad246f39e5739b9209436a19066a10d27ccd9ea7
 SHA512:
-  metadata.gz: 1e2fa856f8d8c4596efa8c274d8606d1666d61971647ffdc29e8dc7d307fb038ad723b644f3ed6ec3b5f1a49fe3f681db873ded28b70cb4d9cd6ba1c0bd22bf3
-  data.tar.gz: 24a1cb1af4daad69c49406c47a0cb98c645f7201809bc5d3da8046cec350f91f7c04f35d9aee156ab19f3041daf9cca35fa9197657654c6b3adb73004b59c6e1
+  metadata.gz: 64bb9b61131575a991142432d073ab5ac2b36f10239dfbdec32f8a79e2268cc7afa44ab5ce1346a13906ab2f8ded4c852dd1ffe3d620d558de28155f3a5634df
+  data.tar.gz: fd28ffaec1cca7d04b07c3e6b426200457cf976e7baf1ebaaa2b88449b2e6366c58d671adb370a18e88127cba105e37cc8aca930a2dfbec7abdfe298cfe03049

data/.travis.yml

@@ -19,7 +19,3 @@ before_install:
   # Bundler on Travis may be too out of date
   # Update bundler to a recent version.
   - gem install bundler
-
-after_success:
-  # Make sure it passes linter
-  - make lint

data/CHANGES.md

@@ -1,6 +1,15 @@
 twilio-ruby changelog
 =====================
 
+[2018-04-20] Version 5.8.1
+---------------------------
+**Library**
+- PR #397: Uses Twilio::REST::RestError when a page fails to load. Thanks to @philnash!
+
+**Twiml**
+- Gather input Enum: remove unnecessary "dtmf speech" value as you can now specify multiple enum values for this parameter and both "dtmf" and "speech" are already available.
+
+
 [2018-04-13] Version 5.8.0
 ---------------------------
 **Library**

data/README.md

@@ -27,13 +27,13 @@ in-line code documentation here in the library.
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.8.0'
+gem 'twilio-ruby', '~> 5.8.1'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.8.0
+gem install twilio-ruby -v 5.8.1
 ```
 
 To build and install the development branch yourself from the latest source:

data/lib/twilio-ruby/framework/error.rb

@@ -1,15 +1,10 @@
 module Twilio
   module REST
     class TwilioError < StandardError
-      attr_reader :message, :body
-
-      def initialize(message, body = nil)
-        @message = message
-        @body = body
-      end
-
-      def to_s
-        "#{@message}: #{@body || 'no body'}"
+      # @deprecated all errors that have a body are now 'Twilio::RestError's
+      def body
+        warn "'Twilio::REST::TwilioError#body' has been deprecated. No 'TwilioError' objects are raised with a body."
+        nil
       end
     end
 
@@ -26,6 +21,13 @@ module Twilio
         @response = response
       end
 
+      # @deprecated use #response instead
+      def body
+        warn 'This error used to be a "Twilio::REST::TwilioError" but is now a "Twilio::REST::RestError". ' \
+             'Please use #response instead of #body.'
+        @response
+      end
+
       def to_s
         message
       end

data/lib/twilio-ruby/framework/page.rb

@@ -29,7 +29,7 @@ module Twilio
 
       def process_response(response)
         if response.status_code != 200
-          raise Twilio::REST::TwilioError.new('Unable to fetch page', response)
+          raise Twilio::REST::RestError.new('Unable to fetch page', response)
         end
 
         response.body

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

@@ -111,7 +111,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/api/v2010/account.rb

@@ -43,9 +43,10 @@ module Twilio
           # Lists AccountInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
-          # @param [String] friendly_name Filter accounts where the friendly name exactly
-          #   matches the desired FriendlyName
-          # @param [account.Status] status Only show accounts with the given Status
+          # @param [String] friendly_name Only return the Account resources with friendly
+          #   names that exactly match this name.
+          # @param [account.Status] status Only return Account resources with the given
+          #   status. Can be `closed`, `suspended` or `active`.
           # @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
@@ -66,9 +67,10 @@ module Twilio
           # Streams AccountInstance records from the API as an Enumerable.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
-          # @param [String] friendly_name Filter accounts where the friendly name exactly
-          #   matches the desired FriendlyName
-          # @param [account.Status] status Only show accounts with the given Status
+          # @param [String] friendly_name Only return the Account resources with friendly
+          #   names that exactly match this name.
+          # @param [account.Status] status Only return Account resources with the given
+          #   status. Can be `closed`, `suspended` or `active`.
           # @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
@@ -101,9 +103,10 @@ module Twilio
           ##
           # Retrieve a single page of AccountInstance records from the API.
           # Request is executed immediately.
-          # @param [String] friendly_name Filter accounts where the friendly name exactly
-          #   matches the desired FriendlyName
-          # @param [account.Status] status Only show accounts with the given Status
+          # @param [String] friendly_name Only return the Account resources with friendly
+          #   names that exactly match this name.
+          # @param [account.Status] status Only return Account resources with the given
+          #   status. Can be `closed`, `suspended` or `active`.
           # @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

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

@@ -174,7 +174,8 @@ module Twilio
 
             ##
             # Update the KeyInstance
-            # @param [String] friendly_name The friendly_name
+            # @param [String] friendly_name A descriptive string for this resource, chosen by
+            #   your application, up to 64 characters long.
             # @return [KeyInstance] Updated KeyInstance
             def update(friendly_name: :unset)
               data = Twilio::Values.of({'FriendlyName' => friendly_name, })
@@ -240,25 +241,25 @@ module Twilio
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] A 34 character string that uniquely identifies this API Key.
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] A descriptive string for this resource, chosen by your application, up to 64 characters long.
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The date-time this API Key was created, given as a RFC 2822 Timestamp.
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The date-time this API Key was most recently updated, given as a  RFC 2822 Timestamp.
             def date_updated
               @properties['date_updated']
             end
@@ -272,7 +273,8 @@ module Twilio
 
             ##
             # Update the KeyInstance
-            # @param [String] friendly_name The friendly_name
+            # @param [String] friendly_name A descriptive string for this resource, chosen by
+            #   your application, up to 64 characters long.
             # @return [KeyInstance] Updated KeyInstance
             def update(friendly_name: :unset)
               context.update(friendly_name: friendly_name, )

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

@@ -27,7 +27,8 @@ module Twilio
             ##
             # Retrieve a single page of NewKeyInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
+            # @param [String] friendly_name A descriptive string for this resource, chosen by
+            #   your application, up to 64 characters long.
             # @return [NewKeyInstance] Newly created NewKeyInstance
             def create(friendly_name: :unset)
               data = Twilio::Values.of({'FriendlyName' => friendly_name, })
@@ -99,31 +100,31 @@ module Twilio
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] A 34 character string that uniquely identifies this API Key.
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] A descriptive string for this resource, chosen by your application, up to 64 characters long.
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The date-time this API Key was created, given as a RFC 2822 Timestamp.
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The date-time this API Key was most recently updated, given as a  RFC 2822 Timestamp.
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The secret
+            # @return [String] The secret your application uses to sign Access Tokens and to authenticate to the REST API.
             def secret
               @properties['secret']
             end

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

@@ -15,7 +15,8 @@ module Twilio
                 ##
                 # Initialize the CredentialList
                 # @param [Version] version Version that contains the resource
-                # @param [String] account_sid The account_sid
+                # @param [String] account_sid The unique id of the Account that responsible for
+                #   this resource.
                 # @param [String] credential_list_sid The credential_list_sid
                 # @return [CredentialList] CredentialList
                 def initialize(version, account_sid: nil, credential_list_sid: nil)
@@ -111,8 +112,8 @@ module Twilio
                 ##
                 # Retrieve a single page of CredentialInstance records from the API.
                 # Request is executed immediately.
-                # @param [String] username The username
-                # @param [String] password The password
+                # @param [String] username The username for this credential.
+                # @param [String] password The password will not be returned in the response.
                 # @return [CredentialInstance] Newly created CredentialInstance
                 def create(username: nil, password: nil)
                   data = Twilio::Values.of({'Username' => username, 'Password' => password, })
@@ -251,7 +252,8 @@ module Twilio
                 # Initialize the CredentialInstance
                 # @param [Version] version Version that contains the resource
                 # @param [Hash] payload payload that contains response from Twilio
-                # @param [String] account_sid The account_sid
+                # @param [String] account_sid The unique id of the Account that responsible for
+                #   this resource.
                 # @param [String] credential_list_sid The credential_list_sid
                 # @param [String] sid The sid
                 # @return [CredentialInstance] CredentialInstance
@@ -295,13 +297,13 @@ module Twilio
                 end
 
                 ##
-                # @return [String] The sid
+                # @return [String] A 34 character string that uniquely identifies this resource.
                 def sid
                   @properties['sid']
                 end
 
                 ##
-                # @return [String] The account_sid
+                # @return [String] The unique id of the Account that responsible for this resource.
                 def account_sid
                   @properties['account_sid']
                 end
@@ -313,25 +315,25 @@ module Twilio
                 end
 
                 ##
-                # @return [String] The username
+                # @return [String] The username for this credential.
                 def username
                   @properties['username']
                 end
 
                 ##
-                # @return [Time] The date_created
+                # @return [Time] The date that this resource was created, given as GMT in RFC 2822 format.
                 def date_created
                   @properties['date_created']
                 end
 
                 ##
-                # @return [Time] The date_updated
+                # @return [Time] The date that this resource was last updated, given as GMT in RFC 2822 format.
                 def date_updated
                   @properties['date_updated']
                 end
 
                 ##
-                # @return [String] The uri
+                # @return [String] The URI for this resource, relative to https://api.
                 def uri
                   @properties['uri']
                 end

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

@@ -111,21 +111,23 @@ module Twilio
               # Retrieve a single page of DomainInstance records from the API.
               # Request is executed immediately.
               # @param [String] domain_name The unique address you reserve on Twilio to which
-              #   you route your SIP traffic
-              # @param [String] friendly_name A user-specified, human-readable name for the
-              #   trigger.
+              #   you route your SIP traffic. Domain names can contain letters, digits, and "-".
+              # @param [String] friendly_name A human readable descriptive text, up to 64
+              #   characters long.
               # @param [String] auth_type The types of authentication you have mapped to your
               #   domain
               # @param [String] voice_url The URL Twilio will request when this domain receives
-              #   a call
-              # @param [String] voice_method The HTTP method to use with the voice_url
-              # @param [String] voice_fallback_url The URL that Twilio will use if an error
-              #   occurs retrieving or executing the TwiML requested by VoiceUrl
+              #   a call.
+              # @param [String] voice_method The HTTP method Twilio will use when requesting the
+              #   above Url. Either `GET` or `POST`.
+              # @param [String] voice_fallback_url The URL that Twilio will request if an error
+              #   occurs retrieving or executing the TwiML requested by VoiceUrl.
               # @param [String] voice_fallback_method The HTTP method Twilio will use when
-              #   requesting the VoiceFallbackUrl
+              #   requesting the VoiceFallbackUrl. Either `GET` or `POST`.
               # @param [String] voice_status_callback_url The URL that Twilio will request to
-              #   pass status parameters
-              # @param [String] voice_status_callback_method The voice_status_callback_method
+              #   pass status parameters (such as call ended) to your application.
+              # @param [String] voice_status_callback_method The HTTP method Twilio will use to
+              #   make requests to the StatusCallback URL. Either `GET` or `POST`.
               # @param [Boolean] sip_registration The sip_registration
               # @return [DomainInstance] Newly created DomainInstance
               def create(domain_name: nil, friendly_name: :unset, auth_type: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, voice_status_callback_url: :unset, voice_status_callback_method: :unset, sip_registration: :unset)
@@ -442,7 +444,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The voice_status_callback_method
+              # @return [String] The HTTP method Twilio will use to make requests to the StatusCallback URL.
               def voice_status_callback_method
                 @properties['voice_status_callback_method']
               end

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

@@ -17,7 +17,7 @@ module Twilio
                 # @param [Version] version Version that contains the resource
                 # @param [String] account_sid The account_sid
                 # @param [String] domain_sid A 34 character string that uniquely identifies the
-                #   SIP domain in Twilio
+                #   SIP domain in Twilio.
                 # @return [CredentialListMappingList] CredentialListMappingList
                 def initialize(version, account_sid: nil, domain_sid: nil)
                   super(version)
@@ -231,7 +231,7 @@ module Twilio
                 # @param [Hash] payload payload that contains response from Twilio
                 # @param [String] account_sid The account_sid
                 # @param [String] domain_sid A 34 character string that uniquely identifies the
-                #   SIP domain in Twilio
+                #   SIP domain in Twilio.
                 # @param [String] sid The sid
                 # @return [CredentialListMappingInstance] CredentialListMappingInstance
                 def initialize(version, payload, account_sid: nil, domain_sid: nil, sid: nil)

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

@@ -17,7 +17,7 @@ module Twilio
                 # @param [Version] version Version that contains the resource
                 # @param [String] account_sid The account_sid
                 # @param [String] domain_sid A 34 character string that uniquely identifies the
-                #   SIP domain in Twilio
+                #   SIP domain in Twilio.
                 # @return [IpAccessControlListMappingList] IpAccessControlListMappingList
                 def initialize(version, account_sid: nil, domain_sid: nil)
                   super(version)
@@ -231,7 +231,7 @@ module Twilio
                 # @param [Hash] payload payload that contains response from Twilio
                 # @param [String] account_sid The account_sid
                 # @param [String] domain_sid A 34 character string that uniquely identifies the
-                #   SIP domain in Twilio
+                #   SIP domain in Twilio.
                 # @param [String] sid The sid
                 # @return [IpAccessControlListMappingInstance] IpAccessControlListMappingInstance
                 def initialize(version, payload, account_sid: nil, domain_sid: nil, sid: nil)

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

@@ -110,8 +110,9 @@ module Twilio
               ##
               # Retrieve a single page of IpAccessControlListInstance records from the API.
               # Request is executed immediately.
-              # @param [String] friendly_name A human readable descriptive text, up to 64
-              #   characters long.
+              # @param [String] friendly_name A human readable descriptive text that describes
+              #   the IpAccessControlList, up to 64 characters long.
+              #   https://www.twilio.com/docs/admin/pages/add/api_reference/apireferencepage/175/#
               # @return [IpAccessControlListInstance] Newly created IpAccessControlListInstance
               def create(friendly_name: nil)
                 data = Twilio::Values.of({'FriendlyName' => friendly_name, })

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

@@ -39,15 +39,16 @@ module Twilio
               # Lists RecordInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [record.Category] category Only include usage of a given category
+              # @param [record.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 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
+              #   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
@@ -69,15 +70,16 @@ module Twilio
               # Streams RecordInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [record.Category] category Only include usage of a given category
+              # @param [record.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 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
+              #   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
@@ -115,15 +117,16 @@ module Twilio
               ##
               # Retrieve a single page of RecordInstance records from the API.
               # Request is executed immediately.
-              # @param [record.Category] category Only include usage of a given category
+              # @param [record.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 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
+              #   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