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



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

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) 


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

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) 


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

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) 


290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 290

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) 


308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 308

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) 


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

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) 


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

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) 


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

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:



219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 219

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) 


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

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) 


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

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) 


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

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:



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

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:



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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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:



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

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

  @sip
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#tokens ⇒ TokenList, TokenContext

Access the tokens

Returns:



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

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) 


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

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:



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

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:



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

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

  @usage
end

#validation_requests ⇒ ValidationRequestList, ValidationRequestContext

Access the validation_requests

Returns:



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

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

  @validation_requests
end