member.rb in twilio-ruby-5.10.0

- old
+ new

@@ -14,12 +14,16 @@
           class ChannelContext < InstanceContext
             class MemberList < ListResource
               ##
               # 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 unique id of the
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services) this member
+              #   belongs to.
+              # @param [String] channel_sid The unique id of the
+              #   [Channel](https://www.twilio.com/docs/api/chat/rest/v1/channels) for this
+              #   member.
               # @return [MemberList] MemberList
               def initialize(version, service_sid: nil, channel_sid: nil)
                 super(version)
 
                 # Path Solution
@@ -28,12 +32,18 @@
               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
+              # @param [String] identity A unique string identifier for this
+              #   [User](https://www.twilio.com/docs/api/chat/rest/v1/users) in this
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services). See the
+              #   [access
+              #   tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs for more details.
+              # @param [String] role_sid The
+              #   [Role](https://www.twilio.com/docs/api/chat/rest/v1/roles) assigned to this
+              #   member.
               # @return [MemberInstance] Newly created MemberInstance
               def create(identity: nil, role_sid: :unset)
                 data = Twilio::Values.of({'Identity' => identity, 'RoleSid' => role_sid, })
 
                 payload = @version.create(
@@ -52,11 +62,15 @@
 
               ##
               # 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 [String] identity A unique string identifier for this
+              #   [User](https://www.twilio.com/docs/api/chat/rest/v1/users) in this
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services). See the
+              #   [access
+              #   tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs 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
               #    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
@@ -68,11 +82,15 @@
 
               ##
               # 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 [String] identity A unique string identifier for this
+              #   [User](https://www.twilio.com/docs/api/chat/rest/v1/users) in this
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services). See the
+              #   [access
+              #   tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs 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
               #    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
@@ -101,11 +119,15 @@
               end
 
               ##
               # Retrieve a single page of MemberInstance records from the API.
               # Request is executed immediately.
-              # @param [String] identity The identity
+              # @param [String] identity A unique string identifier for this
+              #   [User](https://www.twilio.com/docs/api/chat/rest/v1/users) in this
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services). See the
+              #   [access
+              #   tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens)[/docs/api/chat/guides/create-tokens] docs 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
               # @return [Page] Page of MemberInstance
               def page(identity: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
@@ -221,12 +243,17 @@
                 @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
+              #   [Role](https://www.twilio.com/docs/api/chat/rest/v1/roles) assigned to this
+              #   member.
+              # @param [String] last_consumed_message_index An Integer representing index of the
+              #   last [Message](https://www.twilio.com/docs/api/chat/rest/v1/messages) this
+              #   Member has read within this
+              #   [Channel](https://www.twilio.com/docs/api/chat/rest/v1/channels)
               # @return [MemberInstance] Updated MemberInstance
               def update(role_sid: :unset, last_consumed_message_index: :unset)
                 data = Twilio::Values.of({
                     'RoleSid' => role_sid,
                     'LastConsumedMessageIndex' => last_consumed_message_index,
@@ -258,12 +285,16 @@
             class MemberInstance < InstanceResource
               ##
               # 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] service_sid The unique id of the
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/v1/services) this member
+              #   belongs to.
+              # @param [String] channel_sid The unique id of the
+              #   [Channel](https://www.twilio.com/docs/api/chat/rest/v1/channels) for this
+              #   member.
               # @param [String] sid The sid
               # @return [MemberInstance] MemberInstance
               def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
                 super(version)
 
@@ -306,71 +337,71 @@
                 end
                 @instance_context
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] A 34 character string that uniquely identifies this resource.
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The unique id of the Account responsible for this member.
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The channel_sid
+              # @return [String] The unique id of the Channel for this member.
               def channel_sid
                 @properties['channel_sid']
               end
 
               ##
-              # @return [String] The service_sid
+              # @return [String] The unique id of the Service this member belongs to.
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] The identity
+              # @return [String] A unique string identifier for this User in this Service.
               def identity
                 @properties['identity']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The date that this resource was created.
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date_updated
+              # @return [Time] The date that this resource was last updated.
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The role_sid
+              # @return [String] The Role assigned to this member.
               def role_sid
                 @properties['role_sid']
               end
 
               ##
-              # @return [String] The last_consumed_message_index
+              # @return [String] An Integer representing index of the last Message this Member has read within this Channel
               def last_consumed_message_index
                 @properties['last_consumed_message_index']
               end
 
               ##
-              # @return [Time] The last_consumption_timestamp
+              # @return [Time] An ISO8601 based timestamp string representing the datetime of the last Message read event for this Member within this Channel
               def last_consumption_timestamp
                 @properties['last_consumption_timestamp']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] An absolute URL for this member.
               def url
                 @properties['url']
               end
 
               ##
@@ -387,11 +418,16 @@
                 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
+              #   [Role](https://www.twilio.com/docs/api/chat/rest/v1/roles) assigned to this
+              #   member.
+              # @param [String] last_consumed_message_index An Integer representing index of the
+              #   last [Message](https://www.twilio.com/docs/api/chat/rest/v1/messages) this
+              #   Member has read within this
+              #   [Channel](https://www.twilio.com/docs/api/chat/rest/v1/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, )
               end
 
\ No newline at end of file