class Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkerContext::ReservationList

Public Class Methods

new(version, workspace_sid: nil, worker_sid: nil) click to toggle source

Initialize the ReservationList @param [Version] version Version that contains the resource @param [String] workspace_sid The SID of the Workspace that this worker is

contained within.

@param [String] worker_sid The SID of the reserved Worker resource. @return [ReservationList] ReservationList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb
23 def initialize(version, workspace_sid: nil, worker_sid: nil)
24   super(version)
25 
26   # Path Solution
27   @solution = {workspace_sid: workspace_sid, worker_sid: worker_sid}
28   @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workers/#{@solution[:worker_sid]}/Reservations"
29 end

Public Instance Methods

each() { |x| ... } click to toggle source

When passed a block, yields ReservationInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.

   # File lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb
75 def each
76   limits = @version.read_limits
77 
78   page = self.page(page_size: limits[:page_size], )
79 
80   @version.stream(page,
81                   limit: limits[:limit],
82                   page_limit: limits[:page_limit]).each {|x| yield x}
83 end
get_page(target_url) click to toggle source

Retrieve a single page of ReservationInstance records from the API. Request is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page of ReservationInstance

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb
113 def get_page(target_url)
114   response = @version.domain.request(
115       'GET',
116       target_url
117   )
118   ReservationPage.new(@version, response, @solution)
119 end
list(reservation_status: :unset, limit: nil, page_size: nil) click to toggle source

Lists ReservationInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [reservation.Status] reservation_status Returns the list of reservations

for a worker with a specified ReservationStatus. Can be: `pending`, `accepted`,
`rejected`, `timeout`, `canceled`, or `rescinded`.

@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

   # File lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb
45 def list(reservation_status: :unset, limit: nil, page_size: nil)
46   self.stream(reservation_status: reservation_status, limit: limit, page_size: page_size).entries
47 end
page(reservation_status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

Retrieve a single page of ReservationInstance records from the API. Request is executed immediately. @param [reservation.Status] reservation_status Returns the list of reservations

for a worker with a specified ReservationStatus. Can be: `pending`, `accepted`,
`rejected`, `timeout`, `canceled`, or `rescinded`.

@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 ReservationInstance

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb
 95 def page(reservation_status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
 96   params = Twilio::Values.of({
 97       'ReservationStatus' => reservation_status,
 98       'PageToken' => page_token,
 99       'Page' => page_number,
100       'PageSize' => page_size,
101   })
102 
103   response = @version.page('GET', @uri, params: params)
104 
105   ReservationPage.new(@version, response, @solution)
106 end
stream(reservation_status: :unset, limit: nil, page_size: nil) click to toggle source

Streams ReservationInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [reservation.Status] reservation_status Returns the list of reservations

for a worker with a specified ReservationStatus. Can be: `pending`, `accepted`,
`rejected`, `timeout`, `canceled`, or `rescinded`.

@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

   # File lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb
63 def stream(reservation_status: :unset, limit: nil, page_size: nil)
64   limits = @version.read_limits(limit, page_size)
65 
66   page = self.page(reservation_status: reservation_status, page_size: limits[:page_size], )
67 
68   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
69 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb
123 def to_s
124   '#<Twilio.Taskrouter.V1.ReservationList>'
125 end