ExTwilio v0.8.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.stream(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

all(options \\ [])

all(list()) :: [map()]

children()

children() :: list()

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

close(sid)

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!

Twilio Docs

Example

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

create(data, options \\ [])

create(ExTwilio.Api.data(), list()) :: ExTwilio.Parser.parsed_response()

do_new(struct, list)

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(sid, options \\ [])

find(String.t() | nil, list()) :: ExTwilio.Parser.parsed_list_response()

new()

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

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

parents()

parents() :: list()

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

reactivate(sid)

reactivate(map() | String.t()) ::
  ExTwilio.Parser.success() | ExTwilio.Parser.error()

Reactivate a suspended Account by updating its status to "active".

Twilio Docs

Example

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

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.

Override in your module after use ExTwilio.Resource if you need something different.

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.

Override in your module after use ExTwilio.Resource if you need something different.

stream(options \\ [])

suspend(sid)

suspend(map() | String.t()) ::
  ExTwilio.Parser.success() | ExTwilio.Parser.error()

Suspend an Account by updating its status to "suspended".

Twilio Docs

Example

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

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

update(String.t(), ExTwilio.Api.data(), list()) ::
  ExTwilio.Parser.parsed_response()