D3Public/klicktipp-php-client
8
0
Fork 0
Code Pull Requests Actions Packages Projects Releases Activity

align documentation

Browse Source
This commit is contained in:
Daniel Seifert 2024-12-22 23:39:09 +01:00
parent 7a216173d9
commit 9e6329630d
Signed by: DanielS
GPG Key ID: 6A513E13AEE66170
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -22,11 +22,12 @@ $klicktipp = new \D3\KlicktippPhpClient\Klicktipp(
); );
``` ```
## search a subscriber ## get a subscriber status
```php ```php
$subscriberId = $klicktipp->subscriber()->search('me@johndoe.net'); $subscriberId = $klicktipp->subscriber()->search('me@johndoe.net');
$subscriber = $klicktipp->subscriber()->search($subscriberId); $subscriber = $klicktipp->subscriber()->get($subscriberId);
$subscriber->isSubscribed()
``` ```
## Supported endpoints (still being added) ## Supported endpoints (still being added)
@ -38,8 +39,10 @@ $subscriber = $klicktipp->subscriber()->search($subscriberId);
:x: = Not yet developed<br /> :x: = Not yet developed<br />
:heavy_exclamation_mark: = deprecated/not supported <br /> :heavy_exclamation_mark: = deprecated/not supported <br />
| Endpoint | Status | | Endpoint | Status |
|--------------------------------------------------------------------------------------|-------------------------| |--------------|-------------------------|
| account | :ballot_box_with_check: | | account | :ballot_box_with_check: |
| subscriber | :ballot_box_with_check: | | field | :ballot_box_with_check: |
| tag | :ballot_box_with_check: | | subscriber | :ballot_box_with_check: |
| subscription | :ballot_box_with_check: |
| tag | :ballot_box_with_check: |