Twilio. Sip. CredentialLists
(twilio v0.2.0)
Copy Markdown
API calls: create, delete, list, retrieve, update.
Summary
Functions
Create a Credential List
Like create/2, but returns the result or raises Infusion.Runtime.Error.
Delete a Credential List
Like delete/2, but returns the result or raises Infusion.Runtime.Error.
Get All Credential Lists
Like list/2, but returns the result or raises Infusion.Runtime.Error.
Like list/2, but returns every item, from every page: a lazy stream of Twilio.Schemas.SipCredentialList.t() that fetches pages as it is read.
Like list_all/2, but returns the stream or raises Infusion.Runtime.Error.
Get a Credential List
Like retrieve/2, but returns the result or raises Infusion.Runtime.Error.
Update a Credential List
Like update/3, but returns the result or raises Infusion.Runtime.Error.
Functions
@spec create(map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.SipCredentialList.t()} | {:error, Infusion.Runtime.Error.t()}
Create a Credential List
POST /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists.json
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Parameters
friendly_name(required) - A human readable descriptive text that describes the CredentialList, up to 64 characters long.
@spec create!(map() | keyword(), keyword()) :: Twilio.Schemas.SipCredentialList.t()
Like create/2, but returns the result or raises Infusion.Runtime.Error.
@spec delete(String.t(), keyword()) :: {:ok, nil} | {:error, Infusion.Runtime.Error.t()}
Delete a Credential List
DELETE /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json
Path parameters
sid(required) - The credential list Sid that uniquely identifies this resource
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Like delete/2, but returns the result or raises Infusion.Runtime.Error.
@spec list(map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.SipCredentialListsListResponse.t()} | {:error, Infusion.Runtime.Error.t()}
Get All Credential Lists
GET /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists.json
{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!(map() | keyword(), keyword()) :: Twilio.Schemas.SipCredentialListsListResponse.t()
Like list/2, but returns the result or raises Infusion.Runtime.Error.
@spec list_all(map() | keyword(), keyword()) :: {:ok, Enumerable.t()} | {:error, Infusion.Runtime.Error.t()}
Like list/2, but returns every item, from every page: a lazy stream of Twilio.Schemas.SipCredentialList.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!(map() | keyword(), keyword()) :: Enumerable.t()
Like list_all/2, but returns the stream or raises Infusion.Runtime.Error.
@spec retrieve(String.t(), keyword()) :: {:ok, Twilio.Schemas.SipCredentialList.t()} | {:error, Infusion.Runtime.Error.t()}
Get a Credential List
GET /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json
Path parameters
sid(required) - The credential list Sid that uniquely identifies this resource
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
@spec retrieve!(String.t(), keyword()) :: Twilio.Schemas.SipCredentialList.t()
Like retrieve/2, but returns the result or raises Infusion.Runtime.Error.
@spec update(String.t(), map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.SipCredentialList.t()} | {:error, Infusion.Runtime.Error.t()}
Update a Credential List
POST /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json
Path parameters
sid(required) - The credential list Sid that uniquely identifies this resource
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Parameters
friendly_name(required) - A human readable descriptive text for a CredentialList, up to 64 characters long.
@spec update!(String.t(), map() | keyword(), keyword()) :: Twilio.Schemas.SipCredentialList.t()
Like update/3, but returns the result or raises Infusion.Runtime.Error.