From 6094aad51c3bf842d66f484502cedd7b787800da Mon Sep 17 00:00:00 2001
From: Pradeep Nayak <pradpnayak@gmail.com>
Date: Wed, 17 Feb 2016 10:46:29 +0530
Subject: [PATCH] --CRM-16259, added examples

---
 api/v3/examples/Payment/Cancel.php            | 87 +++++++++++++++++
 api/v3/examples/Payment/Create.php            | 87 +++++++++++++++++
 .../Payment/CreatePaymentWithLineItems.php    | 97 +++++++++++++++++++
 api/v3/examples/Payment/Delete.php            | 70 +++++++++++++
 api/v3/examples/Payment/Get.php               | 86 ++++++++++++++++
 api/v3/examples/Payment/UpdatePayment.php     | 91 +++++++++++++++++
 6 files changed, 518 insertions(+)
 create mode 100644 api/v3/examples/Payment/Cancel.php
 create mode 100644 api/v3/examples/Payment/Create.php
 create mode 100644 api/v3/examples/Payment/CreatePaymentWithLineItems.php
 create mode 100644 api/v3/examples/Payment/Delete.php
 create mode 100644 api/v3/examples/Payment/Get.php
 create mode 100644 api/v3/examples/Payment/UpdatePayment.php

diff --git a/api/v3/examples/Payment/Cancel.php b/api/v3/examples/Payment/Cancel.php
new file mode 100644
index 0000000000..bd71ea4426
--- /dev/null
+++ b/api/v3/examples/Payment/Cancel.php
@@ -0,0 +1,87 @@
+<?php
+/**
+ * Test Generated example demonstrating the Payment.cancel API.
+ *
+ * @return array
+ *   API result array
+ */
+function payment_cancel_example() {
+  $params = array(
+    'id' => 2,
+    'check_permissions' => TRUE,
+  );
+
+  try{
+    $result = civicrm_api3('Payment', 'cancel', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'error' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function payment_cancel_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 3,
+    'values' => array(
+      '3' => array(
+        'id' => 3,
+        'from_financial_account_id' => '7',
+        'to_financial_account_id' => '6',
+        'trxn_date' => '20160217204840',
+        'total_amount' => '-150',
+        'fee_amount' => '0.00',
+        'net_amount' => '150.00',
+        'currency' => 'USD',
+        'is_payment' => 1,
+        'trxn_id' => '',
+        'trxn_result_code' => '',
+        'status_id' => '7',
+        'payment_processor_id' => '',
+      ),
+    ),
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testCancelPayment"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
diff --git a/api/v3/examples/Payment/Create.php b/api/v3/examples/Payment/Create.php
new file mode 100644
index 0000000000..4a8efaae33
--- /dev/null
+++ b/api/v3/examples/Payment/Create.php
@@ -0,0 +1,87 @@
+<?php
+/**
+ * Test Generated example demonstrating the Payment.create API.
+ *
+ * @return array
+ *   API result array
+ */
+function payment_create_example() {
+  $params = array(
+    'contribution_id' => 1,
+    'total_amount' => 50,
+  );
+
+  try{
+    $result = civicrm_api3('Payment', 'create', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'error' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function payment_create_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 3,
+    'values' => array(
+      '3' => array(
+        'id' => '3',
+        'from_financial_account_id' => '7',
+        'to_financial_account_id' => '6',
+        'trxn_date' => '20160217204833',
+        'total_amount' => '50',
+        'fee_amount' => '',
+        'net_amount' => '50',
+        'currency' => 'USD',
+        'is_payment' => '1',
+        'trxn_id' => '',
+        'trxn_result_code' => '',
+        'status_id' => '1',
+        'payment_processor_id' => '',
+      ),
+    ),
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testCreatePaymentNoLineItems"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
diff --git a/api/v3/examples/Payment/CreatePaymentWithLineItems.php b/api/v3/examples/Payment/CreatePaymentWithLineItems.php
new file mode 100644
index 0000000000..b9a9b971c1
--- /dev/null
+++ b/api/v3/examples/Payment/CreatePaymentWithLineItems.php
@@ -0,0 +1,97 @@
+<?php
+/**
+ * Test Generated example demonstrating the Payment.create API.
+ *
+ * Payment with line item
+ *
+ * @return array
+ *   API result array
+ */
+function payment_create_example() {
+  $params = array(
+    'contribution_id' => 1,
+    'total_amount' => 50,
+    'line_item' => array(
+      '0' => array(
+        '1' => 10,
+      ),
+      '1' => array(
+        '2' => 40,
+      ),
+    ),
+  );
+
+  try{
+    $result = civicrm_api3('Payment', 'create', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'error' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function payment_create_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 3,
+    'values' => array(
+      '3' => array(
+        'id' => '3',
+        'from_financial_account_id' => '7',
+        'to_financial_account_id' => '6',
+        'trxn_date' => '20160217204836',
+        'total_amount' => '50',
+        'fee_amount' => '',
+        'net_amount' => '50',
+        'currency' => 'USD',
+        'is_payment' => '1',
+        'trxn_id' => '',
+        'trxn_result_code' => '',
+        'status_id' => '1',
+        'payment_processor_id' => '',
+      ),
+    ),
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testCreatePaymentLineItems"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
diff --git a/api/v3/examples/Payment/Delete.php b/api/v3/examples/Payment/Delete.php
new file mode 100644
index 0000000000..c5be86b58c
--- /dev/null
+++ b/api/v3/examples/Payment/Delete.php
@@ -0,0 +1,70 @@
+<?php
+/**
+ * Test Generated example demonstrating the Payment.delete API.
+ *
+ * @return array
+ *   API result array
+ */
+function payment_delete_example() {
+  $params = array(
+    'id' => 2,
+    'check_permissions' => TRUE,
+  );
+
+  try{
+    $result = civicrm_api3('Payment', 'delete', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'error' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function payment_delete_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'values' => 1,
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testDeletePayment"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
diff --git a/api/v3/examples/Payment/Get.php b/api/v3/examples/Payment/Get.php
new file mode 100644
index 0000000000..c56d91ec57
--- /dev/null
+++ b/api/v3/examples/Payment/Get.php
@@ -0,0 +1,86 @@
+<?php
+/**
+ * Test Generated example demonstrating the Payment.get API.
+ *
+ * @return array
+ *   API result array
+ */
+function payment_get_example() {
+  $params = array(
+    'contribution_id' => 1,
+    'check_permissions' => TRUE,
+  );
+
+  try{
+    $result = civicrm_api3('Payment', 'get', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'error' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function payment_get_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 1,
+    'values' => array(
+      '1' => array(
+        'id' => '1',
+        'to_financial_account_id' => '6',
+        'trxn_date' => '2010-01-20 00:00:00',
+        'total_amount' => '100.00',
+        'fee_amount' => '0.00',
+        'net_amount' => '100.00',
+        'currency' => 'USD',
+        'is_payment' => '1',
+        'trxn_id' => '23456',
+        'status_id' => '1',
+        'payment_instrument_id' => '4',
+        'contribution_id' => '1',
+      ),
+    ),
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testGetPayment"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
diff --git a/api/v3/examples/Payment/UpdatePayment.php b/api/v3/examples/Payment/UpdatePayment.php
new file mode 100644
index 0000000000..d240cbfe2e
--- /dev/null
+++ b/api/v3/examples/Payment/UpdatePayment.php
@@ -0,0 +1,91 @@
+<?php
+/**
+ * Test Generated example demonstrating the Payment.create API.
+ *
+ * Update Payment
+ *
+ * @return array
+ *   API result array
+ */
+function payment_create_example() {
+  $params = array(
+    'contribution_id' => 1,
+    'total_amount' => 100,
+    'id' => 3,
+    'check_permissions' => TRUE,
+  );
+
+  try{
+    $result = civicrm_api3('Payment', 'create', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'error' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
+
+  return $result;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
+ */
+function payment_create_expectedresult() {
+
+  $expectedResult = array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 5,
+    'values' => array(
+      '5' => array(
+        'id' => '5',
+        'from_financial_account_id' => '7',
+        'to_financial_account_id' => '6',
+        'trxn_date' => '20160217204847',
+        'total_amount' => '100',
+        'fee_amount' => '',
+        'net_amount' => '100',
+        'currency' => 'USD',
+        'is_payment' => '1',
+        'trxn_id' => '',
+        'trxn_result_code' => '',
+        'status_id' => '1',
+        'payment_processor_id' => '',
+      ),
+    ),
+  );
+
+  return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testUpdatePayment"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
-- 
2.25.1