twilio-ruby 5.7.2 → 5.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d93f326b9b563f4f707a01d53afc5911f20d7f2
-  data.tar.gz: ed59b2585e16c1b94143e158889ff8f738ff7fb9
+  metadata.gz: f31420e85a848a70feecfe16755e650d9239765b
+  data.tar.gz: a8f8a197dd19c793eadc79f81457b1be96570756
 SHA512:
-  metadata.gz: 9fd1bc1959a70b4df9273943eff9bf9ce50e0a6ea740c93edd5056d834e65e76fe97821943f472d449baed6c974ecda208dedf1bda6e08a8245a9aa6a0063afe
-  data.tar.gz: a781c3847dac0b4b2b013b26a3608231177fc09bdd2043629fd25c4a7f0161373b93c859ec3af7ef09471caacfa56152fd92e8555f2b32fec3a7a8522b04149d
+  metadata.gz: 1e2fa856f8d8c4596efa8c274d8606d1666d61971647ffdc29e8dc7d307fb038ad723b644f3ed6ec3b5f1a49fe3f681db873ded28b70cb4d9cd6ba1c0bd22bf3
+  data.tar.gz: 24a1cb1af4daad69c49406c47a0cb98c645f7201809bc5d3da8046cec350f91f7c04f35d9aee156ab19f3041daf9cca35fa9197657654c6b3adb73004b59c6e1

data/.travis.yml

@@ -19,3 +19,7 @@ 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,25 @@
 twilio-ruby changelog
 =====================
 
+[2018-04-13] Version 5.8.0
+---------------------------
+**Library**
+- PR #389: Add incoming.allow to AccessToken VoiceGrant. Thanks to @ryan-rowland!
+- PR #391: Improves error message for Twilio::REST::RestError. Thanks to @philnash!
+
+**Lookups**
+- Disable support for `fraud` lookups **(breaking change)**
+
+**Preview**
+- Support for Understand V2 APIs - renames various resources and adds new fields
+
+**Studio**
+- Change parameters type from string to object in engagement resource
+
+**Video**
+- [Recordings] Change `size` type to `long`. **(breaking change)**
+
+
 [2018-03-22] Version 5.7.2
 ---------------------------
 **Preview**

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.7.2'
+gem 'twilio-ruby', '~> 5.8.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.7.2
+gem install twilio-ruby -v 5.8.0
 ```
 
 To build and install the development branch yourself from the latest source:

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

@@ -14,16 +14,30 @@ module Twilio
     end
 
     class RestError < TwilioError
-      attr_reader :message, :code, :status_code
+      attr_reader :message, :response, :code, :status_code, :detail, :more_info, :error_message
 
-      def initialize(message, code, status_code)
-        @message = message
-        @code = code
-        @status_code = status_code
+      def initialize(message, response)
+        @status_code = response.status_code
+        @code = response.body.fetch('code', @status_code)
+        @detail = response.body.fetch('detail', nil)
+        @error_message = response.body.fetch('message', nil)
+        @more_info = response.body.fetch('more_info', nil)
+        @message = format_message(message)
+        @response = response
       end
 
       def to_s
-        "[HTTP #{status_code}] #{code} : #{message}"
+        message
+      end
+
+      private
+
+      def format_message(initial_message)
+        message = "[HTTP #{status_code}] #{code} : #{initial_message}"
+        message += "\n#{error_message}" if error_message
+        message += "\n#{detail}" if detail
+        message += "\n#{more_info}" if more_info
+        message + "\n\n"
       end
     end
 

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

@@ -52,16 +52,7 @@ module Twilio
       end
 
       def exception(response, header)
-        message = header
-        code = response.status_code
-
-        if response.body.key?('message')
-          message += ": #{response.body['message']}"
-        end
-
-        code = response.body['code'] if response.body.key?('code')
-
-        Twilio::REST::RestError.new(message, code, response.status_code)
+        Twilio::REST::RestError.new(header, response)
       end
 
       def fetch(method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)

data/lib/twilio-ruby/jwt/access_token.rb

@@ -144,7 +144,8 @@ module Twilio
 
       class VoiceGrant
         include AccessTokenGrant
-        attr_accessor :outgoing_application_sid,
+        attr_accessor :incoming_allow,
+                      :outgoing_application_sid,
                       :outgoing_application_params,
                       :push_credential_sid,
                       :endpoint_id
@@ -155,6 +156,7 @@ module Twilio
 
         def _generate_payload
           payload = {}
+          payload[:incoming] = { allow: true } if incoming_allow == true
 
           if outgoing_application_sid
             outgoing = {}

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

@@ -119,7 +119,6 @@ module Twilio
                 'phone_number' => payload['phone_number'],
                 'national_format' => payload['national_format'],
                 'carrier' => payload['carrier'],
-                'fraud' => payload['fraud'],
                 'add_ons' => payload['add_ons'],
                 'url' => payload['url'],
             }
@@ -170,12 +169,6 @@ module Twilio
             @properties['carrier']
           end
 
-          ##
-          # @return [String] The fraud
-          def fraud
-            @properties['fraud']
-          end
-
           ##
           # @return [Hash] The add_ons
           def add_ons

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

@@ -151,10 +151,10 @@ module Twilio
 
       ##
       # @param [String] sid The sid
-      # @return [Twilio::REST::Preview::Understand::ServiceInstance] if sid was passed.
-      # @return [Twilio::REST::Preview::Understand::ServiceList]
+      # @return [Twilio::REST::Preview::Sync::ServiceInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::Sync::ServiceList]
       def services(sid=:unset)
-        self.understand.services(sid)
+        self.sync.services(sid)
       end
 
       ##
@@ -165,6 +165,14 @@ module Twilio
         self.studio.flows(sid)
       end
 
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Preview::Understand::AssistantInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::Understand::AssistantList]
+      def assistants(sid=:unset)
+        self.understand.assistants(sid)
+      end
+
       ##
       # @param [String] sid The sid
       # @return [Twilio::REST::Preview::Wireless::CommandInstance] if sid was passed.

data/lib/twilio-ruby/rest/preview/understand.rb

@@ -13,20 +13,20 @@ module Twilio
         def initialize(domain)
           super
           @version = 'understand'
-          @services = nil
+          @assistants = nil
         end
 
         ##
         # @param [String] sid The sid
-        # @return [Twilio::REST::Preview::Understand::ServiceContext] if sid was passed.
-        # @return [Twilio::REST::Preview::Understand::ServiceList]
-        def services(sid=:unset)
+        # @return [Twilio::REST::Preview::Understand::AssistantContext] if sid was passed.
+        # @return [Twilio::REST::Preview::Understand::AssistantList]
+        def assistants(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'
           elsif sid == :unset
-            @services ||= ServiceList.new self
+            @assistants ||= AssistantList.new self
           else
-            ServiceContext.new(self, sid)
+            AssistantContext.new(self, sid)
           end
         end
 

data/lib/twilio-ruby/rest/preview/understand/{service.rb → assistant.rb}

@@ -10,21 +10,21 @@ module Twilio
       class Understand < Version
         ##
         # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-        class ServiceList < ListResource
+        class AssistantList < ListResource
           ##
-          # Initialize the ServiceList
+          # Initialize the AssistantList
           # @param [Version] version Version that contains the resource
-          # @return [ServiceList] ServiceList
+          # @return [AssistantList] AssistantList
           def initialize(version)
             super(version)
 
             # Path Solution
             @solution = {}
-            @uri = "/Services"
+            @uri = "/Assistants"
           end
 
           ##
-          # Lists ServiceInstance records from the API as a list.
+          # Lists AssistantInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
           # @param [Integer] limit Upper limit for the number of records to return. stream()
@@ -39,7 +39,7 @@ module Twilio
           end
 
           ##
-          # Streams ServiceInstance records from the API as an Enumerable.
+          # Streams AssistantInstance records from the API as an Enumerable.
           # 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()
@@ -58,7 +58,7 @@ module Twilio
           end
 
           ##
-          # When passed a block, yields ServiceInstance records from the API.
+          # When passed a block, yields AssistantInstance records from the API.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
           def each
@@ -72,12 +72,12 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of ServiceInstance records from the API.
+          # Retrieve a single page of AssistantInstance records from the API.
           # Request is executed immediately.
           # @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
-          # @return [Page] Page of ServiceInstance
+          # @return [Page] Page of AssistantInstance
           def page(page_token: :unset, page_number: :unset, page_size: :unset)
             params = Twilio::Values.of({
                 'PageToken' => page_token,
@@ -89,36 +89,42 @@ module Twilio
                 @uri,
                 params
             )
-            ServicePage.new(@version, response, @solution)
+            AssistantPage.new(@version, response, @solution)
           end
 
           ##
-          # Retrieve a single page of ServiceInstance records from the API.
+          # Retrieve a single page of AssistantInstance records from the API.
           # Request is executed immediately.
           # @param [String] target_url API-generated URL for the requested results page
-          # @return [Page] Page of ServiceInstance
+          # @return [Page] Page of AssistantInstance
           def get_page(target_url)
             response = @version.domain.request(
                 'GET',
                 target_url
             )
-            ServicePage.new(@version, response, @solution)
+            AssistantPage.new(@version, response, @solution)
           end
 
           ##
-          # Retrieve a single page of ServiceInstance records from the API.
+          # Retrieve a single page of AssistantInstance records from the API.
           # Request is executed immediately.
           # @param [String] friendly_name The friendly_name
           # @param [Boolean] log_queries The log_queries
           # @param [String] ttl The ttl
           # @param [String] unique_name The unique_name
-          # @return [ServiceInstance] Newly created ServiceInstance
-          def create(friendly_name: :unset, log_queries: :unset, ttl: :unset, unique_name: :unset)
+          # @param [String] response_url The response_url
+          # @param [String] callback_url The callback_url
+          # @param [String] callback_events The callback_events
+          # @return [AssistantInstance] Newly created AssistantInstance
+          def create(friendly_name: :unset, log_queries: :unset, ttl: :unset, unique_name: :unset, response_url: :unset, callback_url: :unset, callback_events: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'LogQueries' => log_queries,
                 'Ttl' => ttl,
                 'UniqueName' => unique_name,
+                'ResponseUrl' => response_url,
+                'CallbackUrl' => callback_url,
+                'CallbackEvents' => callback_events,
             })
 
             payload = @version.create(
@@ -127,25 +133,25 @@ module Twilio
                 data: data
             )
 
-            ServiceInstance.new(@version, payload, )
+            AssistantInstance.new(@version, payload, )
           end
 
           ##
           # Provide a user friendly representation
           def to_s
-            '#<Twilio.Preview.Understand.ServiceList>'
+            '#<Twilio.Preview.Understand.AssistantList>'
           end
         end
 
         ##
         # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-        class ServicePage < Page
+        class AssistantPage < Page
           ##
-          # Initialize the ServicePage
+          # Initialize the AssistantPage
           # @param [Version] version Version that contains the resource
           # @param [Response] response Response from the API
           # @param [Hash] solution Path solution for the resource
-          # @return [ServicePage] ServicePage
+          # @return [AssistantPage] AssistantPage
           def initialize(version, response, solution)
             super(version, response)
 
@@ -154,34 +160,34 @@ module Twilio
           end
 
           ##
-          # Build an instance of ServiceInstance
+          # Build an instance of AssistantInstance
           # @param [Hash] payload Payload response from the API
-          # @return [ServiceInstance] ServiceInstance
+          # @return [AssistantInstance] AssistantInstance
           def get_instance(payload)
-            ServiceInstance.new(@version, payload, )
+            AssistantInstance.new(@version, payload, )
           end
 
           ##
           # Provide a user friendly representation
           def to_s
-            '<Twilio.Preview.Understand.ServicePage>'
+            '<Twilio.Preview.Understand.AssistantPage>'
           end
         end
 
         ##
         # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-        class ServiceContext < InstanceContext
+        class AssistantContext < InstanceContext
           ##
-          # Initialize the ServiceContext
+          # Initialize the AssistantContext
           # @param [Version] version Version that contains the resource
           # @param [String] sid The sid
-          # @return [ServiceContext] ServiceContext
+          # @return [AssistantContext] AssistantContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
             @solution = {sid: sid, }
-            @uri = "/Services/#{@solution[:sid]}"
+            @uri = "/Assistants/#{@solution[:sid]}"
 
             # Dependents
             @field_types = nil
@@ -191,8 +197,8 @@ module Twilio
           end
 
           ##
-          # Fetch a ServiceInstance
-          # @return [ServiceInstance] Fetched ServiceInstance
+          # Fetch a AssistantInstance
+          # @return [AssistantInstance] Fetched AssistantInstance
           def fetch
             params = Twilio::Values.of({})
 
@@ -202,22 +208,28 @@ module Twilio
                 params,
             )
 
-            ServiceInstance.new(@version, payload, sid: @solution[:sid], )
+            AssistantInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Update the ServiceInstance
+          # Update the AssistantInstance
           # @param [String] friendly_name The friendly_name
           # @param [Boolean] log_queries The log_queries
           # @param [String] ttl The ttl
           # @param [String] unique_name The unique_name
-          # @return [ServiceInstance] Updated ServiceInstance
-          def update(friendly_name: :unset, log_queries: :unset, ttl: :unset, unique_name: :unset)
+          # @param [String] response_url The response_url
+          # @param [String] callback_url The callback_url
+          # @param [String] callback_events The callback_events
+          # @return [AssistantInstance] Updated AssistantInstance
+          def update(friendly_name: :unset, log_queries: :unset, ttl: :unset, unique_name: :unset, response_url: :unset, callback_url: :unset, callback_events: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'LogQueries' => log_queries,
                 'Ttl' => ttl,
                 'UniqueName' => unique_name,
+                'ResponseUrl' => response_url,
+                'CallbackUrl' => callback_url,
+                'CallbackEvents' => callback_events,
             })
 
             payload = @version.update(
@@ -226,11 +238,11 @@ module Twilio
                 data: data,
             )
 
-            ServiceInstance.new(@version, payload, sid: @solution[:sid], )
+            AssistantInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Deletes the ServiceInstance
+          # Deletes the AssistantInstance
           # @return [Boolean] true if delete succeeds, true otherwise
           def delete
             @version.delete('delete', @uri)
@@ -248,7 +260,7 @@ module Twilio
             end
 
             unless @field_types
-              @field_types = FieldTypeList.new(@version, service_sid: @solution[:sid], )
+              @field_types = FieldTypeList.new(@version, assistant_sid: @solution[:sid], )
             end
 
             @field_types
@@ -266,7 +278,7 @@ module Twilio
             end
 
             unless @intents
-              @intents = IntentList.new(@version, service_sid: @solution[:sid], )
+              @intents = IntentList.new(@version, assistant_sid: @solution[:sid], )
             end
 
             @intents
@@ -284,7 +296,7 @@ module Twilio
             end
 
             unless @model_builds
-              @model_builds = ModelBuildList.new(@version, service_sid: @solution[:sid], )
+              @model_builds = ModelBuildList.new(@version, assistant_sid: @solution[:sid], )
             end
 
             @model_builds
@@ -302,7 +314,7 @@ module Twilio
             end
 
             unless @queries
-              @queries = QueryList.new(@version, service_sid: @solution[:sid], )
+              @queries = QueryList.new(@version, assistant_sid: @solution[:sid], )
             end
 
             @queries
@@ -312,19 +324,19 @@ module Twilio
           # Provide a user friendly representation
           def to_s
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Preview.Understand.ServiceContext #{context}>"
+            "#<Twilio.Preview.Understand.AssistantContext #{context}>"
           end
         end
 
         ##
         # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-        class ServiceInstance < InstanceResource
+        class AssistantInstance < InstanceResource
           ##
-          # Initialize the ServiceInstance
+          # Initialize the AssistantInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
           # @param [String] sid The sid
-          # @return [ServiceInstance] ServiceInstance
+          # @return [AssistantInstance] AssistantInstance
           def initialize(version, payload, sid: nil)
             super(version)
 
@@ -341,6 +353,9 @@ module Twilio
                 'ttl' => payload['ttl'].to_i,
                 'unique_name' => payload['unique_name'],
                 'url' => payload['url'],
+                'response_url' => payload['response_url'],
+                'callback_url' => payload['callback_url'],
+                'callback_events' => payload['callback_events'],
             }
 
             # Context
@@ -351,10 +366,10 @@ 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
-          # @return [ServiceContext] ServiceContext for this ServiceInstance
+          # @return [AssistantContext] AssistantContext for this AssistantInstance
           def context
             unless @instance_context
-              @instance_context = ServiceContext.new(@version, @params['sid'], )
+              @instance_context = AssistantContext.new(@version, @params['sid'], )
             end
             @instance_context
           end
@@ -426,30 +441,54 @@ module Twilio
           end
 
           ##
-          # Fetch a ServiceInstance
-          # @return [ServiceInstance] Fetched ServiceInstance
+          # @return [String] The response_url
+          def response_url
+            @properties['response_url']
+          end
+
+          ##
+          # @return [String] The callback_url
+          def callback_url
+            @properties['callback_url']
+          end
+
+          ##
+          # @return [String] The callback_events
+          def callback_events
+            @properties['callback_events']
+          end
+
+          ##
+          # Fetch a AssistantInstance
+          # @return [AssistantInstance] Fetched AssistantInstance
           def fetch
             context.fetch
           end
 
           ##
-          # Update the ServiceInstance
+          # Update the AssistantInstance
           # @param [String] friendly_name The friendly_name
           # @param [Boolean] log_queries The log_queries
           # @param [String] ttl The ttl
           # @param [String] unique_name The unique_name
-          # @return [ServiceInstance] Updated ServiceInstance
-          def update(friendly_name: :unset, log_queries: :unset, ttl: :unset, unique_name: :unset)
+          # @param [String] response_url The response_url
+          # @param [String] callback_url The callback_url
+          # @param [String] callback_events The callback_events
+          # @return [AssistantInstance] Updated AssistantInstance
+          def update(friendly_name: :unset, log_queries: :unset, ttl: :unset, unique_name: :unset, response_url: :unset, callback_url: :unset, callback_events: :unset)
             context.update(
                 friendly_name: friendly_name,
                 log_queries: log_queries,
                 ttl: ttl,
                 unique_name: unique_name,
+                response_url: response_url,
+                callback_url: callback_url,
+                callback_events: callback_events,
             )
           end
 
           ##
-          # Deletes the ServiceInstance
+          # Deletes the AssistantInstance
           # @return [Boolean] true if delete succeeds, true otherwise
           def delete
             context.delete
@@ -487,14 +526,14 @@ module Twilio
           # Provide a user friendly representation
           def to_s
             values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Preview.Understand.ServiceInstance #{values}>"
+            "<Twilio.Preview.Understand.AssistantInstance #{values}>"
           end
 
           ##
           # Provide a detailed, user friendly representation
           def inspect
             values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Preview.Understand.ServiceInstance #{values}>"
+            "<Twilio.Preview.Understand.AssistantInstance #{values}>"
           end
         end
       end