ExTwilio.Message
Represents an Message resource in the Twilio API.
Summary↑
| all(options \\ []) | Retrieve all of the Message records from the Twilio API, paging through all the API response pages |
| children() | |
| create(data, options \\ []) | Create a new Message in the Twilio API. Any field supported by Twilio's Message API can be passed in the 'data' keyword list |
| destroy(sid, options \\ []) | Delete any Message from your Twilio account, using its SID |
| find(sid, options \\ []) | Find any Message by its Twilio SID |
| first_page(metadata) | Get the first page of messages, using metadata from any page's response |
| last_page(metadata) | Get the last page of messages, using metadta from any page's response |
| list(options \\ []) | Retrieve a list of Messages from the API |
| new() | Creates a new ExTwilio.Message 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 messages, using the metadata from the previous response. See |
| parents() | |
| previous_page(metadata) | Get the previous page of messages, 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 Message records from the Twilio API |
| update(sid, data, options \\ []) | Update an Message in the Twilio API. You can pass it a binary SID as the identifier, or a whole %ExTwilio.Message{} struct |
Functions
Specs:
- all(list) :: [%{}]
Retrieve all of the Message records from the Twilio API, paging through all the API response pages.
Delegates to ExTwilio.Api.all/2.
Examples
messages = ExTwilio.Message.allSpecs:
- children :: list
Specs:
- create(list, list) :: ExTwilio.Parser.parsed_response
Create a new Message in the Twilio API. Any field supported by Twilio's Message API can be passed in the 'data' keyword list.
Delegates to ExTwilio.Api.create/3.
Specs:
- destroy(String.t, list) :: ExTwilio.Parser.success_delete | ExTwilio.Parser.error
Delete any Message from your Twilio account, using its SID.
Delegates to ExTwilio.Api.destroy/3.
Specs:
- find(String.t | nil, list) :: ExTwilio.Parser.parsed_list_response
Find any Message by its Twilio SID.
Delegates to ExTwilio.Api.find/3.
Examples
{:ok, message} = ExTwilio.Message.find("...")
{:error, msg, http_status} = ExTwilio.Message.find("...")Specs:
- first_page(%{}) :: ExTwilio.Parser.parsed_list_response
Get the first page of messages, using metadata from any page's response.
Delegates to ExTwilio.Api.fetch_page/2.
Examples
{:ok, page10, meta} = ExTwilio.Message.list(page: 10)
{:ok, page1, meta} = ExTwilio.Message.first_page(meta)Specs:
- last_page(%{}) :: ExTwilio.Parser.parsed_list_response
Get the last page of messages, using metadta from any page's response.
Delegates to ExTwilio.Api.fetch_page/2.
Examples
{:ok, page10, meta} = ExTwilio.Message.list(page: 10)
{:ok, last_page, meta} = ExTwilio.Message.last_page(meta)Specs:
- list(list) :: ExTwilio.Parser.parsed_list_response
Retrieve a list of Messages from the API.
Delegates to ExTwilio.Api.list/2.
Examples
# Successful response
{:ok, messages, metadata} = ExTwilio.Message.list
# Error response
{:error, msg, http_code} = ExTwilio.Message.listSpecs:
- new :: %ExTwilio.Message{account_sid: term, api_version: term, body: term, date_created: term, date_sent: term, date_updated: term, direction: term, error_code: term, error_message: term, from: term, num_media: term, num_segments: term, price: term, price_unit: term, sid: term, status: term, subresource_uri: term, to: term, uri: term}
Creates a new ExTwilio.Message struct. Optionally, you can pass in attributes to set their initial value in the struct.
Example
%ExTwilio.Message{} = ExTwilio.Message.new
%ExTwilio.Message{sid: "sid"} = ExTwilio.Message.new(sid: "sid")Specs:
- new(list) :: %ExTwilio.Message{account_sid: term, api_version: term, body: term, date_created: term, date_sent: term, date_updated: term, direction: term, error_code: term, error_message: term, from: term, num_media: term, num_segments: term, price: term, price_unit: term, sid: term, status: term, subresource_uri: term, to: term, uri: term}
Specs:
- next_page(%{}) :: ExTwilio.Parser.parsed_list_response
Get the next page of messages, 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.Message.list
{:ok, page2, meta} = ExTwilio.Message.next_page(meta)Specs:
- parents :: list
Specs:
- previous_page(%{}) :: ExTwilio.Parser.parsed_list_response
Get the previous page of messages, using metadata from a previous response.
Delegates to ExTwilio.Api.fetch_page/2.
Examples
{:ok, page2, meta} = ExTwilio.Message.list(page: 2)
{:ok, page1, meta} = ExTwilio.Message.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 Message records from the Twilio API.
Delegates to ExTwilio.Api.stream/2.
Specs:
- update(String.t, list, list) :: ExTwilio.Parser.parsed_response
Update an Message in the Twilio API. You can pass it a binary SID as the identifier, or a whole %ExTwilio.Message{} struct.
Delegates to ExTwilio.Api.update/4.
Examples
{:ok, message} = ExTwilio.Message.update(%ExTwilio.Message{...}, field: "new_value")
{:ok, message} = ExTwilio.Message.update("<SID HERE>", field: "new_value")