Skip to content

[README] After the release of 5.0.0 the README.md seems to be completely wrong #381

Open

Description

@jakobmerrild

API Versions

The README.md specifies that the IntercomClient can be configured to use any API version by providing the 3rd argument to the constructor. However, the constructor only takes 2 arguments.

It seems that the correct way to configure the version would be to instantiate the client like so

$client = new IntercomClient('token', ['headers' => ['Intercom-Version' => '1.1']]);

Users

The README.md specifies that if an API version between 1.0 and 1.4 is used then one can work with users by accessing the users property on the IntercomClient class, e.g. $client->users->create(...). However, the users property doesn't exist.

Leads

The README.md specifies that if an API version between 1.0 and 1.4 is used then one can work with leads accessing the leads property. However, the leads property doesn't exist

Counts

The README.md specifies that counts can be accessed on the client, but the property doesn't exist

We generally like to keep up to date with our dependencies, but it looks like with version 5 you no longer support API version < 2.0, which given the age of API version 1.4 is understandable. However, it would be nice if the README reflected this fact and/or if the release notes for version 5 had reflected the fact.

Activity

  1. blackjak231 commented on Sep 2, 2025

    @blackjak231

    Yep, I can confirm and it's not just related to the IntercomClient creation. I created a new issue about this as well.

  2. fern-support commented on Sep 25, 2025

    @fern-support
    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. fern-support commented on Oct 8, 2025

    @fern-support
    Contributor

    The migration guide has been added to the README.md file! Please let us know if you're still having issues.

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