appwrite/src/Appwrite/Utopia/Response/Model/UsageUsers.php

98 lines
3.1 KiB
PHP
Raw Normal View History

<?php
namespace Appwrite\Utopia\Response\Model;
use Appwrite\Utopia\Response;
use Appwrite\Utopia\Response\Model;
class UsageUsers extends Model
{
public function __construct()
{
$this
->addRule('range', [
'type' => self::TYPE_STRING,
'description' => 'The time range of the usage stats.',
'default' => '',
'example' => '30d',
])
2021-10-26 13:19:28 +00:00
->addRule('usersCount', [
'type' => Response::MODEL_METRIC_LIST,
'description' => 'Aggregated stats for total number of users.',
'default' => [],
2022-05-23 14:54:50 +00:00
'example' => new \stdClass(),
'array' => true
])
2021-10-26 13:19:28 +00:00
->addRule('usersCreate', [
'type' => Response::MODEL_METRIC_LIST,
'description' => 'Aggregated stats for users created.',
'default' => [],
2022-05-23 14:54:50 +00:00
'example' => new \stdClass(),
'array' => true
])
2021-10-26 13:19:28 +00:00
->addRule('usersRead', [
'type' => Response::MODEL_METRIC_LIST,
'description' => 'Aggregated stats for users read.',
'default' => [],
2022-05-23 14:54:50 +00:00
'example' => new \stdClass(),
'array' => true
])
2021-10-26 13:19:28 +00:00
->addRule('usersUpdate', [
'type' => Response::MODEL_METRIC_LIST,
'description' => 'Aggregated stats for users updated.',
'default' => [],
2022-05-23 14:54:50 +00:00
'example' => new \stdClass(),
'array' => true
])
2021-10-26 13:19:28 +00:00
->addRule('usersDelete', [
'type' => Response::MODEL_METRIC_LIST,
'description' => 'Aggregated stats for users deleted.',
'default' => [],
2022-05-23 14:54:50 +00:00
'example' => new \stdClass(),
'array' => true
])
2021-10-26 13:19:28 +00:00
->addRule('sessionsCreate', [
'type' => Response::MODEL_METRIC_LIST,
'description' => 'Aggregated stats for sessions created.',
'default' => [],
2022-05-23 14:54:50 +00:00
'example' => new \stdClass(),
'array' => true
])
2021-10-26 13:19:28 +00:00
->addRule('sessionsProviderCreate', [
'type' => Response::MODEL_METRIC_LIST,
'description' => 'Aggregated stats for sessions created for a provider ( email, anonymous or oauth2 ).',
'default' => [],
2022-05-23 14:54:50 +00:00
'example' => new \stdClass(),
'array' => true
])
2021-10-26 13:19:28 +00:00
->addRule('sessionsDelete', [
'type' => Response::MODEL_METRIC_LIST,
'description' => 'Aggregated stats for sessions deleted.',
'default' => [],
2022-05-23 14:54:50 +00:00
'example' => new \stdClass(),
'array' => true
])
;
}
/**
* Get Name
2022-05-23 14:54:50 +00:00
*
* @return string
*/
2022-05-23 14:54:50 +00:00
public function getName(): string
{
return 'UsageUsers';
}
/**
* Get Type
2022-05-23 14:54:50 +00:00
*
* @return string
*/
2022-05-23 14:54:50 +00:00
public function getType(): string
{
return Response::MODEL_USAGE_USERS;
}
2022-05-23 14:54:50 +00:00
}