Twilio.Recordings.AddOnResults.Payloads (twilio v0.2.0)

Copy Markdown

API calls: delete, list, retrieve.

Summary

Functions

Delete a payload from the result along with all associated Data

Retrieve a list of payloads belonging to the AddOnResult

Like list/4, but returns every item, from every page: a lazy stream of Twilio.Schemas.RecordingAddOnResultPayload.t() that fetches pages as it is read.

Fetch an instance of a result payload

Functions

delete(reference_sid, add_on_result_sid, sid, opts \\ [])

@spec delete(String.t(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Infusion.Runtime.Error.t()}

Delete a payload from the result along with all associated Data

DELETE /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json

Path parameters

  • reference_sid (required) - The SID of the recording to which the AddOnResult resource that contains the payloads to delete belongs.
  • add_on_result_sid (required) - The SID of the AddOnResult to which the payloads to delete belongs.
  • sid (required) - The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to delete.

{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.

delete!(reference_sid, add_on_result_sid, sid, opts \\ [])

@spec delete!(String.t(), String.t(), String.t(), keyword()) :: nil

Like delete/4, but returns the result or raises Infusion.Runtime.Error.

list(reference_sid, add_on_result_sid, params \\ %{}, opts \\ [])

Retrieve a list of payloads belonging to the AddOnResult

GET /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json

Path parameters

  • reference_sid (required) - The SID of the recording to which the AddOnResult resource that contains the payloads to read belongs.
  • add_on_result_sid (required) - The SID of the AddOnResult to which the payloads to read belongs.

{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.

Parameters

  • page_size - How many resources to return in each list page. The default is 50, and the maximum is 1000.
  • page - The page index. This value is simply for client state.
  • page_token - The page token. This is provided by the API.

To read every item across all pages, use list_all.

list!(reference_sid, add_on_result_sid, params \\ %{}, opts \\ [])

Like list/4, but returns the result or raises Infusion.Runtime.Error.

list_all(reference_sid, add_on_result_sid, params \\ %{}, opts \\ [])

@spec list_all(String.t(), String.t(), map() | keyword(), keyword()) ::
  {:ok, Enumerable.t()} | {:error, Infusion.Runtime.Error.t()}

Like list/4, but returns every item, from every page: a lazy stream of Twilio.Schemas.RecordingAddOnResultPayload.t() that fetches pages as it is read.

The first page is fetched right away, so its errors are returned; a later page that fails raises Infusion.Runtime.Error. Stopping early (Enum.take/2) fetches no more pages.

list_all!(reference_sid, add_on_result_sid, params \\ %{}, opts \\ [])

@spec list_all!(String.t(), String.t(), map() | keyword(), keyword()) ::
  Enumerable.t()

Like list_all/4, but returns the stream or raises Infusion.Runtime.Error.

retrieve(reference_sid, add_on_result_sid, sid, opts \\ [])

Fetch an instance of a result payload

GET /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json

Path parameters

  • reference_sid (required) - The SID of the recording to which the AddOnResult resource that contains the payload to fetch belongs.
  • add_on_result_sid (required) - The SID of the AddOnResult to which the payload to fetch belongs.
  • sid (required) - The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to fetch.

{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.

retrieve!(reference_sid, add_on_result_sid, sid, opts \\ [])

Like retrieve/4, but returns the result or raises Infusion.Runtime.Error.