Add Legacy SDK submodule and migration guide #1 (#386)

* initial src file inclusion

* add depts to composer.json

* raw copy tests

* update namespace and use statements

* allow php-http discovery

* update phpstan.neon to exclude legacy files from composer analyze

* update readme

* remove legacy tests

* update version mentioned in readme

---------

Co-authored-by: jsklan <[email protected]>

Author: fern-support

.fernignore

@@ -1 +1,4 @@
 # Specify files that shouldn't be modified by Fern
+src/Legacy
+composer.json
+phpstan.neon

README.md

@@ -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.1.0`
+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
 

composer.json

@@ -11,6 +11,12 @@
   "require": {
     "php": "^8.1",
     "ext-json": "*",
+    "php-http/client-common": "^2.0",
+    "php-http/discovery": "^1.0",
+    "php-http/message": "^1.0",
+    "psr/http-client": "^1.0",
+    "psr/http-message": "^1.0 || ^2.0",
+    "nyholm/psr7": "^1.0",
     "guzzlehttp/guzzle": "^7.4"
   },
   "require-dev": {
@@ -42,5 +48,10 @@
       "homepage": "https://www.intercom.com"
     }
   ],
+  "config": {
+    "allow-plugins": {
+      "php-http/discovery": true
+    }
+  },
   "homepage": "https://developers.intercom.com/docs"
-}
+}

phpstan.neon

@@ -3,4 +3,6 @@ parameters:
     reportUnmatchedIgnoredErrors: false
     paths:
         - src
-        - tests
+        - tests
+    excludePaths:
+        - src/Legacy

src/Legacy/IntercomAdmins.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Intercom\Legacy;
+
+use Http\Client\Exception;
+use stdClass;
+
+class IntercomAdmins extends IntercomResource
+{
+    /**
+     * Returns list of Admins.
+     *
+     * @see    https://developers.intercom.io/reference#list-admins
+     * @param  array $options
+     * @return stdClass
+     * @throws Exception
+     */
+    public function getAdmins($options = [])
+    {
+        return $this->client->get("admins", $options);
+    }
+
+    /**
+     * Gets a single Admin based on the Intercom ID.
+     *
+     * @see    https://developers.intercom.com/v2.0/reference#view-an-admin
+     * @param  integer $id
+     * @param  array   $options
+     * @return stdClass
+     * @throws Exception
+     */
+    public function getAdmin($id, $options = [])
+    {
+        $path = $this->adminPath($id);
+        return $this->client->get($path, $options);
+    }
+
+    /**
+     * Returns endpoint path to Admin with given ID.
+     *
+     * @param  string $id
+     * @return string
+     */
+    public function adminPath($id)
+    {
+        return 'admins/' . $id;
+    }
+}

src/Legacy/IntercomBulk.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Intercom\Legacy;
+
+use Http\Client\Exception;
+use stdClass;
+
+class IntercomBulk extends IntercomResource
+{
+    /**
+     * Creates Users in bulk.
+     *
+     * @param  array $options
+     * @return stdClass
+     * @throws Exception
+     */
+    public function users($options)
+    {
+        return $this->client->post("bulk/users", $options);
+    }
+
+    /**
+     * Creates Events in bulk.
+     *
+     * @param  array $options
+     * @return stdClass
+     * @throws Exception
+     */
+    public function events($options)
+    {
+        return $this->client->post("bulk/events", $options);
+    }
+}