Class: Twilio::REST::Api::V2010::AccountContext::QueueList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/queue.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ QueueList

Initialize the QueueList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The account_sid



18
19
20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 18

def initialize(version, account_sid: nil)
  super(version)

  # Path Solution
  @solution = {
      account_sid: 
  }
  @uri = "/Accounts/#{@solution[:account_sid]}/Queues.json"
end

Instance Method Details

#create(friendly_name: nil, max_size: :unset) ⇒ QueueInstance

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

Parameters:

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

    A user-provided string that identifies this queue.

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

    The upper limit of calls allowed to be in the queue. The default is 100. The maximum is 1000.

Returns:



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 124

def create(friendly_name: nil, max_size: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'MaxSize' => max_size,
  })

  payload = @version.create(
      'POST',
      @uri,
      data: data
  )

  QueueInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
  )
end

#each ⇒ Object

When passed a block, yields QueueInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 71

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 QueueInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of QueueInstance



109
110
111
112
113
114
115
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 109

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

#list(limit: nil, page_size: nil) ⇒ Array

Lists QueueInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

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



39
40
41
42
43
44
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 39

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

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

  • 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 QueueInstance



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 90

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  QueuePage.new(@version, response, @solution)
end

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

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

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:

  • (Enumerable) —

    Enumerable that will yield up to limit results



57
58
59
60
61
62
63
64
65
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 57

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

  page = self.page(
      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



145
146
147
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 145

def to_s
  '#<Twilio.Api.V2010.QueueList>'
end