Lockspire.Storage.PushedAuthorizationRequestStore behaviour (lockspire v1.0.0)

Copy Markdown

Domain-level persistence contract for pushed authorization request state.

Summary

Types

store_error()

Callbacks

consume_pushed_authorization_request(t, t)
fetch_active_pushed_authorization_request(t)
put_pushed_authorization_request(t)

Types

store_error()

@type store_error() :: term()

Callbacks

consume_pushed_authorization_request(t, t)

@callback consume_pushed_authorization_request(String.t(), String.t()) ::
  {:ok, Lockspire.Domain.PushedAuthorizationRequest.t() | nil}
  | {:error, store_error()}

fetch_active_pushed_authorization_request(t)

@callback fetch_active_pushed_authorization_request(String.t()) ::
  {:ok, Lockspire.Domain.PushedAuthorizationRequest.t() | nil}
  | {:error, store_error()}

put_pushed_authorization_request(t)

@callback put_pushed_authorization_request(
  Lockspire.Domain.PushedAuthorizationRequest.t()
) ::
  {:ok, Lockspire.Domain.PushedAuthorizationRequest.t()}
  | {:error, store_error()}