twilio-ruby 5.5.1 → 5.58.3

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],
@@ -86,11 +92,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 UserChannelPage.new(@version, response, @solution)
               end
 
@@ -148,15 +152,114 @@ 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 the UserChannelInstance
+              # @return [UserChannelInstance] Fetched UserChannelInstance
+              def fetch
+                payload = @version.fetch('GET', @uri)
+
+                UserChannelInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    user_sid: @solution[:user_sid],
+                    channel_sid: @solution[:channel_sid],
+                )
+              end
+
+              ##
+              # Delete 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 +267,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 the UserChannelInstance
+              # @return [UserChannelInstance] Fetched UserChannelInstance
+              def fetch
+                context.fetch
+              end
+
+              ##
+              # Delete 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