Twilio.IpMessaging.V2.ServiceService (twilio_elixir v0.1.1)

Service for Service API operations.

Operations: list, create, fetch, update, delete

Summary

Functions

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

Operation: CreateService | Tags: IpMessagingV2Service

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

Operation: DeleteService | Tags: IpMessagingV2Service

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

Operation: FetchService | Tags: IpMessagingV2Service

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

Operation: ListService | Tags: IpMessagingV2Service

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

Stream: (lazy auto-pagination).

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

Operation: UpdateService | Tags: IpMessagingV2Service

Functions

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

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

Operation: CreateService | Tags: IpMessagingV2Service

Required Parameters

Parameter	Type	Description
`FriendlyName`	string

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

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

Operation: DeleteService | Tags: IpMessagingV2Service

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

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

Operation: FetchService | Tags: IpMessagingV2Service

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

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

Operation: ListService | Tags: IpMessagingV2Service

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

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

Stream: (lazy auto-pagination).

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

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

Operation: UpdateService | Tags: IpMessagingV2Service

Optional Parameters

Parameter	Type	Description
`ConsumptionReportInterval`	integer
`DefaultChannelCreatorRoleSid`	string
`DefaultChannelRoleSid`	string
`DefaultServiceRoleSid`	string
`FriendlyName`	string
`Limits.ChannelMembers`	integer
`Limits.UserChannels`	integer
`Media.CompatibilityMessage`	string
`Notifications.AddedToChannel.Enabled`	boolean
`Notifications.AddedToChannel.Sound`	string
`Notifications.AddedToChannel.Template`	string
`Notifications.InvitedToChannel.Enabled`	boolean
`Notifications.InvitedToChannel.Sound`	string
`Notifications.InvitedToChannel.Template`	string
`Notifications.LogEnabled`	boolean
`Notifications.NewMessage.BadgeCountEnabled`	boolean
`Notifications.NewMessage.Enabled`	boolean
`Notifications.NewMessage.Sound`	string
`Notifications.NewMessage.Template`	string
`Notifications.RemovedFromChannel.Enabled`	boolean
`Notifications.RemovedFromChannel.Sound`	string
`Notifications.RemovedFromChannel.Template`	string
`PostWebhookRetryCount`	integer
`PostWebhookUrl`	string (uri)
`PreWebhookRetryCount`	integer
`PreWebhookUrl`	string (uri)
`ReachabilityEnabled`	boolean
`ReadStatusEnabled`	boolean
`TypingIndicatorTimeout`	integer
`WebhookFilters`	array
`WebhookMethod`	string (http-method)	Values: `GET`, `POST`