Merge pull request #9 from everli/development

Release: 4.0.0

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Release Notes
 
 ## [Unreleased]
+## [4.0.0] - 2021-04-19
+### Added
+- Support new Soldo 2.0 APIs
+
 ## [3.0.0] - 2020-07-17
 ### Changed
 - Update company name

README.md

@@ -31,7 +31,7 @@ $soldo = new \Soldo\Soldo([
 
 - **Retrieve collections**
     - [Obtaining the Employees list](./examples/collections.md#obtaining-the-employees-list)
-    - [Obtaining the Expense Centres list](./examples/collections.md#obtaining-the-expense-centres-list)
+    - [Obtaining the Groups list](./examples/collections.md#obtaining-the-groups-list)
     - [Obtaining the Wallets list](./examples/collections.md#obtaining-the-wallets-list)
     - [Obtaining the Cards list](./examples/collections.md#obtaining-the-cards-list)
     - [Obtaining the Transactions list](./examples/collections.md#obtaining-the-transactions-list)
@@ -42,8 +42,7 @@ $soldo = new \Soldo\Soldo([
     - [Obtaining the Company resource](./examples/resources.md#obtaining-the-company-resource)
     - [Obtaining an Employee resource](./examples/resources.md#obtaining-an-employee-resource)
     - [Updating an Employee resource](./examples/resources.md#updating-an-employee-resource)
-    - [Obtaining an Expense Centre resource](./examples/resources.md#obtaining-an-expense-centre-resource)
-    - [Updating an Expense Centre resource](./examples/resources.md#updating-an--expense-centre-resource)
+    - [Obtaining a Group resource](./examples/resources.md#obtaining-a-group-resource)
     - [Obtaining a Wallet resource](./examples/resources.md#obtaining-a-wallet-resource)
     - [Obtaining a Card resource](./examples/resources.md#obtaining-a-card-resource)
     - [Obtaining a Transaction resource](./examples/resources.md#obtaining-a-transaction-resource)

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "everli/soldo-php-sdk",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "Unofficial PHP SDK to work with Soldo API",
   "keywords": ["everli", "soldo", "api"],
   "license": "Apache-2.0",

examples/collections.md

@@ -22,16 +22,16 @@ var_dump($collection);
 Accessing the other collections is pretty similar. Below you can find an example for each collection provided by the API.
 
 
-## Obtaining the Expense Centres list
+## Obtaining the Groups list
 
 ```php
 try {
-    $collection = $soldo->getExpenseCentres();
+    $collection = $soldo->getGroups();
 } catch (\Soldo\Exceptions\SoldoException $e) {
     echo 'Soldo returned an error: ' . $e->getMessage();
 }
 
-// each item of $collection is of type \Soldo\Resource\ExpenseCentre
+// each item of $collection is of type \Soldo\Resource\Group
 var_dump($collection);
 ```
 

examples/resources.md

@@ -68,40 +68,17 @@ Any key different from the supported ones will be ignored. If no supported keys
 
 Printing out `$employee->department` will show `Department name` and the value of `custom_reference_id` will be `a-random-string`.
 
-## Obtaining an Expense Centre resource
+## Obtaining a Group resource
 
 ```php
 try {
-    $resource = $soldo->getExpenseCentre('SDMD7784-000002');
+    $resource = $soldo->getGroup('SDMD7784-000002');
 } catch (\Soldo\Exceptions\SoldoException $e) {
     echo 'Soldo returned an error: ' . $e->getMessage();
 }
 ```
 
 
-## Updating an  Expense Centre resource
-
-You can update the following  Expense Centre properties:
-- `custom_reference_id`: the employee reference id into the calling system
-- `assignee`: the assignee of the expense centre
-
-doing as follows:
-
-```php
-try {
-    $expenseCentre = $soldo->updateExpenseCentre('SDMD7784-000001', [
-            'department' => 'Department name',
-            'assignee' => 'An Assignee',
-            ]);
-} catch (\Soldo\Exceptions\SoldoException $e) {
-    echo 'Soldo returned an error: ' . $e->getMessage();
-}
-```
-
-Any key different from the supported ones will be ignored. If no supported keys are provided an `InvalidArgumentException` will be thrown.
-
-Printing out `$expenseCentre->department` will show `Department name` and the value of `assignee` will be `An Assignee`.
-
 ## Obtaining a Wallet resource
 
 ```php

examples/transfer.md

@@ -56,7 +56,7 @@ Array
             [currency_code] => EUR
             [available_amount] => 4623
             [blocked_amount] => 0
-            [primary_user_type] => expensecentre
+            [primary_user_type] => company
             [primary_user_public_id] => SDMD7784-000002
             [visible] => 1
         )

examples/webhooks.md

@@ -50,9 +50,9 @@ The endpoint you expose will receive a JSON Payload similar to:
       ],
       "card_id":"f275d49c-1526-11e7-9287-0a89c8769141",
       "masked_pan":"999999******3706",
-      "owner_id":"SDMD7784-000002",
+      "group_id":"SDMD7784-000002",
       "custom_reference_id":"sdfgsfgsdfg",
-      "owner_type":"expensecentre"
+      "owner_type":"company"
    }
 }
 ```
@@ -158,7 +158,7 @@ Array
     [masked_pan] => 999999******3706
     [owner_id] => SDMD7784-000002
     [custom_reference_id] => sdfgsfgsdfg
-    [owner_type] => expensecentre
+    [owner_type] => COMPANY
 )
 
 ```

src/Soldo/Resources/Group.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Soldo\Resources;
+
+/**
+ * Class Group
+ * @package Soldo\Resources
+ *
+ * @property string id
+ * @property string name
+ * @property string custom_reference_id
+ * @property string type
+ * @property string note
+ * @property string creation_time
+ * @property array members
+ * @property array wallets
+ * @property array cards
+ */
+class Group extends Resource
+{
+    /**
+     * @inheritDoc
+     */
+    protected static $basePath = '/groups';
+
+    /**
+     * @inheritDoc
+     */
+    protected $path = '/{id}';
+}

src/Soldo/Resources/InternalTransfer.php

@@ -5,7 +5,7 @@
 use Soldo\Exceptions\SoldoInternalTransferException;
 
 /**
- * Class ExpenseCentre
+ * Class InternalTransfer
  * @package Soldo\Resources
  *
  * @property string fromWalletId

src/Soldo/Resources/Transaction.php

@@ -27,10 +27,9 @@
  * @property array tags
  * @property string card_id
  * @property string masked_pan
- * @property string owner_id
+ * @property string group_id
  * @property string owner_type
- * @property string owner_name
- * @property string owner_surname
+ * @property string trx_owner_id
  * @property string custom_reference_id
  * @property array details
  */

src/Soldo/Soldo.php

@@ -5,13 +5,13 @@
 use Psr\Log\LoggerInterface;
 use Soldo\Authentication\OAuthCredential;
 use Soldo\Exceptions\SoldoException;
+use Soldo\Resources\Group;
 use Soldo\Resources\InternalTransfer;
 use Soldo\Resources\Transaction;
 use Soldo\Utils\Paginator;
 use Soldo\Resources\Card;
 use Soldo\Resources\Company;
 use Soldo\Resources\Employee;
-use Soldo\Resources\ExpenseCentre;
 use Soldo\Resources\Wallet;
 
 /**
@@ -85,49 +85,6 @@ public function getWallet($id)
         return $wallet;
     }
 
-    /**
-     * Return an array containing a list of ExpenseCentre
-     *
-     * @param int $page
-     * @param int $perPage
-     * @param array $searchFields
-     * @return array
-     */
-    public function getExpenseCentres($page = 0, $perPage = Paginator::MAX_ALLOWED_ITEMS_PER_PAGE, $searchFields = [])
-    {
-        $paginator = new Paginator($page, $perPage);
-        $collection = $this->client->getCollection(ExpenseCentre::class, $paginator, $searchFields);
-
-        return $collection->get();
-    }
-
-    /**
-     * Return a single ExpenseCentre resource
-     *
-     * @param mixed $id
-     * @return \Soldo\Resources\Resource
-     */
-    public function getExpenseCentre($id)
-    {
-        $expense_center = $this->client->getItem(ExpenseCentre::class, $id);
-
-        return $expense_center;
-    }
-
-    /**
-     * Update the ExpenseCentre by id and return the resource up to date
-     *
-     * @param mixed $id
-     * @param array $data
-     * @return \Soldo\Resources\Resource
-     */
-    public function updateExpenseCentre($id, $data)
-    {
-        $expense_center = $this->client->updateItem(ExpenseCentre::class, $id, $data);
-
-        return $expense_center;
-    }
-
     /**
      * Return an array containing a list of Employee
      *
@@ -205,6 +162,35 @@ public function getTransaction($id, $withDetails = false)
         return $transaction;
     }
 
+    /**
+     * Return an array containing a list of Groups
+     *
+     * @param int $page
+     * @param int $perPage
+     * @param array $searchFields
+     * @return array
+     */
+    public function getGroups($page = 0, $perPage = Paginator::MAX_ALLOWED_ITEMS_PER_PAGE, $searchFields = [])
+    {
+        $paginator = new Paginator($page, $perPage);
+        $collection = $this->client->getCollection(Group::class, $paginator, $searchFields);
+
+        return $collection->get();
+    }
+
+    /**
+     * Return a single Group resource
+     *
+     * @param mixed $id
+     * @return \Soldo\Resources\Resource
+     */
+    public function getGroup($id)
+    {
+        $group = $this->client->getItem(Group::class, $id);
+
+        return $group;
+    }
+
     /**
      * Return an array containing a list of Card
      *

src/Soldo/SoldoEvent.php

@@ -20,7 +20,6 @@ class SoldoEvent
     const EVENT_TYPE_CARD = 'Card';
     const EVENT_TYPE_TRANSACTION = 'Transaction';
     const EVENT_TYPE_EMPLOYEE = 'Employee';
-    const EVENT_TYPE_EXPENSE_CENTRE = 'ExpenseCentre';
 
     /**
      * An identifier for the event
@@ -113,7 +112,6 @@ public static function types()
             self::EVENT_TYPE_CARD,
             self::EVENT_TYPE_TRANSACTION,
             self::EVENT_TYPE_EMPLOYEE,
-            self::EVENT_TYPE_EXPENSE_CENTRE,
         ];
     }
 }

src/Soldo/Utils/Paginator.php

@@ -54,8 +54,6 @@ public function __construct($page, $perPage, $orderDirection = null, $orderedPro
             );
         }
 
-        // TODO: handle orderDirection and orderedProperties
-
         // set page param
         $this->page = $page < 0 ?
             0 :