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



28
29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 28

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

Parameters:

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

    A descriptive string that you created to describe this resource. It can be up to 64 characters long.

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

    The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000.

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 41

def create(
    friendly_name: nil, 
    max_size: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    QueueInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
    )
end

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

Create the QueueInstanceMetadata

Parameters:

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

    A descriptive string that you created to describe this resource. It can be up to 64 characters long.

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

    The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000.

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 70

def create_with_metadata(
  friendly_name: nil, 
  max_size: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    queue_instance = QueueInstance.new(
        @version,
        response.body,
        account_sid: @solution[:account_sid],
    )
    QueueInstanceMetadata.new(
        @version,
        queue_instance,
        response.headers,
        response.status_code
    )
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.



165
166
167
168
169
170
171
172
173
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 165

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



202
203
204
205
206
207
208
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 202

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



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

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

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

Lists QueuePageMetadata records from the API as a list.

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



148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 148

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

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

    QueuePageMetadata.new(@version, response, @solution, limits[:limit])
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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 182

def page(page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

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

    QueuePage.new(@version, response, @solution)
end

#stream(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:

  • 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



130
131
132
133
134
135
136
137
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 130

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



213
214
215
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 213

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