97 lines
2.8 KiB
PHP
97 lines
2.8 KiB
PHP
<?php
|
|
|
|
namespace Appwrite\Utopia\Response\Model;
|
|
|
|
use Appwrite\Utopia\Response;
|
|
use Appwrite\Utopia\Response\Model;
|
|
|
|
class Key extends Model
|
|
{
|
|
/**
|
|
* @var bool
|
|
*/
|
|
protected bool $public = false;
|
|
|
|
public function __construct()
|
|
{
|
|
$this
|
|
->addRule('$id', [
|
|
'type' => self::TYPE_STRING,
|
|
'description' => 'Key ID.',
|
|
'default' => '',
|
|
'example' => '5e5ea5c16897e',
|
|
])
|
|
->addRule('$createdAt', [
|
|
'type' => self::TYPE_DATETIME,
|
|
'description' => 'Key creation date in ISO 8601 format.',
|
|
'default' => '',
|
|
'example' => self::TYPE_DATETIME_EXAMPLE,
|
|
])
|
|
->addRule('$updatedAt', [
|
|
'type' => self::TYPE_DATETIME,
|
|
'description' => 'Key update date in ISO 8601 format.',
|
|
'default' => '',
|
|
'example' => self::TYPE_DATETIME_EXAMPLE,
|
|
])
|
|
->addRule('name', [
|
|
'type' => self::TYPE_STRING,
|
|
'description' => 'Key name.',
|
|
'default' => '',
|
|
'example' => 'My API Key',
|
|
])
|
|
->addRule('expire', [
|
|
'type' => self::TYPE_DATETIME,
|
|
'description' => 'Key expiration date in ISO 8601 format.',
|
|
'default' => '',
|
|
'example' => self::TYPE_DATETIME_EXAMPLE,
|
|
])
|
|
->addRule('scopes', [
|
|
'type' => self::TYPE_STRING,
|
|
'description' => 'Allowed permission scopes.',
|
|
'default' => [],
|
|
'example' => 'users.read',
|
|
'array' => true,
|
|
])
|
|
->addRule('secret', [
|
|
'type' => self::TYPE_STRING,
|
|
'description' => 'Secret key.',
|
|
'default' => '',
|
|
'example' => '919c2d18fb5d4...a2ae413da83346ad2',
|
|
])
|
|
->addRule('accessedAt', [
|
|
'type' => self::TYPE_DATETIME,
|
|
'description' => 'Most recent access date in ISO 8601 format.',
|
|
'default' => '',
|
|
'example' => self::TYPE_DATETIME_EXAMPLE
|
|
])
|
|
->addRule('sdks', [
|
|
'type' => self::TYPE_STRING,
|
|
'description' => 'List of SDK user agents that used this key.',
|
|
'default' => null,
|
|
'example' => 'appwrite:flutter',
|
|
'array' => true
|
|
])
|
|
;
|
|
}
|
|
|
|
/**
|
|
* Get Name
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getName(): string
|
|
{
|
|
return 'Key';
|
|
}
|
|
|
|
/**
|
|
* Get Type
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getType(): string
|
|
{
|
|
return Response::MODEL_KEY;
|
|
}
|
|
}
|