lib/twilio-ruby/rest/api/v2010/account/queue.rb in twilio-ruby-5.0.0.rc18 vs lib/twilio-ruby/rest/api/v2010/account/queue.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 Api < Domain
class V2010 < Version
@@ -15,18 +15,18 @@
# @param [Version] version Version that contains the resource
# @param [String] account_sid The account_sid
# @return [QueueList] QueueList
def initialize(version, account_sid: nil)
super(version)
-
+
# Path Solution
@solution = {
account_sid: account_sid
}
@uri = "/Accounts/#{@solution[:account_sid]}/Queues.json"
end
-
+
##
# Lists QueueInstance 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()
@@ -40,11 +40,11 @@
self.stream(
limit: limit,
page_size: page_size
).entries
end
-
+
##
# Streams QueueInstance 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()
@@ -54,18 +54,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 QueueInstance 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()
@@ -74,20 +74,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 QueueInstance 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
@@ -104,11 +104,11 @@
@uri,
params
)
return QueuePage.new(@version, response, @solution)
end
-
+
##
# Retrieve a single page of QueueInstance records from the API.
# Request is executed immediately.
# @param [String] friendly_name A user-provided string that identifies this queue.
# @param [String] max_size The upper limit of calls allowed to be in the queue.
@@ -117,46 +117,46 @@
def create(friendly_name: nil, max_size: nil)
data = {
'FriendlyName' => friendly_name,
'MaxSize' => max_size,
}
-
+
payload = @version.create(
'POST',
@uri,
data: data
)
-
+
return QueueInstance.new(
@version,
payload,
account_sid: @solution[:account_sid],
)
end
-
+
##
# Provide a user friendly representation
def to_s
'#<Twilio.Api.V2010.QueueList>'
end
end
-
+
class QueuePage < Page
##
# Initialize the QueuePage
# @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] account_sid The account_sid
# @return [QueuePage] QueuePage
def initialize(version, response, solution)
super(version, response)
-
+
# Path Solution
@solution = solution
end
-
+
##
# Build an instance of QueueInstance
# @param [Hash] payload Payload response from the API
# @return [QueueInstance] QueueInstance
def get_instance(payload)
@@ -164,59 +164,59 @@
@version,
payload,
account_sid: @solution[:account_sid],
)
end
-
+
##
# Provide a user friendly representation
def to_s
'<Twilio.Api.V2010.QueuePage>'
end
end
-
+
class QueueContext < InstanceContext
##
# Initialize the QueueContext
# @param [Version] version Version that contains the resource
# @param [String] account_sid The account_sid
# @param [String] sid The queue Sid that uniquely identifies this resource
# @return [QueueContext] QueueContext
def initialize(version, account_sid, sid)
super(version)
-
+
# Path Solution
@solution = {
account_sid: account_sid,
sid: sid,
}
@uri = "/Accounts/#{@solution[:account_sid]}/Queues/#{@solution[:sid]}.json"
-
+
# Dependents
@members = nil
end
-
+
##
# Fetch a QueueInstance
# @return [QueueInstance] Fetched QueueInstance
def fetch
params = {}
-
+
payload = @version.fetch(
'GET',
@uri,
params,
)
-
+
return QueueInstance.new(
@version,
payload,
account_sid: @solution[:account_sid],
sid: @solution[:sid],
)
end
-
+
##
# Update the QueueInstance
# @param [String] friendly_name A human readable description of the queue
# @param [String] max_size The maximum number of members that can be in the queue
# at a time
@@ -224,32 +224,32 @@
def update(friendly_name: nil, max_size: nil)
data = {
'FriendlyName' => friendly_name,
'MaxSize' => max_size,
}
-
+
payload = @version.update(
'POST',
@uri,
data: data,
)
-
+
return QueueInstance.new(
@version,
payload,
account_sid: @solution[:account_sid],
sid: @solution[:sid],
)
end
-
+
##
# Deletes the QueueInstance
# @return [Boolean] true if delete succeeds, true otherwise
def delete
return @version.delete('delete', @uri)
end
-
+
##
# Access the members
# @return [MemberList] MemberList
def members(call_sid=:unset)
if call_sid != :unset
@@ -258,41 +258,41 @@
@solution[:account_sid],
@solution[:sid],
call_sid,
)
end
-
+
unless @members
@members = MemberList.new(
@version,
account_sid: @solution[:account_sid],
queue_sid: @solution[:sid],
)
end
-
+
@members
end
-
+
##
# Provide a user friendly representation
def to_s
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
"#<Twilio.Api.V2010.QueueContext #{context}>"
end
end
-
+
class QueueInstance < InstanceResource
##
# Initialize the QueueInstance
# @param [Version] version Version that contains the resource
# @param [Hash] payload payload that contains response from Twilio
# @param [String] account_sid The account_sid
# @param [String] sid The queue Sid that uniquely identifies this resource
# @return [QueueInstance] QueueInstance
def initialize(version, payload, account_sid: nil, sid: nil)
super(version)
-
+
# Marshaled Properties
@properties = {
'account_sid' => payload['account_sid'],
'average_wait_time' => payload['average_wait_time'].to_i,
'current_size' => payload['current_size'].to_i,
@@ -301,19 +301,19 @@
'friendly_name' => payload['friendly_name'],
'max_size' => payload['max_size'].to_i,
'sid' => payload['sid'],
'uri' => payload['uri'],
}
-
+
# Context
@instance_context = nil
@params = {
'account_sid' => account_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 [QueueContext] QueueContext for this QueueInstance
@@ -325,54 +325,54 @@
@params['sid'],
)
end
@instance_context
end
-
+
def account_sid
@properties['account_sid']
end
-
+
def average_wait_time
@properties['average_wait_time']
end
-
+
def current_size
@properties['current_size']
end
-
+
def date_created
@properties['date_created']
end
-
+
def date_updated
@properties['date_updated']
end
-
+
def friendly_name
@properties['friendly_name']
end
-
+
def max_size
@properties['max_size']
end
-
+
def sid
@properties['sid']
end
-
+
def uri
@properties['uri']
end
-
+
##
# Fetch a QueueInstance
# @return [QueueInstance] Fetched QueueInstance
def fetch
context.fetch
end
-
+
##
# Update the QueueInstance
# @param [String] friendly_name A human readable description of the queue
# @param [String] max_size The maximum number of members that can be in the queue
# at a time
@@ -381,24 +381,24 @@
context.update(
friendly_name: friendly_name,
max_size: max_size,
)
end
-
+
##
# Deletes the QueueInstance
# @return [Boolean] true if delete succeeds, true otherwise
def delete
context.delete
end
-
+
##
# Access the members
# @return [members] members
def members
context.members
end
-
+
##
# Provide a user friendly representation
def to_s
values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
"<Twilio.Api.V2010.QueueInstance #{values}>"
\ No newline at end of file