Twilio.Verify.V2.Service.MessagingConfigurationService (twilio_elixir v0.1.1)

Service for MessagingConfiguration API operations.

Operations: list, create, fetch, update, delete

Summary

Functions

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

Create a new MessagingConfiguration for a service.

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

Delete a specific MessagingConfiguration.

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

Fetch a specific MessagingConfiguration.

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

Retrieve a list of all Messaging Configurations for a Service.

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

Stream: Retrieve a list of all Messaging Configurations for a Service. (lazy auto-pagination).

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

Update a specific MessagingConfiguration

Functions

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

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

Create a new MessagingConfiguration for a service.

Operation: CreateMessagingConfiguration | Tags: VerifyV2MessagingConfiguration

Required Parameters

Parameter	Type	Description

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

| Country | string | The ISO-3166-1 country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value all. |

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

| MessagingServiceSid | string | The SID of the Messaging Service to be used to send SMS to the country of this configuration. |

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

Delete a specific MessagingConfiguration.

Operation: DeleteMessagingConfiguration | Tags: VerifyV2MessagingConfiguration

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

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

Fetch a specific MessagingConfiguration.

Operation: FetchMessagingConfiguration | Tags: VerifyV2MessagingConfiguration

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

Retrieve a list of all Messaging Configurations for a Service.

Operation: ListMessagingConfiguration | Tags: VerifyV2MessagingConfiguration

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

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

Stream: Retrieve a list of all Messaging Configurations for a Service. (lazy auto-pagination).

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

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

Update a specific MessagingConfiguration

Operation: UpdateMessagingConfiguration | Tags: VerifyV2MessagingConfiguration

Required Parameters

Parameter	Type	Description

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

| MessagingServiceSid | string | The SID of the Messaging Service to be used to send SMS to the country of this configuration. |