ExTwilio v0.1.0 → Overview → ExTwilio → Application

ExTwilio.Application

Summary
Functions

Represents an Application resource in the Twilio API.

Twilio docs

Source

Summary↑

all(options \\ [])	Retrieve all of the Application records from the Twilio API, paging through all the API response pages
children()
create(data, options \\ [])	Create a new Application in the Twilio API. Any field supported by Twilio's Application API can be passed in the 'data' keyword list
destroy(sid, options \\ [])	Delete any Application from your Twilio account, using its SID
find(sid, options \\ [])	Find any Application by its Twilio SID
first_page(metadata)	Get the first page of applications, using metadata from any page's response
last_page(metadata)	Get the last page of applications, using metadta from any page's response
list(options \\ [])	Retrieve a list of Applications from the API
new()	Creates a new ExTwilio.Application 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 applications, 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 applications, 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 Application records from the Twilio API
update(sid, data, options \\ [])	Update an Application in the Twilio API. You can pass it a binary SID as the identifier, or a whole %ExTwilio.Application{} struct

Functions

all(options \\ [])

(function) # ↑

Specs:

all(list) :: [%{}]

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

Delegates to ExTwilio.Api.all/2.

Examples

applications = ExTwilio.Application.all

Source

children()

(function) # ↑

Specs:

children :: list

Source

create(data, options \\ [])

(function) # ↑

Specs:

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

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

Delegates to ExTwilio.Api.create/3.

Source

destroy(sid, options \\ [])

(function) # ↑

Specs:

destroy(String.t, list) :: ExTwilio.Parser.success_delete | ExTwilio.Parser.error

Delete any Application from your Twilio account, using its SID.

Delegates to ExTwilio.Api.destroy/3.

Source

find(sid, options \\ [])

(function) # ↑

Specs:

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

Find any Application by its Twilio SID.

Delegates to ExTwilio.Api.find/3.

Examples

{:ok, application} = ExTwilio.Application.find("...")
{:error, msg, http_status} = ExTwilio.Application.find("...")

Source

first_page(metadata)

(function) # ↑

Specs:

first_page(%{}) :: ExTwilio.Parser.parsed_list_response

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

Delegates to ExTwilio.Api.fetch_page/2.

Examples

{:ok, page10, meta} = ExTwilio.Application.list(page: 10)
{:ok, page1, meta}  = ExTwilio.Application.first_page(meta)

Source

last_page(metadata)

(function) # ↑

Specs:

last_page(%{}) :: ExTwilio.Parser.parsed_list_response

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

Delegates to ExTwilio.Api.fetch_page/2.

Examples

{:ok, page10, meta}    = ExTwilio.Application.list(page: 10)
{:ok, last_page, meta} = ExTwilio.Application.last_page(meta)

Source

list(options \\ [])

(function) # ↑

Specs:

list(list) :: ExTwilio.Parser.parsed_list_response

Retrieve a list of Applications from the API.

Delegates to ExTwilio.Api.list/2.

Examples

# Successful response
{:ok, applications, metadata} = ExTwilio.Application.list

# Error response
{:error, msg, http_code} = ExTwilio.Application.list

Source

new()

(function) # ↑

Specs:

new :: %ExTwilio.Application{account_sid: term, api_version: term, date_created: term, date_updated: term, friendly_name: term, message_status_callback: term, sid: term, sms_fallback_method: term, sms_fallback_url: term, sms_method: term, sms_status_callback: term, sms_url: term, status_callback: term, uri: term, voice_caller_id_lookup: term, voice_fallback_method: term, voice_fallback_url: term, voice_method: term, voice_url: term}

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

Example

%ExTwilio.Application{} = ExTwilio.Application.new
%ExTwilio.Application{sid: "sid"} = ExTwilio.Application.new(sid: "sid")

Source

new(attrs)

(function) # ↑

Specs:

new(list) :: %ExTwilio.Application{account_sid: term, api_version: term, date_created: term, date_updated: term, friendly_name: term, message_status_callback: term, sid: term, sms_fallback_method: term, sms_fallback_url: term, sms_method: term, sms_status_callback: term, sms_url: term, status_callback: term, uri: term, voice_caller_id_lookup: term, voice_fallback_method: term, voice_fallback_url: term, voice_method: term, voice_url: term}

Source

next_page(metadata)

(function) # ↑

Specs:

next_page(%{}) :: ExTwilio.Parser.parsed_list_response

Get the next page of applications, 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.Application.list
{:ok, page2, meta} = ExTwilio.Application.next_page(meta)

Source

parents()

(function) # ↑

Specs:

parents :: list

Source

previous_page(metadata)

(function) # ↑

Specs:

previous_page(%{}) :: ExTwilio.Parser.parsed_list_response

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

Delegates to ExTwilio.Api.fetch_page/2.

Examples

{:ok, page2, meta} = ExTwilio.Application.list(page: 2)
{:ok, page1, meta} = ExTwilio.Application.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 Application records from the Twilio API.

Delegates to ExTwilio.Api.stream/2.

Source

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

(function) # ↑

Specs:

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

Update an Application in the Twilio API. You can pass it a binary SID as the identifier, or a whole %ExTwilio.Application{} struct.

Delegates to ExTwilio.Api.update/4.

Examples

{:ok, application} = ExTwilio.Application.update(%ExTwilio.Application{...}, field: "new_value")
{:ok, application} = ExTwilio.Application.update("<SID HERE>", field: "new_value")

Source