Twilio.Verify.V2.SafeList.NumberService (twilio_elixir v0.1.1)

Copy Markdown View Source

Service for Number API operations.

Operations: create, fetch, delete

Summary

Functions

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

Add a new phone number to SafeList.

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

Remove a phone number from SafeList.

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

Check if a phone number exists in SafeList.

Functions

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

@spec create(Twilio.Client.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Verify.V2.SafeList.Number.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Add a new phone number to SafeList.

Operation: CreateSafelist | Tags: VerifyV2Safelist

Required Parameters

ParameterTypeDescription

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

| PhoneNumber | string | The phone number to be added in SafeList. Phone numbers must be in E.164 format. |

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

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

Remove a phone number from SafeList.

Operation: DeleteSafelist | Tags: VerifyV2Safelist

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

@spec fetch(Twilio.Client.t(), String.t(), keyword()) ::
  {:ok, Twilio.Resources.Verify.V2.SafeList.Number.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Check if a phone number exists in SafeList.

Operation: FetchSafelist | Tags: VerifyV2Safelist