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



226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 226

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



240
241
242
243
244
245
246
247
248
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 240

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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 253

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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 272

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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 292

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



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

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

Raises:

  • (ArgumentError) 


385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 385

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



403
404
405
406
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 403

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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 320

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



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 350

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