ExTwilio v0.1.0 → Overview → ExTwilio → Address

ExTwilio.Address

Represents an Address resource in the Twilio API.

Source

Summary↑

all(options \\ [])

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

Create a new Address in the Twilio API. Any field supported by Twilio's Address API can be passed in the 'data' keyword list
find(sid, options \\ [])

Find any Address by its Twilio SID
first_page(metadata)

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

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

Retrieve a list of Addresses from the API
new()

Creates a new ExTwilio.Address 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 addresses, 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 addresses, 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 Address records from the Twilio API
update(sid, data, options \\ [])

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

Functions

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

Specs:

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

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

Delegates to ExTwilio.Api.all/2.

Examples

addresses = ExTwilio.Address.all
Source
children()
(function) # ↑

Specs:

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

Specs:

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

Delegates to ExTwilio.Api.create/3.

Source
find(sid, options \\ [])
(function) # ↑

Specs:

Find any Address by its Twilio SID.

Delegates to ExTwilio.Api.find/3.

Examples

{:ok, address} = ExTwilio.Address.find("...")
{:error, msg, http_status} = ExTwilio.Address.find("...")
Source
first_page(metadata)
(function) # ↑

Specs:

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

Delegates to ExTwilio.Api.fetch_page/2.

Examples

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

Specs:

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

Delegates to ExTwilio.Api.fetch_page/2.

Examples

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

Specs:

Retrieve a list of Addresses from the API.

Delegates to ExTwilio.Api.list/2.

Examples

# Successful response
{:ok, addresses, metadata} = ExTwilio.Address.list

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

Specs:

  • new :: %ExTwilio.Address{account_sid: term, city: term, customer_name: term, friendly_name: term, iso_country: term, postal_code: term, region: term, sid: term, street: term}

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

Example

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

Specs:

  • new(list) :: %ExTwilio.Address{account_sid: term, city: term, customer_name: term, friendly_name: term, iso_country: term, postal_code: term, region: term, sid: term, street: term}
Source
next_page(metadata)
(function) # ↑

Specs:

Get the next page of addresses, 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.Address.list
{:ok, page2, meta} = ExTwilio.Address.next_page(meta)
Source
parents()
(function) # ↑

Specs:

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

Specs:

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

Delegates to ExTwilio.Api.fetch_page/2.

Examples

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

Delegates to ExTwilio.Api.stream/2.

Source
update(sid, data, options \\ [])
(function) # ↑

Specs:

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

Delegates to ExTwilio.Api.update/4.

Examples

{:ok, address} = ExTwilio.Address.update(%ExTwilio.Address{...}, field: "new_value")
{:ok, address} = ExTwilio.Address.update("<SID HERE>", field: "new_value")
Source