Visitar URL original
Documentation is completely out of date · Issue #383 · intercom/intercom-php · GitHub
Skip to content

Documentation is completely out of date #383

Open
Open
Documentation is completely out of date#383

Description

@blackjak231
blackjak231
opened on Sep 2, 2025

Since the release of 5.x, the intercom-php documentation/readme has been completely useless. Going from the client initialisation (#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' => 'test@example.com',
    'last_seen_at' => now()
])

you need to do the following :

contacts()->create(new CreateContactRequestWithEmail[
    'email' => 'test@example.com',
    'lastSeenAt' => now()
]))

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

Any update is greatly appreciated.

Activity

  1. Tlapi commented on Sep 9, 2025

    @Tlapi
    Tlapi
    on Sep 9, 2025

    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 #378

    Is not so helpfull, is it.

  2. fern-support commented on Sep 25, 2025

    @fern-support
    fern-support
    on Sep 25, 2025
    Contributor

    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!

  3. blackjak231 commented on Oct 8, 2025

    @blackjak231
    blackjak231
    on Oct 8, 2025
    Author

    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.

  4. Eclairemoy commented on Oct 8, 2025

    @Eclairemoy
    Eclairemoy
    on Oct 8, 2025
    Contributor

    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.

  5. SystematicCZ commented on Nov 7, 2025

    @SystematicCZ
    SystematicCZ
    on Nov 7, 2025

    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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions