Class: Twilio::REST::Api::V2010::AccountContext::QueueInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, sid: nil) ⇒ QueueInstance

Initialize the QueueInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • account_sid (String) (defaults to: nil)

    The SID of the Account that created this Queue resource.

  • sid (String) (defaults to: nil)

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


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

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

  # Marshaled Properties
  @properties = {
      'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
      'current_size' => payload['current_size'].to_i,
      'friendly_name' => payload['friendly_name'],
      'uri' => payload['uri'],
      'account_sid' => payload['account_sid'],
      'average_wait_time' => payload['average_wait_time'].to_i,
      'sid' => payload['sid'],
      'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
      'max_size' => payload['max_size'].to_i,
  }

  # Context
  @instance_context = nil
  @params = {'account_sid' => , 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sidString

Returns The SID of the Account that created this resource.

Returns:

  • (String)

    The SID of the Account that created this resource


319
320
321
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 319

def 
  @properties['account_sid']
end

#average_wait_timeString

Returns Average wait time of members in the queue.

Returns:

  • (String)

    Average wait time of members in the queue


325
326
327
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 325

def average_wait_time
  @properties['average_wait_time']
end

#contextQueueContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:


286
287
288
289
290
291
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 286

def context
  unless @instance_context
    @instance_context = QueueContext.new(@version, @params['account_sid'], @params['sid'], )
  end
  @instance_context
end

#current_sizeString

Returns The number of calls currently in the queue.

Returns:

  • (String)

    The number of calls currently in the queue.


301
302
303
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 301

def current_size
  @properties['current_size']
end

#date_createdTime

Returns The RFC 2822 date and time in GMT that this resource was created.

Returns:

  • (Time)

    The RFC 2822 date and time in GMT that this resource was created


337
338
339
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 337

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The RFC 2822 date and time in GMT that this resource was last updated.

Returns:

  • (Time)

    The RFC 2822 date and time in GMT that this resource was last updated


295
296
297
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 295

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the QueueInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


368
369
370
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 368

def delete
  context.delete
end

#fetchQueueInstance

Fetch the QueueInstance

Returns:


350
351
352
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 350

def fetch
  context.fetch
end

#friendly_nameString

Returns A string that you assigned to describe this resource.

Returns:

  • (String)

    A string that you assigned to describe this resource


307
308
309
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 307

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


388
389
390
391
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 388

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.QueueInstance #{values}>"
end

#max_sizeString

Returns The max number of calls allowed in the queue.

Returns:

  • (String)

    The max number of calls allowed in the queue


343
344
345
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 343

def max_size
  @properties['max_size']
end

#membersmembers

Access the members

Returns:


375
376
377
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 375

def members
  context.members
end

#sidString

Returns The unique string that identifies this resource.

Returns:

  • (String)

    The unique string that identifies this resource


331
332
333
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 331

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


381
382
383
384
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 381

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.QueueInstance #{values}>"
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 100. The maximum is 5000.

Returns:


361
362
363
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 361

def update(friendly_name: :unset, max_size: :unset)
  context.update(friendly_name: friendly_name, max_size: max_size, )
end

#uriString

Returns The URI of this resource, relative to `api.twilio.com`.

Returns:


313
314
315
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 313

def uri
  @properties['uri']
end