Twilio.Memory.V1.Store.Profile.ConversationSummaryService (twilio_elixir v0.1.3)

Copy Markdown View Source

Service for ConversationSummary API operations.

Operations: list, create, fetch, delete

Summary

Functions

Delete a specific conversation summary by its ID. This action is irreversible.

Retrieve a specific conversation summary by its ID for the given profile.

Stream: Retrieve a paginated list of conversation summaries for a specific profile. Supports response compression for large datasets. (lazy auto-pagination).

Functions

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

@spec create(Twilio.Client.t(), String.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Memory.V1.Store.Profile.ConversationSummary.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

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

Create one or more conversation summaries associated with the specified profile. Supports both single summary creation and batch creation of up to 10 summaries. Supports request compression for large batch operations and response compression for the response. All summaries will be automatically indexed for semantic search capabilities. The content summary can be up to 4KB in length. Each summary will be created with a unique ID in Twilio Type ID (TTID) format.

Operation: CreateProfileConversationSummary | Tags: ConversationSummaries

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

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

Delete a specific conversation summary by its ID. This action is irreversible.

Operation: DeleteProfileConversationSummary | Tags: ConversationSummaries

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

Retrieve a specific conversation summary by its ID for the given profile.

Operation: FetchProfileConversationSummary | Tags: ConversationSummaries

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

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

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

Retrieve a paginated list of conversation summaries for a specific profile. Supports response compression for large datasets.

Operation: ListProfileConversationSummaries | Tags: ConversationSummaries

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

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

Stream: Retrieve a paginated list of conversation summaries for a specific profile. Supports response compression for large datasets. (lazy auto-pagination).