Twilio.Intelligence.V3.ControlPlane.ConfigurationService (twilio_elixir v0.1.3)

Service for Configuration API operations.

Operations: list, create, fetch, delete

Summary

Functions

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

Create an Intelligence Configuration to control how and when language operators analyze conversations.

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

Delete a Configuration.

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

Fetch a Configuration.

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

List Configuration resources.

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

Stream all resources with lazy auto-pagination.

Functions

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

@spec create(Twilio.Client.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Intelligence.V3.ControlPlane.Configuration.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Create an Intelligence Configuration to control how and when language operators analyze conversations.

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

You must include the rules field in the request. You can pass an empty array ("rules": []), but an Intelligence Configuration with an empty rules array doesn't execute any language operators. To add rules later, make a PUT /v3/ControlPlane/Configurations/{id} request.

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

After creating an Intelligence Configuration, you must attach it to a Conversations Configuration by using the Conversations API.

Operation: CreateConfiguration | Tags: Configurations

Required Parameters

Parameter	Type	Description
`displayName`	string	The display name of the Intelligence Configuration describing its purpose.

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

| rules | array | List of Intelligence Configuration Rules that govern when and how Language Operators run. Each Rule represents a bundle of Operators, Triggers, Context, and Actions to be executed by the Intelligence Configuration on a Conversation. A maximum of five (5) Rules are allowed per Intelligence Configuration. To create an Intelligence Configuration without any Rules configured yet, pass an empty array ("rules": []). The Configuration will not execute any Language Operators until at least one Rule has been added. |

Optional Parameters

Parameter	Type	Description
`description`	string	The description of the Intelligence Configuration further explaining its purpose.

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

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

Delete a Configuration.

Operation: DeleteConfiguration | Tags: Configurations

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

@spec fetch(Twilio.Client.t(), String.t(), keyword()) ::
  {:ok, Twilio.Resources.Intelligence.V3.ControlPlane.Configuration.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Fetch a Configuration.

Operation: FetchConfiguration | Tags: Configurations

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

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

List Configuration resources.

Operation: ListConfigurations | Tags: Configurations

Query Parameters

Parameter	Type	Description
`pageSize`	integer	The maximum number of resources to return
`pageToken`	string	Token for pagination

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

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

Stream all resources with lazy auto-pagination.