lib/twilio-ruby/rest/chat/v1/service/role.rb in twilio-ruby-5.0.0.rc18 vs lib/twilio-ruby/rest/chat/v1/service/role.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
@@ -15,18 +15,18 @@
# @param [Version] version Version that contains the resource
# @param [String] service_sid The service_sid
# @return [RoleList] RoleList
def initialize(version, service_sid: nil)
super(version)
-
+
# Path Solution
@solution = {
service_sid: service_sid
}
@uri = "/Services/#{@solution[:service_sid]}/Roles"
end
-
+
##
# Retrieve a single page of RoleInstance records from the API.
# Request is executed immediately.
# @param [String] friendly_name The friendly_name
# @param [role.RoleType] type The type
@@ -36,24 +36,24 @@
data = {
'FriendlyName' => friendly_name,
'Type' => type,
'Permission' => permission,
}
-
+
payload = @version.create(
'POST',
@uri,
data: data
)
-
+
return RoleInstance.new(
@version,
payload,
service_sid: @solution[:service_sid],
)
end
-
+
##
# Lists RoleInstance records from the API as a list.
# Unlike stream(), this operation is eager and will load `limit` records into
# memory before returning.
# @param [Integer] limit Upper limit for the number of records to return. stream()
@@ -67,11 +67,11 @@
self.stream(
limit: limit,
page_size: page_size
).entries
end
-
+
##
# Streams RoleInstance records from the API as an Enumerable.
# This operation lazily loads records as efficiently as possible until the limit
# is reached.
# @param [Integer] limit Upper limit for the number of records to return. stream()
@@ -81,18 +81,18 @@
# 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)
limits = @version.read_limits(limit, page_size)
-
+
page = self.page(
page_size: limits[:page_size],
)
-
+
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end
-
+
##
# When passed a block, yields RoleInstance records from the API.
# This operation lazily loads records as efficiently as possible until the limit
# is reached.
# @param [Integer] limit Upper limit for the number of records to return. stream()
@@ -101,20 +101,20 @@
# 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 RoleInstance records from the API.
# Request is executed immediately.
# @param [String] page_token PageToken provided by the API
# @param [Integer] page_number Page Number, this value is simply for client state
@@ -131,33 +131,33 @@
@uri,
params
)
return RolePage.new(@version, response, @solution)
end
-
+
##
# Provide a user friendly representation
def to_s
'#<Twilio.Chat.V1.RoleList>'
end
end
-
+
class RolePage < Page
##
# Initialize the RolePage
# @param [Version] version Version that contains the resource
# @param [Response] response Response from the API
# @param [Hash] solution Path solution for the resource
# @param [String] service_sid The service_sid
# @return [RolePage] RolePage
def initialize(version, response, solution)
super(version, response)
-
+
# Path Solution
@solution = solution
end
-
+
##
# Build an instance of RoleInstance
# @param [Hash] payload Payload response from the API
# @return [RoleInstance] RoleInstance
def get_instance(payload)
@@ -165,105 +165,105 @@
@version,
payload,
service_sid: @solution[:service_sid],
)
end
-
+
##
# Provide a user friendly representation
def to_s
'<Twilio.Chat.V1.RolePage>'
end
end
-
+
class RoleContext < InstanceContext
##
# Initialize the RoleContext
# @param [Version] version Version that contains the resource
# @param [String] service_sid The service_sid
# @param [String] sid The sid
# @return [RoleContext] RoleContext
def initialize(version, service_sid, sid)
super(version)
-
+
# Path Solution
@solution = {
service_sid: service_sid,
sid: sid,
}
@uri = "/Services/#{@solution[:service_sid]}/Roles/#{@solution[:sid]}"
end
-
+
##
# Fetch a RoleInstance
# @return [RoleInstance] Fetched RoleInstance
def fetch
params = {}
-
+
payload = @version.fetch(
'GET',
@uri,
params,
)
-
+
return RoleInstance.new(
@version,
payload,
service_sid: @solution[:service_sid],
sid: @solution[:sid],
)
end
-
+
##
# Deletes the RoleInstance
# @return [Boolean] true if delete succeeds, true otherwise
def delete
return @version.delete('delete', @uri)
end
-
+
##
# Update the RoleInstance
# @param [String] permission The permission
# @return [RoleInstance] Updated RoleInstance
def update(permission: nil)
data = {
'Permission' => permission,
}
-
+
payload = @version.update(
'POST',
@uri,
data: data,
)
-
+
return RoleInstance.new(
@version,
payload,
service_sid: @solution[:service_sid],
sid: @solution[:sid],
)
end
-
+
##
# Provide a user friendly representation
def to_s
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
"#<Twilio.Chat.V1.RoleContext #{context}>"
end
end
-
+
class RoleInstance < InstanceResource
##
# Initialize the RoleInstance
# @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
# @return [RoleInstance] RoleInstance
def initialize(version, payload, service_sid: nil, sid: nil)
super(version)
-
+
# Marshaled Properties
@properties = {
'sid' => payload['sid'],
'account_sid' => payload['account_sid'],
'service_sid' => payload['service_sid'],
@@ -272,19 +272,19 @@
'permissions' => payload['permissions'],
'date_created' => Twilio.deserialize_iso8601(payload['date_created']),
'date_updated' => Twilio.deserialize_iso8601(payload['date_updated']),
'url' => payload['url'],
}
-
+
# Context
@instance_context = nil
@params = {
'service_sid' => service_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 [RoleContext] RoleContext for this RoleInstance
@@ -296,70 +296,70 @@
@params['sid'],
)
end
@instance_context
end
-
+
def sid
@properties['sid']
end
-
+
def account_sid
@properties['account_sid']
end
-
+
def service_sid
@properties['service_sid']
end
-
+
def friendly_name
@properties['friendly_name']
end
-
+
def type
@properties['type']
end
-
+
def permissions
@properties['permissions']
end
-
+
def date_created
@properties['date_created']
end
-
+
def date_updated
@properties['date_updated']
end
-
+
def url
@properties['url']
end
-
+
##
# Fetch a RoleInstance
# @return [RoleInstance] Fetched RoleInstance
def fetch
context.fetch
end
-
+
##
# Deletes the RoleInstance
# @return [Boolean] true if delete succeeds, true otherwise
def delete
context.delete
end
-
+
##
# Update the RoleInstance
# @param [String] permission The permission
# @return [RoleInstance] Updated RoleInstance
def update(permission: nil)
context.update(
permission: permission,
)
end
-
+
##
# Provide a user friendly representation
def to_s
values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
"<Twilio.Chat.V1.RoleInstance #{values}>"
\ No newline at end of file