Twilio. IncomingPhoneNumbers. AssignedAddOns
(twilio v0.2.0)
Copy Markdown
API calls: create, delete, list, retrieve.
Summary
Functions
Assign an Add-on installation to the Number specified.
Like create/3, but returns the result or raises Infusion.Runtime.Error.
Remove the assignment of an Add-on installation from the Number specified.
Like delete/3, but returns the result or raises Infusion.Runtime.Error.
Retrieve a list of Add-on installations currently assigned to this Number.
Like list/3, but returns the result or raises Infusion.Runtime.Error.
Like list/3, but returns every item, from every page: a lazy stream of Twilio.Schemas.IncomingPhoneNumberAssignedAddOn.t() that fetches pages as it is read.
Like list_all/3, but returns the stream or raises Infusion.Runtime.Error.
Fetch an instance of an Add-on installation currently assigned to this Number.
Like retrieve/3, but returns the result or raises Infusion.Runtime.Error.
Functions
@spec create(String.t(), map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.IncomingPhoneNumberAssignedAddOn.t()} | {:error, Infusion.Runtime.Error.t()}
Assign an Add-on installation to the Number specified.
POST /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns.json
Path parameters
resource_sid(required) - The SID of the Phone Number to assign the Add-on.
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Parameters
installed_add_on_sid(required) - The SID that identifies the Add-on installation.
@spec create!(String.t(), map() | keyword(), keyword()) :: Twilio.Schemas.IncomingPhoneNumberAssignedAddOn.t()
Like create/3, but returns the result or raises Infusion.Runtime.Error.
@spec delete(String.t(), String.t(), keyword()) :: {:ok, nil} | {:error, Infusion.Runtime.Error.t()}
Remove the assignment of an Add-on installation from the Number specified.
DELETE /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{Sid}.json
Path parameters
resource_sid(required) - The SID of the Phone Number to which the Add-on is assigned.sid(required) - The Twilio-provided string that uniquely identifies the resource to delete.
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Like delete/3, but returns the result or raises Infusion.Runtime.Error.
@spec list(String.t(), map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.IncomingPhoneNumbersAssignedAddOnsListResponse.t()} | {:error, Infusion.Runtime.Error.t()}
Retrieve a list of Add-on installations currently assigned to this Number.
GET /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns.json
Path parameters
resource_sid(required) - The SID of the Phone Number to which the Add-on is assigned.
{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.
@spec list!(String.t(), map() | keyword(), keyword()) :: Twilio.Schemas.IncomingPhoneNumbersAssignedAddOnsListResponse.t()
Like list/3, but returns the result or raises Infusion.Runtime.Error.
@spec list_all(String.t(), map() | keyword(), keyword()) :: {:ok, Enumerable.t()} | {:error, Infusion.Runtime.Error.t()}
Like list/3, but returns every item, from every page: a lazy stream of Twilio.Schemas.IncomingPhoneNumberAssignedAddOn.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.
@spec list_all!(String.t(), map() | keyword(), keyword()) :: Enumerable.t()
Like list_all/3, but returns the stream or raises Infusion.Runtime.Error.
@spec retrieve(String.t(), String.t(), keyword()) :: {:ok, Twilio.Schemas.IncomingPhoneNumberAssignedAddOn.t()} | {:error, Infusion.Runtime.Error.t()}
Fetch an instance of an Add-on installation currently assigned to this Number.
GET /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{Sid}.json
Path parameters
resource_sid(required) - The SID of the Phone Number to which the Add-on is assigned.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.
@spec retrieve!(String.t(), String.t(), keyword()) :: Twilio.Schemas.IncomingPhoneNumberAssignedAddOn.t()
Like retrieve/3, but returns the result or raises Infusion.Runtime.Error.