Twilio.Trusthub.V1.CustomerProfile.CustomerProfilesEvaluationsService (twilio_elixir v0.1.1)

Copy Markdown View Source

Service for CustomerProfilesEvaluations API operations.

Operations: list, create, fetch

Summary

Functions

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

Create a new Evaluation

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

Fetch specific Evaluation Instance.

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

Retrieve a list of Evaluations associated to the customer_profile resource.

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

Stream: Retrieve a list of Evaluations associated to the customer_profile resource. (lazy auto-pagination).

Functions

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

@spec create(Twilio.Client.t(), String.t(), map(), keyword()) ::
  {:ok,
   Twilio.Resources.Trusthub.V1.CustomerProfile.CustomerProfilesEvaluations.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Create a new Evaluation

Operation: CreateCustomerProfileEvaluation | Tags: TrusthubV1CustomerProfilesEvaluations

Required Parameters

ParameterTypeDescription
PolicySidstringThe unique string of a policy that is associated to the customer_profile resource.

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

@spec fetch(Twilio.Client.t(), String.t(), String.t(), keyword()) ::
  {:ok,
   Twilio.Resources.Trusthub.V1.CustomerProfile.CustomerProfilesEvaluations.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Fetch specific Evaluation Instance.

Operation: FetchCustomerProfileEvaluation | Tags: TrusthubV1CustomerProfilesEvaluations

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

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

Retrieve a list of Evaluations associated to the customer_profile resource.

Operation: ListCustomerProfileEvaluation | Tags: TrusthubV1CustomerProfilesEvaluations

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

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

Stream: Retrieve a list of Evaluations associated to the customer_profile resource. (lazy auto-pagination).