Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskContext::ReservationList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskContext::ReservationList
- Defined in:
- lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb
Instance Method Summary collapse
-
#each ⇒ Object
When passed a block, yields ReservationInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of ReservationInstance records from the API.
-
#initialize(version, workspace_sid: nil, task_sid: nil) ⇒ ReservationList
constructor
Initialize the ReservationList.
-
#list(reservation_status: :unset, worker_sid: :unset, limit: nil, page_size: nil) ⇒ Array
Lists ReservationInstance records from the API as a list.
-
#page(reservation_status: :unset, worker_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of ReservationInstance records from the API.
-
#stream(reservation_status: :unset, worker_sid: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, workspace_sid: nil, task_sid: nil) ⇒ ReservationList
Initialize the ReservationList
28 29 30 31 32 33 34 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 28 def initialize(version, workspace_sid: nil, task_sid: nil) super(version) # Path Solution @solution = { workspace_sid: workspace_sid, task_sid: task_sid } @uri = "/Workspaces/#{@solution[:workspace_sid]}/Tasks/#{@solution[:task_sid]}/Reservations" end |
Instance Method Details
#each ⇒ Object
When passed a block, yields ReservationInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
86 87 88 89 90 91 92 93 94 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 86 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 |
#get_page(target_url) ⇒ Page
Retrieve a single page of ReservationInstance records from the API. Request is executed immediately.
124 125 126 127 128 129 130 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 124 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) ReservationPage.new(@version, response, @solution) end |
#list(reservation_status: :unset, worker_sid: :unset, limit: nil, page_size: nil) ⇒ Array
Lists ReservationInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
49 50 51 52 53 54 55 56 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 49 def list(reservation_status: :unset, worker_sid: :unset, limit: nil, page_size: nil) self.stream( reservation_status: reservation_status, worker_sid: worker_sid, limit: limit, page_size: page_size ).entries end |
#page(reservation_status: :unset, worker_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of ReservationInstance records from the API. Request is executed immediately.
105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 105 def page(reservation_status: :unset, worker_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'ReservationStatus' => reservation_status, 'WorkerSid' => worker_sid, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) ReservationPage.new(@version, response, @solution) end |
#stream(reservation_status: :unset, worker_sid: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
71 72 73 74 75 76 77 78 79 80 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 71 def stream(reservation_status: :unset, worker_sid: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( reservation_status: reservation_status, worker_sid: worker_sid, page_size: limits[:page_size], ) @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) end |
#to_s ⇒ Object
Provide a user friendly representation
135 136 137 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 135 def to_s '#<Twilio.Taskrouter.V1.ReservationList>' end |