View Source ExTwilio.Feedback (ExTwilio v0.10.0)
Represents a Call Feedback resource in the Twilio API.
Examples
Since Call Feedback is a nested resource in the Twilio API, you must pass in a parent Call SID to all functions in this module.
ExTwilio.Feedback.create([quality_score: 5], [call: "call_sid"])
ExTwilio.Feedback.find(call: "call_sid")
Summary
Functions
Children represent path segments that come after the current resource. For example,
in the path /v2/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users/Active
"Active" is
a child. Children may or may not have a key in the next segment.
Find feedback for a given call. Any options other than [call: "sid"]
will
result in a FunctionClauseError
.
Parents represent path segments that precede the current resource. For example,
in the path /v2/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users
"Services" is
a parent. Parents will always have a key in the next segment. If your parent is under a
submodule of ExTwilio
, specify your parent using the ExTwilio.Parent
struct.
Underscored and lowercased collection name for a given resource.
Delegates the real work to ExTwilio.UrlGenerator.resource_collection_name/1
by
default.
CamelCase resource name as it would be used in Twilio's API. Delegates
the real work to ExTwilio.UrlGenerator.resource_name/1
by default.
Functions
@spec children() :: list()
Children represent path segments that come after the current resource. For example,
in the path /v2/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users/Active
"Active" is
a child. Children may or may not have a key in the next segment.
Override this method in your resource to specify children in the order that they will appear in the path.
@spec create(ExTwilio.Api.data(), list()) :: ExTwilio.Parser.parsed_response()
@spec find([{:call, String.t()}]) :: ExTwilio.Parser.success() | ExTwilio.Parser.error()
Find feedback for a given call. Any options other than [call: "sid"]
will
result in a FunctionClauseError
.
Examples
ExTwilio.Feedback.find(call: "sid")
%ExTwilio.Feedback{issues: [], quality_score: 5}
@spec parents() :: list()
Parents represent path segments that precede the current resource. For example,
in the path /v2/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users
"Services" is
a parent. Parents will always have a key in the next segment. If your parent is under a
submodule of ExTwilio
, specify your parent using the ExTwilio.Parent
struct.
Override this method in your resource to specify parents in the order that they will appear in the path.
Underscored and lowercased collection name for a given resource.
Delegates the real work to ExTwilio.UrlGenerator.resource_collection_name/1
by
default.
Override in your module after 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.UrlGenerator.resource_name/1
by default.
Override in your module after use ExTwilio.Resource
if you need
something different.