twilio-ruby 5.0.0.alpha1 → 5.0.0.rc2

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

@@ -2,7 +2,7 @@
 # This code was generated by
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#       /       /       
 
 module Twilio
   module REST
@@ -16,17 +16,18 @@ module Twilio
               # @param [Version] version Version that contains the resource
               # @param [String] account_sid A 34 character string that uniquely identifies this
               #   resource.
+              
               # @return [DomainList] DomainList
               def initialize(version, account_sid: nil)
                 super(version)
-
+                
                 # Path Solution
                 @solution = {
                     account_sid: account_sid
                 }
                 @uri = "/Accounts/#{@solution[:account_sid]}/SIP/Domains.json"
               end
-
+              
               ##
               # Lists DomainInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
@@ -37,6 +38,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(
@@ -44,7 +46,7 @@ module Twilio
                     page_size: page_size
                 ).entries
               end
-
+              
               ##
               # Streams DomainInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
@@ -55,67 +57,62 @@ 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 DomainInstance 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 DomainInstance 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 DomainInstance
-              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
                 )
-                DomainPage.new(@version, response, @solution)
+                return DomainPage.new(@version, response, @solution)
               end
-
-              ##
-              # Retrieve a single page of DomainInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] target_url API-generated URL for the requested results page
-              # @return [Page] Page of DomainInstance
-              def get_page(target_url)
-                response = @version.domain.request(
-                    'GET',
-                    target_url
-                )
-                DomainPage.new(@version, response, @solution)
-              end
-
+              
               ##
               # Retrieve a single page of DomainInstance records from the API.
               # Request is executed immediately.
@@ -123,8 +120,6 @@ module Twilio
               #   you route your SIP traffic
               # @param [String] friendly_name A user-specified, human-readable name for the
               #   trigger.
-              # @param [String] auth_type The types of authentication you have mapped to your
-              #   domain
               # @param [String] voice_url The URL Twilio will request when this domain receives
               #   a call
               # @param [String] voice_method The HTTP method to use with the voice_url
@@ -135,118 +130,136 @@ module Twilio
               # @param [String] voice_status_callback_url The URL that Twilio will request to
               #   pass status parameters
               # @param [String] voice_status_callback_method The voice_status_callback_method
+              
               # @return [DomainInstance] Newly created DomainInstance
-              def create(domain_name: nil, friendly_name: :unset, auth_type: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, voice_status_callback_url: :unset, voice_status_callback_method: :unset)
-                data = Twilio::Values.of({
+              def create(domain_name: nil, friendly_name: nil, voice_url: nil, voice_method: nil, voice_fallback_url: nil, voice_fallback_method: nil, voice_status_callback_url: nil, voice_status_callback_method: nil)
+                data = {
                     'DomainName' => domain_name,
                     'FriendlyName' => friendly_name,
-                    'AuthType' => auth_type,
                     'VoiceUrl' => voice_url,
                     'VoiceMethod' => voice_method,
                     'VoiceFallbackUrl' => voice_fallback_url,
                     'VoiceFallbackMethod' => voice_fallback_method,
                     'VoiceStatusCallbackUrl' => voice_status_callback_url,
                     'VoiceStatusCallbackMethod' => voice_status_callback_method,
-                })
-
+                }
+                
                 payload = @version.create(
                     'POST',
                     @uri,
                     data: data
                 )
-
-                DomainInstance.new(
+                
+                return DomainInstance.new(
                     @version,
                     payload,
+                    account_sid: @solution['account_sid'],
+                )
+              end
+              
+              ##
+              # Constructs a DomainContext
+              # @param [String] sid The domain sid that uniquely identifies the resource
+              
+              # @return [DomainContext] DomainContext
+              def get(sid)
+                DomainContext.new(
+                    @version,
                     account_sid: @solution[:account_sid],
+                    sid: sid,
                 )
               end
-
+              
               ##
               # Provide a user friendly representation
               def to_s
                 '#<Twilio.Api.V2010.DomainList>'
               end
             end
-
+          
             class DomainPage < Page
               ##
               # Initialize the DomainPage
               # @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 A 34 character string that uniquely identifies this
+              #   resource.
+              
               # @return [DomainPage] DomainPage
               def initialize(version, response, solution)
                 super(version, response)
-
+                
                 # Path Solution
                 @solution = solution
               end
-
+              
               ##
               # Build an instance of DomainInstance
               # @param [Hash] payload Payload response from the API
+              
               # @return [DomainInstance] DomainInstance
               def get_instance(payload)
-                DomainInstance.new(
+                return DomainInstance.new(
                     @version,
                     payload,
-                    account_sid: @solution[:account_sid],
+                    account_sid: @solution['account_sid'],
                 )
               end
-
+              
               ##
               # Provide a user friendly representation
               def to_s
                 '<Twilio.Api.V2010.DomainPage>'
               end
             end
-
+          
             class DomainContext < InstanceContext
               ##
               # Initialize the DomainContext
               # @param [Version] version Version that contains the resource
               # @param [String] account_sid The account_sid
               # @param [String] sid The domain sid that uniquely identifies the resource
+              
               # @return [DomainContext] DomainContext
               def initialize(version, account_sid, sid)
                 super(version)
-
+                
                 # Path Solution
                 @solution = {
                     account_sid: account_sid,
                     sid: sid,
                 }
                 @uri = "/Accounts/#{@solution[:account_sid]}/SIP/Domains/#{@solution[:sid]}.json"
-
+                
                 # Dependents
                 @ip_access_control_list_mappings = nil
                 @credential_list_mappings = nil
               end
-
+              
               ##
               # Fetch a DomainInstance
               # @return [DomainInstance] Fetched DomainInstance
               def fetch
-                params = Twilio::Values.of({})
-
+                params = {}
+                
                 payload = @version.fetch(
                     'GET',
                     @uri,
                     params,
                 )
-
-                DomainInstance.new(
+                
+                return DomainInstance.new(
                     @version,
                     payload,
-                    account_sid: @solution[:account_sid],
-                    sid: @solution[:sid],
+                    account_sid: @solution['account_sid'],
+                    sid: @solution['sid'],
                 )
               end
-
+              
               ##
               # Update the DomainInstance
-              # @param [String] auth_type The auth_type
+              # @param [String] api_version The api_version
               # @param [String] friendly_name A user-specified, human-readable name for the
               #   trigger.
               # @param [String] voice_fallback_method The voice_fallback_method
@@ -255,10 +268,11 @@ module Twilio
               # @param [String] voice_status_callback_method The voice_status_callback_method
               # @param [String] voice_status_callback_url The voice_status_callback_url
               # @param [String] voice_url The voice_url
+              
               # @return [DomainInstance] Updated DomainInstance
-              def update(auth_type: :unset, friendly_name: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_status_callback_method: :unset, voice_status_callback_url: :unset, voice_url: :unset)
-                data = Twilio::Values.of({
-                    'AuthType' => auth_type,
+              def update(api_version: nil, friendly_name: nil, voice_fallback_method: nil, voice_fallback_url: nil, voice_method: nil, voice_status_callback_method: nil, voice_status_callback_url: nil, voice_url: nil)
+                data = {
+                    'ApiVersion' => api_version,
                     'FriendlyName' => friendly_name,
                     'VoiceFallbackMethod' => voice_fallback_method,
                     'VoiceFallbackUrl' => voice_fallback_url,
@@ -266,36 +280,33 @@ module Twilio
                     'VoiceStatusCallbackMethod' => voice_status_callback_method,
                     'VoiceStatusCallbackUrl' => voice_status_callback_url,
                     'VoiceUrl' => voice_url,
-                })
-
+                }
+                
                 payload = @version.update(
                     'POST',
                     @uri,
                     data: data,
                 )
-
-                DomainInstance.new(
+                
+                return DomainInstance.new(
                     @version,
                     payload,
-                    account_sid: @solution[:account_sid],
-                    sid: @solution[:sid],
+                    account_sid: @solution['account_sid'],
+                    sid: @solution['sid'],
                 )
               end
-
+              
               ##
               # Deletes the DomainInstance
               # @return [Boolean] true if delete succeeds, true otherwise
               def delete
-                @version.delete('delete', @uri)
+                return @version.delete('delete', @uri)
               end
-
+              
               ##
               # Access the ip_access_control_list_mappings
-              # @return [IpAccessControlListMappingList]
-              # @return [IpAccessControlListMappingContext] if sid was passed.
+              # @return [IpAccessControlListMappingList] IpAccessControlListMappingList
               def ip_access_control_list_mappings(sid=:unset)
-                raise ArgumentError, 'sid cannot be nil' if sid.nil?
-
                 if sid != :unset
                   return IpAccessControlListMappingContext.new(
                       @version,
@@ -304,7 +315,7 @@ module Twilio
                       sid,
                   )
                 end
-
+                
                 unless @ip_access_control_list_mappings
                   @ip_access_control_list_mappings = IpAccessControlListMappingList.new(
                       @version,
@@ -312,17 +323,14 @@ module Twilio
                       domain_sid: @solution[:sid],
                   )
                 end
-
+                
                 @ip_access_control_list_mappings
               end
-
+              
               ##
               # Access the credential_list_mappings
-              # @return [CredentialListMappingList]
-              # @return [CredentialListMappingContext] if sid was passed.
+              # @return [CredentialListMappingList] CredentialListMappingList
               def credential_list_mappings(sid=:unset)
-                raise ArgumentError, 'sid cannot be nil' if sid.nil?
-
                 if sid != :unset
                   return CredentialListMappingContext.new(
                       @version,
@@ -331,7 +339,7 @@ module Twilio
                       sid,
                   )
                 end
-
+                
                 unless @credential_list_mappings
                   @credential_list_mappings = CredentialListMappingList.new(
                       @version,
@@ -339,10 +347,10 @@ module Twilio
                       domain_sid: @solution[:sid],
                   )
                 end
-
+                
                 @credential_list_mappings
               end
-
+              
               ##
               # Provide a user friendly representation
               def to_s
@@ -350,7 +358,7 @@ module Twilio
                 "#<Twilio.Api.V2010.DomainContext #{context}>"
               end
             end
-
+          
             class DomainInstance < InstanceResource
               ##
               # Initialize the DomainInstance
@@ -359,10 +367,11 @@ module Twilio
               # @param [String] account_sid A 34 character string that uniquely identifies this
               #   resource.
               # @param [String] sid The domain sid that uniquely identifies the resource
+              
               # @return [DomainInstance] DomainInstance
               def initialize(version, payload, account_sid: nil, sid: nil)
                 super(version)
-
+                
                 # Marshaled Properties
                 @properties = {
                     'account_sid' => payload['account_sid'],
@@ -380,9 +389,8 @@ module Twilio
                     'voice_status_callback_method' => payload['voice_status_callback_method'],
                     'voice_status_callback_url' => payload['voice_status_callback_url'],
                     'voice_url' => payload['voice_url'],
-                    'subresource_uris' => payload['subresource_uris'],
                 }
-
+                
                 # Context
                 @instance_context = nil
                 @params = {
@@ -390,10 +398,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 [DomainContext] DomainContext for this DomainInstance
               def context
                 unless @instance_context
@@ -405,113 +415,77 @@ module Twilio
                 end
                 @instance_context
               end
-
-              ##
-              # @return [String] The unique id of the account that sent the message
+              
               def account_sid
                 @properties['account_sid']
               end
-
-              ##
-              # @return [String] The Twilio API version used to process the message
+              
               def api_version
                 @properties['api_version']
               end
-
-              ##
-              # @return [String] The types of authentication mapped to the domain
+              
               def auth_type
                 @properties['auth_type']
               end
-
-              ##
-              # @return [Time] The date this resource was created
+              
               def date_created
                 @properties['date_created']
               end
-
-              ##
-              # @return [Time] The date this resource was last updated
+              
               def date_updated
                 @properties['date_updated']
               end
-
-              ##
-              # @return [String] The unique address on Twilio to route SIP traffic
+              
               def domain_name
                 @properties['domain_name']
               end
-
-              ##
-              # @return [String] A user-specified, human-readable name for the trigger.
+              
               def friendly_name
                 @properties['friendly_name']
               end
-
-              ##
-              # @return [String] A string that uniquely identifies the SIP Domain
+              
               def sid
                 @properties['sid']
               end
-
-              ##
-              # @return [String] The URI for this resource
+              
               def uri
                 @properties['uri']
               end
-
-              ##
-              # @return [String] HTTP method used with voice_fallback_url
+              
               def voice_fallback_method
                 @properties['voice_fallback_method']
               end
-
-              ##
-              # @return [String] URL Twilio will request if an error occurs in executing TwiML
+              
               def voice_fallback_url
                 @properties['voice_fallback_url']
               end
-
-              ##
-              # @return [String] HTTP method to use with voice_url
+              
               def voice_method
                 @properties['voice_method']
               end
-
-              ##
-              # @return [String] The voice_status_callback_method
+              
               def voice_status_callback_method
                 @properties['voice_status_callback_method']
               end
-
-              ##
-              # @return [String] URL that Twilio will request with status updates
+              
               def voice_status_callback_url
                 @properties['voice_status_callback_url']
               end
-
-              ##
-              # @return [String] URL Twilio will request when receiving a call
+              
               def voice_url
                 @properties['voice_url']
               end
-
-              ##
-              # @return [String] The subresource_uris
-              def subresource_uris
-                @properties['subresource_uris']
-              end
-
+              
               ##
               # Fetch a DomainInstance
               # @return [DomainInstance] Fetched DomainInstance
               def fetch
-                context.fetch
+                @context.fetch()
               end
-
+              
               ##
               # Update the DomainInstance
-              # @param [String] auth_type The auth_type
+              # @param [String] api_version The api_version
               # @param [String] friendly_name A user-specified, human-readable name for the
               #   trigger.
               # @param [String] voice_fallback_method The voice_fallback_method
@@ -520,10 +494,10 @@ module Twilio
               # @param [String] voice_status_callback_method The voice_status_callback_method
               # @param [String] voice_status_callback_url The voice_status_callback_url
               # @param [String] voice_url The voice_url
+              
               # @return [DomainInstance] Updated DomainInstance
-              def update(auth_type: :unset, friendly_name: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_status_callback_method: :unset, voice_status_callback_url: :unset, voice_url: :unset)
-                context.update(
-                    auth_type: auth_type,
+              def update(api_version: nil, friendly_name: nil, voice_fallback_method: nil, voice_fallback_url: nil, voice_method: nil, voice_status_callback_method: nil, voice_status_callback_url: nil, voice_url: nil)
+                @context.update(
                     friendly_name: friendly_name,
                     voice_fallback_method: voice_fallback_method,
                     voice_fallback_url: voice_fallback_url,
@@ -533,33 +507,33 @@ module Twilio
                     voice_url: voice_url,
                 )
               end
-
+              
               ##
               # Deletes the DomainInstance
               # @return [Boolean] true if delete succeeds, true otherwise
               def delete
-                context.delete
+                @context.delete()
               end
-
+              
               ##
               # Access the ip_access_control_list_mappings
               # @return [ip_access_control_list_mappings] ip_access_control_list_mappings
               def ip_access_control_list_mappings
-                context.ip_access_control_list_mappings
+                @context.ip_access_control_list_mappings
               end
-
+              
               ##
               # Access the credential_list_mappings
               # @return [credential_list_mappings] credential_list_mappings
               def credential_list_mappings
-                context.credential_list_mappings
+                @context.credential_list_mappings
               end
-
+              
               ##
               # Provide a user friendly representation
               def to_s
-                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-                "<Twilio.Api.V2010.DomainInstance #{values}>"
+                context = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Api.V2010.DomainInstance #{context}>"
               end
             end
           end