Twilio.Events.V1.Subscription.SubscribedEventService (twilio_elixir v0.1.1)

Event subscribed to in the parent Subscription

Operations: list, create, fetch, update, delete

Summary

Functions

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

Add an event type to a Subscription.

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

Remove an event type from a Subscription.

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

Read an Event for a Subscription.

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

Retrieve a list of all Subscribed Event types for a Subscription.

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

Stream: Retrieve a list of all Subscribed Event types for a Subscription. (lazy auto-pagination).

update(client, subscription_sid, sid, params \\ %{}, opts \\ [])

Update an Event for a Subscription.

Functions

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

@spec create(Twilio.Client.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Events.V1.Subscription.SubscribedEvent.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Add an event type to a Subscription.

Operation: CreateSubscribedEvent | Tags: EventsV1SubscribedEvent

Required Parameters

Parameter	Type	Description
`Type`	string	Type of event being subscribed to.

Optional Parameters

Parameter	Type	Description
`SchemaVersion`	integer	The schema version that the Subscription should use.

delete(client, subscription_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 event type from a Subscription.

Operation: DeleteSubscribedEvent | Tags: EventsV1SubscribedEvent

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

@spec fetch(Twilio.Client.t(), String.t(), String.t(), keyword()) ::
  {:ok, Twilio.Resources.Events.V1.Subscription.SubscribedEvent.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Read an Event for a Subscription.

Operation: FetchSubscribedEvent | Tags: EventsV1SubscribedEvent

list(client, subscription_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 Subscribed Event types for a Subscription.

Operation: ListSubscribedEvent | Tags: EventsV1SubscribedEvent

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

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

Stream: Retrieve a list of all Subscribed Event types for a Subscription. (lazy auto-pagination).

update(client, subscription_sid, sid, params \\ %{}, opts \\ [])

@spec update(Twilio.Client.t(), String.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Events.V1.Subscription.SubscribedEvent.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Update an Event for a Subscription.

Operation: UpdateSubscribedEvent | Tags: EventsV1SubscribedEvent

Optional Parameters

Parameter	Type	Description
`SchemaVersion`	integer	The schema version that the Subscription should use.