Twilio.IncomingPhoneNumbers.AssignedAddOns.Extensions (twilio v0.2.0)

Copy Markdown

API calls: list, retrieve.

Summary

Functions

Retrieve a list of Extensions for the Assigned Add-on.

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

Fetch an instance of an Extension for the Assigned Add-on.

Functions

list(resource_sid, assigned_add_on_sid, params \\ %{}, opts \\ [])

Retrieve a list of Extensions for the Assigned Add-on.

GET /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{AssignedAddOnSid}/Extensions.json

Path parameters

  • resource_sid (required) - The SID of the Phone Number to which the Add-on is assigned.
  • assigned_add_on_sid (required) - The SID that uniquely identifies the assigned Add-on installation.

{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!(resource_sid, assigned_add_on_sid, params \\ %{}, opts \\ [])

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

list_all(resource_sid, assigned_add_on_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.IncomingPhoneNumberAssignedAddOnExtension.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!(resource_sid, assigned_add_on_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(resource_sid, assigned_add_on_sid, sid, opts \\ [])

Fetch an instance of an Extension for the Assigned Add-on.

GET /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{AssignedAddOnSid}/Extensions/{Sid}.json

Path parameters

  • resource_sid (required) - The SID of the Phone Number to which the Add-on is assigned.
  • assigned_add_on_sid (required) - The SID that uniquely identifies the assigned Add-on installation.
  • sid (required) - The Twilio-provided string that uniquely identifies the resource to fetch.

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

retrieve!(resource_sid, assigned_add_on_sid, sid, opts \\ [])

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