twilio-ruby 5.12.4 → 5.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1067889a70a6093ed700c5b18b1bdb9905974d9a
-  data.tar.gz: 179b4ad89db463e0dfa97eac08064c58dfa449c0
+  metadata.gz: f4ce16d26c62514428db1b1c37f62028e0f7ee7a
+  data.tar.gz: a56c95b413a42d40568a9b9bff97324106ae5eec
 SHA512:
-  metadata.gz: e8ab39d6718adfb193361c499e862c2783502692568a6244d8424c0da54195074a954bcb1791248bf5987d1eca03cc3178fc518b84b6623850f69da0973b0a14
-  data.tar.gz: bcf88f2120c5373af54170bc6831e58d44ab67081e43b355883302df1ed145365f0cd6ac92ac0fa16237af0cf466ef1d0e5b614a67930d243b8b92240321f259
+  metadata.gz: d26d08ff46decea3088152be428ea457a0a32b8f479f17948527821e4b102869ecbb2b27e4ffe5ad7c49702f34822a2e475b2e3f4c28575c131649769220a9d3
+  data.tar.gz: 447f2b394fab6112de58c3784f85bac91f128777592b40f90336d10164d8a7b30595fb46e946e34e41161b52491d754e71b74a88a57106246ef21d949390fc56

data/CHANGES.md

@@ -1,6 +1,19 @@
 twilio-ruby changelog
 =====================
 
+[2018-09-20] Version 5.13.0
+----------------------------
+**Preview**
+- Add `Form` resource to Authy preview given a `form_type`
+- Add Authy initial api-definitions in the 4 main resources: Services, Entities, Factors, Challenges
+
+**Pricing**
+- add voice_numbers resource (v2)
+
+**Verify**
+- Move from preview to beta **(breaking change)**
+
+
 [2018-08-31] Version 5.12.4
 ----------------------------
 **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.12.4'
+gem 'twilio-ruby', '~> 5.13.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.12.4
+gem install twilio-ruby -v 5.13.0
 ```
 
 To build and install the development branch yourself from the latest source:

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

@@ -33,15 +33,22 @@ module Twilio
               ##
               # Retrieve a single page of RecordingInstance records from the API.
               # Request is executed immediately.
-              # @param [String] recording_status_callback_event The
-              #   recording_status_callback_event
-              # @param [String] recording_status_callback The recording_status_callback
-              # @param [String] recording_status_callback_method The
-              #   recording_status_callback_method
-              # @param [String] trim Possible values `trim-silence` or `do-not-trim`.
+              # @param [String] recording_status_callback_event The recording status changes
+              #   that should generate a request to the URL specified in RecordingStatusCallback.
+              #   Possible values: `in-progress`, `completed`, `failed`. To specify multiple
+              #   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.
+              # @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`.
+              # @param [String] trim Possible values: `trim-silence` or `do-not-trim`.
               #   `trim-silence` will trim the silence from the beginning and end of the
               #   recording. `do-not-trim` will not trim the silence. Defaults to `do-not-trim`
-              # @param [String] recording_channels The recording_channels
+              # @param [String] recording_channels Possible values: `mono` or `dual`. `mono`
+              #   records all parties of your call into one channel. `dual` records a 2 party call
+              #   into separate channels. Defaults to `mono`.
               # @return [RecordingInstance] Newly created RecordingInstance
               def create(recording_status_callback_event: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, trim: :unset, recording_channels: :unset)
                 data = Twilio::Values.of({
@@ -231,10 +238,14 @@ module Twilio
               ##
               # Update the RecordingInstance
               # @param [recording.Status] status The status to change the recording to. 
-              #   Possible values : stopped, paused, in-progress
+              #   Possible values: `stopped`, `paused`, `in-progress`
+              # @param [String] pause_behavior Possible values: `skip` or `silence`. `skip` will
+              #   result in no recording at all during the pause period. `silence` will replace
+              #   the actual audio of the call with silence during the pause period.  Defaults to
+              #   `silence`
               # @return [RecordingInstance] Updated RecordingInstance
-              def update(status: nil)
-                data = Twilio::Values.of({'Status' => status, })
+              def update(status: nil, pause_behavior: :unset)
+                data = Twilio::Values.of({'Status' => status, 'PauseBehavior' => pause_behavior, })
 
                 payload = @version.update(
                     'POST',
@@ -449,10 +460,14 @@ module Twilio
               ##
               # Update the RecordingInstance
               # @param [recording.Status] status The status to change the recording to. 
-              #   Possible values : stopped, paused, in-progress
+              #   Possible values: `stopped`, `paused`, `in-progress`
+              # @param [String] pause_behavior Possible values: `skip` or `silence`. `skip` will
+              #   result in no recording at all during the pause period. `silence` will replace
+              #   the actual audio of the call with silence during the pause period.  Defaults to
+              #   `silence`
               # @return [RecordingInstance] Updated RecordingInstance
-              def update(status: nil)
-                context.update(status: status, )
+              def update(status: nil, pause_behavior: :unset)
+                context.update(status: status, pause_behavior: pause_behavior, )
               end
 
               ##

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

@@ -196,10 +196,14 @@ module Twilio
               ##
               # Update the RecordingInstance
               # @param [recording.Status] status The status to change the recording to. 
-              #   Possible values : stopped, paused, in-progress
+              #   Possible values: `stopped`, `paused`, `in-progress`
+              # @param [String] pause_behavior Possible values: `skip` or `silence`. `skip` will
+              #   result in no recording at all during the pause period. `silence` will replace
+              #   the actual audio of the call with silence during the pause period.  Defaults to
+              #   `silence`
               # @return [RecordingInstance] Updated RecordingInstance
-              def update(status: nil)
-                data = Twilio::Values.of({'Status' => status, })
+              def update(status: nil, pause_behavior: :unset)
+                data = Twilio::Values.of({'Status' => status, 'PauseBehavior' => pause_behavior, })
 
                 payload = @version.update(
                     'POST',
@@ -418,10 +422,14 @@ module Twilio
               ##
               # Update the RecordingInstance
               # @param [recording.Status] status The status to change the recording to. 
-              #   Possible values : stopped, paused, in-progress
+              #   Possible values: `stopped`, `paused`, `in-progress`
+              # @param [String] pause_behavior Possible values: `skip` or `silence`. `skip` will
+              #   result in no recording at all during the pause period. `silence` will replace
+              #   the actual audio of the call with silence during the pause period.  Defaults to
+              #   `silence`
               # @return [RecordingInstance] Updated RecordingInstance
-              def update(status: nil)
-                context.update(status: status, )
+              def update(status: nil, pause_behavior: :unset)
+                context.update(status: status, pause_behavior: pause_behavior, )
               end
 
               ##

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

@@ -43,6 +43,7 @@ module Twilio
         @wireless = nil
         @sync = nil
         @studio = nil
+        @verify = nil
       end
 
       ##
@@ -201,6 +202,12 @@ module Twilio
         @studio ||= Studio.new self
       end
 
+      ##
+      # Access the Verify Twilio Domain
+      def verify
+        @verify ||= Verify.new self
+      end
+
       ##
       # @param [String] sid A 34 character string that uniquely identifies this address.
       # @return [Twilio::REST::Api::V2010::AccountContext::AddressInstance] if sid was passed.

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

@@ -19,6 +19,7 @@ module Twilio
         @port = 443
 
         # Versions
+        @authy = nil
         @bulk_exports = nil
         @deployed_devices = nil
         @hosted_numbers = nil
@@ -27,6 +28,13 @@ module Twilio
         @sync = nil
         @understand = nil
         @wireless = nil
+        @permissions = nil
+      end
+
+      ##
+      # Version authy of preview
+      def authy
+        @authy ||= Authy.new self
       end
 
       ##
@@ -77,6 +85,20 @@ module Twilio
         @wireless ||= Wireless.new self
       end
 
+      ##
+      # Version permissions of preview
+      def permissions
+        @permissions ||= Permissions.new self
+      end
+
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Preview::Sync::ServiceInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::Sync::ServiceList]
+      def services(sid=:unset)
+        self.sync.services(sid)
+      end
+
       ##
       # @param [String] resource_type The resource_type
       # @return [Twilio::REST::Preview::BulkExports::ExportInstance] if resource_type was passed.
@@ -138,14 +160,6 @@ module Twilio
         self.marketplace.available_add_ons(sid)
       end
 
-      ##
-      # @param [String] sid The sid
-      # @return [Twilio::REST::Preview::Sync::ServiceInstance] if sid was passed.
-      # @return [Twilio::REST::Preview::Sync::ServiceList]
-      def services(sid=:unset)
-        self.sync.services(sid)
-      end
-
       ##
       # @param [String] sid A 34 character string that uniquely identifies this
       #   resource.
@@ -179,6 +193,12 @@ module Twilio
         self.wireless.sims(sid)
       end
 
+      ##
+      # @return [Twilio::REST::Preview::Permissions::VoicePermissionInstance]
+      def voice_permissions
+        self.permissions.voice_permissions()
+      end
+
       ##
       # Provide a user friendly representation
       def to_s

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

@@ -0,0 +1,43 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Preview
+      class Authy < Version
+        ##
+        # Initialize the Authy version of Preview
+        def initialize(domain)
+          super
+          @version = 'Authy'
+          @services = nil
+        end
+
+        ##
+        # @param [String] sid A 34 character string that uniquely identifies this Service.
+        # @return [Twilio::REST::Preview::Authy::ServiceContext] if sid was passed.
+        # @return [Twilio::REST::Preview::Authy::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
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Preview::Authy>'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,364 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class Authy < 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.Preview.Authy.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.Preview.Authy.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
+
+          ##
+          # 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.Preview.Authy.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
+
+          ##
+          # 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.Preview.Authy.ServiceInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.Authy.ServiceInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end