ExTwilio v0.8.1 ExTwilio.ProgrammableChat.Member View Source

Represents a Member resource in the Twilio Programmable Chat API.

Twilio docs

Link to this section Summary

Functions

all(options \\ [])

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()

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 \\ [])

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

children()

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.

create(data, options \\ [])

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

destroy(sid, options \\ [])

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

do_new(struct, list)

do_new(
  %ExTwilio.ProgrammableChat.Member{
    account_sid: term(),
    channel_sid: term(),
    date_created: term(),
    date_updated: term(),
    identity: term(),
    last_consumed_message_index: term(),
    last_consumption_timestamp: term(),
    role_sid: term(),
    service_sid: term(),
    sid: term(),
    url: term()
  },
  list()
) :: %ExTwilio.ProgrammableChat.Member{
  account_sid: term(),
  channel_sid: term(),
  date_created: term(),
  date_updated: term(),
  identity: term(),
  last_consumed_message_index: term(),
  last_consumption_timestamp: term(),
  role_sid: term(),
  service_sid: term(),
  sid: term(),
  url: term()
}

find(sid, options \\ [])

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

new()

new() :: %ExTwilio.ProgrammableChat.Member{
  account_sid: term(),
  channel_sid: term(),
  date_created: term(),
  date_updated: term(),
  identity: term(),
  last_consumed_message_index: term(),
  last_consumption_timestamp: term(),
  role_sid: term(),
  service_sid: term(),
  sid: term(),
  url: term()
}

new(attrs)

new(list()) :: %ExTwilio.ProgrammableChat.Member{
  account_sid: term(),
  channel_sid: term(),
  date_created: term(),
  date_updated: term(),
  identity: term(),
  last_consumed_message_index: term(),
  last_consumption_timestamp: term(),
  role_sid: term(),
  service_sid: term(),
  sid: term(),
  url: term()
}

parents()

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.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 \\ [])

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