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



22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 22

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

Create the QueueInstance



117
118
119
120
121
122
123
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 117

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.



68
69
70
71
72
73
74
75
76
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 68

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.



102
103
104
105
106
107
108
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 102

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.



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

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.



85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 85

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: 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.



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

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



127
128
129
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 127

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