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

Parameters:

  • version (Version) —

    Version that contains the resource

  • workspace_sid (String) (defaults to: nil) —

    The workspace_sid

  • task_sid (String) (defaults to: nil) —

    The task_sid



20
21
22
23
24
25
26
27
28
29
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 20

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.



78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 78

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



118
119
120
121
122
123
124
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 118

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 (reservation.Status) (defaults to: :unset) —

    The reservation_status

  • 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



43
44
45
46
47
48
49
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 43

def list(reservation_status: :unset, limit: nil, page_size: nil)
  self.stream(
      reservation_status: reservation_status,
      limit: limit,
      page_size: page_size
  ).entries
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 (reservation.Status) (defaults to: :unset) —

    The reservation_status

  • 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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 98

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,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  ReservationPage.new(@version, response, @solution)
end

#stream(reservation_status: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams ReservationInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

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

    The reservation_status

  • 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



63
64
65
66
67
68
69
70
71
72
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 63

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



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

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