ExTwilio.ConnectApp
Represents an ConnectApp resource in the Twilio API.
Summary↑
all(options \\ []) | Retrieve all of the ConnectApp records from the Twilio API, paging through all the API response pages |
children() | |
create(data, options \\ []) | Create a new ConnectApp in the Twilio API. Any field supported by Twilio's ConnectApp API can be passed in the 'data' keyword list |
find(sid, options \\ []) | Find any ConnectApp by its Twilio SID |
first_page(metadata) | Get the first page of connectapps, using metadata from any page's response |
last_page(metadata) | Get the last page of connectapps, using metadta from any page's response |
list(options \\ []) | Retrieve a list of ConnectApps from the API |
new() | Creates a new ExTwilio.ConnectApp 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 connectapps, using the metadata from the previous response. See |
parents() | |
previous_page(metadata) | Get the previous page of connectapps, using metadata from a previous response |
resource_collection_name() | Underscored and lowercased collection name for a given resource. Delegates the real work to |
resource_name() | CamelCase resource name as it would be used in Twilio's API. Delegates the real work to |
stream(options \\ []) | Create a stream of all ConnectApp records from the Twilio API |
update(sid, data, options \\ []) | Update an ConnectApp in the Twilio API. You can pass it a binary SID as the identifier, or a whole %ExTwilio.ConnectApp{} struct |
Functions
Specs:
- all(list) :: [%{}]
Retrieve all of the ConnectApp records from the Twilio API, paging through all the API response pages.
Delegates to ExTwilio.Api.all/2
.
Examples
connectapps = ExTwilio.ConnectApp.all
Specs:
- children :: list
Specs:
- create(list, list) :: ExTwilio.Parser.parsed_response
Create a new ConnectApp in the Twilio API. Any field supported by Twilio's ConnectApp API can be passed in the 'data' keyword list.
Delegates to ExTwilio.Api.create/3
.
Specs:
- find(String.t | nil, list) :: ExTwilio.Parser.parsed_list_response
Find any ConnectApp by its Twilio SID.
Delegates to ExTwilio.Api.find/3
.
Examples
{:ok, connectapp} = ExTwilio.ConnectApp.find("...")
{:error, msg, http_status} = ExTwilio.ConnectApp.find("...")
Specs:
- first_page(%{}) :: ExTwilio.Parser.parsed_list_response
Get the first page of connectapps, using metadata from any page's response.
Delegates to ExTwilio.Api.fetch_page/2
.
Examples
{:ok, page10, meta} = ExTwilio.ConnectApp.list(page: 10)
{:ok, page1, meta} = ExTwilio.ConnectApp.first_page(meta)
Specs:
- last_page(%{}) :: ExTwilio.Parser.parsed_list_response
Get the last page of connectapps, using metadta from any page's response.
Delegates to ExTwilio.Api.fetch_page/2
.
Examples
{:ok, page10, meta} = ExTwilio.ConnectApp.list(page: 10)
{:ok, last_page, meta} = ExTwilio.ConnectApp.last_page(meta)
Specs:
- list(list) :: ExTwilio.Parser.parsed_list_response
Retrieve a list of ConnectApps from the API.
Delegates to ExTwilio.Api.list/2
.
Examples
# Successful response
{:ok, connectapps, metadata} = ExTwilio.ConnectApp.list
# Error response
{:error, msg, http_code} = ExTwilio.ConnectApp.list
Specs:
- new :: %ExTwilio.ConnectApp{account_sid: term, authorize_redirect_url: term, company_name: term, date_created: term, date_updated: term, deauthorize_callback_method: term, deauthorize_callback_url: term, description: term, friendly_name: term, homepage_url: term, permissions: term, sid: term, uri: term}
Creates a new ExTwilio.ConnectApp struct. Optionally, you can pass in attributes to set their initial value in the struct.
Example
%ExTwilio.ConnectApp{} = ExTwilio.ConnectApp.new
%ExTwilio.ConnectApp{sid: "sid"} = ExTwilio.ConnectApp.new(sid: "sid")
Specs:
- new(list) :: %ExTwilio.ConnectApp{account_sid: term, authorize_redirect_url: term, company_name: term, date_created: term, date_updated: term, deauthorize_callback_method: term, deauthorize_callback_url: term, description: term, friendly_name: term, homepage_url: term, permissions: term, sid: term, uri: term}
Specs:
- next_page(%{}) :: ExTwilio.Parser.parsed_list_response
Get the next page of connectapps, 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.ConnectApp.list
{:ok, page2, meta} = ExTwilio.ConnectApp.next_page(meta)
Specs:
- parents :: list
Specs:
- previous_page(%{}) :: ExTwilio.Parser.parsed_list_response
Get the previous page of connectapps, using metadata from a previous response.
Delegates to ExTwilio.Api.fetch_page/2
.
Examples
{:ok, page2, meta} = ExTwilio.ConnectApp.list(page: 2)
{:ok, page1, meta} = ExTwilio.ConnectApp.previous_page(meta)
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.
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.
Create a stream of all ConnectApp records from the Twilio API.
Delegates to ExTwilio.Api.stream/2
.
Specs:
- update(String.t, list, list) :: ExTwilio.Parser.parsed_response
Update an ConnectApp in the Twilio API. You can pass it a binary SID as the identifier, or a whole %ExTwilio.ConnectApp{} struct.
Delegates to ExTwilio.Api.update/4
.
Examples
{:ok, connectapp} = ExTwilio.ConnectApp.update(%ExTwilio.ConnectApp{...}, field: "new_value")
{:ok, connectapp} = ExTwilio.ConnectApp.update("<SID HERE>", field: "new_value")