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 +--------------------------------------------------------------------+
13 * This api exposes CiviCRM recurring entity records.
15 * @package CiviCRM_APIv3
19 * Retrieve a recurring entity.
21 * @param array $params
26 function civicrm_api3_recurring_entity_get($params) {
27 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
31 * Adjust Metadata for Get action.
33 * The metadata is used for setting defaults, documentation & validation.
35 * @param array $params
36 * Array of parameters determined by getfields.
38 function _civicrm_api3_recurring_entity_get_spec(&$params) {
39 $params['entity_table']['options'] = [
40 'civicrm_event' => 'civicrm_event',
41 'civicrm_activity' => 'civicrm_activity',
46 * Add or update a recurring entity.
48 * @param array $params
52 function civicrm_api3_recurring_entity_create($params) {
53 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'RecurringEntity');
57 * Adjust Metadata for Create action.
59 * The metadata is used for setting defaults, documentation & validation.
61 * @param array $params
62 * Array of parameters determined by getfields.
64 function _civicrm_api3_recurring_entity_create_spec(&$params) {
65 $params['entity_table']['options'] = [
66 'civicrm_event' => 'civicrm_event',
67 'civicrm_activity' => 'civicrm_activity',
69 $params['entity_table']['api.required'] = 1;
73 * Deletes an existing ReportInstance.
75 * @param array $params
79 function civicrm_api3_recurring_entity_delete($params) {
80 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);