Twilio.IpMessaging.V2.Service.UserService (twilio_elixir v0.1.1)

Service for User API operations.

Operations: list, create, fetch, update, delete

Summary

Functions

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

Operation: CreateUser | Tags: IpMessagingV2User

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

Operation: DeleteUser | Tags: IpMessagingV2User

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

Operation: FetchUser | Tags: IpMessagingV2User

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

Operation: ListUser | Tags: IpMessagingV2User

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

Stream: (lazy auto-pagination).

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

Operation: UpdateUser | Tags: IpMessagingV2User

Functions

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

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

Operation: CreateUser | Tags: IpMessagingV2User

Required Parameters

Parameter	Type	Description
`Identity`	string

Optional Parameters

Parameter	Type	Description
`Attributes`	string
`FriendlyName`	string
`RoleSid`	string

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

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

Operation: DeleteUser | Tags: IpMessagingV2User

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

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

Operation: FetchUser | Tags: IpMessagingV2User

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

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

Operation: ListUser | Tags: IpMessagingV2User

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

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

Stream: (lazy auto-pagination).

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

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

Operation: UpdateUser | Tags: IpMessagingV2User

Optional Parameters

Parameter	Type	Description
`Attributes`	string
`FriendlyName`	string
`RoleSid`	string