Merge pull request #1 from merch-one/#1

Added possibility to use Guzzle Request Options

Author: merch-one

composer.json

@@ -11,7 +11,7 @@
     ],
     "type": "library",
     "license": "MIT",
-    "version": "1.0.1",
+    "version": "1.0.2",
     "require": {
         "php": ">=7.4",
         "guzzlehttp/guzzle": "^6|^7",
@@ -21,7 +21,7 @@
     },
     "autoload": {
         "psr-4": {
-            "MerchOne\\PhpSdk\\": "src/"
+            "MerchOne\\PhpApiSdk\\": "src/"
         }
     },
     "authors": [

readme.md

@@ -31,10 +31,10 @@ composer require merch-one/php-api-sdk
 
 ### Basic Usage
 
-**Create an instance of `MerchOne\PhpSdk\Http\Client`**
+**Create an instance of `MerchOne\PhpApiSdk\Http\Client`**
 
 ```php
-use MerchOne\PhpSdk\Http\Client;
+use MerchOne\PhpApiSdk\Http\Client;
 
 class MyService
  {
@@ -59,15 +59,15 @@ class MyService
         );
 
         /* Interact with Catalog API */
-        /** @var \MerchOne\PhpSdk\Contracts\Clients\CatalogApi $catalogApi */
+        /** @var \MerchOne\PhpApiSdk\Contracts\Clients\CatalogApi $catalogApi */
         $catalogApi = $this->httpClient->catalog();
 
         /* Interact with Orders API */
-        /** @var \MerchOne\PhpSdk\Contracts\Clients\OrdersApi $ordersApi */
+        /** @var \MerchOne\PhpApiSdk\Contracts\Clients\OrdersApi $ordersApi */
         $ordersApi = $this->httpClient->orders();
 
         /* Interact with Shipping API */
-        /** @var \MerchOne\PhpSdk\Contracts\Clients\ShippingApi $shippingApi */
+        /** @var \MerchOne\PhpApiSdk\Contracts\Clients\ShippingApi $shippingApi */
         $shippingApi = $this->httpClient->shipping();
 
         // switch API version you interact with
@@ -78,13 +78,20 @@ class MyService
     }
 }
 ```
+- The `Client` class accepts two parameters:
+    - `$version` - API version to interact with. Default value is `beta`. 
+      - See [Helpers](#helpers) for available versions.
+    - `$clientOptions` - Custom options to use with request.
+      - See [Guzzle Documentation](https://docs.guzzlephp.org/en/stable/request-options.html) for available options.
+      - The `User-Agent`, `Accept` and `Content-Type` headers, as well as `http_error` properties **CAN NOT** be overwritten !
+
 
 --- 
 
 ### Helpers
 
 ```php
-use MerchOne\PhpSdk\Util\MerchOneApi;
+use MerchOne\PhpApiSdk\Util\MerchOneApi;
 
 // get the list of all available API versions
 MerchOneApi::getVersions();

src/Clients/BaseApiClient.php

@@ -1,15 +1,15 @@
 <?php
 
-namespace MerchOne\PhpSdk\Clients;
+namespace MerchOne\PhpApiSdk\Clients;
 
 use GuzzleHttp\Client as GuzzleClient;
 use GuzzleHttp\Exception\GuzzleException;
 use GuzzleHttp\Psr7\Response as PsrResponse;
-use MerchOne\PhpSdk\Exceptions\InvalidCredentialsException;
-use MerchOne\PhpSdk\Exceptions\MerchOneApiClientException;
-use MerchOne\PhpSdk\Exceptions\MerchOneApiServerException;
-use MerchOne\PhpSdk\Http\Response;
-use MerchOne\PhpSdk\Util\Data;
+use MerchOne\PhpApiSdk\Exceptions\InvalidCredentialsException;
+use MerchOne\PhpApiSdk\Exceptions\MerchOneApiClientException;
+use MerchOne\PhpApiSdk\Exceptions\MerchOneApiServerException;
+use MerchOne\PhpApiSdk\Http\Response;
+use MerchOne\PhpApiSdk\Util\Data;
 use Tightenco\Collect\Support\Collection;
 use Tightenco\Collect\Support\Enumerable;
 

src/Clients/Beta/Catalog.php

@@ -1,11 +1,11 @@
 <?php
 
-namespace MerchOne\PhpSdk\Clients\Beta;
+namespace MerchOne\PhpApiSdk\Clients\Beta;
 
-use MerchOne\PhpSdk\Clients\BaseApiClient;
-use MerchOne\PhpSdk\Contracts\Clients\CatalogApi;
-use MerchOne\PhpSdk\Exceptions\MerchOneApiClientException;
-use MerchOne\PhpSdk\Exceptions\MerchOneApiServerException;
+use MerchOne\PhpApiSdk\Clients\BaseApiClient;
+use MerchOne\PhpApiSdk\Contracts\Clients\CatalogApi;
+use MerchOne\PhpApiSdk\Exceptions\MerchOneApiClientException;
+use MerchOne\PhpApiSdk\Exceptions\MerchOneApiServerException;
 use Tightenco\Collect\Support\Enumerable;
 
 class Catalog extends BaseApiClient implements CatalogApi

src/Clients/Beta/Orders.php

@@ -1,12 +1,12 @@
 <?php
 
-namespace MerchOne\PhpSdk\Clients\Beta;
+namespace MerchOne\PhpApiSdk\Clients\Beta;
 
-use MerchOne\PhpSdk\Clients\BaseApiClient;
-use MerchOne\PhpSdk\Contracts\Clients\OrdersApi;
-use MerchOne\PhpSdk\Exceptions\MerchOneApiClientException;
-use MerchOne\PhpSdk\Exceptions\MerchOneApiServerException;
-use MerchOne\PhpSdk\Util\Data;
+use MerchOne\PhpApiSdk\Clients\BaseApiClient;
+use MerchOne\PhpApiSdk\Contracts\Clients\OrdersApi;
+use MerchOne\PhpApiSdk\Exceptions\MerchOneApiClientException;
+use MerchOne\PhpApiSdk\Exceptions\MerchOneApiServerException;
+use MerchOne\PhpApiSdk\Util\Data;
 use Tightenco\Collect\Support\Enumerable;
 
 class Orders extends BaseApiClient implements OrdersApi

src/Clients/Beta/Shipping.php

@@ -1,11 +1,11 @@
 <?php
 
-namespace MerchOne\PhpSdk\Clients\Beta;
+namespace MerchOne\PhpApiSdk\Clients\Beta;
 
-use MerchOne\PhpSdk\Clients\BaseApiClient;
-use MerchOne\PhpSdk\Contracts\Clients\ShippingApi;
-use MerchOne\PhpSdk\Exceptions\MerchOneApiClientException;
-use MerchOne\PhpSdk\Exceptions\MerchOneApiServerException;
+use MerchOne\PhpApiSdk\Clients\BaseApiClient;
+use MerchOne\PhpApiSdk\Contracts\Clients\ShippingApi;
+use MerchOne\PhpApiSdk\Exceptions\MerchOneApiClientException;
+use MerchOne\PhpApiSdk\Exceptions\MerchOneApiServerException;
 use Tightenco\Collect\Support\Enumerable;
 
 class Shipping extends BaseApiClient implements ShippingApi

src/Contracts/Clients/CatalogApi.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace MerchOne\PhpSdk\Contracts\Clients;
+namespace MerchOne\PhpApiSdk\Contracts\Clients;
 
 use Tightenco\Collect\Support\Enumerable;
 

src/Contracts/Clients/OrdersApi.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace MerchOne\PhpSdk\Contracts\Clients;
+namespace MerchOne\PhpApiSdk\Contracts\Clients;
 
 use Tightenco\Collect\Support\Enumerable;
 

src/Contracts/Clients/ShippingApi.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace MerchOne\PhpSdk\Contracts\Clients;
+namespace MerchOne\PhpApiSdk\Contracts\Clients;
 
 use Tightenco\Collect\Support\Enumerable;
 

src/Contracts/Http/HttpClient.php

@@ -1,17 +1,18 @@
 <?php
 
-namespace MerchOne\PhpSdk\Contracts\Http;
+namespace MerchOne\PhpApiSdk\Contracts\Http;
 
-use MerchOne\PhpSdk\Contracts\Clients\CatalogApi;
-use MerchOne\PhpSdk\Contracts\Clients\OrdersApi;
-use MerchOne\PhpSdk\Contracts\Clients\ShippingApi;
+use MerchOne\PhpApiSdk\Contracts\Clients\CatalogApi;
+use MerchOne\PhpApiSdk\Contracts\Clients\OrdersApi;
+use MerchOne\PhpApiSdk\Contracts\Clients\ShippingApi;
 
 interface HttpClient
 {
     /**
      * @param  string  $version
+     * @param  array  $clientOptions
      */
-    public function __construct(string $version);
+    public function __construct(string $version, array $clientOptions = []);
 
     /**
      * @param  string  $user