twilio-ruby 5.0.0.rc18 → 5.0.0.rc19

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

@@ -2,7 +2,7 @@
 # This code was generated by
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /       
+#       /       /
 
 module Twilio
   module REST
@@ -10,7 +10,7 @@ module Twilio
     # A client for accessing the Twilio API.
     class Client
       attr_accessor :http_client, :username, :password, :account_sid, :auth_token
-      
+
       ##
       # Initializes the Twilio Client
       def initialize(username=nil, password=nil, account_sid=nil, http_client=Twilio::HTTP::Client.new)
@@ -20,10 +20,12 @@ module Twilio
         @auth_token = @password
         @auth = [@username, @password]
         @http_client = http_client
-        
+
         # Domains
+        @accounts = nil
         @api = nil
         @chat = nil
+        @fax = nil
         @ip_messaging = nil
         @lookups = nil
         @monitor = nil
@@ -32,27 +34,29 @@ module Twilio
         @pricing = nil
         @taskrouter = nil
         @trunking = nil
+        @video = nil
+        @messaging = nil
       end
-      
+
       ##
       # Makes a request to the Twilio API using the configured http client
       # Authentication information is automatically added if none is provided
       def request(host, port, method, uri, params={}, data={}, headers={}, auth=nil, timeout=nil)
         auth ||= @auth
-        
+
         headers['User-Agent'] = "twilio-ruby/#{Twilio::VERSION}" +
                                 " (#{RUBY_ENGINE}/#{RUBY_PLATFORM}" +
                                 " #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL})"
         headers['Accept-Charset'] = 'utf-8'
-        
+
         if method == 'POST' && !headers['Content-Type']
           headers['Content-Type'] = 'application/x-www-form-urlencoded'
         end
-        
+
         unless headers['Accept']
           headers['Accept'] = 'application/json'
         end
-        
+
         @http_client.request(
           host,
           port,
@@ -65,171 +69,183 @@ module Twilio
           timeout
         )
       end
-      
+
+      ##
+      # Access the Accounts Twilio Domain
+      def accounts
+        @accounts ||= Accounts.new self
+      end
+
       ##
       # Access the Api Twilio Domain
       def api
         @api ||= Api.new self
       end
-      
+
       ##
       # Access the Chat Twilio Domain
       def chat
         @chat ||= Chat.new self
       end
-      
+
+      ##
+      # Access the Fax Twilio Domain
+      def fax
+        @fax ||= Fax.new self
+      end
+
       ##
       # Access the IpMessaging Twilio Domain
       def ip_messaging
         @ip_messaging ||= IpMessaging.new self
       end
-      
+
       ##
       # Access the Lookups Twilio Domain
       def lookups
         @lookups ||= Lookups.new self
       end
-      
+
       ##
       # Access the Monitor Twilio Domain
       def monitor
         @monitor ||= Monitor.new self
       end
-      
+
       ##
       # Access the Notify Twilio Domain
       def notify
         @notify ||= Notify.new self
       end
-      
+
       ##
       # Access the Preview Twilio Domain
       def preview
         @preview ||= Preview.new self
       end
-      
+
       ##
       # Access the Pricing Twilio Domain
       def pricing
         @pricing ||= Pricing.new self
       end
-      
+
       ##
       # Access the Taskrouter Twilio Domain
       def taskrouter
         @taskrouter ||= Taskrouter.new self
       end
-      
+
       ##
       # Access the Trunking Twilio Domain
       def trunking
         @trunking ||= Trunking.new self
       end
-      
-      def account
-        return self.api.v2010.account
+
+      ##
+      # Access the Video Twilio Domain
+      def video
+        @video ||= Video.new self
       end
-      
-      def accounts
-        return self.api.v2010.accounts
+
+      ##
+      # Access the Messaging Twilio Domain
+      def messaging
+        @messaging ||= Messaging.new self
       end
-      
+
       def addresses
-        return self.account.addresses
+        return self.api.v2010.account.addresses
       end
-      
+
       def applications
-        return self.account.applications
+        return self.api.v2010.account.applications
       end
-      
+
       def authorized_connect_apps
-        return self.account.authorized_connect_apps
+        return self.api.v2010.account.authorized_connect_apps
       end
-      
+
       def available_phone_numbers
-        return self.account.available_phone_numbers
+        return self.api.v2010.account.available_phone_numbers
       end
-      
+
       def calls
-        return self.account.calls
+        return self.api.v2010.account.calls
       end
-      
+
       def conferences
-        return self.account.conferences
+        return self.api.v2010.account.conferences
       end
-      
+
       def connect_apps
-        return self.account.connect_apps
+        return self.api.v2010.account.connect_apps
       end
-      
+
       def incoming_phone_numbers
-        return self.account.incoming_phone_numbers
+        return self.api.v2010.account.incoming_phone_numbers
       end
-      
+
       def keys
-        return self.account.keys
+        return self.api.v2010.account.keys
       end
-      
+
       def messages
-        return self.account.messages
+        return self.api.v2010.account.messages
       end
-      
+
       def new_keys
-        return self.account.new_keys
+        return self.api.v2010.account.new_keys
       end
-      
+
       def new_signing_keys
-        return self.account.new_signing_keys
+        return self.api.v2010.account.new_signing_keys
       end
-      
+
       def notifications
-        return self.account.notifications
+        return self.api.v2010.account.notifications
       end
-      
+
       def outgoing_caller_ids
-        return self.account.outgoing_caller_ids
+        return self.api.v2010.account.outgoing_caller_ids
       end
-      
+
       def queues
-        return self.account.queues
+        return self.api.v2010.account.queues
       end
-      
+
       def recordings
-        return self.account.recordings
+        return self.api.v2010.account.recordings
       end
-      
-      def sandbox
-        return self.account.sandbox
-      end
-      
+
       def signing_keys
-        return self.account.signing_keys
+        return self.api.v2010.account.signing_keys
       end
-      
+
       def sip
-        return self.account.sip
+        return self.api.v2010.account.sip
       end
-      
+
       def short_codes
-        return self.account.short_codes
+        return self.api.v2010.account.short_codes
       end
-      
+
       def tokens
-        return self.account.tokens
+        return self.api.v2010.account.tokens
       end
-      
+
       def transcriptions
-        return self.account.transcriptions
+        return self.api.v2010.account.transcriptions
       end
-      
+
       def usage
-        return self.account.usage
+        return self.api.v2010.account.usage
       end
-      
+
       def validation_requests
-        return self.account.validation_requests
+        return self.api.v2010.account.validation_requests
       end
-      
+
       ##
       # Provide a user friendly representation
       def to_s

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

@@ -0,0 +1,40 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Fax < Domain
+      ##
+      # Initialize the Fax Domain
+      def initialize(twilio)
+        super
+
+        @base_url = 'https://fax.twilio.com'
+        @host = 'fax.twilio.com'
+        @port = 443
+
+        # Versions
+        @v1 = nil
+      end
+
+      ##
+      # Version v1 of fax
+      def v1
+        @v1 ||= V1.new self
+      end
+
+      def faxes
+        self.v1.faxes
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '#<Twilio::REST::Fax>'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Fax
+      class V1 < Version
+        ##
+        # Initialize the V1 version of Fax
+        def initialize(domain)
+          super
+          @version = 'v1'
+          @faxes = nil
+        end
+
+        def faxes(sid=:unset)
+          if sid == :unset
+            @faxes ||= FaxList.new self
+          else
+            FaxContext.new(self, sid)
+          end
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Fax::V1>'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,397 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Fax < Domain
+      class V1 < Version
+        class FaxList < ListResource
+          ##
+          # Initialize the FaxList
+          # @param [Version] version Version that contains the resource
+          # @return [FaxList] FaxList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Faxes"
+          end
+
+          ##
+          # Lists FaxInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @param [String] from The from
+          # @param [String] to The to
+          # @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(from: nil, to: nil, limit: nil, page_size: nil)
+            self.stream(
+                from: from,
+                to: to,
+                limit: limit,
+                page_size: page_size
+            ).entries
+          end
+
+          ##
+          # Streams FaxInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [String] from The from
+          # @param [String] to The to
+          # @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(from: nil, to: nil, limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(
+                from: from,
+                to: to,
+                page_size: limits[:page_size],
+            )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields FaxInstance records from the API.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [String] from The from
+          # @param [String] to The to
+          # @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 FaxInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] from The from
+          # @param [String] to The to
+          # @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 FaxInstance
+          def page(from: nil, to: nil, page_token: nil, page_number: nil, page_size: nil)
+            params = {
+                'From' => from,
+                'To' => to,
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            }
+            response = @version.page(
+                'GET',
+                @uri,
+                params
+            )
+            return FaxPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of FaxInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] from The from
+          # @param [String] to The to
+          # @param [String] media_url The media_url
+          # @param [fax.Quality] quality The quality
+          # @param [String] status_callback The status_callback
+          # @return [FaxInstance] Newly created FaxInstance
+          def create(from: nil, to: nil, media_url: nil, quality: nil, status_callback: nil)
+            data = {
+                'From' => from,
+                'To' => to,
+                'MediaUrl' => media_url,
+                'Quality' => quality,
+                'StatusCallback' => status_callback,
+            }
+
+            payload = @version.create(
+                'POST',
+                @uri,
+                data: data
+            )
+
+            return FaxInstance.new(
+                @version,
+                payload,
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Fax.V1.FaxList>'
+          end
+        end
+
+        class FaxPage < Page
+          ##
+          # Initialize the FaxPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [FaxPage] FaxPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of FaxInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [FaxInstance] FaxInstance
+          def get_instance(payload)
+            return FaxInstance.new(
+                @version,
+                payload,
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Fax.V1.FaxPage>'
+          end
+        end
+
+        class FaxContext < InstanceContext
+          ##
+          # Initialize the FaxContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The sid
+          # @return [FaxContext] FaxContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {
+                sid: sid,
+            }
+            @uri = "/Faxes/#{@solution[:sid]}"
+          end
+
+          ##
+          # Fetch a FaxInstance
+          # @return [FaxInstance] Fetched FaxInstance
+          def fetch
+            params = {}
+
+            payload = @version.fetch(
+                'GET',
+                @uri,
+                params,
+            )
+
+            return FaxInstance.new(
+                @version,
+                payload,
+                sid: @solution[:sid],
+            )
+          end
+
+          ##
+          # Update the FaxInstance
+          # @param [fax.UpdateStatus] status The status
+          # @return [FaxInstance] Updated FaxInstance
+          def update(status: nil)
+            data = {
+                'Status' => status,
+            }
+
+            payload = @version.update(
+                'POST',
+                @uri,
+                data: data,
+            )
+
+            return FaxInstance.new(
+                @version,
+                payload,
+                sid: @solution[:sid],
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Fax.V1.FaxContext #{context}>"
+          end
+        end
+
+        class FaxInstance < InstanceResource
+          ##
+          # Initialize the FaxInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The sid
+          # @return [FaxInstance] FaxInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'account_sid' => payload['account_sid'],
+                'from' => payload['from'],
+                'to' => payload['to'],
+                'quality' => payload['quality'],
+                'media_url' => payload['media_url'],
+                'num_pages' => payload['num_pages'] == nil ? payload['num_pages'] : payload['num_pages'].to_i,
+                'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
+                'status' => payload['status'],
+                'direction' => payload['direction'],
+                'api_version' => payload['api_version'],
+                'price' => payload['price'].to_f,
+                'price_unit' => payload['price_unit'],
+                'date_created' => Twilio.deserialize_iso8601(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601(payload['date_updated']),
+                'url' => payload['url'],
+            }
+
+            # 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
+          # @param [Version] version Version that contains the resource
+          # @return [FaxContext] FaxContext for this FaxInstance
+          def context
+            unless @instance_context
+              @instance_context = FaxContext.new(
+                  @version,
+                  @params['sid'],
+              )
+            end
+            @instance_context
+          end
+
+          def sid
+            @properties['sid']
+          end
+
+          def account_sid
+            @properties['account_sid']
+          end
+
+          def from
+            @properties['from']
+          end
+
+          def to
+            @properties['to']
+          end
+
+          def quality
+            @properties['quality']
+          end
+
+          def media_url
+            @properties['media_url']
+          end
+
+          def num_pages
+            @properties['num_pages']
+          end
+
+          def duration
+            @properties['duration']
+          end
+
+          def status
+            @properties['status']
+          end
+
+          def direction
+            @properties['direction']
+          end
+
+          def api_version
+            @properties['api_version']
+          end
+
+          def price
+            @properties['price']
+          end
+
+          def price_unit
+            @properties['price_unit']
+          end
+
+          def date_created
+            @properties['date_created']
+          end
+
+          def date_updated
+            @properties['date_updated']
+          end
+
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch a FaxInstance
+          # @return [FaxInstance] Fetched FaxInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Update the FaxInstance
+          # @param [fax.UpdateStatus] status The status
+          # @return [FaxInstance] Updated FaxInstance
+          def update(status: nil)
+            context.update(
+                status: status,
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Fax.V1.FaxInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end