twilio-ruby 5.0.0.alpha1 → 5.0.0.rc2

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

@@ -2,7 +2,7 @@
 # This code was generated by
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#       /       /       
 
 module Twilio
   module REST
@@ -16,10 +16,11 @@ module Twilio
               # @param [Version] version Version that contains the resource
               # @param [String] account_sid The account_sid
               # @param [String] recording_sid The recording_sid
+              
               # @return [TranscriptionList] TranscriptionList
               def initialize(version, account_sid: nil, recording_sid: nil)
                 super(version)
-
+                
                 # Path Solution
                 @solution = {
                     account_sid: account_sid,
@@ -27,7 +28,7 @@ module Twilio
                 }
                 @uri = "/Accounts/#{@solution[:account_sid]}/Recordings/#{@solution[:recording_sid]}/Transcriptions.json"
               end
-
+              
               ##
               # Lists TranscriptionInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
@@ -38,6 +39,7 @@ module Twilio
               #  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(
@@ -45,7 +47,7 @@ module Twilio
                     page_size: page_size
                 ).entries
               end
-
+              
               ##
               # Streams TranscriptionInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
@@ -56,108 +58,121 @@ module Twilio
               #  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],
+                    page_size: limits['page_size'],
                 )
-
-                @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                
+                @version.stream(page, limit: limits['limit'], page_limit: limits['page_limit'])
               end
-
+              
               ##
               # When passed a block, yields TranscriptionInstance 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],
+                    page_size: limits['page_size'],
                 )
-
+                
                 @version.stream(page,
-                                limit: limits[:limit],
-                                page_limit: limits[:page_limit]).each {|x| yield x}
+                                limit: limits['limit'],
+                                page_limit: limits['page_limit']).each {|x| yield x}
               end
-
+              
               ##
               # Retrieve a single page of TranscriptionInstance 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 TranscriptionInstance
-              def page(page_token: :unset, page_number: :unset, page_size: :unset)
-                params = Twilio::Values.of({
+              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
                 )
-                TranscriptionPage.new(@version, response, @solution)
+                return TranscriptionPage.new(@version, response, @solution)
               end
-
+              
               ##
-              # Retrieve a single page of TranscriptionInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] target_url API-generated URL for the requested results page
-              # @return [Page] Page of TranscriptionInstance
-              def get_page(target_url)
-                response = @version.domain.request(
-                    'GET',
-                    target_url
+              # Constructs a TranscriptionContext
+              # @param [String] sid The sid
+              
+              # @return [TranscriptionContext] TranscriptionContext
+              def get(sid)
+                TranscriptionContext.new(
+                    @version,
+                    account_sid: @solution[:account_sid],
+                    recording_sid: @solution[:recording_sid],
+                    sid: sid,
                 )
-                TranscriptionPage.new(@version, response, @solution)
               end
-
+              
               ##
               # Provide a user friendly representation
               def to_s
                 '#<Twilio.Api.V2010.TranscriptionList>'
               end
             end
-
+          
             class TranscriptionPage < Page
               ##
               # Initialize the TranscriptionPage
               # @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] account_sid The account_sid
+              # @param [String] recording_sid The recording_sid
+              
               # @return [TranscriptionPage] TranscriptionPage
               def initialize(version, response, solution)
                 super(version, response)
-
+                
                 # Path Solution
                 @solution = solution
               end
-
+              
               ##
               # Build an instance of TranscriptionInstance
               # @param [Hash] payload Payload response from the API
+              
               # @return [TranscriptionInstance] TranscriptionInstance
               def get_instance(payload)
-                TranscriptionInstance.new(
+                return TranscriptionInstance.new(
                     @version,
                     payload,
-                    account_sid: @solution[:account_sid],
-                    recording_sid: @solution[:recording_sid],
+                    account_sid: @solution['account_sid'],
+                    recording_sid: @solution['recording_sid'],
                 )
               end
-
+              
               ##
               # Provide a user friendly representation
               def to_s
                 '<Twilio.Api.V2010.TranscriptionPage>'
               end
             end
-
+          
             class TranscriptionContext < InstanceContext
               ##
               # Initialize the TranscriptionContext
@@ -165,10 +180,11 @@ module Twilio
               # @param [String] account_sid The account_sid
               # @param [String] recording_sid The recording_sid
               # @param [String] sid The sid
+              
               # @return [TranscriptionContext] TranscriptionContext
               def initialize(version, account_sid, recording_sid, sid)
                 super(version)
-
+                
                 # Path Solution
                 @solution = {
                     account_sid: account_sid,
@@ -177,35 +193,35 @@ module Twilio
                 }
                 @uri = "/Accounts/#{@solution[:account_sid]}/Recordings/#{@solution[:recording_sid]}/Transcriptions/#{@solution[:sid]}.json"
               end
-
+              
               ##
               # Fetch a TranscriptionInstance
               # @return [TranscriptionInstance] Fetched TranscriptionInstance
               def fetch
-                params = Twilio::Values.of({})
-
+                params = {}
+                
                 payload = @version.fetch(
                     'GET',
                     @uri,
                     params,
                 )
-
-                TranscriptionInstance.new(
+                
+                return TranscriptionInstance.new(
                     @version,
                     payload,
-                    account_sid: @solution[:account_sid],
-                    recording_sid: @solution[:recording_sid],
-                    sid: @solution[:sid],
+                    account_sid: @solution['account_sid'],
+                    recording_sid: @solution['recording_sid'],
+                    sid: @solution['sid'],
                 )
               end
-
+              
               ##
               # Deletes the TranscriptionInstance
               # @return [Boolean] true if delete succeeds, true otherwise
               def delete
-                @version.delete('delete', @uri)
+                return @version.delete('delete', @uri)
               end
-
+              
               ##
               # Provide a user friendly representation
               def to_s
@@ -213,7 +229,7 @@ module Twilio
                 "#<Twilio.Api.V2010.TranscriptionContext #{context}>"
               end
             end
-
+          
             class TranscriptionInstance < InstanceResource
               ##
               # Initialize the TranscriptionInstance
@@ -222,10 +238,11 @@ module Twilio
               # @param [String] account_sid The account_sid
               # @param [String] recording_sid The recording_sid
               # @param [String] sid The sid
+              
               # @return [TranscriptionInstance] TranscriptionInstance
               def initialize(version, payload, account_sid: nil, recording_sid: nil, sid: nil)
                 super(version)
-
+                
                 # Marshaled Properties
                 @properties = {
                     'account_sid' => payload['account_sid'],
@@ -242,7 +259,7 @@ module Twilio
                     'type' => payload['type'],
                     'uri' => payload['uri'],
                 }
-
+                
                 # Context
                 @instance_context = nil
                 @params = {
@@ -251,10 +268,12 @@ module Twilio
                     '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 [TranscriptionContext] TranscriptionContext for this TranscriptionInstance
               def context
                 unless @instance_context
@@ -267,104 +286,78 @@ module Twilio
                 end
                 @instance_context
               end
-
-              ##
-              # @return [String] The account_sid
+              
               def account_sid
                 @properties['account_sid']
               end
-
-              ##
-              # @return [String] The api_version
+              
               def api_version
                 @properties['api_version']
               end
-
-              ##
-              # @return [Time] The date_created
+              
               def date_created
                 @properties['date_created']
               end
-
-              ##
-              # @return [Time] The date_updated
+              
               def date_updated
                 @properties['date_updated']
               end
-
-              ##
-              # @return [String] The duration
+              
               def duration
                 @properties['duration']
               end
-
-              ##
-              # @return [String] The price
+              
               def price
                 @properties['price']
               end
-
-              ##
-              # @return [String] The price_unit
+              
               def price_unit
                 @properties['price_unit']
               end
-
-              ##
-              # @return [String] The recording_sid
+              
               def recording_sid
                 @properties['recording_sid']
               end
-
-              ##
-              # @return [String] The sid
+              
               def sid
                 @properties['sid']
               end
-
-              ##
-              # @return [transcription.Status] The status
+              
               def status
                 @properties['status']
               end
-
-              ##
-              # @return [String] The transcription_text
+              
               def transcription_text
                 @properties['transcription_text']
               end
-
-              ##
-              # @return [String] The type
+              
               def type
                 @properties['type']
               end
-
-              ##
-              # @return [String] The uri
+              
               def uri
                 @properties['uri']
               end
-
+              
               ##
               # Fetch a TranscriptionInstance
               # @return [TranscriptionInstance] Fetched TranscriptionInstance
               def fetch
-                context.fetch
+                @context.fetch()
               end
-
+              
               ##
               # Deletes the TranscriptionInstance
               # @return [Boolean] true if delete succeeds, true otherwise
               def delete
-                context.delete
+                @context.delete()
               end
-
+              
               ##
               # Provide a user friendly representation
               def to_s
-                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-                "<Twilio.Api.V2010.TranscriptionInstance #{values}>"
+                context = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Api.V2010.TranscriptionInstance #{context}>"
               end
             end
           end

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

@@ -0,0 +1,304 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /       
+
+module Twilio
+  module REST
+    class Api < Domain
+      class V2010 < Version
+        class AccountContext < InstanceContext
+          class SandboxList < ListResource
+            ##
+            # Initialize the SandboxList
+            # @param [Version] version Version that contains the resource
+            # @param [String] account_sid The account_sid
+            
+            # @return [SandboxList] SandboxList
+            def initialize(version, account_sid: nil)
+              super(version)
+              
+              # Path Solution
+              @solution = {
+                  account_sid: account_sid
+              }
+            end
+            
+            ##
+            # Constructs a SandboxContext
+            # @return [SandboxContext] SandboxContext
+            def get
+              SandboxContext.new(
+                  @version,
+                  account_sid: @solution[:account_sid],
+              )
+            end
+            
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Api.V2010.SandboxList>'
+            end
+          end
+        
+          class SandboxPage < Page
+            ##
+            # Initialize the SandboxPage
+            # @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] account_sid The account_sid
+            
+            # @return [SandboxPage] SandboxPage
+            def initialize(version, response, solution)
+              super(version, response)
+              
+              # Path Solution
+              @solution = solution
+            end
+            
+            ##
+            # Build an instance of SandboxInstance
+            # @param [Hash] payload Payload response from the API
+            
+            # @return [SandboxInstance] SandboxInstance
+            def get_instance(payload)
+              return SandboxInstance.new(
+                  @version,
+                  payload,
+                  account_sid: @solution['account_sid'],
+              )
+            end
+            
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Api.V2010.SandboxPage>'
+            end
+          end
+        
+          class SandboxContext < InstanceContext
+            ##
+            # Initialize the SandboxContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] account_sid The account_sid
+            
+            # @return [SandboxContext] SandboxContext
+            def initialize(version, account_sid)
+              super(version)
+              
+              # Path Solution
+              @solution = {
+                  account_sid: account_sid,
+              }
+              @uri = "/Accounts/#{@solution[:account_sid]}/Sandbox.json"
+            end
+            
+            ##
+            # Fetch a SandboxInstance
+            # @return [SandboxInstance] Fetched SandboxInstance
+            def fetch
+              params = {}
+              
+              payload = @version.fetch(
+                  'GET',
+                  @uri,
+                  params,
+              )
+              
+              return SandboxInstance.new(
+                  @version,
+                  payload,
+                  account_sid: @solution['account_sid'],
+              )
+            end
+            
+            ##
+            # Update the SandboxInstance
+            # @param [String] voice_url The voice_url
+            # @param [String] voice_method The voice_method
+            # @param [String] sms_url The sms_url
+            # @param [String] sms_method The sms_method
+            # @param [String] status_callback The status_callback
+            # @param [String] status_callback_method The status_callback_method
+            
+            # @return [SandboxInstance] Updated SandboxInstance
+            def update(voice_url: nil, voice_method: nil, sms_url: nil, sms_method: nil, status_callback: nil, status_callback_method: nil)
+              data = {
+                  'VoiceUrl' => voice_url,
+                  'VoiceMethod' => voice_method,
+                  'SmsUrl' => sms_url,
+                  'SmsMethod' => sms_method,
+                  'StatusCallback' => status_callback,
+                  'StatusCallbackMethod' => status_callback_method,
+              }
+              
+              payload = @version.update(
+                  'POST',
+                  @uri,
+                  data: data,
+              )
+              
+              return SandboxInstance.new(
+                  @version,
+                  payload,
+                  account_sid: @solution['account_sid'],
+              )
+            end
+            
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.SandboxContext #{context}>"
+            end
+          end
+        
+          class SandboxInstance < InstanceResource
+            ##
+            # Initialize the SandboxInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] account_sid The account_sid
+            
+            # @return [SandboxInstance] SandboxInstance
+            def initialize(version, payload, account_sid: nil)
+              super(version)
+              
+              # Marshaled Properties
+              @properties = {
+                  'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
+                  'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
+                  'pin' => payload['pin'].to_i,
+                  'account_sid' => payload['account_sid'],
+                  'phone_number' => payload['phone_number'],
+                  'application_sid' => payload['application_sid'],
+                  'api_version' => payload['api_version'],
+                  'voice_url' => payload['voice_url'],
+                  'voice_method' => payload['voice_method'],
+                  'sms_url' => payload['sms_url'],
+                  'sms_method' => payload['sms_method'],
+                  'status_callback' => payload['status_callback'],
+                  'status_callback_method' => payload['status_callback_method'],
+                  'uri' => payload['uri'],
+              }
+              
+              # Context
+              @instance_context = nil
+              @params = {
+                  'account_sid' => account_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 [SandboxContext] SandboxContext for this SandboxInstance
+            def context
+              unless @instance_context
+                @instance_context = SandboxContext.new(
+                    @version,
+                    @params['account_sid'],
+                )
+              end
+              @instance_context
+            end
+            
+            def date_created
+              @properties['date_created']
+            end
+            
+            def date_updated
+              @properties['date_updated']
+            end
+            
+            def pin
+              @properties['pin']
+            end
+            
+            def account_sid
+              @properties['account_sid']
+            end
+            
+            def phone_number
+              @properties['phone_number']
+            end
+            
+            def application_sid
+              @properties['application_sid']
+            end
+            
+            def api_version
+              @properties['api_version']
+            end
+            
+            def voice_url
+              @properties['voice_url']
+            end
+            
+            def voice_method
+              @properties['voice_method']
+            end
+            
+            def sms_url
+              @properties['sms_url']
+            end
+            
+            def sms_method
+              @properties['sms_method']
+            end
+            
+            def status_callback
+              @properties['status_callback']
+            end
+            
+            def status_callback_method
+              @properties['status_callback_method']
+            end
+            
+            def uri
+              @properties['uri']
+            end
+            
+            ##
+            # Fetch a SandboxInstance
+            # @return [SandboxInstance] Fetched SandboxInstance
+            def fetch
+              @context.fetch()
+            end
+            
+            ##
+            # Update the SandboxInstance
+            # @param [String] voice_url The voice_url
+            # @param [String] voice_method The voice_method
+            # @param [String] sms_url The sms_url
+            # @param [String] sms_method The sms_method
+            # @param [String] status_callback The status_callback
+            # @param [String] status_callback_method The status_callback_method
+            
+            # @return [SandboxInstance] Updated SandboxInstance
+            def update(voice_url: nil, voice_method: nil, sms_url: nil, sms_method: nil, status_callback: nil, status_callback_method: nil)
+              @context.update(
+                  voice_method: voice_method,
+                  sms_url: sms_url,
+                  sms_method: sms_method,
+                  status_callback: status_callback,
+                  status_callback_method: status_callback_method,
+              )
+            end
+            
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Api.V2010.SandboxInstance #{context}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end