twilio-ruby 5.0.0.alpha1 → 5.0.0.rc2

data/lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb

@@ -2,7 +2,7 @@
 # This code was generated by
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#       /       /       
 
 module Twilio
   module REST
@@ -14,46 +14,44 @@ module Twilio
             # Initialize the UserList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The service_sid
+            
             # @return [UserList] UserList
             def initialize(version, service_sid: nil)
               super(version)
-
+              
               # Path Solution
               @solution = {
                   service_sid: service_sid
               }
               @uri = "/Services/#{@solution[:service_sid]}/Users"
             end
-
+            
             ##
             # Retrieve a single page of UserInstance records from the API.
             # Request is executed immediately.
             # @param [String] identity The identity
             # @param [String] role_sid The role_sid
-            # @param [String] attributes The attributes
-            # @param [String] friendly_name The friendly_name
+            
             # @return [UserInstance] Newly created UserInstance
-            def create(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset)
-              data = Twilio::Values.of({
+            def create(identity: nil, role_sid: nil)
+              data = {
                   'Identity' => identity,
                   'RoleSid' => role_sid,
-                  'Attributes' => attributes,
-                  'FriendlyName' => friendly_name,
-              })
-
+              }
+              
               payload = @version.create(
                   'POST',
                   @uri,
                   data: data
               )
-
-              UserInstance.new(
+              
+              return UserInstance.new(
                   @version,
                   payload,
-                  service_sid: @solution[:service_sid],
+                  service_sid: @solution['service_sid'],
               )
             end
-
+            
             ##
             # Lists UserInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
@@ -64,6 +62,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(
@@ -71,7 +70,7 @@ module Twilio
                   page_size: page_size
               ).entries
             end
-
+            
             ##
             # Streams UserInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
@@ -82,198 +81,188 @@ 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 UserInstance 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 UserInstance 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 UserInstance
-            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
               )
-              UserPage.new(@version, response, @solution)
+              return UserPage.new(@version, response, @solution)
             end
-
+            
             ##
-            # Retrieve a single page of UserInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] target_url API-generated URL for the requested results page
-            # @return [Page] Page of UserInstance
-            def get_page(target_url)
-              response = @version.domain.request(
-                  'GET',
-                  target_url
+            # Constructs a UserContext
+            # @param [String] sid The sid
+            
+            # @return [UserContext] UserContext
+            def get(sid)
+              UserContext.new(
+                  @version,
+                  service_sid: @solution[:service_sid],
+                  sid: sid,
               )
-              UserPage.new(@version, response, @solution)
             end
-
+            
             ##
             # Provide a user friendly representation
             def to_s
               '#<Twilio.IpMessaging.V1.UserList>'
             end
           end
-
+        
           class UserPage < Page
             ##
             # Initialize the UserPage
             # @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] service_sid The service_sid
+            
             # @return [UserPage] UserPage
             def initialize(version, response, solution)
               super(version, response)
-
+              
               # Path Solution
               @solution = solution
             end
-
+            
             ##
             # Build an instance of UserInstance
             # @param [Hash] payload Payload response from the API
+            
             # @return [UserInstance] UserInstance
             def get_instance(payload)
-              UserInstance.new(
+              return UserInstance.new(
                   @version,
                   payload,
-                  service_sid: @solution[:service_sid],
+                  service_sid: @solution['service_sid'],
               )
             end
-
+            
             ##
             # Provide a user friendly representation
             def to_s
               '<Twilio.IpMessaging.V1.UserPage>'
             end
           end
-
+        
           class UserContext < InstanceContext
             ##
             # Initialize the UserContext
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The service_sid
             # @param [String] sid The sid
+            
             # @return [UserContext] UserContext
             def initialize(version, service_sid, sid)
               super(version)
-
+              
               # Path Solution
               @solution = {
                   service_sid: service_sid,
                   sid: sid,
               }
               @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:sid]}"
-
-              # Dependents
-              @user_channels = nil
             end
-
+            
             ##
             # Fetch a UserInstance
             # @return [UserInstance] Fetched UserInstance
             def fetch
-              params = Twilio::Values.of({})
-
+              params = {}
+              
               payload = @version.fetch(
                   'GET',
                   @uri,
                   params,
               )
-
-              UserInstance.new(
+              
+              return UserInstance.new(
                   @version,
                   payload,
-                  service_sid: @solution[:service_sid],
-                  sid: @solution[:sid],
+                  service_sid: @solution['service_sid'],
+                  sid: @solution['sid'],
               )
             end
-
+            
             ##
             # Deletes the UserInstance
             # @return [Boolean] true if delete succeeds, true otherwise
             def delete
-              @version.delete('delete', @uri)
+              return @version.delete('get', @uri)
             end
-
+            
             ##
             # Update the UserInstance
             # @param [String] role_sid The role_sid
-            # @param [String] attributes The attributes
-            # @param [String] friendly_name The friendly_name
+            
             # @return [UserInstance] Updated UserInstance
-            def update(role_sid: :unset, attributes: :unset, friendly_name: :unset)
-              data = Twilio::Values.of({
+            def update(role_sid: nil)
+              data = {
                   'RoleSid' => role_sid,
-                  'Attributes' => attributes,
-                  'FriendlyName' => friendly_name,
-              })
-
+              }
+              
               payload = @version.update(
                   'POST',
                   @uri,
                   data: data,
               )
-
-              UserInstance.new(
+              
+              return UserInstance.new(
                   @version,
                   payload,
-                  service_sid: @solution[:service_sid],
-                  sid: @solution[:sid],
+                  service_sid: @solution['service_sid'],
+                  sid: @solution['sid'],
               )
             end
-
-            ##
-            # Access the user_channels
-            # @return [UserChannelList]
-            # @return [UserChannelContext]
-            def user_channels
-              unless @user_channels
-                @user_channels = UserChannelList.new(
-                    @version,
-                    service_sid: @solution[:service_sid],
-                    user_sid: @solution[:sid],
-                )
-              end
-
-              @user_channels
-            end
-
+            
             ##
             # Provide a user friendly representation
             def to_s
@@ -281,7 +270,7 @@ module Twilio
               "#<Twilio.IpMessaging.V1.UserContext #{context}>"
             end
           end
-
+        
           class UserInstance < InstanceResource
             ##
             # Initialize the UserInstance
@@ -289,28 +278,24 @@ module Twilio
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The service_sid
             # @param [String] sid The sid
+            
             # @return [UserInstance] UserInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
-
+              
               # Marshaled Properties
               @properties = {
                   'sid' => payload['sid'],
                   'account_sid' => payload['account_sid'],
                   'service_sid' => payload['service_sid'],
-                  'attributes' => payload['attributes'],
-                  'friendly_name' => payload['friendly_name'],
                   'role_sid' => payload['role_sid'],
                   'identity' => payload['identity'],
-                  'is_online' => payload['is_online'],
-                  'is_notifiable' => payload['is_notifiable'],
-                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
-                  'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                  'joined_channels_count' => payload['joined_channels_count'].to_i,
-                  'links' => payload['links'],
+                  'date_created' => Twilio.deserialize_iso8601(payload['date_created']),
+                  'date_updated' => Twilio.deserialize_iso8601(payload['date_updated']),
                   'url' => payload['url'],
+                  'links' => payload['links'],
               }
-
+              
               # Context
               @instance_context = nil
               @params = {
@@ -318,10 +303,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 [UserContext] UserContext for this UserInstance
             def context
               unless @instance_context
@@ -333,131 +320,71 @@ module Twilio
               end
               @instance_context
             end
-
-            ##
-            # @return [String] The sid
+            
             def sid
               @properties['sid']
             end
-
-            ##
-            # @return [String] The account_sid
+            
             def account_sid
               @properties['account_sid']
             end
-
-            ##
-            # @return [String] The service_sid
+            
             def service_sid
               @properties['service_sid']
             end
-
-            ##
-            # @return [String] The attributes
-            def attributes
-              @properties['attributes']
-            end
-
-            ##
-            # @return [String] The friendly_name
-            def friendly_name
-              @properties['friendly_name']
-            end
-
-            ##
-            # @return [String] The role_sid
+            
             def role_sid
               @properties['role_sid']
             end
-
-            ##
-            # @return [String] The identity
+            
             def identity
               @properties['identity']
             end
-
-            ##
-            # @return [Boolean] The is_online
-            def is_online
-              @properties['is_online']
-            end
-
-            ##
-            # @return [Boolean] The is_notifiable
-            def is_notifiable
-              @properties['is_notifiable']
-            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 joined_channels_count
-            def joined_channels_count
-              @properties['joined_channels_count']
+            
+            def url
+              @properties['url']
             end
-
-            ##
-            # @return [String] The links
+            
             def links
               @properties['links']
             end
-
-            ##
-            # @return [String] The url
-            def url
-              @properties['url']
-            end
-
+            
             ##
             # Fetch a UserInstance
             # @return [UserInstance] Fetched UserInstance
             def fetch
-              context.fetch
+              @context.fetch()
             end
-
+            
             ##
             # Deletes the UserInstance
             # @return [Boolean] true if delete succeeds, true otherwise
             def delete
-              context.delete
+              @context.delete()
             end
-
+            
             ##
             # Update the UserInstance
             # @param [String] role_sid The role_sid
-            # @param [String] attributes The attributes
-            # @param [String] friendly_name The friendly_name
+            
             # @return [UserInstance] Updated UserInstance
-            def update(role_sid: :unset, attributes: :unset, friendly_name: :unset)
-              context.update(
-                  role_sid: role_sid,
-                  attributes: attributes,
-                  friendly_name: friendly_name,
-              )
-            end
-
-            ##
-            # Access the user_channels
-            # @return [user_channels] user_channels
-            def user_channels
-              context.user_channels
+            def update(role_sid: nil)
+              @context.update()
             end
-
+            
             ##
             # Provide a user friendly representation
             def to_s
-              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.IpMessaging.V1.UserInstance #{values}>"
+              context = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.IpMessaging.V1.UserInstance #{context}>"
             end
           end
         end