twilio-ruby 5.6.0 → 5.33.1

data/lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,8 +16,12 @@ 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/chat/rest/service-resource) the User
+              #   Channel resource is associated with.
+              # @param [String] user_sid The SID of the
+              #   [User](https://www.twilio.com/docs/chat/rest/user-resource) the User Channel
+              #   belongs to.
               # @return [UserChannelList] UserChannelList
               def initialize(version, service_sid: nil, user_sid: nil)
                 super(version)
@@ -54,7 +60,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 +72,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],
@@ -148,15 +154,124 @@ module Twilio
               end
             end
 
+            class UserChannelContext < InstanceContext
+              ##
+              # Initialize the UserChannelContext
+              # @param [Version] version Version that contains the resource
+              # @param [String] service_sid The SID of the
+              #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the
+              #   User Channel resource from.
+              # @param [String] user_sid The SID of the
+              #   [User](https://www.twilio.com/docs/chat/rest/user-resource) to fetch the User
+              #   Channel resource from. This value can be either the `sid` or the `identity` of
+              #   the User resource.
+              # @param [String] channel_sid The SID of the
+              #   [Channel](https://www.twilio.com/docs/chat/channels) that has the User Channel
+              #   to fetch. This value can be either the `sid` or the `unique_name` of the Channel
+              #   to fetch.
+              # @return [UserChannelContext] UserChannelContext
+              def initialize(version, service_sid, user_sid, channel_sid)
+                super(version)
+
+                # Path Solution
+                @solution = {service_sid: service_sid, user_sid: user_sid, channel_sid: channel_sid, }
+                @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:user_sid]}/Channels/#{@solution[:channel_sid]}"
+              end
+
+              ##
+              # Fetch a UserChannelInstance
+              # @return [UserChannelInstance] Fetched UserChannelInstance
+              def fetch
+                params = Twilio::Values.of({})
+
+                payload = @version.fetch(
+                    'GET',
+                    @uri,
+                    params,
+                )
+
+                UserChannelInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    user_sid: @solution[:user_sid],
+                    channel_sid: @solution[:channel_sid],
+                )
+              end
+
+              ##
+              # Deletes the UserChannelInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
+              def delete
+                @version.delete('delete', @uri)
+              end
+
+              ##
+              # Update the UserChannelInstance
+              # @param [user_channel.NotificationLevel] notification_level The push notification
+              #   level to assign to the User Channel. Can be: `default` or `muted`.
+              # @param [String] last_consumed_message_index The index of the last
+              #   [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the
+              #   [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read.
+              # @param [Time] last_consumption_timestamp The [ISO
+              #   8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last
+              #   [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for
+              #   the Member within the [Channel](https://www.twilio.com/docs/chat/channels).
+              # @return [UserChannelInstance] Updated UserChannelInstance
+              def update(notification_level: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset)
+                data = Twilio::Values.of({
+                    'NotificationLevel' => notification_level,
+                    'LastConsumedMessageIndex' => last_consumed_message_index,
+                    'LastConsumptionTimestamp' => Twilio.serialize_iso8601_datetime(last_consumption_timestamp),
+                })
+
+                payload = @version.update(
+                    'POST',
+                    @uri,
+                    data: data,
+                )
+
+                UserChannelInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    user_sid: @solution[:user_sid],
+                    channel_sid: @solution[:channel_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Chat.V2.UserChannelContext #{context}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Chat.V2.UserChannelContext #{context}>"
+              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
+              # @param [String] service_sid The SID of the
+              #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User
+              #   Channel resource is associated with.
+              # @param [String] user_sid The SID of the
+              #   [User](https://www.twilio.com/docs/chat/rest/user-resource) the User Channel
+              #   belongs to.
+              # @param [String] channel_sid The SID of the
+              #   [Channel](https://www.twilio.com/docs/chat/channels) that has the User Channel
+              #   to fetch. This value can be either the `sid` or the `unique_name` of the Channel
+              #   to fetch.
               # @return [UserChannelInstance] UserChannelInstance
-              def initialize(version, payload, service_sid: nil, user_sid: nil)
+              def initialize(version, payload, service_sid: nil, user_sid: nil, channel_sid: nil)
                 super(version)
 
                 # Marshaled Properties
@@ -164,72 +279,153 @@ module Twilio
                     'account_sid' => payload['account_sid'],
                     'service_sid' => payload['service_sid'],
                     'channel_sid' => payload['channel_sid'],
+                    'user_sid' => payload['user_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'],
+                    'url' => payload['url'],
+                    'notification_level' => payload['notification_level'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {
+                    'service_sid' => service_sid,
+                    'user_sid' => user_sid,
+                    'channel_sid' => channel_sid || @properties['channel_sid'],
                 }
               end
 
               ##
-              # @return [String] The account_sid
+              # Generate an instance context for the instance, the context is capable of
+              # performing various actions.  All instance actions are proxied to the context
+              # @return [UserChannelContext] UserChannelContext for this UserChannelInstance
+              def context
+                unless @instance_context
+                  @instance_context = UserChannelContext.new(
+                      @version,
+                      @params['service_sid'],
+                      @params['user_sid'],
+                      @params['channel_sid'],
+                  )
+                end
+                @instance_context
+              end
+
+              ##
+              # @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 the User Channel belongs to
+              def user_sid
+                @properties['user_sid']
+              end
+
+              ##
+              # @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
 
+              ##
+              # @return [String] The absolute URL of the resource
+              def url
+                @properties['url']
+              end
+
+              ##
+              # @return [user_channel.NotificationLevel] The push notification level of the User for the Channel
+              def notification_level
+                @properties['notification_level']
+              end
+
+              ##
+              # Fetch a UserChannelInstance
+              # @return [UserChannelInstance] Fetched UserChannelInstance
+              def fetch
+                context.fetch
+              end
+
+              ##
+              # Deletes the UserChannelInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
+              def delete
+                context.delete
+              end
+
+              ##
+              # Update the UserChannelInstance
+              # @param [user_channel.NotificationLevel] notification_level The push notification
+              #   level to assign to the User Channel. Can be: `default` or `muted`.
+              # @param [String] last_consumed_message_index The index of the last
+              #   [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the
+              #   [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read.
+              # @param [Time] last_consumption_timestamp The [ISO
+              #   8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last
+              #   [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for
+              #   the Member within the [Channel](https://www.twilio.com/docs/chat/channels).
+              # @return [UserChannelInstance] Updated UserChannelInstance
+              def update(notification_level: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset)
+                context.update(
+                    notification_level: notification_level,
+                    last_consumed_message_index: last_consumed_message_index,
+                    last_consumption_timestamp: last_consumption_timestamp,
+                )
+              end
+
               ##
               # Provide a user friendly representation
               def to_s
-                "<Twilio.Chat.V2.UserChannelInstance>"
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Chat.V2.UserChannelInstance #{values}>"
               end
 
               ##
               # Provide a detailed, user friendly representation
               def inspect
-                "<Twilio.Chat.V2.UserChannelInstance>"
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Chat.V2.UserChannelInstance #{values}>"
               end
             end
           end

data/lib/twilio-ruby/rest/chat/v2/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/chat/rest/service-resource) the User
+            #   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/chat/rest/user-resource) within
+            #   the [Service](https://www.twilio.com/docs/chat/rest/service-resource). This
+            #   value is often a username or email address. See the Identity documentation for
+            #   more info.
+            # @param [String] role_sid The SID of the
+            #   [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign 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/chat/rest/service-resource) to fetch the
+            #   User resource from.
+            # @param [String] sid The SID of the User resource to fetch. This value can be
+            #   either the `sid` or the `identity` of 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
@@ -197,21 +212,25 @@ 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/chat/rest/role-resource) to assign to the
+            #   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({
@@ -226,14 +245,20 @@ 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
 
             ##
             # Access the user_channels
             # @return [UserChannelList]
-            # @return [UserChannelContext]
-            def user_channels
+            # @return [UserChannelContext] if channel_sid was passed.
+            def user_channels(channel_sid=:unset)
+              raise ArgumentError, 'channel_sid cannot be nil' if channel_sid.nil?
+
+              if channel_sid != :unset
+                return UserChannelContext.new(@version, @solution[:service_sid], @solution[:sid], channel_sid, )
+              end
+
               unless @user_channels
                 @user_channels = UserChannelList.new(
                     @version,
@@ -253,7 +278,7 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return UserBindingContext.new(@version, @solution[:service_sid], @solution[:sid], sid)
+                return UserBindingContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
               end
 
               unless @user_bindings
@@ -273,6 +298,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Chat.V2.UserContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Chat.V2.UserContext #{context}>"
+            end
           end
 
           class UserInstance < InstanceResource
@@ -280,8 +312,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/chat/rest/service-resource) the User
+            #   resource is associated with.
+            # @param [String] sid The SID of the User resource to fetch. This value can be
+            #   either the `sid` or the `identity` of the User resource to fetch.
             # @return [UserInstance] UserInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -306,7 +341,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
 
             ##
@@ -315,91 +350,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 Role 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 ISO 8601 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 ISO 8601 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 the 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
@@ -413,19 +448,23 @@ 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/chat/rest/role-resource) to assign to the
+            #   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
 
             ##