intercom-php icon indicating copy to clipboard operation
intercom-php copied to clipboard

Documentation is completely out of date

Open blackjak231 opened this issue 3 months ago • 4 comments

Since the release of 5.x, the intercom-php documentation/readme has been completely useless. Going from the client initialisation (https://github.com/intercom/intercom-php/issues/381) to the request building, a lot of things have been type hinted and documentation not updated at all.

A migration guide would actually be amazing considering it's very painful to migrate going from one endpoint to another and manually looking for the types.

Simple example : The contacts()->create() method now accept any of these objects instead of an array :

  • CreateContactRequestWithExternalId
  • CreateContactRequestWithEmail
  • CreateContactRequestWithRole

So instead of

contacts()->create([
    'email' => '[email protected]',
    'last_seen_at' => now()
])

you need to do the following :

contacts()->create(new CreateContactRequestWithEmail[
    'email' => '[email protected]',
    'lastSeenAt' => now()
]))

Note that attribute names have also been changed from snake case to camelCase.

Any update is greatly appreciated.

blackjak231 avatar Sep 02 '25 14:09 blackjak231

Also there is no information on what has changed form 4.x to 5.x whatsoever.

I mean, this: What's Changed 🌿 New SDK released by fern on August 11, 2025 by https://github.com/fern-api[bot] in https://github.com/intercom/intercom-php/pull/378

Is not so helpfull, is it.

Tlapi avatar Sep 09 '25 08:09 Tlapi

Hi! Thanks for the feedback. We have just merged an updated README and will be releasing a new version to packagist soon to include the updates in the registry. We are planning to add a migration guide within the next few weeks, so look out for that as well!

fern-support avatar Sep 25 '25 14:09 fern-support

I just read the new README and all I can say is that it's still unclear.

A migration guide will be useful for people already using the SDK but for any new team, understanding which endpoints are available, how to call them etc. will be a nightmare.

The previous documentation was fairly thorough when it came to listing the endpoints and what to do with actual examples.

While I understand the switch to Fern to streamline SDK developments, you're Fern config definitely needs to be checked out to improve SDK Readme and API reference doc to include actual examples using the SDK.

blackjak231 avatar Oct 08 '25 10:10 blackjak231

Hey @blackjak231 thanks for the feedback about including some examples using the SDK, we'll start working on that.

Have you had a chance to check out this yet? Curious if it helps at all with the migration piece of this.

Eclairemoy avatar Oct 08 '25 13:10 Eclairemoy

Also, the newly generated contract completely sucks. Why create a DTO for each request when you’re just passing an array into it? Maybe it would be better if an actual human reviewed this slop before making it a new major release.

SystematicCZ avatar Nov 07 '25 10:11 SystematicCZ