twilio-ruby 5.0.0.rc18 → 5.0.0.rc19

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
@@ -17,14 +17,14 @@ module Twilio
             # @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.
@@ -40,20 +40,20 @@ module Twilio
                   'Attributes' => attributes,
                   'FriendlyName' => friendly_name,
               }
-              
+
               payload = @version.create(
                   'POST',
                   @uri,
                   data: data
               )
-              
+
               return UserInstance.new(
                   @version,
                   payload,
                   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
@@ -71,7 +71,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
@@ -85,14 +85,14 @@ module Twilio
             # @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 UserInstance records from the API.
             # This operation lazily loads records as efficiently as possible until the limit
@@ -105,16 +105,16 @@ module Twilio
             #                       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 UserInstance records from the API.
             # Request is executed immediately.
@@ -135,14 +135,14 @@ module Twilio
               )
               return 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
@@ -153,11 +153,11 @@ module Twilio
             # @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
@@ -169,14 +169,14 @@ module Twilio
                   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
@@ -186,27 +186,30 @@ module Twilio
             # @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 = {}
-              
+
               payload = @version.fetch(
                   'GET',
                   @uri,
                   params,
               )
-              
+
               return UserInstance.new(
                   @version,
                   payload,
@@ -214,18 +217,18 @@ module Twilio
                   sid: @solution[:sid],
               )
             end
-            
+
             ##
             # Deletes the UserInstance
             # @return [Boolean] true if delete succeeds, true otherwise
             def delete
               return @version.delete('delete', @uri)
             end
-            
+
             ##
             # Update the UserInstance
             # @param [String] role_sid The role_sid
-            # @param [Hash] attributes The attributes
+            # @param [String] attributes The attributes
             # @param [String] friendly_name The friendly_name
             # @return [UserInstance] Updated UserInstance
             def update(role_sid: nil, attributes: nil, friendly_name: nil)
@@ -234,13 +237,13 @@ module Twilio
                   'Attributes' => attributes,
                   'FriendlyName' => friendly_name,
               }
-              
+
               payload = @version.update(
                   'POST',
                   @uri,
                   data: data,
               )
-              
+
               return UserInstance.new(
                   @version,
                   payload,
@@ -248,7 +251,22 @@ module Twilio
                   sid: @solution[:sid],
               )
             end
-            
+
+            ##
+            # Access the user_channels
+            # @return [UserChannelList] UserChannelList
+            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
@@ -256,7 +274,7 @@ module Twilio
               "#<Twilio.IpMessaging.V1.UserContext #{context}>"
             end
           end
-        
+
           class UserInstance < InstanceResource
             ##
             # Initialize the UserInstance
@@ -267,19 +285,25 @@ module Twilio
             # @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(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601(payload['date_updated']),
+                  'joined_channels_count' => payload['joined_channels_count'].to_i,
+                  'links' => payload['links'],
                   'url' => payload['url'],
               }
-              
+
               # Context
               @instance_context = nil
               @params = {
@@ -287,7 +311,7 @@ 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
@@ -303,57 +327,81 @@ module Twilio
               end
               @instance_context
             end
-            
+
             def sid
               @properties['sid']
             end
-            
+
             def account_sid
               @properties['account_sid']
             end
-            
+
             def service_sid
               @properties['service_sid']
             end
-            
+
+            def attributes
+              @properties['attributes']
+            end
+
+            def friendly_name
+              @properties['friendly_name']
+            end
+
             def role_sid
               @properties['role_sid']
             end
-            
+
             def identity
               @properties['identity']
             end
-            
+
+            def is_online
+              @properties['is_online']
+            end
+
+            def is_notifiable
+              @properties['is_notifiable']
+            end
+
             def date_created
               @properties['date_created']
             end
-            
+
             def date_updated
               @properties['date_updated']
             end
-            
+
+            def joined_channels_count
+              @properties['joined_channels_count']
+            end
+
+            def links
+              @properties['links']
+            end
+
             def url
               @properties['url']
             end
-            
+
             ##
             # Fetch a UserInstance
             # @return [UserInstance] Fetched UserInstance
             def fetch
               context.fetch
             end
-            
+
             ##
             # Deletes the UserInstance
             # @return [Boolean] true if delete succeeds, true otherwise
             def delete
               context.delete
             end
-            
+
             ##
             # Update the UserInstance
             # @param [String] role_sid The role_sid
-            # @param [Hash] attributes The attributes
+            # @param [String] attributes The attributes
             # @param [String] friendly_name The friendly_name
             # @return [UserInstance] Updated UserInstance
             def update(role_sid: nil, attributes: nil, friendly_name: nil)
@@ -363,7 +411,14 @@ module Twilio
                   friendly_name: friendly_name,
               )
             end
-            
+
+            ##
+            # Access the user_channels
+            # @return [user_channels] user_channels
+            def user_channels
+              context.user_channels
+            end
+
             ##
             # Provide a user friendly representation
             def to_s

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

@@ -0,0 +1,223 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class IpMessaging < Domain
+      class V1 < Version
+        class ServiceContext < InstanceContext
+          class UserContext < InstanceContext
+            class UserChannelList < ListResource
+              ##
+              # Initialize the UserChannelList
+              # @param [Version] version Version that contains the resource
+              # @param [String] service_sid The service_sid
+              # @param [String] user_sid The sid
+              # @return [UserChannelList] UserChannelList
+              def initialize(version, service_sid: nil, user_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {
+                    service_sid: service_sid,
+                    user_sid: user_sid
+                }
+                @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:user_sid]}/Channels"
+              end
+
+              ##
+              # Lists UserChannelInstance 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 UserChannelInstance 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 UserChannelInstance 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 UserChannelInstance 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 UserChannelInstance
+              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 UserChannelPage.new(@version, response, @solution)
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.IpMessaging.V1.UserChannelList>'
+              end
+            end
+
+            class UserChannelPage < Page
+              ##
+              # Initialize the UserChannelPage
+              # @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
+              # @param [String] user_sid The sid
+              # @return [UserChannelPage] UserChannelPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of UserChannelInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [UserChannelInstance] UserChannelInstance
+              def get_instance(payload)
+                return UserChannelInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    user_sid: @solution[:user_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.IpMessaging.V1.UserChannelPage>'
+              end
+            end
+
+            class UserChannelInstance < InstanceResource
+              ##
+              # Initialize the UserChannelInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] service_sid The service_sid
+              # @param [String] user_sid The sid
+              # @return [UserChannelInstance] UserChannelInstance
+              def initialize(version, payload, service_sid: nil, user_sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'account_sid' => payload['account_sid'],
+                    'service_sid' => payload['service_sid'],
+                    'channel_sid' => payload['channel_sid'],
+                    'member_sid' => payload['member_sid'],
+                    'status' => payload['status'],
+                    'last_consumed_message_index' => payload['last_consumed_message_index'] == nil ? payload['last_consumed_message_index'] : payload['last_consumed_message_index'].to_i,
+                    'unread_messages_count' => payload['unread_messages_count'] == nil ? payload['unread_messages_count'] : payload['unread_messages_count'].to_i,
+                    'links' => payload['links'],
+                }
+              end
+
+              def account_sid
+                @properties['account_sid']
+              end
+
+              def service_sid
+                @properties['service_sid']
+              end
+
+              def channel_sid
+                @properties['channel_sid']
+              end
+
+              def member_sid
+                @properties['member_sid']
+              end
+
+              def status
+                @properties['status']
+              end
+
+              def last_consumed_message_index
+                @properties['last_consumed_message_index']
+              end
+
+              def unread_messages_count
+                @properties['unread_messages_count']
+              end
+
+              def links
+                @properties['links']
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                "<Twilio.IpMessaging.V1.UserChannelInstance>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end