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

Parameters:

  • version (Version) —

    Version that contains the resource



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.



108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb', line 108

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of ReservationInstance



147
148
149
150
151
152
153
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb', line 147

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.

Parameters:

  • reservation_status (Status) (defaults to: :unset) —

    Returns the list of reservations for a worker with a specified ReservationStatus. Can be: pending, accepted, rejected, timeout, canceled, or rescinded.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    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)

Returns:

  • (Array) —

    Array of up to limit results



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

Returns Array of up to limit results.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    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)

Returns:

  • (Array) —

    Array of up to limit results



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb', line 90

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.

Parameters:

  • reservation_status (Status) (defaults to: :unset) —

    Returns the list of reservations for a worker with a specified ReservationStatus. Can be: pending, accepted, rejected, timeout, canceled, or rescinded.

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of ReservationInstance



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb', line 126

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.

Parameters:

  • reservation_status (Status) (defaults to: :unset) —

    Returns the list of reservations for a worker with a specified ReservationStatus. Can be: pending, accepted, rejected, timeout, canceled, or rescinded.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    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)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



70
71
72
73
74
75
76
77
78
 
# 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], )

    @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



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

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