Cavemanon/piratepoet
7
Fork 0
Code Pull Requests Actions Releases 16 Activity

Fix documentation

Browse Source 
[MAILPOET-2041]
This commit is contained in:
Pavel Dohnal
2019-05-30 14:45:12 +02:00
committed by M. Shull
parent c5162383dd
commit bfdff27b19
3 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/Readme.md
View File

@ -22,7 +22,7 @@ Class `\MailPoet\API\API` becomes available once MailPoet plugin is loaded by Wo
### Available API Methods
* [Add List (addList)](api_methods/AddList.md)
* [Add Subscriber (addSubscriber)](api_methods/AddSubscriber.md)
* [Add Subscriber Field(addSubscriberField)](api_methods/AddSubscriberField.md)
* [Add Subscriber Field (addSubscriberField)](api_methods/AddSubscriberField.md)
* [Get Lists (getLists)](api_methods/GetLists.md)
* [Get Subscriber (getSubscriber)](api_methods/GetSubscriber.md)
* [Get Subscriber Fields (getSubscriberFields)](api_methods/GetSubscriberFields.md)

6
doc/api_methods/AddSubscriberField.md
View File

@ -50,7 +50,7 @@ The common properties for all types:
| Property | Type | Description |
| --- | --- | --- |
| date_type | string | Possible values are: Values: `year_month_day`, `year_month`, `month`, `day` |
| date_format | string | Values: for year_month_day: 'MM/DD/YYYY', 'DD/MM/YYYY', 'YYYY/MM/DD', for year_month: 'YYYY/MM', 'MM/YY', for year: 'YYYY', for month: 'MM' |
| date_format | string | Values: for year_month_day: `MM/DD/YYYY`, `DD/MM/YYYY`, `YYYY/MM/DD`, for year_month: `YYYY/MM`, `MM/YY`, for year: `YYYY`, for month: `MM` |
## Response
@ -60,6 +60,6 @@ The common properties for all types:
| name | string | 90 chars | Human readable name. Intended to be used, as an example, as a label for form input. |
| type | string | - | Type of the field. Possible values are: `text`, `date`, `textarea`, `radio`, `checkbox`, `select` |
| params | array | - | Contains various information, see examples below. |
| created_at | string\|null | - | UTC time of creation in 'Y-m-d H:i:s' format |
| updated_at | string | - | UTC time of last update in 'Y-m-d H:i:s' format |
| created_at | string\|null | - | UTC time of creation in `Y-m-d H:i:s` format |
| updated_at | string | - | UTC time of last update in `Y-m-d H:i:s` format |

2
doc/api_methods/GetSubscriberFields.md
View File

@ -7,7 +7,7 @@
Each subscriber has a set of default properties (`email`, `first_name`, `last_name`).
MailPoet enables the extension of these properties by adding custom properties.
This method returns list of all properties available for a subscriber (default + custom).
See also [addSubscriberField function](./AddSubscriberField.md)
See also [addSubscriberField function.](./AddSubscriberField.md)
## Subscriber Field