twilio-ruby 5.0.0.rc19 → 5.0.0.rc20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dba18a84d3ea275b33269aff666af1928443e47a
-  data.tar.gz: 5e97a408b7bc62067632cfcc37a38c20fadb3a6b
+  metadata.gz: 5a237c668281992d46d1bdd3c6d9417a8f2ca040
+  data.tar.gz: 70bcf47381f5e55675fe35ac01bee5de15355f36
 SHA512:
-  metadata.gz: bb1727016dd35b1ef9259b94a03e00debed4231c3d86e0625c2d081412881d7a586224d60d6f3b30affc807543f8aca058adbe6ac68aeb26687bf6a74d061c48
-  data.tar.gz: d5bb365effca9041f73b11bd614447188491ecdfbb7c9c13e37c4b93defd9aa56c754cdfe63e1b7b4c7c6eaa8eb877f195c034f0965f765b2ccba91b0f19317f
+  metadata.gz: be90b36898a29bdb6744d61a45199a0f47bfe128010f7c61088ef4ecd90d77f1f35e06b54c3f4ded8da47ee86e1c520e021a8bfc87b727816ef2e7be91525568
+  data.tar.gz: 020e62824e298f3c106e9a4fcd38d97b1e8f6202a92623cd227a8586dc501a3ffcfaf414f187ede70044340034e4ad41afd6001e13d0577421aa475d6eb84f71

data/CHANGES.md

@@ -1,6 +1,14 @@
 twilio-ruby changelog
 =====================
 
+[2017-05-22] Version 5.0.0-rc20
+- Add Wireless Domain
+- Add Fax Domain
+- Add Video Domain
+- Updated Usage Trigger enums with missing categories.
+- Add `area_code_geomatch`, `validtiy_period`, `fallback_to_long_code` to Messaging Service
+- Converted `TwilioException` to `TwilioError`
+
 [2017-04-27] Version 5.0.0-rc19
 ------------------
 

data/README.md

@@ -11,13 +11,13 @@ A module for using the Twilio REST API and generating valid [TwiML](http://www.t
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.0.0.rc17'
+gem 'twilio-ruby', '~> 5.0.0.rc20'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.0.0.rc17
+gem install twilio-ruby -v 5.0.0.rc20
 ```
 
 To build and install the development branch yourself from the latest source:

data/VERSIONS.md

@@ -0,0 +1,64 @@
+# Versioning Strategy
+
+`twilio-ruby` uses a modified version of [Semantic Versioning][semver] for all 
+changes to the helper library.  It is strongly encouraged that you pin at least 
+the major version and potentially the minor version to avoid pulling in breaking 
+changes.
+
+Semantic Versions take the form of `MAJOR`.`MINOR`.`PATCH`
+
+When bugs are fixed in the library in a backwards compatible way, the `PATCH` 
+level will be incremented by one.  When new features are added to the library 
+in a backwards compatible way, the `PATCH` level will be incremented by one.
+`PATCH` changes should _not_ break your code and are generally safe for upgrade.
+
+When a new large feature set comes online or a small breaking change is 
+introduced, the `MINOR` version will be incremented by one and the `PATCH` 
+version reset to zero. `MINOR` changes _may_ require some amount of manual code
+change for upgrade. These backwards-incompatible changes will generally be limited 
+to a small number of function signature changes.
+
+The `MAJOR` version is used to indicate the family of technology represented by 
+the helper library.  It increased from `4.x.x` to `5.x.x` when Twilio moved to 
+auto generation of helper libraries.  Breaking changes that requires extensive 
+reworking of code (like the `4.x.x` to `5.x.x` upgrade) will case the `MAJOR` 
+version to be incremented by one, the `MINOR` and `PATCH` versions will be reset 
+to zero.  Twilio understands that this can be very disruptive, we will only 
+introduce this type of breaking change when absolutely necessary. New `MAJOR` 
+versions will be communicated in advance with `Release Candidates` and a 
+schedule.
+
+## Supported Versions
+
+`twilio-ruby` follows an evergreen model of support.  New features and 
+functionality will only be added to the current version.  The current version - 
+1 will continue to be supported with bugfixes and security updates, but no new 
+features.
+
+## Edge Features (alpha Branch)
+
+Twilio frequently rolls out new features in public and private beta periods.
+Twilio strives to ship early and often and bake customer feedback back into our 
+products.  To support that mission, the `twilio-ruby` helper library has an 
+`Edge` version based of the `alpha` branch.  This version is identified with an
+`alpha` metadata tag on the version number.
+
+The way the `Edge` artifact is created is by playing the `Edge` features on top
+of our stable artifact.  The `Edge` artifact will always have the same version 
+number as the stable artifact it was created from, but with an `alpha` suffix.
+
+For example, `5.0.0-alpha-1` is the `5.0.0` branch with `Edge` features included.
+If there is a change to one of the `Edge` features we may regenerate the `Edge`
+artifact and release a new `5.0.0-alpha-2`, new `Edge` artifacts simply increment
+the number after the `alpha` suffix.  All `Edge` features are considered 
+unstable and a backwards incompatible change in an `Edge` feature will not cause
+any version change so you should take care when upgrading from one `alpha` 
+version to another.  
+
+Once an `Edge` feature has matured it will be considered `Mainline` and included
+in the stable artifact, with a `MAJOR` or `MINOR` version bump.
+
+To use an `Edge` artifact in your Ruby project you will have to make sure that 
+you pin the artifact with `alpha` stability in your `pom.xml`.
+
+[semver]: http://semver.org/

data/lib/twilio-ruby/framework/{exception.rb → error.rb}

@@ -1,6 +1,6 @@
 module Twilio
   module REST
-    class TwilioException < Exception
+    class TwilioError < StandardError
       attr_reader :message, :body
 
       def initialize(message, body = nil)
@@ -13,7 +13,7 @@ module Twilio
       end
     end
 
-    class RestException < TwilioException
+    class RestError < TwilioError
       attr_reader :message, :code, :status_code
 
       def initialize(message, code, status_code)
@@ -26,5 +26,6 @@ module Twilio
         "[HTTP #{status_code}] #{code} : #{message}"
       end
     end
+
   end
 end

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

@@ -28,7 +28,7 @@ module Twilio
 
       def process_response(response)
         if response.status_code != 200
-          raise Twilio::REST::TwilioException.new('Unable to fetch page', response)
+          raise Twilio::REST::TwilioError.new('Unable to fetch page', response)
         end
 
         response.body
@@ -45,7 +45,7 @@ module Twilio
           end
         end
 
-        raise Twilio::REST::TwilioException.new('Page Records can not be deserialized')
+        raise Twilio::REST::TwilioError.new('Page Records can not be deserialized')
       end
 
       def previous_page_url
@@ -69,7 +69,7 @@ module Twilio
       end
 
       def get_instance(payload)
-        raise Twilio::REST::TwilioException.new('Page.get_instance() must be implemented in the derived class')
+        raise Twilio::REST::TwilioError.new('Page.get_instance() must be implemented in the derived class')
       end
 
       def previous_page

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

@@ -17,6 +17,15 @@ module Twilio
     end
   end
 
+  def self.serialize_object(object)
+    if object.is_a?(Hash) or object.is_a?(Array)
+      require 'json'
+      JSON.generate(object)
+    else
+      object
+    end
+  end
+
   def self.flatten(map, result={}, previous=[])
     map.each do |key, value|
       if value.is_a? Hash

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

@@ -74,7 +74,7 @@ module Twilio
           code = response.body['code']
         end
 
-        return Twilio::REST::RestException.new(message, code, response.status_code)
+        return Twilio::REST::RestError.new(message, code, response.status_code)
       end
 
       def fetch(method, uri, params={}, data={}, headers={}, auth=nil, timeout=nil)

data/lib/twilio-ruby/http/http_client.rb

@@ -18,6 +18,7 @@ module Twilio
       end
 
       def request(host, port, method, url, params={}, data={}, headers={}, auth=nil, timeout=nil)
+        puts(url)
         @connection = Faraday.new(url: host + ":" + port.to_s, ssl: {verify: true}) do |f|
           f.request :url_encoded
           f.adapter @adapter

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

@@ -187,6 +187,34 @@ module Twilio
         end
       end
 
+      class TaskRouterGrant
+        attr_accessor :workspace_sid,
+                      :worker_sid,
+                      :role
+
+        def key
+          'task_router'
+        end
+
+        def payload
+          payload = {}
+
+          if workspace_sid
+            payload[:workspace_sid] = workspace_sid
+          end
+
+          if worker_sid
+            payload[:worker_sid] = worker_sid
+          end
+
+          if role
+            payload[:role] = role
+          end
+
+          payload
+        end
+      end
+
 
     end
   end

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

@@ -9,13 +9,14 @@ module Twilio
     ##
     # A client for accessing the Twilio API.
     class Client
-      attr_accessor :http_client, :username, :password, :account_sid, :auth_token
+      attr_accessor :http_client, :username, :password, :account_sid, :auth_token, :region
 
       ##
       # Initializes the Twilio Client
-      def initialize(username=nil, password=nil, account_sid=nil, http_client=Twilio::HTTP::Client.new)
+      def initialize(username=nil, password=nil, account_sid=nil, region=nil, http_client=Twilio::HTTP::Client.new)
         @username = username || Twilio.account_sid
         @password = password || Twilio.auth_token
+        @region = region
         @account_sid = account_sid || @username
         @auth_token = @password
         @auth = [@username, @password]
@@ -36,6 +37,8 @@ module Twilio
         @trunking = nil
         @video = nil
         @messaging = nil
+        @wireless = nil
+        @sync = nil
       end
 
       ##
@@ -57,6 +60,13 @@ module Twilio
           headers['Accept'] = 'application/json'
         end
 
+        if !region.nil?
+            head, tail  = uri.split('.', 2)
+            if !tail.start_with?(region)
+                uri = [head, region, tail].join('.')
+            end
+        end
+
         @http_client.request(
           host,
           port,
@@ -154,96 +164,108 @@ module Twilio
         @messaging ||= Messaging.new self
       end
 
-      def addresses
-        return self.api.v2010.account.addresses
+      ##
+      # Access the Wireless Twilio Domain
+      def wireless
+        @wireless ||= Wireless.new self
+      end
+
+      ##
+      # Access the Sync Twilio Domain
+      def sync
+        @sync ||= Sync.new self
+      end
+
+      def addresses(sid=:unset)
+        self.api.v2010.account.addresses(sid)
       end
 
-      def applications
-        return self.api.v2010.account.applications
+      def applications(sid=:unset)
+        self.api.v2010.account.applications(sid)
       end
 
-      def authorized_connect_apps
-        return self.api.v2010.account.authorized_connect_apps
+      def authorized_connect_apps(sid=:unset)
+        self.api.v2010.account.authorized_connect_apps(sid)
       end
 
-      def available_phone_numbers
-        return self.api.v2010.account.available_phone_numbers
+      def available_phone_numbers(sid=:unset)
+        self.api.v2010.account.available_phone_numbers(sid)
       end
 
-      def calls
-        return self.api.v2010.account.calls
+      def calls(sid=:unset)
+        self.api.v2010.account.calls(sid)
       end
 
-      def conferences
-        return self.api.v2010.account.conferences
+      def conferences(sid=:unset)
+        self.api.v2010.account.conferences(sid)
       end
 
-      def connect_apps
-        return self.api.v2010.account.connect_apps
+      def connect_apps(sid=:unset)
+        self.api.v2010.account.connect_apps(sid)
       end
 
-      def incoming_phone_numbers
-        return self.api.v2010.account.incoming_phone_numbers
+      def incoming_phone_numbers(sid=:unset)
+        self.api.v2010.account.incoming_phone_numbers(sid)
       end
 
-      def keys
-        return self.api.v2010.account.keys
+      def keys(sid=:unset)
+        self.api.v2010.account.keys(sid)
       end
 
-      def messages
-        return self.api.v2010.account.messages
+      def messages(sid=:unset)
+        self.api.v2010.account.messages(sid)
       end
 
       def new_keys
-        return self.api.v2010.account.new_keys
+        self.api.v2010.account.new_keys
       end
 
       def new_signing_keys
-        return self.api.v2010.account.new_signing_keys
+        self.api.v2010.account.new_signing_keys
       end
 
-      def notifications
-        return self.api.v2010.account.notifications
+      def notifications(sid=:unset)
+        self.api.v2010.account.notifications(sid)
       end
 
-      def outgoing_caller_ids
-        return self.api.v2010.account.outgoing_caller_ids
+      def outgoing_caller_ids(sid=:unset)
+        self.api.v2010.account.outgoing_caller_ids(sid)
       end
 
-      def queues
-        return self.api.v2010.account.queues
+      def queues(sid=:unset)
+        self.api.v2010.account.queues(sid)
       end
 
-      def recordings
-        return self.api.v2010.account.recordings
+      def recordings(sid=:unset)
+        self.api.v2010.account.recordings(sid)
       end
 
-      def signing_keys
-        return self.api.v2010.account.signing_keys
+      def signing_keys(sid=:unset)
+        self.api.v2010.account.signing_keys(sid)
       end
 
       def sip
-        return self.api.v2010.account.sip
+        self.api.v2010.account.sip
       end
 
-      def short_codes
-        return self.api.v2010.account.short_codes
+      def short_codes(sid=:unset)
+        self.api.v2010.account.short_codes(sid)
       end
 
       def tokens
-        return self.api.v2010.account.tokens
+        self.api.v2010.account.tokens
       end
 
-      def transcriptions
-        return self.api.v2010.account.transcriptions
+      def transcriptions(sid=:unset)
+        self.api.v2010.account.transcriptions(sid)
       end
 
       def usage
-        return self.api.v2010.account.usage
+        self.api.v2010.account.usage
       end
 
       def validation_requests
-        return self.api.v2010.account.validation_requests
+        self.api.v2010.account.validation_requests
       end
 
       ##

data/lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb

@@ -0,0 +1,303 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Fax < Domain
+      class V1 < Version
+        class FaxContext < InstanceContext
+          class FaxMediaList < ListResource
+            ##
+            # Initialize the FaxMediaList
+            # @param [Version] version Version that contains the resource
+            # @param [String] fax_sid The fax_sid
+            # @return [FaxMediaList] FaxMediaList
+            def initialize(version, fax_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {
+                  fax_sid: fax_sid
+              }
+              @uri = "/Faxes/#{@solution[:fax_sid]}/Media"
+            end
+
+            ##
+            # Lists FaxMediaInstance 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 FaxMediaInstance 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 FaxMediaInstance records from the API.
+            # 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)
+            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 FaxMediaInstance 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 FaxMediaInstance
+            def page(page_token: nil, page_number: nil, page_size: nil)
+              params = {
+                  'PageToken' => page_token,
+                  'Page' => page_number,
+                  'PageSize' => page_size,
+              }
+              response = @version.page(
+                  'GET',
+                  @uri,
+                  params
+              )
+              return FaxMediaPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Fax.V1.FaxMediaList>'
+            end
+          end
+
+          class FaxMediaPage < Page
+            ##
+            # Initialize the FaxMediaPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @param [String] fax_sid The fax_sid
+            # @return [FaxMediaPage] FaxMediaPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of FaxMediaInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [FaxMediaInstance] FaxMediaInstance
+            def get_instance(payload)
+              return FaxMediaInstance.new(
+                  @version,
+                  payload,
+                  fax_sid: @solution[:fax_sid],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Fax.V1.FaxMediaPage>'
+            end
+          end
+
+          class FaxMediaContext < InstanceContext
+            ##
+            # Initialize the FaxMediaContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] fax_sid The fax_sid
+            # @param [String] sid The sid
+            # @return [FaxMediaContext] FaxMediaContext
+            def initialize(version, fax_sid, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {
+                  fax_sid: fax_sid,
+                  sid: sid,
+              }
+              @uri = "/Faxes/#{@solution[:fax_sid]}/Media/#{@solution[:sid]}"
+            end
+
+            ##
+            # Fetch a FaxMediaInstance
+            # @return [FaxMediaInstance] Fetched FaxMediaInstance
+            def fetch
+              params = {}
+
+              payload = @version.fetch(
+                  'GET',
+                  @uri,
+                  params,
+              )
+
+              return FaxMediaInstance.new(
+                  @version,
+                  payload,
+                  fax_sid: @solution[:fax_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Deletes the FaxMediaInstance
+            # @return [Boolean] true if delete succeeds, true otherwise
+            def delete
+              return @version.delete('delete', @uri)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Fax.V1.FaxMediaContext #{context}>"
+            end
+          end
+
+          class FaxMediaInstance < InstanceResource
+            ##
+            # Initialize the FaxMediaInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] fax_sid The fax_sid
+            # @param [String] sid The sid
+            # @return [FaxMediaInstance] FaxMediaInstance
+            def initialize(version, payload, fax_sid: nil, sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'account_sid' => payload['account_sid'],
+                  'fax_sid' => payload['fax_sid'],
+                  'content_type' => payload['content_type'],
+                  'date_created' => Twilio.deserialize_iso8601(payload['date_created']),
+                  'date_updated' => Twilio.deserialize_iso8601(payload['date_updated']),
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {
+                  'fax_sid' => fax_sid,
+                  '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
+            # @param [Version] version Version that contains the resource
+            # @return [FaxMediaContext] FaxMediaContext for this FaxMediaInstance
+            def context
+              unless @instance_context
+                @instance_context = FaxMediaContext.new(
+                    @version,
+                    @params['fax_sid'],
+                    @params['sid'],
+                )
+              end
+              @instance_context
+            end
+
+            def sid
+              @properties['sid']
+            end
+
+            def account_sid
+              @properties['account_sid']
+            end
+
+            def fax_sid
+              @properties['fax_sid']
+            end
+
+            def content_type
+              @properties['content_type']
+            end
+
+            def date_created
+              @properties['date_created']
+            end
+
+            def date_updated
+              @properties['date_updated']
+            end
+
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Fetch a FaxMediaInstance
+            # @return [FaxMediaInstance] Fetched FaxMediaInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Deletes the FaxMediaInstance
+            # @return [Boolean] true if delete succeeds, true otherwise
+            def delete
+              context.delete
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Fax.V1.FaxMediaInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end