Permify v0.1.0

View Source Permify.Client (Permify v0.1.0)

Provides some helpers to call the service via HTTP.

Link to this section Summary

Types

error()
http_client()
success()
t()

Functions

generate_upload_body(schema)
get(client, path)

Defines a helper to make HTTP GET request.

new(endpoint \\ "http://localhost:3476/v1")

Creates a new struct Permify.Client.

parse_response(response)
post(client, path, body)

Defines a helper to make HTTP POST request.

upload_schema(client, path, schema)

Defines a helper to upload the Permify schema.

Link to this section Types

Link to this type

error()

View Source 
@type error() :: {:error, binary()} | {:error, pos_integer()}
Link to this opaque

http_client()

View Source (opaque) 
@opaque http_client()
Link to this type

success()

View Source 
@type success() :: :ok | {:ok, any()}
Link to this type

t()

View Source 
@type t() :: %Permify.Client{http_client: http_client()}

Link to this section Functions

Link to this function

generate_upload_body(schema)

View Source 
@spec generate_upload_body(binary()) :: binary()
Link to this function

get(client, path)

View Source 
@spec get(t(), binary()) :: success() | error()

Defines a helper to make HTTP GET request.

Link to this function

new(endpoint \\ "http://localhost:3476/v1")

View Source 
@spec new(binary() | URI.t()) :: t()

Creates a new struct Permify.Client.

Link to this function

parse_response(response)

View Source 
@spec parse_response(Req.Response.t()) :: success() | error()
Link to this function

post(client, path, body)

View Source 
@spec post(t(), binary(), any()) :: success() | error()

Defines a helper to make HTTP POST request.

Link to this function

upload_schema(client, path, schema)

View Source 
@spec upload_schema(t(), binary(), binary()) :: success() | error()

Defines a helper to upload the Permify schema.