Download the PHP package intercom/intercom-php without Composer
On this page you can find all versions of the php package intercom/intercom-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download intercom/intercom-php
More information about intercom/intercom-php
Files in intercom/intercom-php
Package intercom-php
Short Description Intercom API client.
License MIT
Homepage https://developers.intercom.com/docs
Informations about the package intercom-php
Intercom PHP Library
The Intercom PHP library provides convenient access to the Intercom APIs from PHP.
Table of Contents
- Requirements
- Installation
- Usage
- Exception Handling
- Pagination
- Legacy Sdk
- Advanced
- Custom Client
- Retries
- Timeouts
- Contributing
Requirements
This SDK requires PHP ^8.1.
Installation
Usage
Instantiate and use the client with the following:
Exception Handling
When the API returns a non-success status code (4xx or 5xx response), an exception will be thrown.
Pagination
List endpoints return a Pager<T> which lets you loop over all items and the SDK will automatically make multiple HTTP requests for you.
You can also iterate page-by-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:
We recommend migrating to the new SDK using the following steps:
- Upgrade the package to
^5.1.0 -
Search and replace all requires and imports from
Intercom\...toIntercom\Legacy\... - Gradually move over to use the new SDK by importing it from the
Intercom\...import.
Advanced
Custom Client
This SDK is built to work with any HTTP client that implements Guzzle's ClientInterface.
By default, if no client is provided, the SDK will use Guzzle's default HTTP client.
However, you can pass your own client that adheres to ClientInterface:
Retries
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).
A request is deemed retryable when any of the following HTTP status codes is returned:
Use the maxRetries request option to configure this behavior.
Timeouts
The SDK defaults to a 30 second timeout. Use the timeout option to configure this behavior.
Contributing
While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!
All versions of intercom-php with dependencies
ext-json Version *
php-http/client-common Version ^2.0
php-http/discovery Version ^1.0
php-http/message Version ^1.0
psr/http-client Version ^1.0
psr/http-message Version ^1.0 || ^2.0
nyholm/psr7 Version ^1.0
guzzlehttp/guzzle Version ^7.4