Class: Twilio::REST::Api::V2010::AccountInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ AccountInstance

Initialize the AccountInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • sid (String) (defaults to: nil) —

    The Account Sid that uniquely identifies the account to fetch



673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 673

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'auth_token' => payload['auth_token'],
      'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
      'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
      'friendly_name' => payload['friendly_name'],
      'owner_account_sid' => payload['owner_account_sid'],
      'sid' => payload['sid'],
      'status' => payload['status'],
      'subresource_uris' => payload['subresource_uris'],
      'type' => payload['type'],
      'uri' => payload['uri'],
  }

  # Context
  @instance_context = nil
  @params = {'sid' => sid || @properties['sid'], }
end

Instance Method Details

#addresses ⇒ addresses

Access the addresses

Returns:



788
789
790
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 788

def addresses
  context.addresses
end

#applications ⇒ applications

Access the applications

Returns:



795
796
797
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 795

def applications
  context.applications
end

#auth_token ⇒ String

Returns The authorization token for this account.

Returns:

  • (String) —

    The authorization token for this account



708
709
710
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 708

def auth_token
  @properties['auth_token']
end

#authorized_connect_apps ⇒ authorized_connect_apps

Access the authorized_connect_apps

Returns:



802
803
804
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 802

def authorized_connect_apps
  context.authorized_connect_apps
end

#available_phone_numbers ⇒ available_phone_numbers

Access the available_phone_numbers

Returns:



809
810
811
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 809

def available_phone_numbers
  context.available_phone_numbers
end

#balance ⇒ balance

Access the balance

Returns:



816
817
818
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 816

def balance
  context.balance
end

#calls ⇒ calls

Access the calls

Returns:



823
824
825
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 823

def calls
  context.calls
end

#conferences ⇒ conferences

Access the conferences

Returns:



830
831
832
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 830

def conferences
  context.conferences
end

#connect_apps ⇒ connect_apps

Access the connect_apps

Returns:



837
838
839
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 837

def connect_apps
  context.connect_apps
end

#context ⇒ AccountContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



699
700
701
702
703
704
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 699

def context
  unless @instance_context
    @instance_context = AccountContext.new(@version, @params['sid'], )
  end
  @instance_context
end

#date_created ⇒ Time

Returns The date this account was created.

Returns:

  • (Time) —

    The date this account was created



714
715
716
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 714

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this account was last updated.

Returns:

  • (Time) —

    The date this account was last updated



720
721
722
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 720

def date_updated
  @properties['date_updated']
end

#fetch ⇒ AccountInstance

Fetch a AccountInstance

Returns:



769
770
771
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 769

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A human readable description of this account.

Returns:

  • (String) —

    A human readable description of this account



726
727
728
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 726

def friendly_name
  @properties['friendly_name']
end

#incoming_phone_numbers ⇒ incoming_phone_numbers

Access the incoming_phone_numbers

Returns:



844
845
846
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 844

def incoming_phone_numbers
  context.incoming_phone_numbers
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



962
963
964
965
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 962

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.AccountInstance #{values}>"
end

#keys ⇒ keys

Access the keys

Returns:



851
852
853
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 851

def keys
  context.keys
end

#messages ⇒ messages

Access the messages

Returns:



858
859
860
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 858

def messages
  context.messages
end

#new_keys ⇒ new_keys

Access the new_keys

Returns:



865
866
867
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 865

def new_keys
  context.new_keys
end

#new_signing_keys ⇒ new_signing_keys

Access the new_signing_keys

Returns:



872
873
874
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 872

def new_signing_keys
  context.new_signing_keys
end

#notifications ⇒ notifications

Access the notifications

Returns:



879
880
881
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 879

def notifications
  context.notifications
end

#outgoing_caller_ids ⇒ outgoing_caller_ids

Access the outgoing_caller_ids

Returns:



886
887
888
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 886

def outgoing_caller_ids
  context.outgoing_caller_ids
end

#owner_account_sid ⇒ String

Returns The unique 34 character id representing the parent of this account.

Returns:

  • (String) —

    The unique 34 character id representing the parent of this account



732
733
734
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 732

def 
  @properties['owner_account_sid']
end

#queues ⇒ queues

Access the queues

Returns:



893
894
895
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 893

def queues
  context.queues
end

#recordings ⇒ recordings

Access the recordings

Returns:



900
901
902
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 900

def recordings
  context.recordings
end

#short_codes ⇒ short_codes

Access the short_codes

Returns:



921
922
923
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 921

def short_codes
  context.short_codes
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



738
739
740
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 738

def sid
  @properties['sid']
end

#signing_keys ⇒ signing_keys

Access the signing_keys

Returns:



907
908
909
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 907

def signing_keys
  context.signing_keys
end

#sip ⇒ sip

Access the sip

Returns:

  • (sip) —

    sip



914
915
916
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 914

def sip
  context.sip
end

#status ⇒ account.Status

Returns The status of this account.

Returns:

  • (account.Status) —

    The status of this account



744
745
746
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 744

def status
  @properties['status']
end

#subresource_uris ⇒ String

Returns Account Instance Subresources.

Returns:

  • (String) —

    Account Instance Subresources



750
751
752
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 750

def subresource_uris
  @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



955
956
957
958
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 955

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.AccountInstance #{values}>"
end

#tokens ⇒ tokens

Access the tokens

Returns:



928
929
930
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 928

def tokens
  context.tokens
end

#transcriptions ⇒ transcriptions

Access the transcriptions

Returns:



935
936
937
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 935

def transcriptions
  context.transcriptions
end

#type ⇒ account.Type

Returns The type of this account.

Returns:

  • (account.Type) —

    The type of this account



756
757
758
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 756

def type
  @properties['type']
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: use ‘closed` to irreversibly close this account, `suspended` to temporarily suspend it, or `active` to reactivate it.

Returns:



781
782
783
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 781

def update(friendly_name: :unset, status: :unset)
  context.update(friendly_name: friendly_name, status: status, )
end

#uri ⇒ String

Returns The URI for this resource, relative to ‘api.twilio.com`.

Returns:

  • (String) —

    The URI for this resource, relative to ‘api.twilio.com`



762
763
764
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 762

def uri
  @properties['uri']
end

#usage ⇒ usage

Access the usage

Returns:



942
943
944
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 942

def usage
  context.usage
end

#validation_requests ⇒ validation_requests

Access the validation_requests

Returns:



949
950
951
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 949

def validation_requests
  context.validation_requests
end