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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the ReservationList



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

def initialize(version, workspace_sid: nil, worker_sid: nil)
    super(version)
    
    # Path Solution
    @solution = { workspace_sid: workspace_sid, worker_sid: worker_sid }
    @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workers/#{@solution[:worker_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.



112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb', line 112

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit])
    return [].each if result.nil?
    result.each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of ReservationInstance records from the API. Request is executed immediately.



155
156
157
158
159
160
161
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb', line 155

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
ReservationPage.new(@version, response, @solution)
end

#list(reservation_status: :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
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb', line 50

def list(reservation_status: :unset, limit: nil, page_size: nil)
    self.stream(
        reservation_status: reservation_status,
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(reservation_status: :unset, limit: nil, page_size: nil) ⇒ Array 



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb', line 94

def list_with_metadata(reservation_status: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'ReservationStatus' => reservation_status,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    ReservationPageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(reservation_status: :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.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb', line 134

def page(reservation_status: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'ReservationStatus' => reservation_status,
        '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, 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.



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

def stream(reservation_status: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        reservation_status: reservation_status,
        page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
    return [].each if result.nil?
    result
end

#to_s ⇒ Object

Provide a user friendly representation



166
167
168
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb', line 166

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