Permify v0.1.0

View Source Permify.Relationship (Permify v0.1.0)

Provides some functions to manipulate the relationships.

Link to this section Summary

Types

delete_req()
delete_resp()
entity()
read_req()
read_resp()
relation()
schema_version()
subject()
write_req()
write_resp()

Functions

delete(client, request)

Delete relation tuple

read(client, request)

Read relation tuple(s)

write(client, request)

Create new relation tuple

Link to this section Types

Link to this type

delete_req()

View Source 
@type delete_req() :: %{entity: entity(), relation: binary(), subject: subject()}
Link to this type

delete_resp()

View Source 
@type delete_resp() :: map()
Link to this type

entity()

View Source 
@type entity() :: %{id: binary(), type: binary()}
Link to this type

read_req()

View Source 
@type read_req() :: %{
  filter: %{entity: entity(), relation: relation(), subject: subject()}
}
Link to this type

read_resp()

View Source 
@type read_resp() :: [map()]
Link to this type

relation()

View Source 
@type relation() :: binary()
Link to this type

schema_version()

View Source 
@type schema_version() :: binary()
Link to this type

subject()

View Source 
@type subject() :: %{
  :id => binary(),
  optional(:relation) => relation(),
  type: binary()
}
Link to this type

write_req()

View Source 
@type write_req() :: %{
  :entity => entity(),
  :relation => binary(),
  :subject => subject(),
  optional(:schema_version) => binary()
}
Link to this type

write_resp()

View Source 
@type write_resp() :: map()

Link to this section Functions

Link to this function

delete(client, request)

View Source 
@spec delete(Permify.Client.t(), delete_req()) ::
  {:ok, delete_resp()} | Permify.Client.error()

Delete relation tuple

Link to this function

read(client, request)

View Source 
@spec read(Permify.Client.t(), read_req()) ::
  {:ok, read_resp()} | Permify.Client.error()

Read relation tuple(s)

Link to this function

write(client, request)

View Source 
@spec write(Permify.Client.t(), write_req()) ::
  {:ok, write_resp()} | Permify.Client.error()

Create new relation tuple