Merge pull request #6408 from johanv/CRM-16963-permissions_country_api

[civicrm-core.git] / api / v3 / MailingEventUnsubscribe.php

diff --git a/api/v3/MailingEventUnsubscribe.php b/api/v3/MailingEventUnsubscribe.php
index 5362b5001bb270995c101ad18583d3cdd964845c..4c3ddaa13a8ed20a7baba47905125d0f6497af11 100644 (file)
--- a/api/v3/MailingEventUnsubscribe.php
+++ b/api/v3/MailingEventUnsubscribe.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,30 +23,23 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * APIv3 functions for registering/processing mailing group events.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_MailerGroup
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id$
- *
  */
 
 /**
- * Unsubscribe from mailing group
+ * Unsubscribe from mailing group.
  *
  * @param array $params
- *   Associative array of property.
- *                       name/value pairs to insert in new 'survey'
+ *   Array per getfields metadata.
  *
  * @return array
- *   api result array
- * {@getfields mailing_event_unsubscribe_create}
- * @access public
+ *   Api result array
  */
 function civicrm_api3_mailing_event_unsubscribe_create($params) {
 
@@ -70,22 +63,31 @@ function civicrm_api3_mailing_event_unsubscribe_create($params) {
     return civicrm_api3_create_success($params);
   }
 
-
   return civicrm_api3_create_error('Queue event could not be found');
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
  *
- * The metadata is used for setting defaults, documentation & validation
  * @param array $params
- *   Array or parameters determined by getfields.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_mailing_event_unsubscribe_create_spec(&$params) {
-  $params['job_id']['api.required'] = 1;
-  $params['job_id']['title'] = 'Mailing Job ID';
-  $params['hash']['api.required'] = 1;
-  $params['hash']['title'] = 'Mailing Hash';
-  $params['event_queue_id']['api.required'] = 1;
-  $params['event_queue_id']['title'] = 'Mailing Queue ID';
+  $params['job_id'] = array(
+    'api.required' => 1,
+    'title' => 'Mailing Job ID',
+    'type' => CRM_Utils_Type::T_INT,
+  );
+  $params['hash'] = array(
+    'api.required' => 1,
+    'title' => 'Mailing Hash',
+    'type' => CRM_Utils_Type::T_STRING,
+  );
+  $params['event_queue_id'] = array(
+    'api.required' => 1,
+    'title' => 'Mailing Queue ID',
+    'type' => CRM_Utils_Type::T_INT,
+  );
 }