Twilio.Messaging.V1.Service.AlphaSenderService (twilio_elixir v0.1.1)

Copy Markdown View Source

A Messaging Service resource to add, fetch or remove an Alpha Sender ID from a Messaging Service.

Operations: list, create, fetch, delete

Summary

Functions

Operation: CreateAlphaSender | Tags: MessagingV1AlphaSender

Operation: DeleteAlphaSender | Tags: MessagingV1AlphaSender

Operation: FetchAlphaSender | Tags: MessagingV1AlphaSender

Operation: ListAlphaSender | Tags: MessagingV1AlphaSender

Functions

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

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

Operation: CreateAlphaSender | Tags: MessagingV1AlphaSender

Required Parameters

ParameterTypeDescription

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| AlphaSender | string | The Alphanumeric Sender ID string. Can be up to 11 characters long. Valid characters are A-Z, a-z, 0-9, space, hyphen -, plus +, underscore _ and ampersand &. This value cannot contain only numbers. |

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

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

Operation: DeleteAlphaSender | Tags: MessagingV1AlphaSender

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

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

Operation: FetchAlphaSender | Tags: MessagingV1AlphaSender

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

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

Operation: ListAlphaSender | Tags: MessagingV1AlphaSender

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

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

Stream: (lazy auto-pagination).