// ********************************************************************************
// Generated by DMVCFRAMEWORK 3.4.3-aluminium-rc1 at 2025-04-26 18.40.15
// ********************************************************************************

// Tries to acquire an exclusive lock on `LockIdentifier` for a max of `LockTTL` minutes, optionally attaching the data contained in `LockData`. 
// TryAcquireLock calls cannot be nested - a subsequent call with same LockIdentifier tryies to re-acquire the lock and will raise an exception if can't.
// If the lock has been acquired, TryAcquireLock returns a <LockHandle> (a random string) that need to be used to estend or release the lock.
// If cannot acquire lock, returns the const string "error"
// "TryAcquireLock" is invokable with POST only
function TryAcquireLock(const Token: string; const LockIdentifier: string; const LockTTL: Int64; const LockData: TJsonObject): string;

// Allows to extend the LockTTL for an owned-lock. LockExtender is the token returned by the TryAcquireLock call. Lock extension starts from "now" for LockTTL seconds.
// "ExtendLock" is invokable with POST only
function ExtendLock(const Token: string; const LockTTL: Int64; const LockHandle: string): Boolean;

// Get the lock data from an exclusive lock (owned, or not owned, by the user). If the lock doesn't exist, an exception raise.
// "GetLockData" is invokable with POST only
function GetLockData(const Token: string; const LockIdentifier: string): TJsonObject;

// Returns the time remaining for the natural exclusive lock expiration and the LockData.If the lock doesn't exists property "expires_in" is -1.
// "GetLockExpiration" is invokable with POST only
function GetLockExpiration(const Token: string; const LockIdentifier: string): Int64;

// Returns the system queue where any change to the lock status is published.
// "GetExclusiveLockQueueName" is invokable with POST only
function GetExclusiveLockQueueName(const Token: string; const LockIdentifier: string): string;

// Release an owned exclusive lock and return true. If the lock doesn't exist or is not owned by the current user, return false.
// "ReleaseLock" is invokable with POST only
function ReleaseLock(const Token: string; const LockHandle: string): Boolean;

// Returns all active locks - only ADMIN and MONITOR roles can call this method
// "GetLocks" is invokable with POST only
function GetLocks(const Token: string): TJsonObject;

// Returns the JWT token which can be used to call all other methods.
// "Login" is invokable with POST only
function Login(const UserName: string; const Password: string): TJsonObject;

// Extends the expiration time of a still-valid token. Clients must use the token returned instead of the previous one.
// "RefreshToken" is invokable with POST only
function RefreshToken(const Token: string): TJsonObject;