Skip to content

Fix inconsistency in listPeopleEvent method by adding listPeopleEvents & marking listPeopleEvent() deprecated #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix inconsistency in listPeopleEvent method by adding listPeopleEvents & marking listPeopleEvent() deprecated #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
21cab08
Fix inconsistency in listPeopleEvent method by adding listPeopleEvents
ziming Jun 22, 2025
5637161
add = 1 to the $pageNumber argument of listPeopleEvents() too
ziming Jun 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,7 @@ All methods that you will most likely need when building a Crisp integration are
</details>

* **List Events** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-people-events)
* `CrispClient->websitePeople->listPeopleEvent(websiteId, peopleId, pageNumber)`
* `CrispClient->websitePeople->listPeopleEvents(websiteId, peopleId, pageNumber)`
* <details>
<summary>See Example</summary>

Expand All @@ -505,7 +505,7 @@ All methods that you will most likely need when building a Crisp integration are
$peopleId = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
$pageNumber = 1;

CrispClient->websitePeople->listPeopleEvent(websiteId, peopleId, pageNumber);
CrispClient->websitePeople->listPeopleEvents(websiteId, peopleId, pageNumber);
```
</details>

Expand Down
17 changes: 17 additions & 0 deletions src/Resources/WebsitePeople.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,23 @@ public function addPeopleEvent($websiteId, $peopleId, $data)
* @throws ClientExceptionInterface
* @throws CrispException
*/
public function listPeopleEvents($websiteId, $peopleId, $pageNumber = 1)
{
$result = $this->crisp->get(
"website/$websiteId/people/events/$peopleId/list/$pageNumber"
);
return $this->formatResponse($result);
}

/**
* @param string $websiteId
* @param string $peopleId
* @param int $pageNumber
* @return array
* @throws ClientExceptionInterface
* @throws CrispException
*/
#[\Deprecated(message: 'use listPeopleEvents() instead')]
public function listPeopleEvent($websiteId, $peopleId, $pageNumber)
{
$result = $this->crisp->get(
Expand Down