Twilio.Conversations.V1.RoleService (twilio_elixir v0.1.1)

A Role resource represents a set of permissions granted to a user within a service or a conversation.

Operations: list, create, fetch, update, delete

Summary

Functions

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

Create a new user role in your account's default service

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

Remove a user role from your account's default service

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

Fetch a user role from your account's default service

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

Retrieve a list of all user roles in your account's default service

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

Stream: Retrieve a list of all user roles in your account's default service (lazy auto-pagination).

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

Update an existing user role in your account's default service

Functions

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

@spec create(Twilio.Client.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Conversations.V1.Role.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Create a new user role in your account's default service

Operation: CreateRole | Tags: ConversationsV1Role

Required Parameters

Parameter	Type	Description

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

| FriendlyName | string | A descriptive string that you create to describe the new resource. It can be up to 64 characters long. |

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

`Permission`	array	A permission that you grant to the new role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's `type`.
`Type`	string	Values: `conversation`, `service`

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

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

Remove a user role from your account's default service

Operation: DeleteRole | Tags: ConversationsV1Role

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

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

Fetch a user role from your account's default service

Operation: FetchRole | Tags: ConversationsV1Role

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

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

Retrieve a list of all user roles in your account's default service

Operation: ListRole | Tags: ConversationsV1Role

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

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

Stream: Retrieve a list of all user roles in your account's default service (lazy auto-pagination).

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

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

Update an existing user role in your account's default service

Operation: UpdateRole | Tags: ConversationsV1Role

Required Parameters

Parameter	Type	Description

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

| Permission | array | A permission that you grant to the role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. Note that the update action replaces all previously assigned permissions with those defined in the update action. To remove a permission, do not include it in the subsequent update action. The values for this parameter depend on the role's type. |