ExTwilio.SipDomain (ExTwilio v0.9.0) View Source

Represents an SIP Domain resource in the Twilio API.

Twilio docs

Link to this section Summary

Functions

Children represent path segments that come after the current resource. For example, in the path /v2/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users/Active "Active" is a child. Children may or may not have a key in the next segment.

create(data, options \\ [])

destroy(sid, options \\ [])

do_new(struct, list)

find(sid, options \\ [])

new()

new(attrs)

parents()

Parents represent path segments that precede the current resource. For example, in the path /v2/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users "Services" is a parent. Parents will always have a key in the next segment. If your parent is under a submodule of ExTwilio, specify your parent using the ExTwilio.Parent struct.

resource_collection_name()

Underscored and lowercased collection name for a given resource. Delegates the real work to ExTwilio.Api.resource_collection_name/1 by default.

resource_name()

CamelCase resource name as it would be used in Twilio's API. Delegates the real work to ExTwilio.Api.resource_name/1 by default.

stream(options \\ [])

update(sid, data, options \\ [])

Link to this section Functions

all(options \\ [])

Specs

all(list()) :: [map()]

children()

Specs

children() :: list()

Override this method in your resource to specify children in the order that they will appear in the path.

create(data, options \\ [])

Specs

create(ExTwilio.Api.data(), list()) :: ExTwilio.Parser.parsed_response()

destroy(sid, options \\ [])

Specs

destroy(String.t(), list()) ::
  ExTwilio.Parser.success_delete() | ExTwilio.Parser.error()

do_new(struct, list)

Specs

do_new(
  %ExTwilio.SipDomain{
    account_sid: term(),
    api_version: term(),
    auth_type: term(),
    date_created: term(),
    date_updated: term(),
    domain_name: term(),
    friendly_name: term(),
    sid: term(),
    uri: term(),
    voice_fallback_method: term(),
    voice_fallback_url: term(),
    voice_method: term(),
    voice_status_callback_method: term(),
    voice_status_callback_url: term(),
    voice_url: term()
  },
  list()
) :: %ExTwilio.SipDomain{
  account_sid: term(),
  api_version: term(),
  auth_type: term(),
  date_created: term(),
  date_updated: term(),
  domain_name: term(),
  friendly_name: term(),
  sid: term(),
  uri: term(),
  voice_fallback_method: term(),
  voice_fallback_url: term(),
  voice_method: term(),
  voice_status_callback_method: term(),
  voice_status_callback_url: term(),
  voice_url: term()
}

find(sid, options \\ [])

Specs

find(String.t() | nil, list()) :: ExTwilio.Parser.parsed_list_response()

new()

Specs

new() :: %ExTwilio.SipDomain{
  account_sid: term(),
  api_version: term(),
  auth_type: term(),
  date_created: term(),
  date_updated: term(),
  domain_name: term(),
  friendly_name: term(),
  sid: term(),
  uri: term(),
  voice_fallback_method: term(),
  voice_fallback_url: term(),
  voice_method: term(),
  voice_status_callback_method: term(),
  voice_status_callback_url: term(),
  voice_url: term()
}

new(attrs)

Specs

new(list()) :: %ExTwilio.SipDomain{
  account_sid: term(),
  api_version: term(),
  auth_type: term(),
  date_created: term(),
  date_updated: term(),
  domain_name: term(),
  friendly_name: term(),
  sid: term(),
  uri: term(),
  voice_fallback_method: term(),
  voice_fallback_url: term(),
  voice_method: term(),
  voice_status_callback_method: term(),
  voice_status_callback_url: term(),
  voice_url: term()
}

parents()

Specs

parents() :: list()

Override this method in your resource to specify parents in the order that they will appear in the path.

resource_collection_name()

Underscored and lowercased collection name for a given resource. Delegates the real work to ExTwilio.Api.resource_collection_name/1 by default.

Override in your module after use ExTwilio.Resource if you need something different.

resource_name()

CamelCase resource name as it would be used in Twilio's API. Delegates the real work to ExTwilio.Api.resource_name/1 by default.

Override in your module after use ExTwilio.Resource if you need something different.

stream(options \\ [])

update(sid, data, options \\ [])

Specs

update(String.t(), ExTwilio.Api.data(), list()) ::
  ExTwilio.Parser.parsed_response()