Modified response data, added travis, modified README

Author: imbue

.travis.yml

@@ -0,0 +1,31 @@
+language: php
+
+branches:
+  only:
+    - master
+
+matrix:
+  include:
+    - php: 7.2
+      dist: trusty
+      sudo: required
+    - php: 7.3
+      dist: trusty
+      sudo: required
+    - php: hhvm
+      dist: trusty
+      sudo: required
+    - php: nightly
+      dist: trusty
+      sudo: required
+
+  allow_failures:
+    - php: hhvm
+    - php: nightly
+
+cache:
+  directories:
+    - $HOME/.composer/cache
+
+install:
+  - COMPOSER_MEMORY_LIMIT=-1 travis_retry composer install

README.md

@@ -2,6 +2,8 @@
 
 <img src="https://i.imgur.com/kEZU7HH.png" />
 
+> Note that this library does not yet implement the complete functionality of the SendCloud API. Feel free to open a merge request with the additional implementation.
+
 ## Installation
 
 ```
@@ -26,8 +28,33 @@ $sendCloud->setApiAuth('gb3iogpp8uf74p92holav67ij7jmpswe', '1m9mtv4ylnd8fy0xb61u
 Creating a new parcel
 
 ```php
-$payment = $sendcloud->parcels->create([
-    'name'  => 'Julie Appleseed',
+$parcel = $sendCloud->parcels->create([
+    'parcel' => [
+        'name' => 'Julie Appleseed',
+        'company_name' => 'SendCloud',
+        'address' => 'Insulindelaan 115',
+        'house_number' => 115,
+        'city' => 'Eindhoven',
+        'postal_code' => '5642CV',
+        'telephone' => '+31612345678',
+        'request_label' => true,
+        'email' => 'julie@appleseed.com',
+        'country' => 'NL',
+        'shipment' => [
+            'id' => 8,
+        ],
+        'weight' => '10.000',
+        'order_number' => '1234567890',
+        'insured_value' => 2000,
+    ]
+]);
+```
+
+Insert or update (upsert) shipment for an integration
+
+```php
+$shipment = $sendCloud->integrationShipments->upsert(1346, [
+    'name' => 'Julie Appleseed',
     'company_name' => 'SendCloud',
     'address' => 'Insulindelaan 115',
     'house_number' => 115,
@@ -45,3 +72,15 @@ $payment = $sendcloud->parcels->create([
     'insured_value' => 2000,
 ]);
 ```
+
+##### Partner ID
+
+Set the Partner ID
+
+```php
+$sendCloud->setPartnerId('3dd88a04-26e4-4959-af11-f5674491573e')
+```
+
+## Want to help improving the library?
+
+I will happily accept new [pull requests](https://github.com/imbue/sendcloud-api-php/pulls).

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "imbue/sendcloud-api-php",
-  "description": "SendCloud API client library for PHP. SendCloud is a European shipping software for e-commerce.",
+  "description": "SendCloud API client library for PHP. SendCloud is a European shipping software for e-commerce",
   "keywords": [
     "sendcloud",
     "php",

src/Endpoints/AbstractEndpoint.php

@@ -22,6 +22,10 @@ abstract class AbstractEndpoint
     /** @var string */
     protected $resourcePath;
     /** @var string */
+    protected $singleResourceKey;
+    /** @var string */
+    protected $listResourceKey;
+    /** @var string */
     protected $parentId;
 
     /**
@@ -43,15 +47,6 @@ protected function buildQueryString(array $filters)
             return '';
         }
 
-        foreach ($filters as $key => $value) {
-            if ($value === true) {
-                $filters[$key] = 'true';
-            }
-            if ($value === false) {
-                $filters[$key] = 'false';
-            }
-        }
-
         return '?' . http_build_query($filters, '', '&');
     }
 
@@ -68,7 +63,7 @@ protected function restCreate(array $body)
             $this->parseRequestBody($body)
         );
 
-        return ResourceFactory::createFromApiResult($result, $this->getResourceObject());
+        return ResourceFactory::createFromApiResult($result, $this->getResourceObject(), $this->getSingleResourceKey());
     }
 
     /**
@@ -77,7 +72,7 @@ protected function restCreate(array $body)
      * @return AbstractResource
      * @throws ApiException
      */
-    protected function restRead($id, array $filters)
+    protected function restRead($id, array $filters): AbstractResource
     {
         if (empty($id)) {
             throw new ApiException('Invalid resource id.');
@@ -90,7 +85,7 @@ protected function restRead($id, array $filters)
             "{$this->getResourcePath()}/{$id}" . $this->buildQueryString($filters)
         );
 
-        return ResourceFactory::createFromApiResult($result, $this->getResourceObject());
+        return ResourceFactory::createFromApiResult($result, $this->getResourceObject(), $this->getSingleResourceKey());
     }
 
     /**
@@ -99,7 +94,7 @@ protected function restRead($id, array $filters)
      * @return AbstractResource|null
      * @throws ApiException
      */
-    protected function restDelete($id, array $body = [])
+    protected function restDelete($id, array $body = []): AbstractResource
     {
         if (empty($id)) {
             throw new ApiException('Invalid resource id.');
@@ -122,10 +117,10 @@ protected function restDelete($id, array $body = [])
 
     /**
      * @param array $filters
-     * @return array|AbstractCollection
+     * @return AbstractCollection
      * @throws ApiException
      */
-    protected function restList(array $filters = [])
+    protected function restList(array $filters = []): AbstractCollection
     {
         $apiPath = $this->getResourcePath();
 
@@ -135,33 +130,29 @@ protected function restList(array $filters = [])
 
         $result = $this->client->performHttpCall(self::REST_LIST, $apiPath);
 
-        $collection = null;
+        $previous = null;
+        $next = null;
 
-        if (is_object($result)) {
-            $previous = null;
-            $next = null;
+        if (isset($result->previous)) {
+            $previous = $result->previous;
+        }
 
-            if (isset($result->previous)) {
-                $previous = $result->previous;
-            }
+        if (isset($result->next)) {
+            $next = $result->next;
+        }
 
-            if (isset($result->next)) {
-                $next = $result->next;
-            }
+        /** @var AbstractCollection $collection */
+        $collection = $this->getResourceCollectionObject(
+            $previous,
+            $next
+        );
 
-            /** @var AbstractCollection $collection */
-            $collection = $this->getResourceCollectionObject(
-                $previous,
-                $next
-            );
+        if (is_object($result)) {
+            $result = $result->{$collection->getCollectionResourceName()};
+        }
 
-            foreach ($result->{$collection->getCollectionResourceName()} as $dataResult) {
-                $collection[] = ResourceFactory::createFromApiResult($dataResult, $this->getResourceObject());
-            }
-        } else {
-            foreach ($result as $dataResult) {
-                $collection[] = ResourceFactory::createFromApiResult($dataResult, $this->getResourceObject());
-            }
+        foreach ($result as $dataResult) {
+            $collection[] = ResourceFactory::createFromApiResult($dataResult, $this->getResourceObject());
         }
 
         return $collection;
@@ -196,6 +187,22 @@ public function getResourcePath()
         return $this->resourcePath;
     }
 
+    /**
+     * @return string
+     */
+    protected function getSingleResourceKey()
+    {
+        return $this->singleResourceKey;
+    }
+
+    /**
+     * @return string
+     */
+    protected function getListResourceKey()
+    {
+        return $this->listResourceKey;
+    }
+
     /**
      * @param array $body
      * @return null|string
@@ -206,8 +213,9 @@ protected function parseRequestBody(array $body)
         if (empty($body)) {
             return null;
         }
+
         try {
-            $encoded = json_encode($body);
+            $encoded = \GuzzleHttp\json_encode($body);
         } catch (InvalidArgumentException $e) {
             throw new ApiException("Error encoding parameters into JSON: '" . $e->getMessage() . "'");
         }

src/Endpoints/IntegrationEndpoint.php

@@ -3,7 +3,7 @@
 namespace Imbue\SendCloud\Endpoints;
 
 use Imbue\SendCloud\Exceptions\ApiException;
-use Imbue\SendCloud\Resources\Collections\AbstractCollection;
+use Imbue\SendCloud\Resources\Collections\IntegrationCollection;
 use Imbue\SendCloud\Resources\Integration;
 
 class IntegrationEndpoint extends AbstractEndpoint
@@ -20,11 +20,19 @@ protected function getResourceObject(): Integration
     }
 
     /**
-     * @return array|AbstractCollection
+     * @return IntegrationCollection
+     */
+    protected function getResourceCollectionObject(): IntegrationCollection
+    {
+        return new IntegrationCollection();
+    }
+
+    /**
+     * @return IntegrationCollection
      * @throws ApiException
      */
     public function list()
     {
-        return $this->restList();
+        return $this->restList([]);
     }
 }

src/Endpoints/InvoiceEndpoint.php

@@ -3,7 +3,7 @@
 namespace Imbue\SendCloud\Endpoints;
 
 use Imbue\SendCloud\Exceptions\ApiException;
-use Imbue\SendCloud\Resources\Collections\AbstractCollection;
+use Imbue\SendCloud\Resources\Collections\InvoiceCollection;
 use Imbue\SendCloud\Resources\Invoice;
 
 class InvoiceEndpoint extends AbstractEndpoint
@@ -20,7 +20,15 @@ protected function getResourceObject(): Invoice
     }
 
     /**
-     * @return array|AbstractCollection
+     * @return InvoiceCollection
+     */
+    protected function getResourceCollectionObject(): InvoiceCollection
+    {
+        return new InvoiceCollection();
+    }
+
+    /**
+     * @return InvoiceCollection
      * @throws ApiException
      */
     public function list()
@@ -29,11 +37,12 @@ public function list()
     }
 
     /**
-     * @return array|AbstractCollection
+     * @param $id
+     * @return Invoice
      * @throws ApiException
      */
-    public function get()
+    public function get($id)
     {
-        return $this->restList([]);
+        return $this->restRead($id, []);
     }
 }

src/Endpoints/ParcelEndpoint.php

@@ -3,14 +3,15 @@
 namespace Imbue\SendCloud\Endpoints;
 
 use Imbue\SendCloud\Exceptions\ApiException;
-use Imbue\SendCloud\Resources\Collections\AbstractCollection;
 use Imbue\SendCloud\Resources\Collections\ParcelCollection;
 use Imbue\SendCloud\Resources\Parcel;
 
 class ParcelEndpoint extends AbstractEndpoint
 {
     /** @var string */
     protected $resourcePath = 'parcels';
+    /** @var string */
+    protected $singleResourceKey = 'parcel';
 
     /**
      * @return Parcel
@@ -31,11 +32,31 @@ protected function getResourceCollectionObject($previous, $next): ParcelCollecti
     }
 
     /**
-     * @return array|AbstractCollection
+     * @param $id
+     * @return Parcel
+     * @throws ApiException
+     */
+    public function get($id)
+    {
+        return $this->restRead($id, []);
+    }
+
+    /**
+     * @return ParcelCollection
      * @throws ApiException
      */
     public function list()
     {
         return $this->restList();
     }
+
+    /**
+     * @param array $data
+     * @return Parcel
+     * @throws ApiException
+     */
+    public function create(array $data = [])
+    {
+        return $this->restCreate($data);
+    }
 }