3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
12 namespace Civi\API\Provider
;
15 * An API "provider" provides a means to execute API requests.
17 interface ProviderInterface
{
20 * @param array $apiRequest
21 * The full description of the API request.
23 * structured response data (per civicrm_api3_create_success)
24 * @see civicrm_api3_create_success
25 * @throws \API_Exception
27 public function invoke($apiRequest);
32 * @return array<string>
34 public function getEntityNames($version);
39 * @param string $entity
41 * @return array<string>
43 public function getActionNames($version, $entity);