Twilio.IpMessaging.V2.Service.User.ChannelService (twilio_elixir v0.1.1)

Copy Markdown View Source

Service for Channel API operations.

Operations: list, fetch, update, delete

Summary

Functions

Operation: DeleteUserChannel | Tags: IpMessagingV2UserChannel

Operation: FetchUserChannel | Tags: IpMessagingV2UserChannel

Operation: ListUserChannel | Tags: IpMessagingV2UserChannel

Operation: UpdateUserChannel | Tags: IpMessagingV2UserChannel

Functions

delete(client, service_sid, user_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: DeleteUserChannel | Tags: IpMessagingV2UserChannel

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

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

Operation: FetchUserChannel | Tags: IpMessagingV2UserChannel

list(client, service_sid, user_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: ListUserChannel | Tags: IpMessagingV2UserChannel

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

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

Stream: (lazy auto-pagination).

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

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

Operation: UpdateUserChannel | Tags: IpMessagingV2UserChannel

Optional Parameters

ParameterTypeDescription
LastConsumedMessageIndexinteger
LastConsumptionTimestampstring (date-time)
NotificationLevelstringValues: default, muted