twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/chat/v1/service/channel/member.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,8 +16,11 @@ module Twilio
               ##
               # Initialize the MemberList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] channel_sid The channel_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] channel_sid The unique ID of the
+              #   {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] for the member.
               # @return [MemberList] MemberList
               def initialize(version, service_sid: nil, channel_sid: nil)
                 super(version)
@@ -26,19 +31,21 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of MemberInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] identity The identity
-              # @param [String] role_sid The role_sid
-              # @return [MemberInstance] Newly created MemberInstance
+              # Create the MemberInstance
+              # @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/services]. See {access
+              #   tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more
+              #   details.
+              # @param [String] role_sid The SID of the
+              #   {Role}[https://www.twilio.com/docs/api/chat/rest/roles] to assign to the member.
+              #   The default roles are those specified on the
+              #   {Service}[https://www.twilio.com/docs/chat/api/services].
+              # @return [MemberInstance] Created MemberInstance
               def create(identity: nil, role_sid: :unset)
-                data = Twilio::Values.of({'Identity' => identity, 'RoleSid' => role_sid})
+                data = Twilio::Values.of({'Identity' => identity, 'RoleSid' => role_sid, })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 MemberInstance.new(
                     @version,
@@ -52,7 +59,11 @@ module Twilio
               # Lists MemberInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [String] identity The identity
+              # @param [Array[String]] identity The
+              #   {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of
+              #   the resources to read. See {access
+              #   tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more
+              #   details.
               # @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
@@ -68,7 +79,11 @@ module Twilio
               # Streams MemberInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [String] identity The identity
+              # @param [Array[String]] identity The
+              #   {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of
+              #   the resources to read. See {access
+              #   tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more
+              #   details.
               # @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
@@ -79,7 +94,7 @@ module Twilio
               def stream(identity: :unset, limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(identity: identity, page_size: limits[:page_size])
+                page = self.page(identity: identity, page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -91,7 +106,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],
@@ -101,7 +116,11 @@ module Twilio
               ##
               # Retrieve a single page of MemberInstance records from the API.
               # Request is executed immediately.
-              # @param [String] identity The identity
+              # @param [Array[String]] identity The
+              #   {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of
+              #   the resources to read. See {access
+              #   tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more
+              #   details.
               # @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
@@ -113,11 +132,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 MemberPage.new(@version, response, @solution)
               end
 
@@ -179,29 +196,28 @@ module Twilio
               ##
               # Initialize the MemberContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] channel_sid The channel_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] channel_sid The unique ID of the
+              #   {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] the member to
+              #   fetch belongs to. Can be the Channel resource's `sid` or `unique_name` value.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Member resource to fetch.
               # @return [MemberContext] MemberContext
               def initialize(version, service_sid, channel_sid, sid)
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, channel_sid: channel_sid, sid: sid}
+                @solution = {service_sid: service_sid, channel_sid: channel_sid, sid: sid, }
                 @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Members/#{@solution[:sid]}"
               end
 
               ##
-              # Fetch a MemberInstance
+              # Fetch the MemberInstance
               # @return [MemberInstance] Fetched MemberInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 MemberInstance.new(
                     @version,
@@ -213,16 +229,22 @@ module Twilio
               end
 
               ##
-              # Deletes the MemberInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the MemberInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
               # Update the MemberInstance
-              # @param [String] role_sid The role_sid
-              # @param [String] last_consumed_message_index The last_consumed_message_index
+              # @param [String] role_sid The SID of the
+              #   {Role}[https://www.twilio.com/docs/api/chat/rest/roles] to assign to the member.
+              #   The default roles are those specified on the
+              #   {Service}[https://www.twilio.com/docs/chat/api/services].
+              # @param [String] last_consumed_message_index The index of the last
+              #   {Message}[https://www.twilio.com/docs/api/chat/rest/messages] that the Member
+              #   has read within the
+              #   {Channel}[https://www.twilio.com/docs/api/chat/rest/channels].
               # @return [MemberInstance] Updated MemberInstance
               def update(role_sid: :unset, last_consumed_message_index: :unset)
                 data = Twilio::Values.of({
@@ -230,11 +252,7 @@ module Twilio
                     'LastConsumedMessageIndex' => last_consumed_message_index,
                 })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 MemberInstance.new(
                     @version,
@@ -251,6 +269,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Chat.V1.MemberContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Chat.V1.MemberContext #{context}>"
+              end
             end
 
             class MemberInstance < InstanceResource
@@ -258,9 +283,13 @@ module Twilio
               # Initialize the MemberInstance
               # @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] channel_sid The channel_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] channel_sid The unique ID of the
+              #   {Channel}[https://www.twilio.com/docs/api/chat/rest/channels] for the member.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Member resource to fetch.
               # @return [MemberInstance] MemberInstance
               def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
                 super(version)
@@ -306,92 +335,98 @@ module Twilio
               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 channel_sid
+              # @return [String] The unique ID of the Channel for the member
               def channel_sid
                 @properties['channel_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 identity
+              # @return [String] The string that identifies the resource's User
               def identity
                 @properties['identity']
               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 role_sid
+              # @return [String] The SID of the Role assigned to the member
               def role_sid
                 @properties['role_sid']
               end
 
               ##
-              # @return [String] The last_consumed_message_index
+              # @return [String] The index of the last Message that the Member has read within the Channel
               def last_consumed_message_index
                 @properties['last_consumed_message_index']
               end
 
               ##
-              # @return [Time] The last_consumption_timestamp
+              # @return [Time] The ISO 8601 based timestamp string that represents the date-time of the last Message read event for the Member within the Channel
               def last_consumption_timestamp
                 @properties['last_consumption_timestamp']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the Member resource
               def url
                 @properties['url']
               end
 
               ##
-              # Fetch a MemberInstance
+              # Fetch the MemberInstance
               # @return [MemberInstance] Fetched MemberInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the MemberInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the MemberInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end
 
               ##
               # Update the MemberInstance
-              # @param [String] role_sid The role_sid
-              # @param [String] last_consumed_message_index The last_consumed_message_index
+              # @param [String] role_sid The SID of the
+              #   {Role}[https://www.twilio.com/docs/api/chat/rest/roles] to assign to the member.
+              #   The default roles are those specified on the
+              #   {Service}[https://www.twilio.com/docs/chat/api/services].
+              # @param [String] last_consumed_message_index The index of the last
+              #   {Message}[https://www.twilio.com/docs/api/chat/rest/messages] that the Member
+              #   has read within the
+              #   {Channel}[https://www.twilio.com/docs/api/chat/rest/channels].
               # @return [MemberInstance] Updated MemberInstance
               def update(role_sid: :unset, last_consumed_message_index: :unset)
-                context.update(role_sid: role_sid, last_consumed_message_index: last_consumed_message_index)
+                context.update(role_sid: role_sid, last_consumed_message_index: last_consumed_message_index, )
               end
 
               ##