ProPeace/de.systopia.twingle
6
0
Fork 0
Code Issues 2 Pull requests Projects 1 Releases Packages Wiki Activity Actions

Add better date/time parameter documentation.

Browse source
This commit is contained in:
Jens Schuppe 2018-12-20 11:30:28 +01:00
parent 0f69169561
commit 63c3f79776
4 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -67,7 +67,7 @@ The action accepts the following parameters:
|----------------------------------------|---------|-------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------| |----------------------------------------|---------|-------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| <nobr>`project_id`</nobr> | String | The Twingle project ID | | Yes | | <nobr>`project_id`</nobr> | String | The Twingle project ID | | Yes |
| <nobr>`trx_id`</nobr> | String | The unique transaction ID of the donation | A unique transaction ID for the donation. | Yes | | <nobr>`trx_id`</nobr> | String | The unique transaction ID of the donation | A unique transaction ID for the donation. | Yes |
| <nobr>`confirmed_at`</nobr> | String | The date when the donation was issued | A string representing a date in the format `YYYYMMDD` | Yes | | <nobr>`confirmed_at`</nobr> | String | The date when the donation was issued | A string representing a date in the format `YmdHis` | Yes |
| <nobr>`purpose`</nobr> | String | The purpose of the donation | | | | <nobr>`purpose`</nobr> | String | The purpose of the donation | | |
| <nobr>`amount`</nobr> | Integer | The donation amount in minor currency unit | | Yes | | <nobr>`amount`</nobr> | Integer | The donation amount in minor currency unit | | Yes |
| <nobr>`currency`</nobr> | String | The ISO-4217 currency code of the donation | A valid ISO-4217 currency code | Yes | | <nobr>`currency`</nobr> | String | The ISO-4217 currency code of the donation | A valid ISO-4217 currency code | Yes |
@ -82,7 +82,7 @@ The action accepts the following parameters:
| <nobr>`debit_account_holder`</nobr> | String | The account holder for SEPA Direct Debit payments | | | | <nobr>`debit_account_holder`</nobr> | String | The account holder for SEPA Direct Debit payments | | |
| <nobr>`is_anonymous`</nobr> | Boolean | Whether the donation is submitted anonymously | | | | <nobr>`is_anonymous`</nobr> | Boolean | Whether the donation is submitted anonymously | | |
| <nobr>`user_gender`</nobr> | String | The gender of the contact | | | | <nobr>`user_gender`</nobr> | String | The gender of the contact | | |
| <nobr>`user_birthdate`</nobr> | String | The date of birth of the contact | A string representing a date in the format `YYYYMMDD` | | | <nobr>`user_birthdate`</nobr> | String | The date of birth of the contact | A string representing a date in the format `Ymd` | |
| <nobr>`user_title`</nobr> | String | The formal title of the contact | | | | <nobr>`user_title`</nobr> | String | The formal title of the contact | | |
| <nobr>`user_email`</nobr> | String | The e-mail address of the contact | A valid e-mail address | | | <nobr>`user_email`</nobr> | String | The e-mail address of the contact | A valid e-mail address | |
| <nobr>`user_firstname`</nobr> | String | The first name of the contact | | | | <nobr>`user_firstname`</nobr> | String | The first name of the contact | | |
@ -109,7 +109,7 @@ The action accepts the following parameters:
|---------------------------|---------|------------------------------------------------|-------------------------------------------------------|----------| |---------------------------|---------|------------------------------------------------|-------------------------------------------------------|----------|
| <nobr>`project_id`</nobr> | String | The Twingle project ID | | Yes | | <nobr>`project_id`</nobr> | String | The Twingle project ID | | Yes |
| <nobr>`trx_id`</nobr> | String | The unique transaction ID of the donation | A unique transaction ID for the donation. | Yes | | <nobr>`trx_id`</nobr> | String | The unique transaction ID of the donation | A unique transaction ID for the donation. | Yes |
| <nobr>`ended_at`</nobr> | Integer | The date when the recurring donation was ended | A string representing a date in the format `YYYYMMDD` | Yes | | <nobr>`ended_at`</nobr> | Integer | The date when the recurring donation was ended | A string representing a date in the format `YmdHis` | Yes |
You may also refer to You may also refer to
[the code](https://github.com/systopia/de.systopia.twingle/blob/master/api/v3/TwingleDonation/Endrecurring.php) [the code](https://github.com/systopia/de.systopia.twingle/blob/master/api/v3/TwingleDonation/Endrecurring.php)
@ -126,8 +126,8 @@ The action accepts the following parameters:
|------------------------------|--------|----------------------------------------------------|-------------------------------------------------------|----------| |------------------------------|--------|----------------------------------------------------|-------------------------------------------------------|----------|
| <nobr>`project_id`</nobr> | String | The Twingle project ID | | Yes | | <nobr>`project_id`</nobr> | String | The Twingle project ID | | Yes |
| <nobr>`trx_id`</nobr> | String | The unique transaction ID of the donation | A unique transaction ID for the donation. | Yes | | <nobr>`trx_id`</nobr> | String | The unique transaction ID of the donation | A unique transaction ID for the donation. | Yes |
| <nobr>`cancelled_at`</nobr> | String | The date when the recurring donation was cancelled | A string representing a date in the format `YYYYMMDD` | Yes | | <nobr>`cancelled_at`</nobr> | String | The date when the recurring donation was cancelled | A string representing a date in the format `YmdHis` | Yes |
| <nobr>`cancel_reason`</nobr> | String | he reason for the donation being cancelled | | Yes | | <nobr>`cancel_reason`</nobr> | String | The reason for the donation being cancelled | | Yes |
You may also refer to You may also refer to
[the code](https://github.com/systopia/de.systopia.twingle/blob/master/api/v3/TwingleDonation/Cancel.php) [the code](https://github.com/systopia/de.systopia.twingle/blob/master/api/v3/TwingleDonation/Cancel.php)

2
api/v3/TwingleDonation/Cancel.php
View file

@ -45,7 +45,7 @@ function _civicrm_api3_twingle_donation_Cancel_spec(&$params) {
'title' => 'Cancelled at', 'title' => 'Cancelled at',
'type' => CRM_Utils_Type::T_INT, 'type' => CRM_Utils_Type::T_INT,
'api.required' => 1, 'api.required' => 1,
'description' => 'The date when the donation was cancelled, format: YYYYMMDD.', 'description' => 'The date when the donation was cancelled, format: YmdHis.',
); );
$params['cancel_reason'] = array( $params['cancel_reason'] = array(
'name' => 'cancel_reason', 'name' => 'cancel_reason',

2
api/v3/TwingleDonation/Endrecurring.php
View file

@ -45,7 +45,7 @@ function _civicrm_api3_twingle_donation_endrecurring_spec(&$params) {
'title' => 'Ended at', 'title' => 'Ended at',
'type' => CRM_Utils_Type::T_INT, 'type' => CRM_Utils_Type::T_INT,
'api.required' => 1, 'api.required' => 1,
'description' => 'The date when the recurring donation was ended, format: YYYYMMDD.', 'description' => 'The date when the recurring donation was ended, format: YmdHis.',
); );
} }

4
api/v3/TwingleDonation/Submit.php
View file

@ -46,7 +46,7 @@ function _civicrm_api3_twingle_donation_Submit_spec(&$params) {
'title' => 'Confirmed at', 'title' => 'Confirmed at',
'type' => CRM_Utils_Type::T_STRING, 'type' => CRM_Utils_Type::T_STRING,
'api.required' => 1, 'api.required' => 1,
'description' => 'The date when the donation was issued, format: YYYYMMDD.', 'description' => 'The date when the donation was issued, format: YmdHis.',
); );
$params['purpose'] = array( $params['purpose'] = array(
'name' => 'purpose', 'name' => 'purpose',
@ -152,7 +152,7 @@ function _civicrm_api3_twingle_donation_Submit_spec(&$params) {
'title' => 'Date of birth', 'title' => 'Date of birth',
'type' => CRM_Utils_Type::T_STRING, 'type' => CRM_Utils_Type::T_STRING,
'api.required' => 0, 'api.required' => 0,
'description' => 'The date of birth of the contact, format: YYYYMMDD.', 'description' => 'The date of birth of the contact, format: Ymd.',
); );
$params['user_title'] = array( $params['user_title'] = array(
'name' => 'user_title', 'name' => 'user_title',