twilio-ruby 5.6.0 → 5.33.0

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,8 +16,11 @@ module Twilio
               ##
               # Initialize the UserChannelList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] user_sid The sid
+              # @param [String] service_sid The SID of the
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is
+              #   associated with.
+              # @param [String] user_sid The unique string that we created to identify the User
+              #   resource.
               # @return [UserChannelList] UserChannelList
               def initialize(version, service_sid: nil, user_sid: nil)
                 super(version)
@@ -54,7 +59,7 @@ module Twilio
               def stream(limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -66,7 +71,7 @@ module Twilio
               def each
                 limits = @version.read_limits
 
-                page = self.page(page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page,
                                 limit: limits[:limit],
@@ -153,8 +158,11 @@ module Twilio
               # 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
+              # @param [String] service_sid The SID of the
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is
+              #   associated with.
+              # @param [String] user_sid The unique string that we created to identify the User
+              #   resource.
               # @return [UserChannelInstance] UserChannelInstance
               def initialize(version, payload, service_sid: nil, user_sid: nil)
                 super(version)
@@ -173,49 +181,49 @@ module Twilio
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The service_sid
+              # @return [String] The SID of the Service that the resource is associated with
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] The channel_sid
+              # @return [String] The SID of the Channel the resource belongs to
               def channel_sid
                 @properties['channel_sid']
               end
 
               ##
-              # @return [String] The member_sid
+              # @return [String] The SID of the User as a Member in the Channel
               def member_sid
                 @properties['member_sid']
               end
 
               ##
-              # @return [user_channel.ChannelStatus] The status
+              # @return [user_channel.ChannelStatus] The status of the User on the Channel
               def status
                 @properties['status']
               end
 
               ##
-              # @return [String] The last_consumed_message_index
+              # @return [String] The index of the last Message in the Channel the Member has read
               def last_consumed_message_index
                 @properties['last_consumed_message_index']
               end
 
               ##
-              # @return [String] The unread_messages_count
+              # @return [String] The number of unread Messages in the Channel for the User
               def unread_messages_count
                 @properties['unread_messages_count']
               end
 
               ##
-              # @return [String] The links
+              # @return [String] Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel
               def links
                 @properties['links']
               end

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,9 @@ module Twilio
             ##
             # Initialize the UserList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is
+            #   associated with.
             # @return [UserList] UserList
             def initialize(version, service_sid: nil)
               super(version)
@@ -26,10 +30,18 @@ module Twilio
             ##
             # 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
+            # @param [String] identity The `identity` value that uniquely identifies the new
+            #   resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). This value is
+            #   often a username or email address. See the Identity documentation for more
+            #   details.
+            # @param [String] role_sid The SID of the
+            #   [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the new
+            #   User.
+            # @param [String] attributes A valid JSON string that contains
+            #   application-specific data.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the new resource. This value is often used for display purposes.
             # @return [UserInstance] Newly created UserInstance
             def create(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset)
               data = Twilio::Values.of({
@@ -45,7 +57,7 @@ module Twilio
                   data: data
               )
 
-              UserInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              UserInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -77,7 +89,7 @@ module Twilio
             def stream(limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -89,7 +101,7 @@ module Twilio
             def each
               limits = @version.read_limits
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page,
                               limit: limits[:limit],
@@ -156,7 +168,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [UserInstance] UserInstance
             def get_instance(payload)
-              UserInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              UserInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -170,14 +182,17 @@ module Twilio
             ##
             # Initialize the UserContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @param [String] sid The sid
+            # @param [String] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the
+            #   resource from.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the User
+            #   resource to fetch.
             # @return [UserContext] UserContext
             def initialize(version, service_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {service_sid: service_sid, sid: sid}
+              @solution = {service_sid: service_sid, sid: sid, }
               @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:sid]}"
 
               # Dependents
@@ -196,21 +211,24 @@ module Twilio
                   params,
               )
 
-              UserInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              UserInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
             # Deletes the UserInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
 
             ##
             # Update the UserInstance
-            # @param [String] role_sid The role_sid
-            # @param [String] attributes The attributes
-            # @param [String] friendly_name The friendly_name
+            # @param [String] role_sid The SID of the
+            #   [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to this user.
+            # @param [String] attributes A valid JSON string that contains
+            #   application-specific data.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It is often used for display purposes.
             # @return [UserInstance] Updated UserInstance
             def update(role_sid: :unset, attributes: :unset, friendly_name: :unset)
               data = Twilio::Values.of({
@@ -225,7 +243,7 @@ module Twilio
                   data: data,
               )
 
-              UserInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              UserInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
@@ -250,6 +268,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.IpMessaging.V1.UserContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.IpMessaging.V1.UserContext #{context}>"
+            end
           end
 
           class UserInstance < InstanceResource
@@ -257,8 +282,11 @@ module Twilio
             # Initialize the UserInstance
             # @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] sid The sid
+            # @param [String] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is
+            #   associated with.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the User
+            #   resource to fetch.
             # @return [UserInstance] UserInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -283,7 +311,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid']}
+              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -292,91 +320,91 @@ module Twilio
             # @return [UserContext] UserContext for this UserInstance
             def context
               unless @instance_context
-                @instance_context = UserContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = UserContext.new(@version, @params['service_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The service_sid
+            # @return [String] The SID of the Service that the resource is associated with
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The attributes
+            # @return [String] The JSON string that stores application-specific data
             def attributes
               @properties['attributes']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The role_sid
+            # @return [String] The SID of the assigned to the user
             def role_sid
               @properties['role_sid']
             end
 
             ##
-            # @return [String] The identity
+            # @return [String] The string that identifies the resource's User
             def identity
               @properties['identity']
             end
 
             ##
-            # @return [Boolean] The is_online
+            # @return [Boolean] Whether the User is actively connected to the Service instance and online
             def is_online
               @properties['is_online']
             end
 
             ##
-            # @return [Boolean] The is_notifiable
+            # @return [Boolean] Whether the User has a potentially valid Push Notification registration for the Service instance
             def is_notifiable
               @properties['is_notifiable']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The joined_channels_count
+            # @return [String] The number of Channels this User is a Member of
             def joined_channels_count
               @properties['joined_channels_count']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] The absolute URLs of the Channel and Binding resources related to the user
             def links
               @properties['links']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the User resource
             def url
               @properties['url']
             end
@@ -390,19 +418,22 @@ module Twilio
 
             ##
             # Deletes the UserInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def 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
+            # @param [String] role_sid The SID of the
+            #   [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to this user.
+            # @param [String] attributes A valid JSON string that contains
+            #   application-specific data.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It is often used for display purposes.
             # @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)
+              context.update(role_sid: role_sid, attributes: attributes, friendly_name: friendly_name, )
             end
 
             ##