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, MemberList, MemberPage

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 account_sid

  • sid (String) —

    The queue Sid that uniquely identifies this resource



190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 190

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

Deletes the QueueInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



253
254
255
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 253

def delete
  @version.delete('delete', @uri)
end

#fetch ⇒ QueueInstance

Fetch a QueueInstance

Returns:



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 207

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  QueueInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      sid: @solution[:sid],
  )
end

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

Access the members

Returns:

Raises:

  • (ArgumentError) 


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

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



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

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 human readable description of the queue

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

    The maximum number of members that can be in the queue at a time

Returns:



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 230

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

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  QueueInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      sid: @solution[:sid],
  )
end