Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskContext::ReservationList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid: nil, task_sid: nil) ⇒ ReservationList

Initialize the ReservationList



29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 29

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.



87
88
89
90
91
92
93
94
95
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 87

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.



128
129
130
131
132
133
134
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 128

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.



50
51
52
53
54
55
56
57
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 50

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.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 106

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,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

    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.



72
73
74
75
76
77
78
79
80
81
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 72

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



139
140
141
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 139

def to_s
    '#<Twilio.Taskrouter.V1.ReservationList>'
end