Commit Graph

45 Commits

Author SHA1 Message Date
fc3d0ea439 Add last_subscribed_at in getSubscribers() response to MP API docs
[MAILPOET-5894]
2024-03-22 11:09:42 +01:00
ae28e62b1a Add documentation for the unsubscribe() MP API method
[MAILPOET-5152]
2023-03-27 19:25:49 +02:00
8161b83ded Add check on list type when deleting list
[MAILPOET-4752]
2022-11-02 14:05:39 +01:00
ad46d05c6b Add check on list type
[MAILPOET-4752]
2022-11-02 14:05:39 +01:00
933b947f45 Add deleteList documentation
[MAILPOET-4752]
2022-11-02 14:05:39 +01:00
1ac9c86a66 Add updateList documentation
[MAILPOET-4752]
2022-11-02 14:05:39 +01:00
291f46d732 Fix spacing in docs 2022-10-25 13:13:47 +01:00
e236d3312c Fix listId typo 2022-10-25 13:15:28 +02:00
794090291a Update getSubscribers filter arguments
Filter arguments 'list_id' and 'min_updated_at' do not work. These arguments currently only work with lowerCamelCase.
2022-10-25 13:15:28 +02:00
47ee47c372 Add getSubscribersCount documentation
[MAILPOET-4717]
2022-10-17 09:12:10 +02:00
3773bc4985 Add link to subscriber doc
Because we want to avoid duplicities, we added a link to the method getting a subscriber.
[MAILPOET-4716]
2022-10-13 11:12:10 +02:00
ae0d60df3a Add getSubscribers documentation
[MAILPOET-4716]
2022-10-13 11:12:10 +02:00
083bad3051 Add subscriber tags to documentation
[MAILPOET-4716]
2022-10-13 11:12:10 +02:00
2139b4d035 Fix typo in doc/Readme.md
[MAILPOET-4716]
2022-10-13 11:12:10 +02:00
9c5e9e0da6 Remove version number from API doc
[MAILPOET-4474]
2022-09-09 11:25:51 +02:00
ab27eaee2d Autoformat files with prettier
[MAILPOET-4075]
2022-04-12 15:38:27 +02:00
fac560071a Move doc folder to the root to make it more accessible
[MAILPOET-4107]
2022-02-09 15:57:06 +01:00
9f790efbf0 Move plugin files to a subfolder
[MAILPOET-3988]
2022-01-18 15:30:22 +01:00
ff5841c928 Document isSetupComplete endpoint
[MAILPOET-4042]
2021-12-29 16:05:19 +01:00
e64ba70561 Remove minimum required PHP version
This commit removes a reference to the minimum required PHP version (which is presumably outdated as it mentions PHP 5.6) from the MailPoet API documentation.

I'm assuming that the minimum required version to use the API is the same as the one to run MailPoet. If that is the case, I don't see a reason to mention it in the API documentation, and removing it has the benefit of reducing the maintenance burden when the minimum required version is updated.
2021-01-18 12:28:50 +01:00
wxa
b0e7a486ff Remove new-default-list-name feature flag [MAILPOET-3004] 2020-09-08 14:44:45 +02:00
a1efca7537 Fix api docs for custom checkbox
[MAILPOET-2939]
2020-06-04 10:00:42 +02:00
31fc05dbfd Updated variable name
Updated $getsubscriber to $get_subscriber for coding compliance and to ensure that $subscriber array isn't overwritten.
2020-03-24 14:12:49 +01:00
ab44227c11 Update UsageExamples.md
Changed variable name of $subscriber to $getsubscriber, so the subscriber array isn't overwritten.
2020-03-24 14:12:49 +01:00
b830bb203b Small comment type change on UsageExamples.md 2019-07-29 09:56:38 +02:00
8ee1ead0a6 Add new exception to API documentation
[MAILPOET-2107]
2019-06-06 11:22:48 -04:00
bfdff27b19 Fix documentation
[MAILPOET-2041]
2019-05-30 13:03:33 -04:00
5df3c6c46e Add documentationfor adding custom fields api
[MAILPOET-2041]
2019-05-30 13:03:33 -04:00
3c01b054da Document the new sending notification option
[MAILPOET-2042]
2019-05-29 09:58:18 -04:00
wxa
4a04e588cf Fix a typo [MAILPOET-2099] 2019-05-28 10:39:02 -04:00
3e5f9cdc10 Add documentation for the new fields
[MAILPOET-2099]
2019-05-28 10:39:02 -04:00
31cc119858 minor grammatical changes for clarity[MAILPOET-2035] 2019-05-27 06:10:46 -04:00
e162c72d58 Add confirmation option warning
[MAILPOET-2035]
2019-05-27 06:10:46 -04:00
9251a91149 Add refactoring warning to docs
[MAILOET-2035]
2019-05-27 06:10:46 -04:00
c79569e12c Add usage examples page
[MAILPOET-2035]
2019-05-27 06:10:46 -04:00
9959d9e344 Add doc page for unsubscribeFromLists method
[MAILPOET-2035]
2019-05-27 06:10:46 -04:00
8d4e3793b3 Add doc page for unsubscribeFromList method
[MAILPOET-2035]
2019-05-27 06:10:46 -04:00
712877ad63 Add doc page for subscribeToLists method
[MAILPOET-2035]
2019-05-27 06:10:46 -04:00
41d5dc72fb Add doc page for subscribeToList method
[MAILPOET-2035]
2019-05-27 06:10:46 -04:00
4926d2e289 Add doc page for getSubscriberFields method
[MAILPOET-2035]
2019-05-27 06:10:46 -04:00
3b63578852 Add doc page for getSubscriber method
[MAILPOET-2035]
2019-05-27 06:10:46 -04:00
0ce0990016 Add doc page for getLists method
[MAILPOET-2035]
2019-05-27 06:10:46 -04:00
2d9c53aa44 Add doc page for addSubscriber method
[MAILPOET-2035]
2019-05-27 06:10:46 -04:00
75feb900bd Add doc page for addList method
[MAILPOET-2035]
2019-05-27 06:10:46 -04:00
22ee0964bd Add main readme page
[MAILPOET-2035]
2019-05-27 06:10:46 -04:00