ExTwilio v0.4.0 ExTwilio.Account View Source
Represents an Account or Subaccount resource.
Examples
An ExTwilio.Account can represent either an Account or a SubAccount. To see all accounts and subaccounts that your auth_token has access to, run:
ExTwilio.Account.all
If you want to find a SubAccount, use find/1
.
ExTwilio.Account.find("sid")
If you want to see items associated with a SubAccount, you can do so by
passing in an account:
option in all other ExTwilio resources. For example:
ExTwilio.Call.list(account: "subaccount_sid")
Link to this section Summary
Functions
Permanently close an Account by updating its status to “closed”. This cannot be undone, so use it carefully!
Reactivate a suspended Account by updating its status to “active”
Underscored and lowercased collection name for a given resource.
Delegates the real work to ExTwilio.Api.resource_collection_name/1
by
default
CamelCase resource name as it would be used in Twilio’s API. Delegates
the real work to ExTwilio.Api.resource_name/1
by default
Suspend an Account by updating its status to “suspended”
Link to this section Functions
close(map | String.t) :: ExTwilio.Parser.success | ExTwilio.Parser.error
Permanently close an Account by updating its status to “closed”. This cannot be undone, so use it carefully!
Example
{:ok, account} = ExTwilio.Account.find("<sid>")
ExTwilio.Account.close(account)
create(ExTwilio.Api.data, list) :: ExTwilio.Parser.parsed_response
do_new(%ExTwilio.Account{auth_token: term, date_created: term, date_updated: term, friendly_name: term, owner_account_sid: term, sid: term, status: term, subresource_uris: term, type: term, uri: term}, list) :: %ExTwilio.Account{auth_token: term, date_created: term, date_updated: term, friendly_name: term, owner_account_sid: term, sid: term, status: term, subresource_uris: term, type: term, uri: term}
find(String.t | nil, list) :: ExTwilio.Parser.parsed_list_response
new() :: %ExTwilio.Account{auth_token: term, date_created: term, date_updated: term, friendly_name: term, owner_account_sid: term, sid: term, status: term, subresource_uris: term, type: term, uri: term}
new(list) :: %ExTwilio.Account{auth_token: term, date_created: term, date_updated: term, friendly_name: term, owner_account_sid: term, sid: term, status: term, subresource_uris: term, type: term, uri: term}
reactivate(map | String.t) :: ExTwilio.Parser.success | ExTwilio.Parser.error
Reactivate a suspended Account by updating its status to “active”.
Example
{:ok, account} = ExTwilio.Account.find("<sid>")
ExTwilio.Account.reactivate(account)
Underscored and lowercased collection name for a given resource.
Delegates the real work to ExTwilio.Api.resource_collection_name/1
by
default.
Override in your module before use ExTwilio.Resource
if you need
something different.
CamelCase resource name as it would be used in Twilio’s API. Delegates
the real work to ExTwilio.Api.resource_name/1
by default.
Override in your module before use ExTwilio.Resource
if you need
something different.
suspend(map | String.t) :: ExTwilio.Parser.success | ExTwilio.Parser.error
Suspend an Account by updating its status to “suspended”.
Example
{:ok, account} = ExTwilio.Account.find("<sid>")
ExTwilio.Account.suspend(account)
update(String.t, ExTwilio.Api.data, list) :: ExTwilio.Parser.parsed_response