twilio-ruby 5.14.1 → 5.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 695b02619ce6b0eb12679c7f6b581834a3fd01cc
-  data.tar.gz: 45c5a81aaf31343678d57c14f0029b7f742ad550
+  metadata.gz: 82c6b89bf22181ab4c74c1214738562fbfd45806
+  data.tar.gz: 711415d89893d32bc5c8d35c3e2431a96e047d34
 SHA512:
-  metadata.gz: f71591f4762fefee517c5278de1d742f64b1e3a36e6de2c3ae3f7930d5779a4e49bda592fed71750b27dedea492bf290d79a0421936c85640160150ead8e18a1
-  data.tar.gz: c7c9bf6c34747894d9372f152fb0f5c4f7eeeb05607f8f2af2600138150f4aee0b645ecd1889217d6508c7fbd59bc805cabd6a3bbbeae67fb23ee0d5be712bce
+  metadata.gz: 3bd5ca81977cc69f73e9bfe379c17a569e6a8ef07ccdf3e5c3b0a9c1621dba9a91b4f9eefc4b29f8ea98e67fe83dad8b5d1a9eaf42ab230707646cc5a81422f2
+  data.tar.gz: f04fdf23b7966d7dcdb33ad324d23087a1bdff8751049328094e734737c08b0e7635b03ce9b296ae853a8024ba95de196b29df598c17ba22b2cc5e98f9b071fe

data/CHANGES.md

@@ -1,6 +1,39 @@
 twilio-ruby changelog
 =====================
 
+[2018-10-15] Version 5.15.0
+----------------------------
+**Library**
+- PR #428: Fix custom param tests. Thanks to @ryan-rowland!
+
+**Api**
+- Add `coaching` and `call_sid_to_coach` to participant properties, create and update requests.
+
+**Authy**
+- Set public library visibility, and added PII stanza
+- Dropped support for `FactorType` param given new Factor prefixes **(breaking change)**
+- Supported `DELETE` actions for Authy resources
+- Move Authy Services resources to `authy` subdomain
+
+**Autopilot**
+- Introduce `autopilot` subdomain with all resources from `preview.understand`
+
+**Preview**
+- Renamed Understand intent to task **(breaking change)**
+- Deprecated Authy endpoints from `preview` to `authy` subdomain
+
+**Taskrouter**
+- Allow TaskQueue ReservationActivitySid and AssignmentActivitySid to not be configured for MultiTask Workspaces
+
+**Verify**
+- Add `LookupEnabled` optional parameter on Service resource creation or update.
+- Add `SendDigits` optional parameter on Verification creation.
+- Add delete action on Service resourse.
+
+**Twiml**
+- Add custom parameters to TwiML `Client` noun and renamed the optional `name` field to `identity`. This is a breaking change in Ruby, and applications will need to transition from `dial.client ''` and `dial.client 'alice'` formats to `dial.client` and `dial.client(identity: alice)` formats. **(breaking change)**
+
+
 [2018-10-04] Version 5.14.1
 ----------------------------
 **Twiml**

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

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

@@ -39,7 +39,8 @@ module Twilio
               #   values separate them with a space. Defaults to `completed`.
               # @param [String] recording_status_callback The URL which Twilio will make its GET
               #   or POST request to for the recording events specified in parameter
-              #   RecordingStatusCallbackEvent.
+              #   RecordingStatusCallbackEvent. See [RecordingStatusCallback
+              #   parameters](https://www.twilio.com/docs/voice/api/recording#recordingstatuscallback) for more details.
               # @param [String] recording_status_callback_method The HTTP method Twilio should
               #   use when making a request to the RecordingStatusCallback URL. Possible values:
               #   `GET`, `POST`. Defaults to `POST`.

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

@@ -0,0 +1,55 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Authy < Domain
+      ##
+      # Initialize the Authy Domain
+      def initialize(twilio)
+        super
+
+        @base_url = 'https://authy.twilio.com'
+        @host = 'authy.twilio.com'
+        @port = 443
+
+        # Versions
+        @v1 = nil
+      end
+
+      ##
+      # Version v1 of authy
+      def v1
+        @v1 ||= V1.new self
+      end
+
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this Service.
+      # @return [Twilio::REST::Authy::V1::ServiceInstance] if sid was passed.
+      # @return [Twilio::REST::Authy::V1::ServiceList]
+      def services(sid=:unset)
+        self.v1.services(sid)
+      end
+
+      ##
+      # @param [form.FormType] form_type The Form Type of this Form. One of
+      #   `form-app-push`, `form-sms` or `form-totp`.
+      # @return [Twilio::REST::Authy::V1::FormInstance] if form_type was passed.
+      # @return [Twilio::REST::Authy::V1::FormList]
+      def forms(form_type=:unset)
+        self.v1.forms(form_type)
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '#<Twilio::REST::Authy>'
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/authy/v1.rb

@@ -0,0 +1,59 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Authy
+      class V1 < Version
+        ##
+        # Initialize the V1 version of Authy
+        def initialize(domain)
+          super
+          @version = 'v1'
+          @services = nil
+          @forms = nil
+        end
+
+        ##
+        # @param [String] sid A 34 character string that uniquely identifies this Service.
+        # @return [Twilio::REST::Authy::V1::ServiceContext] if sid was passed.
+        # @return [Twilio::REST::Authy::V1::ServiceList]
+        def services(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @services ||= ServiceList.new self
+          else
+            ServiceContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @param [form.FormType] form_type The Form Type of this Form. One of
+        #   `form-app-push`, `form-sms` or `form-totp`.
+        # @return [Twilio::REST::Authy::V1::FormContext] if form_type was passed.
+        # @return [Twilio::REST::Authy::V1::FormList]
+        def forms(form_type=:unset)
+          if form_type.nil?
+            raise ArgumentError, 'form_type cannot be nil'
+          elsif form_type == :unset
+            @forms ||= FormList.new self
+          else
+            FormContext.new(self, form_type)
+          end
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Authy::V1>'
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/authy/v1/form.rb

@@ -0,0 +1,190 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Authy < Domain
+      class V1 < 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 FormList < ListResource
+          ##
+          # Initialize the FormList
+          # @param [Version] version Version that contains the resource
+          # @return [FormList] FormList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Authy.V1.FormList>'
+          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 FormPage < Page
+          ##
+          # Initialize the FormPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [FormPage] FormPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of FormInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [FormInstance] FormInstance
+          def get_instance(payload)
+            FormInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Authy.V1.FormPage>'
+          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 FormContext < InstanceContext
+          ##
+          # Initialize the FormContext
+          # @param [Version] version Version that contains the resource
+          # @param [form.FormType] form_type The Form Type of this Form. One of
+          #   `form-app-push`, `form-sms` or `form-totp`.
+          # @return [FormContext] FormContext
+          def initialize(version, form_type)
+            super(version)
+
+            # Path Solution
+            @solution = {form_type: form_type, }
+            @uri = "/Forms/#{@solution[:form_type]}"
+          end
+
+          ##
+          # Fetch a FormInstance
+          # @return [FormInstance] Fetched FormInstance
+          def fetch
+            params = Twilio::Values.of({})
+
+            payload = @version.fetch(
+                'GET',
+                @uri,
+                params,
+            )
+
+            FormInstance.new(@version, payload, form_type: @solution[:form_type], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Authy.V1.FormContext #{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 FormInstance < InstanceResource
+          ##
+          # Initialize the FormInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [form.FormType] form_type The Form Type of this Form. One of
+          #   `form-app-push`, `form-sms` or `form-totp`.
+          # @return [FormInstance] FormInstance
+          def initialize(version, payload, form_type: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'form_type' => payload['form_type'],
+                'forms' => payload['forms'],
+                'form_meta' => payload['form_meta'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'form_type' => form_type || @properties['form_type'], }
+          end
+
+          ##
+          # Generate an instance context for the instance, the context is capable of
+          # performing various actions.  All instance actions are proxied to the context
+          # @return [FormContext] FormContext for this FormInstance
+          def context
+            unless @instance_context
+              @instance_context = FormContext.new(@version, @params['form_type'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [form.FormType] The Form Type of this Form
+          def form_type
+            @properties['form_type']
+          end
+
+          ##
+          # @return [Hash] Object that contains the available forms for this form type.
+          def forms
+            @properties['forms']
+          end
+
+          ##
+          # @return [Hash] Additional information for the available forms for this form type.
+          def form_meta
+            @properties['form_meta']
+          end
+
+          ##
+          # @return [String] The URL to access the forms for this form type.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch a FormInstance
+          # @return [FormInstance] Fetched FormInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Authy.V1.FormInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Authy.V1.FormInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/authy/v1/service.rb

@@ -0,0 +1,378 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Authy < Domain
+      class V1 < 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
+          ##
+          # Initialize the ServiceList
+          # @param [Version] version Version that contains the resource
+          # @return [ServiceList] ServiceList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Services"
+          end
+
+          ##
+          # Retrieve a single page of ServiceInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] friendly_name A human readable description of this resource, up
+          #   to 64 characters.
+          # @return [ServiceInstance] Newly created ServiceInstance
+          def create(friendly_name: nil)
+            data = Twilio::Values.of({'FriendlyName' => friendly_name, })
+
+            payload = @version.create(
+                'POST',
+                @uri,
+                data: data
+            )
+
+            ServiceInstance.new(@version, payload, )
+          end
+
+          ##
+          # Lists ServiceInstance 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()
+          #    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)
+          # @return [Array] Array of up to limit results
+          def list(limit: nil, page_size: nil)
+            self.stream(limit: limit, page_size: page_size).entries
+          end
+
+          ##
+          # Streams ServiceInstance 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()
+          #    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)
+          # @return [Enumerable] Enumerable that will yield up to limit results
+          def stream(limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields ServiceInstance records from the API.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          def each
+            limits = @version.read_limits
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit]).each {|x| yield x}
+          end
+
+          ##
+          # Retrieve a single page of ServiceInstance 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
+          def page(page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+            response = @version.page(
+                'GET',
+                @uri,
+                params
+            )
+            ServicePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of ServiceInstance 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
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            ServicePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Authy.V1.ServiceList>'
+          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
+          ##
+          # Initialize the ServicePage
+          # @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
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of ServiceInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [ServiceInstance] ServiceInstance
+          def get_instance(payload)
+            ServiceInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Authy.V1.ServicePage>'
+          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
+          ##
+          # Initialize the ServiceContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid A 34 character string that uniquely identifies this Service.
+          # @return [ServiceContext] ServiceContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/Services/#{@solution[:sid]}"
+
+            # Dependents
+            @entities = nil
+          end
+
+          ##
+          # Deletes the ServiceInstance
+          # @return [Boolean] true if delete succeeds, true otherwise
+          def delete
+            @version.delete('delete', @uri)
+          end
+
+          ##
+          # Fetch a ServiceInstance
+          # @return [ServiceInstance] Fetched ServiceInstance
+          def fetch
+            params = Twilio::Values.of({})
+
+            payload = @version.fetch(
+                'GET',
+                @uri,
+                params,
+            )
+
+            ServiceInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Update the ServiceInstance
+          # @param [String] friendly_name A human readable description of this resource, up
+          #   to 64 characters.
+          # @return [ServiceInstance] Updated ServiceInstance
+          def update(friendly_name: :unset)
+            data = Twilio::Values.of({'FriendlyName' => friendly_name, })
+
+            payload = @version.update(
+                'POST',
+                @uri,
+                data: data,
+            )
+
+            ServiceInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Access the entities
+          # @return [EntityList]
+          # @return [EntityContext] if identity was passed.
+          def entities(identity=:unset)
+            raise ArgumentError, 'identity cannot be nil' if identity.nil?
+
+            if identity != :unset
+              return EntityContext.new(@version, @solution[:sid], identity, )
+            end
+
+            unless @entities
+              @entities = EntityList.new(@version, service_sid: @solution[:sid], )
+            end
+
+            @entities
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Authy.V1.ServiceContext #{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
+          ##
+          # Initialize the ServiceInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid A 34 character string that uniquely identifies this Service.
+          # @return [ServiceInstance] ServiceInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'friendly_name' => payload['friendly_name'],
+                'account_sid' => payload['account_sid'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'url' => payload['url'],
+                'links' => payload['links'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'sid' => sid || @properties['sid'], }
+          end
+
+          ##
+          # 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
+          def context
+            unless @instance_context
+              @instance_context = ServiceContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] A string that uniquely identifies this Service.
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] A human readable description of this resource.
+          def friendly_name
+            @properties['friendly_name']
+          end
+
+          ##
+          # @return [String] Account Sid.
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [Time] The date this Service was created
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] The date this Service was updated
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] The URL of this resource.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] Nested resource URLs.
+          def links
+            @properties['links']
+          end
+
+          ##
+          # Deletes the ServiceInstance
+          # @return [Boolean] true if delete succeeds, true otherwise
+          def delete
+            context.delete
+          end
+
+          ##
+          # Fetch a ServiceInstance
+          # @return [ServiceInstance] Fetched ServiceInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Update the ServiceInstance
+          # @param [String] friendly_name A human readable description of this resource, up
+          #   to 64 characters.
+          # @return [ServiceInstance] Updated ServiceInstance
+          def update(friendly_name: :unset)
+            context.update(friendly_name: friendly_name, )
+          end
+
+          ##
+          # Access the entities
+          # @return [entities] entities
+          def entities
+            context.entities
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Authy.V1.ServiceInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Authy.V1.ServiceInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end