lib/twilio-ruby/rest/chat/v1/service/channel/member.rb in twilio-ruby-5.0.0.rc18 vs lib/twilio-ruby/rest/chat/v1/service/channel/member.rb in twilio-ruby-5.0.0.rc19
- old
+ new
@@ -1,10 +1,10 @@
##
# This code was generated by
# \ / _ _ _| _ _
# | (_)\/(_)(_|\/| |(/_ v1.0.0
-# / /
+# / /
module Twilio
module REST
class Chat < Domain
class V1 < Version
@@ -17,19 +17,19 @@
# @param [String] service_sid The service_sid
# @param [String] channel_sid The channel_sid
# @return [MemberList] MemberList
def initialize(version, service_sid: nil, channel_sid: nil)
super(version)
-
+
# Path Solution
@solution = {
service_sid: service_sid,
channel_sid: channel_sid
}
@uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Members"
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
@@ -37,95 +37,102 @@
def create(identity: nil, role_sid: nil)
data = {
'Identity' => identity,
'RoleSid' => role_sid,
}
-
+
payload = @version.create(
'POST',
@uri,
data: data
)
-
+
return MemberInstance.new(
@version,
payload,
service_sid: @solution[:service_sid],
channel_sid: @solution[:channel_sid],
)
end
-
+
##
# 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 [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 efficient page size, i.e. min(limit, 1000)
# @return [Array] Array of up to limit results
- def list(limit: nil, page_size: nil)
+ def list(identity: nil, limit: nil, page_size: nil)
self.stream(
+ identity: identity,
limit: limit,
page_size: page_size
).entries
end
-
+
##
# 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 [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 efficient page size, i.e. min(limit, 1000)
# @return [Enumerable] Enumerable that will yield up to limit results
- def stream(limit: nil, page_size: nil)
+ def stream(identity: nil, limit: nil, page_size: nil)
limits = @version.read_limits(limit, page_size)
-
+
page = self.page(
+ identity: identity,
page_size: limits[:page_size],
)
-
+
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end
-
+
##
# When passed a block, yields MemberInstance records from the API.
# This operation lazily loads records as efficiently as possible until the limit
# is reached.
+ # @param [String] identity The identity
# @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 efficient page size, i.e. min(limit, 1000)
def each
limits = @version.read_limits
-
+
page = self.page(
page_size: limits[:page_size],
)
-
+
@version.stream(page,
limit: limits[:limit],
page_limit: limits[:page_limit]).each {|x| yield x}
end
-
+
##
# Retrieve a single page of MemberInstance records from the API.
# Request is executed immediately.
+ # @param [String] identity The identity
# @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(page_token: nil, page_number: nil, page_size: nil)
+ def page(identity: nil, page_token: nil, page_number: nil, page_size: nil)
params = {
+ 'Identity' => identity,
'PageToken' => page_token,
'Page' => page_number,
'PageSize' => page_size,
}
response = @version.page(
@@ -133,18 +140,18 @@
@uri,
params
)
return MemberPage.new(@version, response, @solution)
end
-
+
##
# Provide a user friendly representation
def to_s
'#<Twilio.Chat.V1.MemberList>'
end
end
-
+
class MemberPage < Page
##
# Initialize the MemberPage
# @param [Version] version Version that contains the resource
# @param [Response] response Response from the API
@@ -152,15 +159,15 @@
# @param [String] service_sid The service_sid
# @param [String] channel_sid The channel_sid
# @return [MemberPage] MemberPage
def initialize(version, response, solution)
super(version, response)
-
+
# Path Solution
@solution = solution
end
-
+
##
# Build an instance of MemberInstance
# @param [Hash] payload Payload response from the API
# @return [MemberInstance] MemberInstance
def get_instance(payload)
@@ -169,74 +176,100 @@
payload,
service_sid: @solution[:service_sid],
channel_sid: @solution[:channel_sid],
)
end
-
+
##
# Provide a user friendly representation
def to_s
'<Twilio.Chat.V1.MemberPage>'
end
end
-
+
class MemberContext < InstanceContext
##
# 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
# @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,
}
@uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Members/#{@solution[:sid]}"
end
-
+
##
# Fetch a MemberInstance
# @return [MemberInstance] Fetched MemberInstance
def fetch
params = {}
-
+
payload = @version.fetch(
'GET',
@uri,
params,
)
-
+
return MemberInstance.new(
@version,
payload,
service_sid: @solution[:service_sid],
channel_sid: @solution[:channel_sid],
sid: @solution[:sid],
)
end
-
+
##
# Deletes the MemberInstance
# @return [Boolean] true if delete succeeds, true otherwise
def delete
return @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
+ # @return [MemberInstance] Updated MemberInstance
+ def update(role_sid: nil, last_consumed_message_index: nil)
+ data = {
+ 'RoleSid' => role_sid,
+ 'LastConsumedMessageIndex' => last_consumed_message_index,
+ }
+
+ payload = @version.update(
+ 'POST',
+ @uri,
+ data: data,
+ )
+
+ return MemberInstance.new(
+ @version,
+ payload,
+ service_sid: @solution[:service_sid],
+ channel_sid: @solution[:channel_sid],
+ sid: @solution[:sid],
+ )
+ end
+
+ ##
# Provide a user friendly representation
def to_s
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
"#<Twilio.Chat.V1.MemberContext #{context}>"
end
end
-
+
class MemberInstance < InstanceResource
##
# Initialize the MemberInstance
# @param [Version] version Version that contains the resource
# @param [Hash] payload payload that contains response from Twilio
@@ -244,33 +277,35 @@
# @param [String] channel_sid The channel_sid
# @param [String] sid The sid
# @return [MemberInstance] MemberInstance
def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
super(version)
-
+
# Marshaled Properties
@properties = {
'sid' => payload['sid'],
'account_sid' => payload['account_sid'],
'channel_sid' => payload['channel_sid'],
'service_sid' => payload['service_sid'],
'identity' => payload['identity'],
'date_created' => Twilio.deserialize_iso8601(payload['date_created']),
'date_updated' => Twilio.deserialize_iso8601(payload['date_updated']),
'role_sid' => payload['role_sid'],
+ 'last_consumed_message_index' => payload['last_consumed_message_index'] == nil ? payload['last_consumed_message_index'] : payload['last_consumed_message_index'].to_i,
+ 'last_consumption_timestamp' => Twilio.deserialize_iso8601(payload['last_consumption_timestamp']),
'url' => payload['url'],
}
-
+
# Context
@instance_context = nil
@params = {
'service_sid' => service_sid,
'channel_sid' => channel_sid,
'sid' => sid || @properties['sid'],
}
end
-
+
##
# Generate an instance context for the instance, the context is capable of
# performing various actions. All instance actions are proxied to the context
# @param [Version] version Version that contains the resource
# @return [MemberContext] MemberContext for this MemberInstance
@@ -283,60 +318,80 @@
@params['sid'],
)
end
@instance_context
end
-
+
def sid
@properties['sid']
end
-
+
def account_sid
@properties['account_sid']
end
-
+
def channel_sid
@properties['channel_sid']
end
-
+
def service_sid
@properties['service_sid']
end
-
+
def identity
@properties['identity']
end
-
+
def date_created
@properties['date_created']
end
-
+
def date_updated
@properties['date_updated']
end
-
+
def role_sid
@properties['role_sid']
end
-
+
+ def last_consumed_message_index
+ @properties['last_consumed_message_index']
+ end
+
+ def last_consumption_timestamp
+ @properties['last_consumption_timestamp']
+ end
+
def url
@properties['url']
end
-
+
##
# Fetch a MemberInstance
# @return [MemberInstance] Fetched MemberInstance
def fetch
context.fetch
end
-
+
##
# Deletes the MemberInstance
# @return [Boolean] true if delete succeeds, true 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
+ # @return [MemberInstance] Updated MemberInstance
+ def update(role_sid: nil, last_consumed_message_index: nil)
+ context.update(
+ role_sid: role_sid,
+ last_consumed_message_index: last_consumed_message_index,
+ )
+ end
+
##
# Provide a user friendly representation
def to_s
values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
"<Twilio.Chat.V1.MemberInstance #{values}>"
\ No newline at end of file