Twilio.Studio.V2.FlowService (twilio_elixir v0.1.3)

Studio flows

Operations: list, create, fetch, update, delete

Summary

Functions

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

Create a Flow.

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

Delete a specific Flow.

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

Retrieve a specific Flow.

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

Retrieve a list of all Flows.

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

Stream: Retrieve a list of all Flows. (lazy auto-pagination).

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

Update a Flow.

Functions

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

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

Create a Flow.

Operation: CreateFlow | Tags: StudioV2Flow

Required Parameters

Parameter	Type	Description
`Definition`	string	JSON representation of flow definition.
`FriendlyName`	string	The string that you assigned to describe the Flow.
`Status`	string	Values: `draft`, `published`

Optional Parameters

Parameter	Type	Description
`AuthorSid`	string	The SID of the User that created the Flow.
`CommitMessage`	string	Description of change made in the revision.

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

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

Delete a specific Flow.

Operation: DeleteFlow | Tags: StudioV2Flow

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

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

Retrieve a specific Flow.

Operation: FetchFlow | Tags: StudioV2Flow

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

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

Retrieve a list of all Flows.

Operation: ListFlow | Tags: StudioV2Flow

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

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

Stream: Retrieve a list of all Flows. (lazy auto-pagination).

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

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

Update a Flow.

Operation: UpdateFlow | Tags: StudioV2Flow

Required Parameters

Parameter	Type	Description
`Status`	string	Values: `draft`, `published`

Optional Parameters

Parameter	Type	Description
`AuthorSid`	string	The SID of the User that created or last updated the Flow.
`CommitMessage`	string	Description of change made in the revision.
`Definition`	string	JSON representation of flow definition.
`FriendlyName`	string	The string that you assigned to describe the Flow.