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

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account.rb,
lib/twilio-ruby/rest/api/v2010/account/key.rb,
lib/twilio-ruby/rest/api/v2010/account/sip.rb,
lib/twilio-ruby/rest/api/v2010/account/call.rb,
lib/twilio-ruby/rest/api/v2010/account/queue.rb,
lib/twilio-ruby/rest/api/v2010/account/token.rb,
lib/twilio-ruby/rest/api/v2010/account/usage.rb,
lib/twilio-ruby/rest/api/v2010/account/address.rb,
lib/twilio-ruby/rest/api/v2010/account/balance.rb,
lib/twilio-ruby/rest/api/v2010/account/message.rb,
lib/twilio-ruby/rest/api/v2010/account/new_key.rb,
lib/twilio-ruby/rest/api/v2010/account/recording.rb,
lib/twilio-ruby/rest/api/v2010/account/call/event.rb,
lib/twilio-ruby/rest/api/v2010/account/conference.rb,
lib/twilio-ruby/rest/api/v2010/account/short_code.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb,
lib/twilio-ruby/rest/api/v2010/account/application.rb,
lib/twilio-ruby/rest/api/v2010/account/connect_app.rb,
lib/twilio-ruby/rest/api/v2010/account/signing_key.rb,
lib/twilio-ruby/rest/api/v2010/account/call/payment.rb,
lib/twilio-ruby/rest/api/v2010/account/notification.rb,
lib/twilio-ruby/rest/api/v2010/account/queue/member.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record.rb,
lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb,
lib/twilio-ruby/rest/api/v2010/account/message/media.rb,
lib/twilio-ruby/rest/api/v2010/account/transcription.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb,
lib/twilio-ruby/rest/api/v2010/account/call/recording.rb,
lib/twilio-ruby/rest/api/v2010/account/new_signing_key.rb,
lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb,
lib/twilio-ruby/rest/api/v2010/account/call/notification.rb,
lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/daily.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/today.rb,
lib/twilio-ruby/rest/api/v2010/account/validation_request.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb,
lib/twilio-ruby/rest/api/v2010/account/conference/recording.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/monthly.rb,
lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/all_time.rb,
lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb,
lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/yesterday.rb,
lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb,
lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/this_month.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number/voip.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number/mobile.rb,
lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number/national.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb,
lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number/toll_free.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number/shared_cost.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number/machine_to_machine.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_credential_list_mapping.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_calls_mapping/auth_calls_ip_access_control_list_mapping.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping/auth_registrations_credential_list_mapping.rb

Defined Under Namespace

Classes: AddressContext, AddressInstance, AddressList, AddressPage, ApplicationContext, ApplicationInstance, ApplicationList, ApplicationPage, AuthorizedConnectAppContext, AuthorizedConnectAppInstance, AuthorizedConnectAppList, AuthorizedConnectAppPage, AvailablePhoneNumberCountryContext, AvailablePhoneNumberCountryInstance, AvailablePhoneNumberCountryList, AvailablePhoneNumberCountryPage, BalanceInstance, BalanceList, BalancePage, CallContext, CallInstance, CallList, CallPage, ConferenceContext, ConferenceInstance, ConferenceList, ConferencePage, ConnectAppContext, ConnectAppInstance, ConnectAppList, ConnectAppPage, IncomingPhoneNumberContext, IncomingPhoneNumberInstance, IncomingPhoneNumberList, IncomingPhoneNumberPage, KeyContext, KeyInstance, KeyList, KeyPage, MessageContext, MessageInstance, MessageList, MessagePage, NewKeyInstance, NewKeyList, NewKeyPage, NewSigningKeyInstance, NewSigningKeyList, NewSigningKeyPage, NotificationContext, NotificationInstance, NotificationList, NotificationPage, OutgoingCallerIdContext, OutgoingCallerIdInstance, OutgoingCallerIdList, OutgoingCallerIdPage, QueueContext, QueueInstance, QueueList, QueuePage, RecordingContext, RecordingInstance, RecordingList, RecordingPage, ShortCodeContext, ShortCodeInstance, ShortCodeList, ShortCodePage, SigningKeyContext, SigningKeyInstance, SigningKeyList, SigningKeyPage, SipInstance, SipList, SipPage, TokenInstance, TokenList, TokenPage, TranscriptionContext, TranscriptionInstance, TranscriptionList, TranscriptionPage, UsageInstance, UsageList, UsagePage, ValidationRequestInstance, ValidationRequestList, ValidationRequestPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ AccountContext

Initialize the AccountContext



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 181

def initialize(version, sid)
  super(version)

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

  # Dependents
  @addresses = nil
  @applications = nil
  @authorized_connect_apps = nil
  @available_phone_numbers = nil
  @balance = nil
  @calls = nil
  @conferences = nil
  @connect_apps = nil
  @incoming_phone_numbers = nil
  @keys = nil
  @messages = nil
  @new_keys = nil
  @new_signing_keys = nil
  @notifications = nil
  @outgoing_caller_ids = nil
  @queues = nil
  @recordings = nil
  @signing_keys = nil
  @sip = nil
  @short_codes = nil
  @tokens = nil
  @transcriptions = nil
  @usage = nil
  @validation_requests = nil
end

Instance Method Details

#addresses(sid = :unset) ⇒ AddressList, AddressContext

Access the addresses

Raises:

  • (ArgumentError) 


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

def addresses(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

  unless @addresses
    @addresses = AddressList.new(@version, account_sid: @solution[:sid], )
  end

  @addresses
end

#applications(sid = :unset) ⇒ ApplicationList, ApplicationContext

Access the applications

Raises:

  • (ArgumentError) 


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

def applications(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

  unless @applications
    @applications = ApplicationList.new(@version, account_sid: @solution[:sid], )
  end

  @applications
end

#authorized_connect_apps(connect_app_sid = :unset) ⇒ AuthorizedConnectAppList, AuthorizedConnectAppContext

Access the authorized_connect_apps

Raises:

  • (ArgumentError) 


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

def authorized_connect_apps(connect_app_sid=:unset)
  raise ArgumentError, 'connect_app_sid cannot be nil' if connect_app_sid.nil?

  if connect_app_sid != :unset
    return AuthorizedConnectAppContext.new(@version, @solution[:sid], connect_app_sid, )
  end

  unless @authorized_connect_apps
    @authorized_connect_apps = AuthorizedConnectAppList.new(@version, account_sid: @solution[:sid], )
  end

  @authorized_connect_apps
end

#available_phone_numbers(country_code = :unset) ⇒ AvailablePhoneNumberCountryList, AvailablePhoneNumberCountryContext

Access the available_phone_numbers

Raises:

  • (ArgumentError) 


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

def available_phone_numbers(country_code=:unset)
  raise ArgumentError, 'country_code cannot be nil' if country_code.nil?

  if country_code != :unset
    return AvailablePhoneNumberCountryContext.new(@version, @solution[:sid], country_code, )
  end

  unless @available_phone_numbers
    @available_phone_numbers = AvailablePhoneNumberCountryList.new(
        @version,
        account_sid: @solution[:sid],
    )
  end

  @available_phone_numbers
end

#balance ⇒ BalanceList, BalanceContext

Access the balance



319
320
321
322
323
324
325
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 319

def balance
  unless @balance
    @balance = BalanceList.new(@version, account_sid: @solution[:sid], )
  end

  @balance
end

#calls(sid = :unset) ⇒ CallList, CallContext

Access the calls

Raises:

  • (ArgumentError) 


331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 331

def calls(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

  unless @calls
    @calls = CallList.new(@version, account_sid: @solution[:sid], )
  end

  @calls
end

#conferences(sid = :unset) ⇒ ConferenceList, ConferenceContext

Access the conferences

Raises:

  • (ArgumentError) 


349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 349

def conferences(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

  unless @conferences
    @conferences = ConferenceList.new(@version, account_sid: @solution[:sid], )
  end

  @conferences
end

#connect_apps(sid = :unset) ⇒ ConnectAppList, ConnectAppContext

Access the connect_apps

Raises:

  • (ArgumentError) 


367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 367

def connect_apps(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

  unless @connect_apps
    @connect_apps = ConnectAppList.new(@version, account_sid: @solution[:sid], )
  end

  @connect_apps
end

#fetch ⇒ AccountInstance

Fetch the AccountInstance



218
219
220
221
222
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 218

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

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

#incoming_phone_numbers(sid = :unset) ⇒ IncomingPhoneNumberList, IncomingPhoneNumberContext

Access the incoming_phone_numbers

Raises:

  • (ArgumentError) 


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

def incoming_phone_numbers(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

  unless @incoming_phone_numbers
    @incoming_phone_numbers = IncomingPhoneNumberList.new(@version, account_sid: @solution[:sid], )
  end

  @incoming_phone_numbers
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



642
643
644
645
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 642

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

#keys(sid = :unset) ⇒ KeyList, KeyContext

Access the keys

Raises:

  • (ArgumentError) 


403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 403

def keys(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

  unless @keys
    @keys = KeyList.new(@version, account_sid: @solution[:sid], )
  end

  @keys
end

#messages(sid = :unset) ⇒ MessageList, MessageContext

Access the messages

Raises:

  • (ArgumentError) 


421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 421

def messages(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

  unless @messages
    @messages = MessageList.new(@version, account_sid: @solution[:sid], )
  end

  @messages
end

#new_keys ⇒ NewKeyList, NewKeyContext

Access the new_keys



439
440
441
442
443
444
445
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 439

def new_keys
  unless @new_keys
    @new_keys = NewKeyList.new(@version, account_sid: @solution[:sid], )
  end

  @new_keys
end

#new_signing_keys ⇒ NewSigningKeyList, NewSigningKeyContext

Access the new_signing_keys



451
452
453
454
455
456
457
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 451

def new_signing_keys
  unless @new_signing_keys
    @new_signing_keys = NewSigningKeyList.new(@version, account_sid: @solution[:sid], )
  end

  @new_signing_keys
end

#notifications(sid = :unset) ⇒ NotificationList, NotificationContext

Access the notifications

Raises:

  • (ArgumentError) 


463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 463

def notifications(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

  unless @notifications
    @notifications = NotificationList.new(@version, account_sid: @solution[:sid], )
  end

  @notifications
end

#outgoing_caller_ids(sid = :unset) ⇒ OutgoingCallerIdList, OutgoingCallerIdContext

Access the outgoing_caller_ids

Raises:

  • (ArgumentError) 


481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 481

def outgoing_caller_ids(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

  unless @outgoing_caller_ids
    @outgoing_caller_ids = OutgoingCallerIdList.new(@version, account_sid: @solution[:sid], )
  end

  @outgoing_caller_ids
end

#queues(sid = :unset) ⇒ QueueList, QueueContext

Access the queues

Raises:

  • (ArgumentError) 


499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 499

def queues(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

  unless @queues
    @queues = QueueList.new(@version, account_sid: @solution[:sid], )
  end

  @queues
end

#recordings(sid = :unset) ⇒ RecordingList, RecordingContext

Access the recordings

Raises:

  • (ArgumentError) 


517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 517

def recordings(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

  unless @recordings
    @recordings = RecordingList.new(@version, account_sid: @solution[:sid], )
  end

  @recordings
end

#short_codes(sid = :unset) ⇒ ShortCodeList, ShortCodeContext

Access the short_codes

Raises:

  • (ArgumentError) 


565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 565

def short_codes(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

  unless @short_codes
    @short_codes = ShortCodeList.new(@version, account_sid: @solution[:sid], )
  end

  @short_codes
end

#signing_keys(sid = :unset) ⇒ SigningKeyList, SigningKeyContext

Access the signing_keys

Raises:

  • (ArgumentError) 


535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 535

def signing_keys(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

  unless @signing_keys
    @signing_keys = SigningKeyList.new(@version, account_sid: @solution[:sid], )
  end

  @signing_keys
end

#sip ⇒ SipList, SipContext

Access the sip



553
554
555
556
557
558
559
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 553

def sip
  unless @sip
    @sip = SipList.new(@version, account_sid: @solution[:sid], )
  end

  @sip
end

#to_s ⇒ Object

Provide a user friendly representation



635
636
637
638
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 635

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

#tokens ⇒ TokenList, TokenContext

Access the tokens



583
584
585
586
587
588
589
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 583

def tokens
  unless @tokens
    @tokens = TokenList.new(@version, account_sid: @solution[:sid], )
  end

  @tokens
end

#transcriptions(sid = :unset) ⇒ TranscriptionList, TranscriptionContext

Access the transcriptions

Raises:

  • (ArgumentError) 


595
596
597
598
599
600
601
602
603
604
605
606
607
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 595

def transcriptions(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

  unless @transcriptions
    @transcriptions = TranscriptionList.new(@version, account_sid: @solution[:sid], )
  end

  @transcriptions
end

#update(friendly_name: :unset, status: :unset) ⇒ AccountInstance

Update the AccountInstance



232
233
234
235
236
237
238
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 232

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

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

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

#usage ⇒ UsageList, UsageContext

Access the usage



613
614
615
616
617
618
619
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 613

def usage
  unless @usage
    @usage = UsageList.new(@version, account_sid: @solution[:sid], )
  end

  @usage
end

#validation_requests ⇒ ValidationRequestList, ValidationRequestContext

Access the validation_requests



625
626
627
628
629
630
631
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 625

def validation_requests
  unless @validation_requests
    @validation_requests = ValidationRequestList.new(@version, account_sid: @solution[:sid], )
  end

  @validation_requests
end