View Source ExTwilio.Call (ExTwilio v0.10.0)

Represents an Call resource in the Twilio API.

Twilio docs

Summary

Functions

all(options \\ [])

cancel(sid)

children()

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.

complete(sid)

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.UrlGenerator.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.UrlGenerator.resource_name/1 by default.

stream(options \\ [])

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

Functions

all(options \\ [])

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

cancel(sid)

children()

@spec children() :: list()

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.

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

complete(sid)

create(data, options \\ [])

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

destroy(sid, options \\ [])

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

do_new(struct, list)

@spec do_new(
  %ExTwilio.Call{
    account_sid: term(),
    answered_by: term(),
    caller_name: term(),
    date_created: term(),
    date_updated: term(),
    direction: term(),
    duration: term(),
    end_time: term(),
    forwarded_from: term(),
    from: term(),
    parent_call_sid: term(),
    phone_number_sid: term(),
    price: term(),
    price_unit: term(),
    sid: term(),
    start_time: term(),
    status: term(),
    to: term(),
    uri: term()
  },
  list()
) :: %ExTwilio.Call{
  account_sid: term(),
  answered_by: term(),
  caller_name: term(),
  date_created: term(),
  date_updated: term(),
  direction: term(),
  duration: term(),
  end_time: term(),
  forwarded_from: term(),
  from: term(),
  parent_call_sid: term(),
  phone_number_sid: term(),
  price: term(),
  price_unit: term(),
  sid: term(),
  start_time: term(),
  status: term(),
  to: term(),
  uri: term()
}

find(sid, options \\ [])

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

new()

@spec new() :: %ExTwilio.Call{
  account_sid: term(),
  answered_by: term(),
  caller_name: term(),
  date_created: term(),
  date_updated: term(),
  direction: term(),
  duration: term(),
  end_time: term(),
  forwarded_from: term(),
  from: term(),
  parent_call_sid: term(),
  phone_number_sid: term(),
  price: term(),
  price_unit: term(),
  sid: term(),
  start_time: term(),
  status: term(),
  to: term(),
  uri: term()
}

new(attrs)

@spec new(list()) :: %ExTwilio.Call{
  account_sid: term(),
  answered_by: term(),
  caller_name: term(),
  date_created: term(),
  date_updated: term(),
  direction: term(),
  duration: term(),
  end_time: term(),
  forwarded_from: term(),
  from: term(),
  parent_call_sid: term(),
  phone_number_sid: term(),
  price: term(),
  price_unit: term(),
  sid: term(),
  start_time: term(),
  status: term(),
  to: term(),
  uri: term()
}

parents()

@spec parents() :: list()

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.

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.UrlGenerator.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.UrlGenerator.resource_name/1 by default.

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

stream(options \\ [])

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

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