Merge pull request #11 from dant89/feature/support-ixapi-v2

Feature/support ixapi v2

Author: dant89

README.md

@@ -3,11 +3,13 @@
 [![Latest Stable Version][packagist-image]][packagist-url]
 [![Github Issues][github-issues-image]][github-issues-url]
 
-An unofficial lightweight PHP API client for the [IX-API](https://ix-api.net).
+A lightweight PHP API client for the [IX-API](https://ix-api.net).
 
 ## Installation
 
 To install, run `composer require dant89/ixapi-client` in the root of your project or add `dant89/ix-api-client` to your composer.json.
+
+View the tagged versions to choose between `v1` and `v2` implementations of this client.
 ```json
 "require": {
     "dant89/ix-api-client": "^LATEST_VERSION_TAG"
@@ -25,31 +27,43 @@ use Dant89\IXAPIClient\Client;
 $client = new Client(IXAPI_URL);
 
 // Get a bearer token from key / secret
-$response = $client->getHttpClient('auth')
+$response = $client->getHttpClient(HttpClientType::AUTH)
     ->postAuthToken(IXAPI_KEY, IXAPI_SECRET);
 
 // Check for valid response status
 if ($response->getStatus() === 200) {
-    $data = $response->getContent();
-    $client->setBearerToken($data['access_token']);
+    $client->setBearerToken($response->getContent()['access_token']);
 }
 ```
 
-With the bearer token set, you can return data from all endpoints that require authentication, such as the products endpoints:
+With the bearer token set, you can return data from all endpoints that require authentication.
+
+**Get Product Offerings:**
 ```php
 // Query for products
-$response = $client->getHttpClient('products')
-    ->getProducts();
+$response = $client->getHttpClient(HttpClientType::PRODUCT_OFFERINGS)
+    ->getProductOfferingss();
+
+// Check for valid response and set the array of products
+if ($response->getStatus() === 200) {
+    $productOfferings = $response->getContent();
+}
+````
+**Get Connections Statistical Timeseries Data:**
+```php
+// Query for connections timeseries data
+$response = $client->getHttpClient(HttpClientType::CONNECTIONS)
+    ->getStatisticTimeseries('connection-123-uuid', '30d');
 
 // Check for valid response and set the array of products
 if ($response->getStatus() === 200) {
-    $products = $response->getContent();
+    $timeseries = $response->getContent();
 }
 ````
 
 ## Authentication
 
-You will need to speak directly to an exchange to be provided with an API key / secret combination and the URL of their IX-API implementation.
+You will need to contact an exchange to create an API key / secret combination and find out the URL of their IX-API implementation.
 
 ## Questions
 

composer.json

@@ -22,13 +22,13 @@
         }
     },
     "require": {
-        "php": "^7.1",
+        "php": "^8.1",
         "ext-json": "*",
         "symfony/http-client": "^4.3"
     },
     "require-dev": {
         "phpmd/phpmd": "^2.7",
-        "phpunit/phpunit": "^7.5",
+        "phpunit/phpunit": "^9.0",
         "squizlabs/php_codesniffer": "^3.4"
     },
     "config": {