wishthis/vendor/knplabs/github-api/lib/Github/Api/Organization/Hooks.php
2022-01-21 09:23:52 +01:00

111 lines
2.6 KiB
PHP

<?php
namespace Github\Api\Organization;
use Github\Api\AbstractApi;
use Github\Exception\MissingArgumentException;
class Hooks extends AbstractApi
{
/**
* List hooks.
*
* @link https://developer.github.com/v3/orgs/hooks/#list-hooks
*
* @param string $organization
*
* @return array
*/
public function all($organization)
{
return $this->get('/orgs/'.rawurlencode($organization).'/hooks');
}
/**
* Get a single hook.
*
* @link https://developer.github.com/v3/orgs/hooks/#get-single-hook
*
* @param string $organization
* @param int $id
*
* @return array
*/
public function show($organization, $id)
{
return $this->get('/orgs/'.rawurlencode($organization).'/hooks/'.$id);
}
/**
* Create a hook.
*
* @link https://developer.github.com/v3/orgs/hooks/#create-a-hook
*
* @param string $organization
* @param array $params
*
* @throws \Github\Exception\MissingArgumentException
*
* @return array
*/
public function create($organization, array $params)
{
if (!isset($params['name'], $params['config'])) {
throw new MissingArgumentException(['name', 'config']);
}
return $this->post('/orgs/'.rawurlencode($organization).'/hooks', $params);
}
/**
* Edit a hook.
*
* @link https://developer.github.com/v3/orgs/hooks/#edit-a-hook
*
* @param string $organization
* @param int $id
* @param array $params
*
* @throws \Github\Exception\MissingArgumentException
*
* @return array
*/
public function update($organization, $id, array $params)
{
if (!isset($params['config'])) {
throw new MissingArgumentException(['config']);
}
return $this->patch('/orgs/'.rawurlencode($organization).'/hooks/'.$id, $params);
}
/**
* Ping a hook.
*
* @link https://developer.github.com/v3/orgs/hooks/#ping-a-hook
*
* @param string $organization
* @param int $id
*
* @return array|string
*/
public function ping($organization, $id)
{
return $this->post('/orgs/'.rawurlencode($organization).'/hooks/'.$id.'/pings');
}
/**
* Delete a hook.
*
* @link https://developer.github.com/v3/orgs/hooks/#delete-a-hook
*
* @param string $organization
* @param int $id
*
* @return array|string
*/
public function remove($organization, $id)
{
return $this->delete('/orgs/'.rawurlencode($organization).'/hooks/'.$id);
}
}