class Twilio::REST::Api::V2010::AccountContext
Public Class Methods
Initialize the AccountContext
@param [Version] version Version
that contains the resource @param [String] sid The Account Sid that uniquely identifies the account to
fetch
@return [AccountContext] AccountContext
Twilio::REST::InstanceContext::new
# File lib/twilio-ruby/rest/api/v2010/account.rb 181 def initialize(version, sid) 182 super(version) 183 184 # Path Solution 185 @solution = {sid: sid, } 186 @uri = "/Accounts/#{@solution[:sid]}.json" 187 188 # Dependents 189 @addresses = nil 190 @applications = nil 191 @authorized_connect_apps = nil 192 @available_phone_numbers = nil 193 @balance = nil 194 @calls = nil 195 @conferences = nil 196 @connect_apps = nil 197 @incoming_phone_numbers = nil 198 @keys = nil 199 @messages = nil 200 @new_keys = nil 201 @new_signing_keys = nil 202 @notifications = nil 203 @outgoing_caller_ids = nil 204 @queues = nil 205 @recordings = nil 206 @signing_keys = nil 207 @sip = nil 208 @short_codes = nil 209 @tokens = nil 210 @transcriptions = nil 211 @usage = nil 212 @validation_requests = nil 213 end
Public Instance Methods
Access the addresses @return [AddressList] @return [AddressContext] if sid was passed.
# File lib/twilio-ruby/rest/api/v2010/account.rb 244 def addresses(sid=:unset) 245 raise ArgumentError, 'sid cannot be nil' if sid.nil? 246 247 if sid != :unset 248 return AddressContext.new(@version, @solution[:sid], sid, ) 249 end 250 251 unless @addresses 252 @addresses = AddressList.new(@version, account_sid: @solution[:sid], ) 253 end 254 255 @addresses 256 end
Access the applications @return [ApplicationList] @return [ApplicationContext] if sid was passed.
# File lib/twilio-ruby/rest/api/v2010/account.rb 262 def applications(sid=:unset) 263 raise ArgumentError, 'sid cannot be nil' if sid.nil? 264 265 if sid != :unset 266 return ApplicationContext.new(@version, @solution[:sid], sid, ) 267 end 268 269 unless @applications 270 @applications = ApplicationList.new(@version, account_sid: @solution[:sid], ) 271 end 272 273 @applications 274 end
Access the available_phone_numbers
@return [AvailablePhoneNumberCountryList] @return [AvailablePhoneNumberCountryContext] if country_code was passed.
# File lib/twilio-ruby/rest/api/v2010/account.rb 298 def available_phone_numbers(country_code=:unset) 299 raise ArgumentError, 'country_code cannot be nil' if country_code.nil? 300 301 if country_code != :unset 302 return AvailablePhoneNumberCountryContext.new(@version, @solution[:sid], country_code, ) 303 end 304 305 unless @available_phone_numbers 306 @available_phone_numbers = AvailablePhoneNumberCountryList.new( 307 @version, 308 account_sid: @solution[:sid], 309 ) 310 end 311 312 @available_phone_numbers 313 end
Access the balance @return [BalanceList] @return [BalanceContext]
# File lib/twilio-ruby/rest/api/v2010/account.rb 319 def balance 320 unless @balance 321 @balance = BalanceList.new(@version, account_sid: @solution[:sid], ) 322 end 323 324 @balance 325 end
Access the calls @return [CallList] @return [CallContext] if sid was passed.
# File lib/twilio-ruby/rest/api/v2010/account.rb 331 def calls(sid=:unset) 332 raise ArgumentError, 'sid cannot be nil' if sid.nil? 333 334 if sid != :unset 335 return CallContext.new(@version, @solution[:sid], sid, ) 336 end 337 338 unless @calls 339 @calls = CallList.new(@version, account_sid: @solution[:sid], ) 340 end 341 342 @calls 343 end
Access the conferences @return [ConferenceList] @return [ConferenceContext] if sid was passed.
# File lib/twilio-ruby/rest/api/v2010/account.rb 349 def conferences(sid=:unset) 350 raise ArgumentError, 'sid cannot be nil' if sid.nil? 351 352 if sid != :unset 353 return ConferenceContext.new(@version, @solution[:sid], sid, ) 354 end 355 356 unless @conferences 357 @conferences = ConferenceList.new(@version, account_sid: @solution[:sid], ) 358 end 359 360 @conferences 361 end
Access the connect_apps
@return [ConnectAppList] @return [ConnectAppContext] if sid was passed.
# File lib/twilio-ruby/rest/api/v2010/account.rb 367 def connect_apps(sid=:unset) 368 raise ArgumentError, 'sid cannot be nil' if sid.nil? 369 370 if sid != :unset 371 return ConnectAppContext.new(@version, @solution[:sid], sid, ) 372 end 373 374 unless @connect_apps 375 @connect_apps = ConnectAppList.new(@version, account_sid: @solution[:sid], ) 376 end 377 378 @connect_apps 379 end
Fetch the AccountInstance
@return [AccountInstance] Fetched AccountInstance
# File lib/twilio-ruby/rest/api/v2010/account.rb 218 def fetch 219 payload = @version.fetch('GET', @uri) 220 221 AccountInstance.new(@version, payload, sid: @solution[:sid], ) 222 end
Access the incoming_phone_numbers
@return [IncomingPhoneNumberList] @return [IncomingPhoneNumberContext] if sid was passed.
# File lib/twilio-ruby/rest/api/v2010/account.rb 385 def incoming_phone_numbers(sid=:unset) 386 raise ArgumentError, 'sid cannot be nil' if sid.nil? 387 388 if sid != :unset 389 return IncomingPhoneNumberContext.new(@version, @solution[:sid], sid, ) 390 end 391 392 unless @incoming_phone_numbers 393 @incoming_phone_numbers = IncomingPhoneNumberList.new(@version, account_sid: @solution[:sid], ) 394 end 395 396 @incoming_phone_numbers 397 end
Provide a detailed, user friendly representation
# File lib/twilio-ruby/rest/api/v2010/account.rb 642 def inspect 643 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',') 644 "#<Twilio.Api.V2010.AccountContext #{context}>" 645 end
Access the keys @return [KeyList] @return [KeyContext] if sid was passed.
# File lib/twilio-ruby/rest/api/v2010/account.rb 403 def keys(sid=:unset) 404 raise ArgumentError, 'sid cannot be nil' if sid.nil? 405 406 if sid != :unset 407 return KeyContext.new(@version, @solution[:sid], sid, ) 408 end 409 410 unless @keys 411 @keys = KeyList.new(@version, account_sid: @solution[:sid], ) 412 end 413 414 @keys 415 end
Access the messages @return [MessageList] @return [MessageContext] if sid was passed.
# File lib/twilio-ruby/rest/api/v2010/account.rb 421 def messages(sid=:unset) 422 raise ArgumentError, 'sid cannot be nil' if sid.nil? 423 424 if sid != :unset 425 return MessageContext.new(@version, @solution[:sid], sid, ) 426 end 427 428 unless @messages 429 @messages = MessageList.new(@version, account_sid: @solution[:sid], ) 430 end 431 432 @messages 433 end
Access the new_keys
@return [NewKeyList] @return [NewKeyContext]
# File lib/twilio-ruby/rest/api/v2010/account.rb 439 def new_keys 440 unless @new_keys 441 @new_keys = NewKeyList.new(@version, account_sid: @solution[:sid], ) 442 end 443 444 @new_keys 445 end
Access the new_signing_keys
@return [NewSigningKeyList] @return [NewSigningKeyContext]
# File lib/twilio-ruby/rest/api/v2010/account.rb 451 def new_signing_keys 452 unless @new_signing_keys 453 @new_signing_keys = NewSigningKeyList.new(@version, account_sid: @solution[:sid], ) 454 end 455 456 @new_signing_keys 457 end
Access the notifications @return [NotificationList] @return [NotificationContext] if sid was passed.
# File lib/twilio-ruby/rest/api/v2010/account.rb 463 def notifications(sid=:unset) 464 raise ArgumentError, 'sid cannot be nil' if sid.nil? 465 466 if sid != :unset 467 return NotificationContext.new(@version, @solution[:sid], sid, ) 468 end 469 470 unless @notifications 471 @notifications = NotificationList.new(@version, account_sid: @solution[:sid], ) 472 end 473 474 @notifications 475 end
Access the outgoing_caller_ids
@return [OutgoingCallerIdList] @return [OutgoingCallerIdContext] if sid was passed.
# File lib/twilio-ruby/rest/api/v2010/account.rb 481 def outgoing_caller_ids(sid=:unset) 482 raise ArgumentError, 'sid cannot be nil' if sid.nil? 483 484 if sid != :unset 485 return OutgoingCallerIdContext.new(@version, @solution[:sid], sid, ) 486 end 487 488 unless @outgoing_caller_ids 489 @outgoing_caller_ids = OutgoingCallerIdList.new(@version, account_sid: @solution[:sid], ) 490 end 491 492 @outgoing_caller_ids 493 end
Access the queues @return [QueueList] @return [QueueContext] if sid was passed.
# File lib/twilio-ruby/rest/api/v2010/account.rb 499 def queues(sid=:unset) 500 raise ArgumentError, 'sid cannot be nil' if sid.nil? 501 502 if sid != :unset 503 return QueueContext.new(@version, @solution[:sid], sid, ) 504 end 505 506 unless @queues 507 @queues = QueueList.new(@version, account_sid: @solution[:sid], ) 508 end 509 510 @queues 511 end
Access the recordings @return [RecordingList] @return [RecordingContext] if sid was passed.
# File lib/twilio-ruby/rest/api/v2010/account.rb 517 def recordings(sid=:unset) 518 raise ArgumentError, 'sid cannot be nil' if sid.nil? 519 520 if sid != :unset 521 return RecordingContext.new(@version, @solution[:sid], sid, ) 522 end 523 524 unless @recordings 525 @recordings = RecordingList.new(@version, account_sid: @solution[:sid], ) 526 end 527 528 @recordings 529 end
Access the short_codes
@return [ShortCodeList] @return [ShortCodeContext] if sid was passed.
# File lib/twilio-ruby/rest/api/v2010/account.rb 565 def short_codes(sid=:unset) 566 raise ArgumentError, 'sid cannot be nil' if sid.nil? 567 568 if sid != :unset 569 return ShortCodeContext.new(@version, @solution[:sid], sid, ) 570 end 571 572 unless @short_codes 573 @short_codes = ShortCodeList.new(@version, account_sid: @solution[:sid], ) 574 end 575 576 @short_codes 577 end
Access the signing_keys
@return [SigningKeyList] @return [SigningKeyContext] if sid was passed.
# File lib/twilio-ruby/rest/api/v2010/account.rb 535 def signing_keys(sid=:unset) 536 raise ArgumentError, 'sid cannot be nil' if sid.nil? 537 538 if sid != :unset 539 return SigningKeyContext.new(@version, @solution[:sid], sid, ) 540 end 541 542 unless @signing_keys 543 @signing_keys = SigningKeyList.new(@version, account_sid: @solution[:sid], ) 544 end 545 546 @signing_keys 547 end
Access the sip @return [SipList] @return [SipContext]
# File lib/twilio-ruby/rest/api/v2010/account.rb 553 def sip 554 unless @sip 555 @sip = SipList.new(@version, account_sid: @solution[:sid], ) 556 end 557 558 @sip 559 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/api/v2010/account.rb 635 def to_s 636 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',') 637 "#<Twilio.Api.V2010.AccountContext #{context}>" 638 end
Access the tokens @return [TokenList] @return [TokenContext]
# File lib/twilio-ruby/rest/api/v2010/account.rb 583 def tokens 584 unless @tokens 585 @tokens = TokenList.new(@version, account_sid: @solution[:sid], ) 586 end 587 588 @tokens 589 end
Access the transcriptions @return [TranscriptionList] @return [TranscriptionContext] if sid was passed.
# File lib/twilio-ruby/rest/api/v2010/account.rb 595 def transcriptions(sid=:unset) 596 raise ArgumentError, 'sid cannot be nil' if sid.nil? 597 598 if sid != :unset 599 return TranscriptionContext.new(@version, @solution[:sid], sid, ) 600 end 601 602 unless @transcriptions 603 @transcriptions = TranscriptionList.new(@version, account_sid: @solution[:sid], ) 604 end 605 606 @transcriptions 607 end
Update the AccountInstance
@param [String] friendly_name Update the human-readable description of this
Account
@param [account.Status] status Alter the status of this account: use `closed` to
irreversibly close this account, `suspended` to temporarily suspend it, or `active` to reactivate it.
@return [AccountInstance] Updated AccountInstance
# File lib/twilio-ruby/rest/api/v2010/account.rb 232 def update(friendly_name: :unset, status: :unset) 233 data = Twilio::Values.of({'FriendlyName' => friendly_name, 'Status' => status, }) 234 235 payload = @version.update('POST', @uri, data: data) 236 237 AccountInstance.new(@version, payload, sid: @solution[:sid], ) 238 end
Access the usage @return [UsageList] @return [UsageContext]
# File lib/twilio-ruby/rest/api/v2010/account.rb 613 def usage 614 unless @usage 615 @usage = UsageList.new(@version, account_sid: @solution[:sid], ) 616 end 617 618 @usage 619 end
Access the validation_requests
@return [ValidationRequestList] @return [ValidationRequestContext]
# File lib/twilio-ruby/rest/api/v2010/account.rb 625 def validation_requests 626 unless @validation_requests 627 @validation_requests = ValidationRequestList.new(@version, account_sid: @solution[:sid], ) 628 end 629 630 @validation_requests 631 end