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

Link to this function all(options \\ []) View Source
all(list) :: [map]
Link to this function children() View Source
children() :: list

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)
Link to this function do_new(struct, list) View Source
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}
Link to this function new() View Source
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}
Link to this function new(attrs) View Source
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}
Link to this function parents() View Source
parents() :: list

Reactivate a suspended Account by updating its status to “active”.

Example

{:ok, account} = ExTwilio.Account.find("<sid>")
ExTwilio.Account.reactivate(account)
Link to this function resource_collection_name() View Source

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 an Account by updating its status to “suspended”.

Example

{:ok, account} = ExTwilio.Account.find("<sid>")
ExTwilio.Account.suspend(account)