twilio-ruby 5.3.0 → 5.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 088b6c58d49ae8c6b5aab315bccc32e9660daaba
-  data.tar.gz: 9c3e344611be8f54f83c719d8c56e79a2008112f
+  metadata.gz: 28600f3f5e0d481da956dbb2220933c52aa949dd
+  data.tar.gz: 83b9e42f778ae67c4d9d3c7a6690cbabba9de09d
 SHA512:
-  metadata.gz: f160ffb9e3c889ee406c611c98f8870e925bc78ea91a397911f6ba888dc5c342516cae66455237f153cdff01313096c8e54ecf60efb45d2648057b0342653a67
-  data.tar.gz: f3aeabd256f24bd9f60cf77dc7fa2e659446a2d5eb88f91e385613c836254afdd83efe089546c33d8fc0e4b272329d5db14e5d7f48e17a9e2703c43759af54f1
+  metadata.gz: 88883d2d4ba13c23d42d602e8e244d1606b717197cb854a9803a8c6f0da6338c179e6ac55a7f24b9c3965eda91936ccd50e2611acc3653c594c7277134e16ca3
+  data.tar.gz: 95c16494c7f80f1ce8d22891a81e5fd1fc64e0bb0af5b38f0457a30d21b01be950030fe5b5e7709f80f6cd29d2477ca1e9346c6a440c2f19c0fea932d91c7a3b

data/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
     - 'spec/integration/**/*'
     - 'lib/twilio-ruby/version.rb'
     - 'lib/twilio-ruby/twiml/**/*'
+    - 'lib/twilio-ruby/util/configuration.rb'
 
 Metrics/LineLength:
   Max: 120

data/CHANGES.md

@@ -1,6 +1,15 @@
 twilio-ruby changelog
 =====================
 
+[2017-10-06] Version 5.3.1
+---------------------------
+**Preview**
+- Add `acc_security` (authy-phone-verification) initial api-definitions
+
+**Taskrouter**
+- [bi] Less verbose naming of cumulative and real time statistics
+
+
 [2017-09-29] Version 5.3.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.3.0'
+gem 'twilio-ruby', '~> 5.3.1'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.3.0
+gem install twilio-ruby -v 5.3.1
 ```
 
 To build and install the development branch yourself from the latest source:
@@ -66,15 +66,6 @@ auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 
 # set up a client to talk to the Twilio REST API
 @client = Twilio::REST::Client.new account_sid, auth_token
-
-# alternatively, you can preconfigure the client like so
-Twilio.configure do |config|
-  config.account_sid = account_sid
-  config.auth_token = auth_token
-end
-
-# and then you can create a new client without parameters
-@client = Twilio::REST::Client.new
 ```
 
 ### Make a Call

data/lib/twilio-ruby.rb

@@ -17,6 +17,7 @@ require 'twilio-ruby/jwt/access_token'
 require 'twilio-ruby/jwt/client_capability'
 require 'twilio-ruby/jwt/task_router'
 require 'twilio-ruby/security/request_validator'
+require 'twilio-ruby/util/configuration'
 
 require 'twilio-ruby/twiml/twiml'
 require 'twilio-ruby/twiml/voice_response'
@@ -40,4 +41,20 @@ end
 
 module Twilio
   extend SingleForwardable
+
+  def_delegators :configuration, :account_sid, :auth_token
+
+  ##
+  # Pre-configure with account SID and auth token so that you don't need to
+  # pass them to various initializers each time.
+  def self.configure(&block)
+    yield configuration
+  end
+
+  ##
+  # Returns an existing or instantiates a new configuration object.
+  def self.configuration
+    @configuration ||= Util::Configuration.new
+  end
+  private_class_method :configuration
 end

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

@@ -14,8 +14,8 @@ module Twilio
       ##
       # Initializes the Twilio Client
       def initialize(username=nil, password=nil, account_sid=nil, region=nil, http_client=Twilio::HTTP::Client.new)
-        @username = username
-        @password = password
+        @username = username || Twilio.account_sid
+        @password = password || Twilio.auth_token
         @region = region
         @account_sid = account_sid || @username
         @auth_token = @password
@@ -394,4 +394,4 @@ module Twilio
     # Dummy client which provides no functionality. Please use Twilio::REST::Client instead.
     class TrunkingClient < ObsoleteClient; end
   end
-end
+end

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

@@ -22,6 +22,7 @@ module Twilio
         @hosted_numbers = nil
         @marketplace = nil
         @proxy = nil
+        @acc_security = nil
         @sync = nil
         @wireless = nil
       end
@@ -56,6 +57,12 @@ module Twilio
         @proxy ||= Proxy.new self
       end
 
+      ##
+      # Version acc_security of preview
+      def acc_security
+        @acc_security ||= AccSecurity.new self
+      end
+
       ##
       # Version sync of preview
       def sync

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

@@ -0,0 +1,41 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Preview
+      class AccSecurity < Version
+        ##
+        # Initialize the AccSecurity version of Preview
+        def initialize(domain)
+          super
+          @version = 'Verification'
+          @services = nil
+        end
+
+        ##
+        # @param [String] sid The unique SID identifier of Verification Service Instance.
+        # @return [Twilio::REST::Preview::AccSecurity::ServiceInstance] if sid was passed.
+        # @return [Twilio::REST::Preview::AccSecurity::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::AccSecurity>'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,429 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class AccSecurity < 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] name A 1-64 character string with friendly name of service
+          # @param [String] code_length The length of the verification code to be generated.
+          #   Must be an integer value between 4-10
+          # @return [ServiceInstance] Newly created ServiceInstance
+          def create(name: nil, code_length: :unset)
+            data = Twilio::Values.of({
+                'Name' => name,
+                'CodeLength' => code_length,
+            })
+
+            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.AccSecurity.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.AccSecurity.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 The unique SID identifier of Verification Service Instance.
+          # @return [ServiceContext] ServiceContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {
+                sid: sid,
+            }
+            @uri = "/Services/#{@solution[:sid]}"
+
+            # Dependents
+            @verifications = nil
+            @verification_checks = 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] name A 1-64 character string with friendly name of service
+          # @param [String] code_length The length of the verification code to be generated.
+          #   Must be an integer value between 4-10
+          # @return [ServiceInstance] Updated ServiceInstance
+          def update(name: :unset, code_length: :unset)
+            data = Twilio::Values.of({
+                'Name' => name,
+                'CodeLength' => code_length,
+            })
+
+            payload = @version.update(
+                'POST',
+                @uri,
+                data: data,
+            )
+
+            ServiceInstance.new(
+                @version,
+                payload,
+                sid: @solution[:sid],
+            )
+          end
+
+          ##
+          # Access the verifications
+          # @return [VerificationList]
+          # @return [VerificationContext]
+          def verifications
+            unless @verifications
+              @verifications = VerificationList.new(
+                  @version,
+                  service_sid: @solution[:sid],
+              )
+            end
+
+            @verifications
+          end
+
+          ##
+          # Access the verification_checks
+          # @return [VerificationCheckList]
+          # @return [VerificationCheckContext]
+          def verification_checks
+            unless @verification_checks
+              @verification_checks = VerificationCheckList.new(
+                  @version,
+                  service_sid: @solution[:sid],
+              )
+            end
+
+            @verification_checks
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.AccSecurity.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 The unique SID identifier of Verification Service Instance.
+          # @return [ServiceInstance] ServiceInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'account_sid' => payload['account_sid'],
+                'name' => payload['name'],
+                'code_length' => payload['code_length'].to_i,
+                '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] Account Sid.
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] Friendly name of the service
+          def name
+            @properties['name']
+          end
+
+          ##
+          # @return [String] Length of verification code. Valid values are 4-10
+          def code_length
+            @properties['code_length']
+          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
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] The links
+          def links
+            @properties['links']
+          end
+
+          ##
+          # Fetch a ServiceInstance
+          # @return [ServiceInstance] Fetched ServiceInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Update the ServiceInstance
+          # @param [String] name A 1-64 character string with friendly name of service
+          # @param [String] code_length The length of the verification code to be generated.
+          #   Must be an integer value between 4-10
+          # @return [ServiceInstance] Updated ServiceInstance
+          def update(name: :unset, code_length: :unset)
+            context.update(
+                name: name,
+                code_length: code_length,
+            )
+          end
+
+          ##
+          # Access the verifications
+          # @return [verifications] verifications
+          def verifications
+            context.verifications
+          end
+
+          ##
+          # Access the verification_checks
+          # @return [verification_checks] verification_checks
+          def verification_checks
+            context.verification_checks
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.AccSecurity.ServiceInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.AccSecurity.ServiceInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end