Skip to content

Add Legacy SDK submodule and migration guide #1 #386

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

Merged
Eclairemoy merged 9 commits into from
Oct 8, 2025
Merged

Add Legacy SDK submodule and migration guide #1 #386

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
e25833a
initial src file inclusion
jsklan Oct 7, 2025
f0c097f
add depts to composer.json
jsklan Oct 7, 2025
012f896
raw copy tests
jsklan Oct 7, 2025
6cbb818
update namespace and use statements
jsklan Oct 7, 2025
ee16a92
allow php-http discovery
jsklan Oct 7, 2025
4b28e8c
update phpstan.neon to exclude legacy files from composer analyze
jsklan Oct 7, 2025
2f28ee6
update readme
jsklan Oct 7, 2025
86ff03f
remove legacy tests
jsklan Oct 7, 2025
de686c3
update version mentioned in readme
jsklan Oct 7, 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
Prev Previous commit
Next Next commit
update readme
  • Loading branch information
@jsklan
jsklan committed Oct 7, 2025
commit 2f28ee694bc8a69c04862f731a59f9f61c141470
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,27 @@ foreach ($items->getPages() as $page) {
}
```

## Legacy SDK

While the new SDK has a lot of improvements, we at Intercom understand that it takes time to upgrade when there are breaking changes.
To make the migration easier, the new SDK also exports the legacy SDK as `Intercom\Legacy\...`. Here's an example of how you can use the
legacy SDK alongside the new SDK inside a single file:

```php
use Intercom\IntercomClient;
use Intercom\Legacy\IntercomClient as LegacyIntercomClient;

$intercom = new IntercomClient();
$legacyClient = new LegacyIntercomClient();
```

We recommend migrating to the new SDK using the following steps:

1. Upgrade the package to `^5.0.1`
2. Search and replace all requires and imports from `Intercom\...` to `Intercom\Legacy\...`

3. Gradually move over to use the new SDK by importing it from the `Intercom\...` import.


## Advanced

Expand Down