Twilio.IpMessaging.V1.Service.Channel.MemberService (twilio_elixir v0.1.1)

Copy Markdown View Source

Service for Member API operations.

Operations: list, create, fetch, update, delete

Summary

Functions

create(client, service_sid, channel_sid, params \\ %{}, opts \\ [])

Operation: CreateMember | Tags: IpMessagingV1Member

delete(client, service_sid, channel_sid, sid, opts \\ [])

Operation: DeleteMember | Tags: IpMessagingV1Member

fetch(client, service_sid, channel_sid, sid, opts \\ [])

Operation: FetchMember | Tags: IpMessagingV1Member

list(client, service_sid, channel_sid, params \\ %{}, opts \\ [])

Operation: ListMember | Tags: IpMessagingV1Member

stream(client, service_sid, channel_sid, params \\ %{}, opts \\ [])

Stream: (lazy auto-pagination).

update(client, service_sid, channel_sid, sid, params \\ %{}, opts \\ [])

Operation: UpdateMember | Tags: IpMessagingV1Member

Functions

create(client, service_sid, channel_sid, params \\ %{}, opts \\ [])

@spec create(Twilio.Client.t(), String.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.IpMessaging.V1.Service.Channel.Member.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Operation: CreateMember | Tags: IpMessagingV1Member

Required Parameters

ParameterTypeDescription
Identitystring

Optional Parameters

ParameterTypeDescription
RoleSidstring

delete(client, service_sid, channel_sid, sid, opts \\ [])

@spec delete(Twilio.Client.t(), String.t(), String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:ok, map(), map()} | :ok | {:error, Twilio.Error.t()}

Operation: DeleteMember | Tags: IpMessagingV1Member

fetch(client, service_sid, channel_sid, sid, opts \\ [])

@spec fetch(Twilio.Client.t(), String.t(), String.t(), String.t(), keyword()) ::
  {:ok, Twilio.Resources.IpMessaging.V1.Service.Channel.Member.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Operation: FetchMember | Tags: IpMessagingV1Member

list(client, service_sid, channel_sid, params \\ %{}, opts \\ [])

@spec list(Twilio.Client.t(), String.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Page.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Operation: ListMember | Tags: IpMessagingV1Member

Query Parameters

ParameterTypeDescription
Identityarray

stream(client, service_sid, channel_sid, params \\ %{}, opts \\ [])

@spec stream(Twilio.Client.t(), String.t(), String.t(), map(), keyword()) ::
  Enumerable.t()

Stream: (lazy auto-pagination).

update(client, service_sid, channel_sid, sid, params \\ %{}, opts \\ [])

@spec update(Twilio.Client.t(), String.t(), String.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.IpMessaging.V1.Service.Channel.Member.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Operation: UpdateMember | Tags: IpMessagingV1Member

Optional Parameters

ParameterTypeDescription
LastConsumedMessageIndexinteger
RoleSidstring