twilio-ruby 5.0.0.rc9 → 5.0.0.rc10

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

@@ -0,0 +1,324 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /       
+
+module Twilio
+  module REST
+    class Api < Domain
+      class V2010 < Version
+        class AccountContext < InstanceContext
+          class SigningKeyList < ListResource
+            ##
+            # Initialize the SigningKeyList
+            # @param [Version] version Version that contains the resource
+            # @param [String] account_sid A 34 character string that uniquely identifies this
+            #   resource.
+            # @return [SigningKeyList] SigningKeyList
+            def initialize(version, account_sid: nil)
+              super(version)
+              
+              # Path Solution
+              @solution = {
+                  account_sid: account_sid
+              }
+              @uri = "/Accounts/#{@solution[:account_sid]}/SigningKeys.json"
+            end
+            
+            ##
+            # Lists SigningKeyInstance 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 SigningKeyInstance 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 SigningKeyInstance 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 SigningKeyInstance 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 SigningKeyInstance
+            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 SigningKeyPage.new(@version, response, @solution)
+            end
+            
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Api.V2010.SigningKeyList>'
+            end
+          end
+        
+          class SigningKeyPage < Page
+            ##
+            # Initialize the SigningKeyPage
+            # @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 [SigningKeyPage] SigningKeyPage
+            def initialize(version, response, solution)
+              super(version, response)
+              
+              # Path Solution
+              @solution = solution
+            end
+            
+            ##
+            # Build an instance of SigningKeyInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [SigningKeyInstance] SigningKeyInstance
+            def get_instance(payload)
+              return SigningKeyInstance.new(
+                  @version,
+                  payload,
+                  account_sid: @solution[:account_sid],
+              )
+            end
+            
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Api.V2010.SigningKeyPage>'
+            end
+          end
+        
+          class SigningKeyContext < InstanceContext
+            ##
+            # Initialize the SigningKeyContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] account_sid The account_sid
+            # @param [String] sid The sid
+            # @return [SigningKeyContext] SigningKeyContext
+            def initialize(version, account_sid, sid)
+              super(version)
+              
+              # Path Solution
+              @solution = {
+                  account_sid: account_sid,
+                  sid: sid,
+              }
+              @uri = "/Accounts/#{@solution[:account_sid]}/SigningKeys/#{@solution[:sid]}.json"
+            end
+            
+            ##
+            # Fetch a SigningKeyInstance
+            # @return [SigningKeyInstance] Fetched SigningKeyInstance
+            def fetch
+              params = {}
+              
+              payload = @version.fetch(
+                  'GET',
+                  @uri,
+                  params,
+              )
+              
+              return SigningKeyInstance.new(
+                  @version,
+                  payload,
+                  account_sid: @solution[:account_sid],
+                  sid: @solution[:sid],
+              )
+            end
+            
+            ##
+            # Update the SigningKeyInstance
+            # @param [String] friendly_name The friendly_name
+            # @return [SigningKeyInstance] Updated SigningKeyInstance
+            def update(friendly_name: nil)
+              data = {
+                  'FriendlyName' => friendly_name,
+              }
+              
+              payload = @version.update(
+                  'POST',
+                  @uri,
+                  data: data,
+              )
+              
+              return SigningKeyInstance.new(
+                  @version,
+                  payload,
+                  account_sid: @solution[:account_sid],
+                  sid: @solution[:sid],
+              )
+            end
+            
+            ##
+            # Deletes the SigningKeyInstance
+            # @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.Api.V2010.SigningKeyContext #{context}>"
+            end
+          end
+        
+          class SigningKeyInstance < InstanceResource
+            ##
+            # Initialize the SigningKeyInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] account_sid A 34 character string that uniquely identifies this
+            #   resource.
+            # @param [String] sid The sid
+            # @return [SigningKeyInstance] SigningKeyInstance
+            def initialize(version, payload, account_sid: nil, sid: nil)
+              super(version)
+              
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'friendly_name' => payload['friendly_name'],
+                  'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
+                  'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
+              }
+              
+              # Context
+              @instance_context = nil
+              @params = {
+                  'account_sid' => account_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 [SigningKeyContext] SigningKeyContext for this SigningKeyInstance
+            def context
+              unless @instance_context
+                @instance_context = SigningKeyContext.new(
+                    @version,
+                    @params['account_sid'],
+                    @params['sid'],
+                )
+              end
+              @instance_context
+            end
+            
+            def sid
+              @properties['sid']
+            end
+            
+            def friendly_name
+              @properties['friendly_name']
+            end
+            
+            def date_created
+              @properties['date_created']
+            end
+            
+            def date_updated
+              @properties['date_updated']
+            end
+            
+            ##
+            # Fetch a SigningKeyInstance
+            # @return [SigningKeyInstance] Fetched SigningKeyInstance
+            def fetch
+              context.fetch
+            end
+            
+            ##
+            # Update the SigningKeyInstance
+            # @param [String] friendly_name The friendly_name
+            # @return [SigningKeyInstance] Updated SigningKeyInstance
+            def update(friendly_name: nil)
+              context.update(
+                  friendly_name: friendly_name,
+              )
+            end
+            
+            ##
+            # Deletes the SigningKeyInstance
+            # @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.Api.V2010.SigningKeyInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -17,7 +17,6 @@ module Twilio
                 # @param [Version] version Version that contains the resource
                 # @param [String] account_sid The account_sid
                 # @param [String] credential_list_sid The credential_list_sid
-                
                 # @return [CredentialList] CredentialList
                 def initialize(version, account_sid: nil, credential_list_sid: nil)
                   super(version)
@@ -40,7 +39,6 @@ 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(
@@ -59,7 +57,6 @@ 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)
@@ -99,7 +96,6 @@ module Twilio
                 # @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 CredentialInstance
                 def page(page_token: nil, page_number: nil, page_size: nil)
                   params = {
@@ -120,7 +116,6 @@ module Twilio
                 # Request is executed immediately.
                 # @param [String] username The username
                 # @param [String] password The password
-                
                 # @return [CredentialInstance] Newly created CredentialInstance
                 def create(username: nil, password: nil)
                   data = {
@@ -137,8 +132,8 @@ module Twilio
                   return CredentialInstance.new(
                       @version,
                       payload,
-                      account_sid: @solution['account_sid'],
-                      credential_list_sid: @solution['credential_list_sid'],
+                      account_sid: @solution[:account_sid],
+                      credential_list_sid: @solution[:credential_list_sid],
                   )
                 end
                 
@@ -157,7 +152,6 @@ module Twilio
                 # @param [Hash] solution Path solution for the resource
                 # @param [String] account_sid The account_sid
                 # @param [String] credential_list_sid The credential_list_sid
-                
                 # @return [CredentialPage] CredentialPage
                 def initialize(version, response, solution)
                   super(version, response)
@@ -169,14 +163,13 @@ module Twilio
                 ##
                 # Build an instance of CredentialInstance
                 # @param [Hash] payload Payload response from the API
-                
                 # @return [CredentialInstance] CredentialInstance
                 def get_instance(payload)
                   return CredentialInstance.new(
                       @version,
                       payload,
-                      account_sid: @solution['account_sid'],
-                      credential_list_sid: @solution['credential_list_sid'],
+                      account_sid: @solution[:account_sid],
+                      credential_list_sid: @solution[:credential_list_sid],
                   )
                 end
                 
@@ -194,7 +187,6 @@ module Twilio
                 # @param [String] account_sid The account_sid
                 # @param [String] credential_list_sid The credential_list_sid
                 # @param [String] sid The sid
-                
                 # @return [CredentialContext] CredentialContext
                 def initialize(version, account_sid, credential_list_sid, sid)
                   super(version)
@@ -223,9 +215,9 @@ module Twilio
                   return CredentialInstance.new(
                       @version,
                       payload,
-                      account_sid: @solution['account_sid'],
-                      credential_list_sid: @solution['credential_list_sid'],
-                      sid: @solution['sid'],
+                      account_sid: @solution[:account_sid],
+                      credential_list_sid: @solution[:credential_list_sid],
+                      sid: @solution[:sid],
                   )
                 end
                 
@@ -233,7 +225,6 @@ module Twilio
                 # Update the CredentialInstance
                 # @param [String] username The username
                 # @param [String] password The password
-                
                 # @return [CredentialInstance] Updated CredentialInstance
                 def update(username: nil, password: nil)
                   data = {
@@ -250,9 +241,9 @@ module Twilio
                   return CredentialInstance.new(
                       @version,
                       payload,
-                      account_sid: @solution['account_sid'],
-                      credential_list_sid: @solution['credential_list_sid'],
-                      sid: @solution['sid'],
+                      account_sid: @solution[:account_sid],
+                      credential_list_sid: @solution[:credential_list_sid],
+                      sid: @solution[:sid],
                   )
                 end
                 
@@ -279,7 +270,6 @@ module Twilio
                 # @param [String] account_sid The account_sid
                 # @param [String] credential_list_sid The credential_list_sid
                 # @param [String] sid The sid
-                
                 # @return [CredentialInstance] CredentialInstance
                 def initialize(version, payload, account_sid: nil, credential_list_sid: nil, sid: nil)
                   super(version)
@@ -308,7 +298,6 @@ module Twilio
                 # 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 [CredentialContext] CredentialContext for this CredentialInstance
                 def context
                   unless @instance_context
@@ -354,17 +343,17 @@ module Twilio
                 # Fetch a CredentialInstance
                 # @return [CredentialInstance] Fetched CredentialInstance
                 def fetch
-                  @context.fetch()
+                  context.fetch
                 end
                 
                 ##
                 # Update the CredentialInstance
                 # @param [String] username The username
                 # @param [String] password The password
-                
                 # @return [CredentialInstance] Updated CredentialInstance
                 def update(username: nil, password: nil)
-                  @context.update(
+                  context.update(
+                      username: username,
                       password: password,
                   )
                 end
@@ -373,14 +362,14 @@ module Twilio
                 # Deletes the CredentialInstance
                 # @return [Boolean] true if delete succeeds, true otherwise
                 def delete
-                  @context.delete()
+                  context.delete
                 end
                 
                 ##
                 # Provide a user friendly representation
                 def to_s
-                  context = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-                  "<Twilio.Api.V2010.CredentialInstance #{context}>"
+                  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                  "<Twilio.Api.V2010.CredentialInstance #{values}>"
                 end
               end
             end