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

Service for TraitGroup API operations.

Operations: list, create, fetch, delete

Summary

Functions

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

Creates a Trait Group with declarative trait schemas for this Memory Store.

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

Deletes the Trait Group and all associated Traits from the Memory Store.

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

Retrieve a specific Trait Group by its unique name for this Memory Store, with optional traits information.

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

Returns a list of Trait Groups for this Memory Store, with optional traits information.

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

Stream: Returns a list of Trait Groups for this Memory Store, with optional traits information. (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.TraitGroup.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Creates a Trait Group with declarative trait schemas for this Memory Store.

Operation: CreateTraitGroup | Tags: TraitGroup

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()}

Deletes the Trait Group and all associated Traits from the Memory Store.

Operation: DeleteTraitGroup | Tags: TraitGroup

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

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

Retrieve a specific Trait Group by its unique name for this Memory Store, with optional traits information.

Operation: FetchTraitGroup | Tags: TraitGroup

Query Parameters

Parameter	Type	Description
`includeTraits`	boolean	Whether to include trait definitions in the response

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()}

Returns a list of Trait Groups for this Memory Store, with optional traits information.

Operation: ListTraitGroups | Tags: TraitGroup

Query Parameters

Parameter	Type	Description
`includeTraits`	boolean	Whether to include trait definitions in the response

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

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

Stream: Returns a list of Trait Groups for this Memory Store, with optional traits information. (lazy auto-pagination).