2017-07-19 20:49:41 -05:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace Pterodactyl\Contracts\Repository\Daemon;
|
|
|
|
|
2017-10-05 23:09:43 -05:00
|
|
|
use Psr\Http\Message\ResponseInterface;
|
|
|
|
|
2017-07-19 20:49:41 -05:00
|
|
|
interface ServerRepositoryInterface extends BaseRepositoryInterface
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* Create a new server on the daemon for the panel.
|
|
|
|
*
|
2017-10-05 23:09:43 -05:00
|
|
|
* @param array $structure
|
2017-08-21 22:10:48 -05:00
|
|
|
* @param array $overrides
|
2017-07-21 21:17:42 -05:00
|
|
|
* @return \Psr\Http\Message\ResponseInterface
|
2017-10-05 23:09:43 -05:00
|
|
|
*
|
|
|
|
* @throws \GuzzleHttp\Exception\RequestException
|
2017-07-19 20:49:41 -05:00
|
|
|
*/
|
2017-10-05 23:09:43 -05:00
|
|
|
public function create(array $structure, array $overrides = []): ResponseInterface;
|
2017-07-22 20:15:01 -05:00
|
|
|
|
2017-08-23 21:34:11 -05:00
|
|
|
/**
|
2017-07-22 20:15:01 -05:00
|
|
|
* Update server details on the daemon.
|
|
|
|
*
|
2017-08-21 22:10:48 -05:00
|
|
|
* @param array $data
|
2017-07-22 20:15:01 -05:00
|
|
|
* @return \Psr\Http\Message\ResponseInterface
|
|
|
|
*/
|
2018-01-05 18:27:47 -06:00
|
|
|
public function update(array $data): ResponseInterface;
|
2017-07-23 14:51:18 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Mark a server to be reinstalled on the system.
|
|
|
|
*
|
2017-08-21 22:10:48 -05:00
|
|
|
* @param array|null $data
|
2017-07-23 14:51:18 -05:00
|
|
|
* @return \Psr\Http\Message\ResponseInterface
|
|
|
|
*/
|
2018-01-05 18:27:47 -06:00
|
|
|
public function reinstall(array $data = null): ResponseInterface;
|
2017-07-23 14:51:18 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Mark a server as needing a container rebuild the next time the server is booted.
|
|
|
|
*
|
|
|
|
* @return \Psr\Http\Message\ResponseInterface
|
|
|
|
*/
|
2018-01-05 18:27:47 -06:00
|
|
|
public function rebuild(): ResponseInterface;
|
2017-07-23 14:51:18 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Suspend a server on the daemon.
|
|
|
|
*
|
|
|
|
* @return \Psr\Http\Message\ResponseInterface
|
|
|
|
*/
|
2018-01-05 18:27:47 -06:00
|
|
|
public function suspend(): ResponseInterface;
|
2017-07-23 14:51:18 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Un-suspend a server on the daemon.
|
|
|
|
*
|
|
|
|
* @return \Psr\Http\Message\ResponseInterface
|
|
|
|
*/
|
2018-01-05 18:27:47 -06:00
|
|
|
public function unsuspend(): ResponseInterface;
|
2017-07-24 21:34:10 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Delete a server on the daemon.
|
|
|
|
*
|
|
|
|
* @return \Psr\Http\Message\ResponseInterface
|
|
|
|
*/
|
2018-01-05 18:27:47 -06:00
|
|
|
public function delete(): ResponseInterface;
|
2017-08-30 21:11:14 -05:00
|
|
|
|
|
|
|
/**
|
2018-05-13 10:50:56 -04:00
|
|
|
* Return details on a specific server.
|
2017-08-30 21:11:14 -05:00
|
|
|
*
|
|
|
|
* @return \Psr\Http\Message\ResponseInterface
|
|
|
|
*/
|
2018-01-05 18:27:47 -06:00
|
|
|
public function details(): ResponseInterface;
|
2017-09-24 21:12:30 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Revoke an access key on the daemon before the time is expired.
|
|
|
|
*
|
2017-12-03 14:00:47 -06:00
|
|
|
* @param string|array $key
|
2017-09-24 21:12:30 -05:00
|
|
|
* @return \Psr\Http\Message\ResponseInterface
|
2017-12-03 14:00:47 -06:00
|
|
|
*
|
|
|
|
* @throws \GuzzleHttp\Exception\RequestException
|
2017-09-24 21:12:30 -05:00
|
|
|
*/
|
2018-01-05 18:27:47 -06:00
|
|
|
public function revokeAccessKey($key): ResponseInterface;
|
2017-07-19 20:49:41 -05:00
|
|
|
}
|