AmpSdk.Threads (AmpSdk v0.6.0)

Copy Markdown View Source

Thread management via the Amp CLI.

Summary

Types

visibility()

@type visibility() :: :private | :public | :workspace | :group

Functions

archive(thread_id)

@spec archive(String.t()) :: {:ok, String.t()} | {:error, AmpSdk.Error.t()}

delete(thread_id)

@spec delete(String.t()) :: {:ok, String.t()} | {:error, AmpSdk.Error.t()}

handoff(thread_id, opts \\ [])

@spec handoff(
  String.t(),
  keyword()
) :: {:ok, String.t()} | {:error, AmpSdk.Error.t()}

list(opts \\ [])

@spec list(keyword()) ::
  {:ok, [AmpSdk.Types.ThreadSummary.t()]} | {:error, AmpSdk.Error.t()}

markdown(thread_id)

@spec markdown(String.t()) :: {:ok, String.t()} | {:error, AmpSdk.Error.t()}

new(opts \\ [])

@spec new(keyword()) :: {:ok, String.t()} | {:error, AmpSdk.Error.t()}

rename(thread_id, name)

@spec rename(String.t(), String.t()) :: {:ok, String.t()} | {:error, AmpSdk.Error.t()}

replay(thread_id, opts \\ [])

@spec replay(
  String.t(),
  keyword()
) :: {:ok, String.t()} | {:error, AmpSdk.Error.t()}

search(query, opts \\ [])

@spec search(
  String.t(),
  keyword()
) :: {:ok, String.t()} | {:error, AmpSdk.Error.t()}

share(thread_id, opts \\ [])

@spec share(
  String.t(),
  keyword()
) :: {:ok, String.t()} | {:error, AmpSdk.Error.t()}