ExTwilio

v0.6.1

ExTwilio v0.6.1 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

all(options \\ [])
children()

Children represent path segments that come after the current resource. For example, in the path /v2/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users/Active “Active” is a child. Children may or may not have a key in the next segment

close(sid)

Permanently close an Account by updating its status to “closed”. This cannot be undone, so use it carefully!

create(data, options \\ [])
do_new(struct, list)
find(sid, options \\ [])
new()
new(attrs)
parents()

Parents represent path segments that precede the current resource. For example, in the path /v2/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users “Services” is a parent. Parents will always have a key in the next segment. If your parent is under a submodule of ExTwilio, specify your parent using the ExTwilio.Parent struct

reactivate(sid)

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

resource_collection_name()

Underscored and lowercased collection name for a given resource. Delegates the real work to ExTwilio.Api.resource_collection_name/1 by default

resource_name()

CamelCase resource name as it would be used in Twilio’s API. Delegates the real work to ExTwilio.Api.resource_name/1 by default

stream(options \\ [])
suspend(sid)

Suspend an Account by updating its status to “suspended”

update(sid, data, options \\ [])

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()

Children represent path segments that come after the current resource. For example, in the path /v2/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users/Active “Active” is a child. Children may or may not have a key in the next segment.

Override this method in your resource to specify children in the order that they will appear in the path.

Link to this function close(sid) View Source 
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)
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()

Parents represent path segments that precede the current resource. For example, in the path /v2/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users “Services” is a parent. Parents will always have a key in the next segment. If your parent is under a submodule of ExTwilio, specify your parent using the ExTwilio.Parent struct.

Override this method in your resource to specify parents in the order that they will appear in the path.

Link to this function reactivate(sid) View Source 
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)
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 after use ExTwilio.Resource if you need something different.

Link to this function resource_name() View Source

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 after use ExTwilio.Resource if you need something different.

Link to this function suspend(sid) View Source 
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)