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/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/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/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/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/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/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/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb

Defined Under Namespace

Classes: AddressContext, AddressInstance, AddressList, AddressPage, ApplicationContext, ApplicationInstance, ApplicationList, ApplicationPage, AuthorizedConnectAppContext, AuthorizedConnectAppInstance, AuthorizedConnectAppList, AuthorizedConnectAppPage, AvailablePhoneNumberCountryContext, AvailablePhoneNumberCountryInstance, AvailablePhoneNumberCountryList, AvailablePhoneNumberCountryPage, 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

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The Account Sid that uniquely identifies the account to fetch



178
179
180
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
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 178

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
  @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

Returns:

Raises:

  • (ArgumentError) 


249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 249

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

Returns:

Raises:

  • (ArgumentError) 


267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 267

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

Returns:

Raises:

  • (ArgumentError) 


285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 285

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

Returns:

Raises:

  • (ArgumentError) 


303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 303

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

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

Access the calls

Returns:

Raises:

  • (ArgumentError) 


324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 324

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

Returns:

Raises:

  • (ArgumentError) 


342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 342

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

Returns:

Raises:

  • (ArgumentError) 


360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 360

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 a AccountInstance

Returns:



214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 214

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

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

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

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

Access the incoming_phone_numbers

Returns:

Raises:

  • (ArgumentError) 


378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 378

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

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

Access the keys

Returns:

Raises:

  • (ArgumentError) 


396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 396

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

Returns:

Raises:

  • (ArgumentError) 


414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 414

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

Returns:



432
433
434
435
436
437
438
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 432

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

Returns:



444
445
446
447
448
449
450
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 444

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

Returns:

Raises:

  • (ArgumentError) 


456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 456

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

Returns:

Raises:

  • (ArgumentError) 


474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 474

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

Returns:

Raises:

  • (ArgumentError) 


492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 492

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

Returns:

Raises:

  • (ArgumentError) 


510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 510

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

Returns:

Raises:

  • (ArgumentError) 


558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 558

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

Returns:

Raises:

  • (ArgumentError) 


528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 528

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

Returns:



546
547
548
549
550
551
552
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 546

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

  @sip
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#tokens ⇒ TokenList, TokenContext

Access the tokens

Returns:



576
577
578
579
580
581
582
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 576

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

  @tokens
end

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

Access the transcriptions

Returns:

Raises:

  • (ArgumentError) 


588
589
590
591
592
593
594
595
596
597
598
599
600
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 588

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

Parameters:

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

    Update the human-readable description of this Account

  • status (account.Status) (defaults to: :unset) —

    Alter the status of this account with a given Status

Returns:



233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 233

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

Returns:



606
607
608
609
610
611
612
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 606

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

  @usage
end

#validation_requests ⇒ ValidationRequestList, ValidationRequestContext

Access the validation_requests

Returns:



618
619
620
621
622
623
624
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 618

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

  @validation_requests
end