Twilio.Sync.V1.Service.Map.PermissionService (twilio_elixir v0.1.1)

Service for Permission API operations.

Operations: list, fetch, update, delete

Summary

Functions

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

Delete a specific Sync Map Permission.

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

Fetch a specific Sync Map Permission.

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

Retrieve a list of all Permissions applying to a Sync Map.

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

Stream: Retrieve a list of all Permissions applying to a Sync Map. (lazy auto-pagination).

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

Update an identity's access to a specific Sync Map.

Functions

delete(client, service_sid, map_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()}

Delete a specific Sync Map Permission.

Operation: DeleteSyncMapPermission | Tags: SyncV1SyncMapPermission

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

@spec fetch(Twilio.Client.t(), String.t(), String.t(), String.t(), keyword()) ::
  {:ok, Twilio.Resources.Sync.V1.Service.Map.Permission.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Fetch a specific Sync Map Permission.

Operation: FetchSyncMapPermission | Tags: SyncV1SyncMapPermission

list(client, service_sid, map_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()}

Retrieve a list of all Permissions applying to a Sync Map.

Operation: ListSyncMapPermission | Tags: SyncV1SyncMapPermission

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

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

Stream: Retrieve a list of all Permissions applying to a Sync Map. (lazy auto-pagination).

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

@spec update(Twilio.Client.t(), String.t(), String.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Sync.V1.Service.Map.Permission.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Update an identity's access to a specific Sync Map.

Operation: UpdateSyncMapPermission | Tags: SyncV1SyncMapPermission

Required Parameters

Parameter	Type	Description
`Manage`	boolean	Whether the identity can delete the Sync Map. Default value is `false`.
`Read`	boolean	Whether the identity can read the Sync Map and its Items. Default value is `false`.

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

| Write | boolean | Whether the identity can create, update, and delete Items in the Sync Map. Default value is false. |