ExTwilio v0.1.1 → Overview → ExTwilio → Token

ExTwilio.Token

Represents an Token resource in the Twilio API.

Source

Summary↑

all(options \\ [])

Retrieve all of the Token records from the Twilio API, paging through all the API response pages
children()
create(data, options \\ [])

Create a new Token in the Twilio API. Any field supported by Twilio's Token API can be passed in the 'data' keyword list
first_page(metadata)

Get the first page of tokens, using metadata from any page's response
last_page(metadata)

Get the last page of tokens, using metadta from any page's response
list(options \\ [])

Retrieve a list of Tokens from the API
new()

Creates a new ExTwilio.Token struct. Optionally, you can pass in attributes to set their initial value in the struct
new(attrs)
next_page(metadata)

Get the next page of tokens, using the metadata from the previous response. See all/0 for an easy way to get all the records
parents()
previous_page(metadata)

Get the previous page of tokens, using metadata from a previous response
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 \\ [])

Create a stream of all Token records from the Twilio API

Functions

all(options \\ [])
(function) # ↑

Specs:

  • all(list) :: [%{}]

Retrieve all of the Token records from the Twilio API, paging through all the API response pages.

Delegates to ExTwilio.Api.all/2.

Examples

tokens = ExTwilio.Token.all
Source
children()
(function) # ↑

Specs:

  • children :: list
Source
create(data, options \\ [])
(function) # ↑

Specs:

Create a new Token in the Twilio API. Any field supported by Twilio's Token API can be passed in the 'data' keyword list.

Delegates to ExTwilio.Api.create/3.

Source
first_page(metadata)
(function) # ↑

Specs:

Get the first page of tokens, using metadata from any page's response.

Delegates to ExTwilio.Api.fetch_page/2.

Examples

{:ok, page10, meta} = ExTwilio.Token.list(page: 10)
{:ok, page1, meta}  = ExTwilio.Token.first_page(meta)
Source
last_page(metadata)
(function) # ↑

Specs:

Get the last page of tokens, using metadta from any page's response.

Delegates to ExTwilio.Api.fetch_page/2.

Examples

{:ok, page10, meta}    = ExTwilio.Token.list(page: 10)
{:ok, last_page, meta} = ExTwilio.Token.last_page(meta)
Source
list(options \\ [])
(function) # ↑

Specs:

Retrieve a list of Tokens from the API.

Delegates to ExTwilio.Api.list/2.

Examples

# Successful response
{:ok, tokens, metadata} = ExTwilio.Token.list

# Error response
{:error, msg, http_code} = ExTwilio.Token.list
Source
new()
(function) # ↑

Specs:

  • new :: %ExTwilio.Token{account_sid: term, date_created: term, date_updated: term, ice_servers: term, password: term, ttl: term, username: term}

Creates a new ExTwilio.Token struct. Optionally, you can pass in attributes to set their initial value in the struct.

Example

%ExTwilio.Token{} = ExTwilio.Token.new
%ExTwilio.Token{sid: "sid"} = ExTwilio.Token.new(sid: "sid")
Source
new(attrs)
(function) # ↑

Specs:

  • new(list) :: %ExTwilio.Token{account_sid: term, date_created: term, date_updated: term, ice_servers: term, password: term, ttl: term, username: term}
Source
next_page(metadata)
(function) # ↑

Specs:

Get the next page of tokens, using the metadata from the previous response. See all/0 for an easy way to get all the records.

Delegates to ExTwilio.Api.fetch_page/2.

Examples

{:ok, page1, meta} = ExTwilio.Token.list
{:ok, page2, meta} = ExTwilio.Token.next_page(meta)
Source
parents()
(function) # ↑

Specs:

  • parents :: list
Source
previous_page(metadata)
(function) # ↑

Specs:

Get the previous page of tokens, using metadata from a previous response.

Delegates to ExTwilio.Api.fetch_page/2.

Examples

{:ok, page2, meta} = ExTwilio.Token.list(page: 2)
{:ok, page1, meta} = ExTwilio.Token.previous_page(meta)
Source
resource_collection_name()
(function) # ↑

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.

Source
resource_name()
(function) # ↑

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.

Source
stream(options \\ [])
(function) # ↑

Create a stream of all Token records from the Twilio API.

Delegates to ExTwilio.Api.stream/2.

Source