Twilio.Flex.V1.PluginService.ConfigurationService (twilio_elixir v0.1.1)

Copy Markdown View Source

Service for Configuration API operations.

Operations: list, create, fetch

Summary

Functions

Operation: CreatePluginConfiguration | Tags: FlexV1PluginConfiguration

Operation: FetchPluginConfiguration | Tags: FlexV1PluginConfiguration

Operation: ListPluginConfiguration | Tags: FlexV1PluginConfiguration

Stream: (lazy auto-pagination).

Functions

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

@spec create(Twilio.Client.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Flex.V1.PluginService.Configuration.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Operation: CreatePluginConfiguration | Tags: FlexV1PluginConfiguration

Required Parameters

ParameterTypeDescription
NamestringThe Flex Plugin Configuration's name.

Optional Parameters

ParameterTypeDescription
DescriptionstringThe Flex Plugin Configuration's description.

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

| Plugins | array | A list of objects that describe the plugin versions included in the configuration. Each object contains the sid of the plugin version. |

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

@spec fetch(Twilio.Client.t(), String.t(), keyword()) ::
  {:ok, Twilio.Resources.Flex.V1.PluginService.Configuration.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Operation: FetchPluginConfiguration | Tags: FlexV1PluginConfiguration

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

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

Operation: ListPluginConfiguration | Tags: FlexV1PluginConfiguration

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

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

Stream: (lazy auto-pagination).