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

Copy Markdown View Source

Service for Observation API operations.

Operations: list, create, fetch, delete

Summary

Functions

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

Delete a specific transient observation by its ID. This action is irreversible.

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

Retrieve a specific transient observation by its ID for the given profile.

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

Stream: Retrieve a paginated list of transient observations for a specific profile. Observations are sorted by creation time in descending order by default. Results can be filtered by source parameter. 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.Observation.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

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

Create one or more transient observations associated with the specified profile. Supports both single observation creation and batch creation of up to 10 observations. Supports request compression for large batch operations and response compression for the response. All observations will be automatically indexed for semantic search capabilities. The content can be up to 4KB in length and should contain relevant information about the profile. The createdAt and updatedAt timestamps will be automatically set to the current time. Each observation will be created with a unique ID in Twilio Type ID (TTID) format.

Operation: CreateProfileObservation | Tags: Observations

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 transient observation by its ID. This action is irreversible.

Operation: DeleteProfileObservation | Tags: Observations

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

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

Retrieve a specific transient observation by its ID for the given profile.

Operation: FetchProfileObservation | Tags: Observations

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 transient observations for a specific profile. Observations are sorted by creation time in descending order by default. Results can be filtered by source parameter. Supports response compression for large datasets.

Operation: ListProfileObservations | Tags: Observations

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 transient observations for a specific profile. Observations are sorted by creation time in descending order by default. Results can be filtered by source parameter. Supports response compression for large datasets. (lazy auto-pagination).