| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
- * File for the CiviCRM APIv3 premium functions
+ * This api exposes CiviCRM premiums.
*
- * @package CiviCRM_APIv3
- * @subpackage API_premium
+ * Premiums are used as incentive gifts on contribution pages.
+ * Premiums contain "Products" which has a separate api.
+ * Use chaining to create a premium and related products in one api call.
*
+ * @package CiviCRM_APIv3
*/
/**
- * Save a premium
- *
- * Allowed @params array keys are:
- * {@getfields premium_create}
- * @example premiumCreate.php
+ * Save a premium.
*
* @param array $params
*
* @throws API_Exception
* @return array
- * Array of newly created premium property values.
*/
function civicrm_api3_premium_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
- * Get a premium
- *
- * Allowed @params array keys are:
- * {@getfields premium_get}
- * @example premiumCreate.php
+ * Get a premium.
*
* @param array $params
*
}
/**
- * Delete a premium
- *
- * Allowed @params array keys are:
- * {@getfields premium_delete}
- * @example premiumCreate.php
+ * Delete a premium.
*
* @param array $params
*
}
/**
- * return field specification specific to get requests
+ * Return field specification specific to get requests.
+ *
* @param array $params
*/
function _civicrm_api3_premium_get_spec(&$params) {
}
/**
- * return field specification specific to create requests
+ * Return field specification specific to create requests.
+ *
* @param array $params
*/
function _civicrm_api3_premium_create_spec(&$params) {