Twilio.Memory.V1.ControlPlane.Store.DataMappingService (twilio_elixir v0.1.3)

Copy Markdown View Source

Service for DataMapping API operations.

Operations: list, create, fetch, delete

Summary

Functions

Create a new data mapping to connect an external data source to this Memory Store. For DATASET types, validates that all mapped Trait Groups and traits exist and that dataset field data types match their respective mapped trait data types.

Delete a data mapping from the Memory Store. This action cannot be undone.

Retrieve the details of a specific data mapping by its unique ID.

Get a list of data mappings configured for this Memory Store.

Stream: Get a list of data mappings configured for this Memory Store. (lazy auto-pagination).

Functions

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

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

Create a new data mapping to connect an external data source to this Memory Store. For DATASET types, validates that all mapped Trait Groups and traits exist and that dataset field data types match their respective mapped trait data types.

Operation: CreateDataMapping | Tags: DataMapping

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

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

Delete a data mapping from the Memory Store. This action cannot be undone.

Operation: DeleteDataMapping | Tags: DataMapping

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

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

Retrieve the details of a specific data mapping by its unique ID.

Operation: FetchDataMapping | Tags: DataMapping

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

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

Get a list of data mappings configured for this Memory Store.

Operation: ListDataMappings | Tags: DataMapping

Query Parameters

ParameterTypeDescription
typestringFilter data mappings by type.

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

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

Stream: Get a list of data mappings configured for this Memory Store. (lazy auto-pagination).