Clerk.Ports.User behaviour (Clerk Ex v0.2.0)

Behaviour that defines the expected functions for a User adapter.

Summary

ban(t)

count()

create(map)

delete_id(t)

get_id(t)

list()

lock(t)

unban(t)

unlock(t)

update(t, map)

@callback ban(String.t()) :: Clerk.Shared.HandleResponse.t()

@callback count() :: Clerk.Shared.HandleResponse.t()

@callback create(map()) :: Clerk.Shared.HandleResponse.t()

@callback delete_id(String.t()) :: Clerk.Shared.HandleResponse.t()

@callback delete_profile_image(String.t()) :: Clerk.Shared.HandleResponse.t()

@callback get_id(String.t()) :: Clerk.Shared.HandleResponse.t()

@callback list() :: Clerk.Shared.HandleResponse.t()

@callback list_invitations(String.t()) :: Clerk.Shared.HandleResponse.t()

@callback list_memberships(String.t()) :: Clerk.Shared.HandleResponse.t()

@callback lock(String.t()) :: Clerk.Shared.HandleResponse.t()

@callback merge_and_update_user_metadata(String.t(), map()) ::
  Clerk.Shared.HandleResponse.t()

@callback oauth_access_token(String.t(), String.t()) :: Clerk.Shared.HandleResponse.t()

@callback set_profile_image(String.t(), String.t()) :: Clerk.Shared.HandleResponse.t()

@callback unban(String.t()) :: Clerk.Shared.HandleResponse.t()

@callback unlock(String.t()) :: Clerk.Shared.HandleResponse.t()

@callback update(String.t(), map()) :: Clerk.Shared.HandleResponse.t()

@callback verify_password(String.t(), String.t()) :: Clerk.Shared.HandleResponse.t()

@callback verify_totp(String.t(), String.t()) :: Clerk.Shared.HandleResponse.t()