Twilio.Sip.Domains.Auth.Calls.CredentialListMappings (twilio v0.2.0)

Copy Markdown

API calls: create, delete, list, retrieve.

Summary

Functions

Create a new credential list mapping resource

Delete a credential list mapping from the requested domain

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

Retrieve a list of credential list mappings belonging to the domain used in the request

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

Fetch a specific instance of a credential list mapping

Functions

create(domain_sid, params \\ %{}, opts \\ [])

Create a new credential list mapping resource

POST /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings.json

Path parameters

  • domain_sid (required) - The SID of the SIP domain that will contain the new resource.

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

Parameters

  • credential_list_sid (required) - The SID of the CredentialList resource to map to the SIP domain.

create!(domain_sid, params \\ %{}, opts \\ [])

Like create/3, but returns the result or raises Infusion.Runtime.Error.

delete(domain_sid, sid, opts \\ [])

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

Delete a credential list mapping from the requested domain

DELETE /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json

Path parameters

  • domain_sid (required) - The SID of the SIP domain that contains the resource to delete.
  • sid (required) - The Twilio-provided string that uniquely identifies the CredentialListMapping resource to delete.

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

delete!(domain_sid, sid, opts \\ [])

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

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

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

Retrieve a list of credential list mappings belonging to the domain used in the request

GET /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings.json

Path parameters

  • domain_sid (required) - The SID of the SIP domain that contains the resources to read.

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

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

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

@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.SipAuthCallsCredentialListMapping.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!(domain_sid, params \\ %{}, opts \\ [])

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

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

retrieve(domain_sid, sid, opts \\ [])

Fetch a specific instance of a credential list mapping

GET /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json

Path parameters

  • domain_sid (required) - The SID of the SIP domain that contains the resource to fetch.
  • sid (required) - The Twilio-provided string that uniquely identifies the CredentialListMapping resource to fetch.

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

retrieve!(domain_sid, sid, opts \\ [])

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