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



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 161

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



174
175
176
177
178
179
 
# File 'lib/twilio-ruby/rest/api/v2010/account/queue.rb', line 174

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    @version.delete('DELETE', @uri, headers: headers)
end

#fetch ⇒ QueueInstance

Fetch the QueueInstance



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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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) 


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

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



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

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



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

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