Class: Twilio::REST::Api::V2010::AccountContext::QueueContext

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

Defined Under Namespace

Classes: MemberContext, MemberInstance, MemberInstanceMetadata, MemberList, MemberListResponse, MemberPage, MemberPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, sid) ⇒ QueueContext

Initialize the QueueContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

    The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Queue resource to update.

  • sid (String) —

    The Twilio-provided string that uniquely identifies the Queue resource to update



234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 234

def initialize(version, , sid)
    super(version)
    

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

    # Dependents
    @members = nil
end

Instance Method Details

#delete ⇒ Boolean

Delete the QueueInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



248
249
250
251
252
253
254
255
256
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 248

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata ⇒ Boolean

Delete the QueueInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 261

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      queue_instance = QueueInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      QueueInstanceMetadata.new(@version, queue_instance, response.headers, response.status_code)
end

#fetch ⇒ QueueInstance

Fetch the QueueInstance

Returns:



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 280

def fetch

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

#fetch_with_metadata ⇒ QueueInstance

Fetch the QueueInstanceMetadata

Returns:



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 300

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    queue_instance = QueueInstance.new(
        @version,
        response.body,
        account_sid: @solution[:account_sid],
        sid: @solution[:sid],
    )
    QueueInstanceMetadata.new(
        @version,
        queue_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



418
419
420
421
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 418

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Api.V2010.QueueContext #{context}>"
end

#members(call_sid = :unset) ⇒ MemberList, MemberContext

Access the members

Returns:

Raises:

  • (ArgumentError) 


393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 393

def members(call_sid=:unset)

    raise ArgumentError, 'call_sid cannot be nil' if call_sid.nil?

    if call_sid != :unset
        return MemberContext.new(@version, @solution[:account_sid], @solution[:sid],call_sid )
    end

    unless @members
        @members = MemberList.new(
            @version, account_sid: @solution[:account_sid], queue_sid: @solution[:sid], )
    end

 @members
end

#to_s ⇒ Object

Provide a user friendly representation



411
412
413
414
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 411

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Api.V2010.QueueContext #{context}>"
end

#update(friendly_name: :unset, max_size: :unset) ⇒ QueueInstance

Update the QueueInstance

Parameters:

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

    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:



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 328

def update(
  friendly_name: :unset, 
  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.update('POST', @uri, data: data, headers: headers)
    QueueInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        sid: @solution[:sid],
    )
end

#update_with_metadata(friendly_name: :unset, max_size: :unset) ⇒ QueueInstance

Update the QueueInstanceMetadata

Parameters:

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

    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:



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 358

def update_with_metadata(
  friendly_name: :unset, 
  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.update_with_metadata('POST', @uri, data: data, headers: headers)
    queue_instance = QueueInstance.new(
        @version,
        response.body,
        account_sid: @solution[:account_sid],
        sid: @solution[:sid],
    )
    QueueInstanceMetadata.new(
        @version,
        queue_instance,
        response.headers,
        response.status_code
    )
end