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



808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 808

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:



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

def addresses
  context.addresses
end

#applications ⇒ applications

Access the applications

Returns:



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

def applications
  context.applications
end

#auth_token ⇒ String

Returns The authorization token for this account.

Returns:

  • (String) —

    The authorization token for this account



848
849
850
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 848

def auth_token
  @properties['auth_token']
end

#authorized_connect_apps ⇒ authorized_connect_apps

Access the authorized_connect_apps

Returns:



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

def authorized_connect_apps
  context.authorized_connect_apps
end

#available_phone_numbers ⇒ available_phone_numbers

Access the available_phone_numbers

Returns:



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

def available_phone_numbers
  context.available_phone_numbers
end

#calls ⇒ calls

Access the calls

Returns:



958
959
960
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 958

def calls
  context.calls
end

#conferences ⇒ conferences

Access the conferences

Returns:



965
966
967
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 965

def conferences
  context.conferences
end

#connect_apps ⇒ connect_apps

Access the connect_apps

Returns:



972
973
974
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 972

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:



836
837
838
839
840
841
842
843
844
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 836

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



854
855
856
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 854

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



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

def date_updated
  @properties['date_updated']
end

#fetch ⇒ AccountInstance

Fetch a AccountInstance

Returns:



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

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



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

def friendly_name
  @properties['friendly_name']
end

#incoming_phone_numbers ⇒ incoming_phone_numbers

Access the incoming_phone_numbers

Returns:



979
980
981
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 979

def incoming_phone_numbers
  context.incoming_phone_numbers
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



1097
1098
1099
1100
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 1097

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

#keys ⇒ keys

Access the keys

Returns:



986
987
988
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 986

def keys
  context.keys
end

#messages ⇒ messages

Access the messages

Returns:



993
994
995
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 993

def messages
  context.messages
end

#new_keys ⇒ new_keys

Access the new_keys

Returns:



1000
1001
1002
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 1000

def new_keys
  context.new_keys
end

#new_signing_keys ⇒ new_signing_keys

Access the new_signing_keys

Returns:



1007
1008
1009
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 1007

def new_signing_keys
  context.new_signing_keys
end

#notifications ⇒ notifications

Access the notifications

Returns:



1014
1015
1016
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 1014

def notifications
  context.notifications
end

#outgoing_caller_ids ⇒ outgoing_caller_ids

Access the outgoing_caller_ids

Returns:



1021
1022
1023
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 1021

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



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

def 
  @properties['owner_account_sid']
end

#queues ⇒ queues

Access the queues

Returns:



1028
1029
1030
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 1028

def queues
  context.queues
end

#recordings ⇒ recordings

Access the recordings

Returns:



1035
1036
1037
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 1035

def recordings
  context.recordings
end

#short_codes ⇒ short_codes

Access the short_codes

Returns:



1056
1057
1058
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 1056

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.



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

def sid
  @properties['sid']
end

#signing_keys ⇒ signing_keys

Access the signing_keys

Returns:



1042
1043
1044
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 1042

def signing_keys
  context.signing_keys
end

#sip ⇒ sip

Access the sip

Returns:

  • (sip) —

    sip



1049
1050
1051
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 1049

def sip
  context.sip
end

#status ⇒ account.Status

Returns The status of this account.

Returns:

  • (account.Status) —

    The status of this account



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

def status
  @properties['status']
end

#subresource_uris ⇒ String

Returns Account Instance Subresources.

Returns:

  • (String) —

    Account Instance Subresources



890
891
892
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 890

def subresource_uris
  @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



1090
1091
1092
1093
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 1090

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

#tokens ⇒ tokens

Access the tokens

Returns:



1063
1064
1065
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 1063

def tokens
  context.tokens
end

#transcriptions ⇒ transcriptions

Access the transcriptions

Returns:



1070
1071
1072
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 1070

def transcriptions
  context.transcriptions
end

#type ⇒ account.Type

Returns The type of this account.

Returns:

  • (account.Type) —

    The type of this account



896
897
898
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 896

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 with a given Status

Returns:



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

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`



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

def uri
  @properties['uri']
end

#usage ⇒ usage

Access the usage

Returns:



1077
1078
1079
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 1077

def usage
  context.usage
end

#validation_requests ⇒ validation_requests

Access the validation_requests

Returns:



1084
1085
1086
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 1084

def validation_requests
  context.validation_requests
end