Twilio.IpMessaging.V2.Service.Channel.InviteService (twilio_elixir v0.1.1)

Service for Invite API operations.

Operations: list, create, fetch, delete

Summary

Functions

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

Operation: CreateInvite | Tags: IpMessagingV2Invite

delete(client, service_sid, channel_sid, sid, opts \\ [])

Operation: DeleteInvite | Tags: IpMessagingV2Invite

fetch(client, service_sid, channel_sid, sid, opts \\ [])

Operation: FetchInvite | Tags: IpMessagingV2Invite

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

Operation: ListInvite | Tags: IpMessagingV2Invite

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

Stream: (lazy auto-pagination).

Functions

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

@spec create(Twilio.Client.t(), String.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.IpMessaging.V2.Service.Channel.Invite.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Operation: CreateInvite | Tags: IpMessagingV2Invite

Required Parameters

Parameter	Type	Description
`Identity`	string

Optional Parameters

Parameter	Type	Description
`RoleSid`	string

delete(client, service_sid, channel_sid, sid, opts \\ [])

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

Operation: DeleteInvite | Tags: IpMessagingV2Invite

fetch(client, service_sid, channel_sid, sid, opts \\ [])

@spec fetch(Twilio.Client.t(), String.t(), String.t(), String.t(), keyword()) ::
  {:ok, Twilio.Resources.IpMessaging.V2.Service.Channel.Invite.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Operation: FetchInvite | Tags: IpMessagingV2Invite

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

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

Operation: ListInvite | Tags: IpMessagingV2Invite

Query Parameters

Parameter	Type	Description
`Identity`	array

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

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

Stream: (lazy auto-pagination).