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

Service for ChannelEndpointAssignment API operations.

Operations: list, create, fetch, delete

Summary

Functions

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

Create a new Assigned Item.

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

Remove an Assignment Item Instance.

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

Fetch specific Assigned Item Instance.

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

Retrieve a list of all Assigned Items for an account.

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

Stream: Retrieve a list of all Assigned Items for an account. (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.ChannelEndpointAssignment.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Create a new Assigned Item.

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

Operation: CreateCustomerProfileChannelEndpointAssignment | Tags: TrusthubV1CustomerProfilesChannelEndpointAssignment

Required Parameters

Parameter	Type	Description
`ChannelEndpointSid`	string	The SID of an channel endpoint
`ChannelEndpointType`	string	The type of channel endpoint. eg: phone-number

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

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

Remove an Assignment Item Instance.

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

Operation: DeleteCustomerProfileChannelEndpointAssignment | Tags: TrusthubV1CustomerProfilesChannelEndpointAssignment

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

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

Fetch specific Assigned Item Instance.

Operation: FetchCustomerProfileChannelEndpointAssignment | Tags: TrusthubV1CustomerProfilesChannelEndpointAssignment

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 all Assigned Items for an account.

Operation: ListCustomerProfileChannelEndpointAssignment | Tags: TrusthubV1CustomerProfilesChannelEndpointAssignment

Query Parameters

Parameter	Type	Description
`ChannelEndpointSid`	string	The SID of an channel endpoint
`ChannelEndpointSids`	string	comma separated list of channel endpoint sids

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

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

Stream: Retrieve a list of all Assigned Items for an account. (lazy auto-pagination).