Merge pull request #77 from voucherifyio/aw/async-actions

Support for Async Actions
voucherifyio · Mar 11, 2022 · b8b8608 · b8b8608
2 parents 066beab + a3e695e
commit b8b8608
Show file tree

Hide file tree

Showing 4 changed files with 144 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -558,6 +558,21 @@ $client->promotions->tiers->delete($promotionTierId);
 $client->promotions->tiers->getAvailable();
 ```
 
+### Async Actions API
+Methods are provided within `$client->asyncActions->*` namespace.
+- [Get Async Action](#get-async-action)
+- [List Async Actions](#list-async-actions)
+
+#### [Get Async Action]
+```php
+$client->asyncActions->get($id);
+```
+#### [List Async Actions]
+```php
+$client->asyncActions->getList();
+$client->asyncActions->getList($params);
+```
+
 ---
 
 ### Utils
@@ -744,7 +759,8 @@ Bug reports and pull requests are welcome through [GitHub Issues](https://github
   - Voucher informations: *get*, *redemption*
   - Voucher operations: *redeem*
 
-
+[Get Async Action]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#get-async-actions-1
+[List Async Actions]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#list-async-actions
 
 [Create Voucher]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#create-voucher
 [Get Voucher]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#vouchers-get

diff --git a/src/AsyncActions.php b/src/AsyncActions.php
@@ -0,0 +1,46 @@
+<?php
+
+namespace Voucherify;
+
+class AsyncActions
+{
+    /**
+     * @var \Voucherify\ApiClient
+     */
+    private $client;
+
+    /**
+     * @param \Voucherify\ApiClient $client
+     */
+    public function __construct($client)
+    {
+        $this->client = $client;
+    }
+
+    /**
+     * @param string $id
+     *
+     * Get Async Action details.
+     *
+     * @throws \Voucherify\ClientException
+     */
+    public function get($id)
+    {
+        return $this->client->get("/async-actions/" . rawurlencode($id), null);
+    }
+
+    /**
+     * @param array|stdClass $filter
+     *
+     * Get a filtered list of Async Actions. The filter can include following properties:
+     * - limit    - number
+     * - end_date - date in iso format
+     *
+     * @throws \Voucherify\ClientException
+     */
+    public function getList($filter = null)
+    {
+        return $this->client->get("/async-actions/", $filter);
+    }
+
+}
diff --git a/src/VoucherifyClient.php b/src/VoucherifyClient.php
@@ -69,6 +69,11 @@ class VoucherifyClient
      */
     public $vouchers;
 
+    /**
+     * @var \Voucherify\AsyncActions
+     */
+    public $asyncActions;
+
     /**
      * @param string $apiId
      * @param string $apiKey
@@ -99,6 +104,7 @@ public function __construct($apiId, $apiKey, $apiVersion = null, $apiUrl = null)
         ]);
         $this->validationRules = new ValidationRules($this->client);
         $this->vouchers = new Vouchers($this->client);
+        $this->asyncActions = new AsyncActions($this->client);
 
         /* ********* BACKWARD COMPATIBILITY ********* */
 

diff --git a/test/AsyncActionsTest.php b/test/AsyncActionsTest.php
@@ -0,0 +1,75 @@
+<?php
+
+use Voucherify\Test\Helpers\CurlMock;
+
+use Voucherify\VoucherifyClient;
+use Voucherify\ClientException;
+
+class AsyncActionsTest extends PHPUnit_Framework_TestCase
+{
+    protected static $headers;
+    protected static $apiId;
+    protected static $apiKey;
+    protected static $client;
+
+    public static function setUpBeforeClass()
+    {
+        self::$apiId = "c70a6f00-cf91-4756-9df5-47628850002b";
+        self::$apiKey = "3266b9f8-e246-4f79-bdf0-833929b1380c";
+        self::$headers = [
+            "Content-Type: application/json",
+            "X-App-Id: " . self::$apiId,
+            "X-App-Token: " . self::$apiKey,
+            "X-Voucherify-Channel: PHP-SDK"
+        ];
+        self::$client = new VoucherifyClient(self::$apiId, self::$apiKey);
+
+        CurlMock::enable();
+    }
+
+    public static function tearDownAfterClass()
+    {
+        CurlMock::disable();
+    }
+
+    public function testGet()
+    {
+        CurlMock::register("https://api.voucherify.io/v1", self::$headers)
+            ->get("/async-actions/test-id")
+            ->reply(200, [ "status" => "ok" ]);
+
+        $result = self::$client->asyncActions->get("test-id");
+
+        $this->assertEquals($result, (object)[ "status" => "ok" ]);
+
+        CurlMock::done();
+    }
+
+    public function testGetList()
+    {
+        CurlMock::register("https://api.voucherify.io/v1", self::$headers)
+            ->get("/async-actions/")
+            ->reply(200, [ "status" => "ok" ]);
+
+        $result = self::$client->asyncActions->getList();
+
+        $this->assertEquals($result, (object)[ "status" => "ok" ]);
+
+        CurlMock::done();
+    }
+
+    public function testGetListByQuery()
+    {
+        CurlMock::register("https://api.voucherify.io/v1", self::$headers)
+            ->get("/async-actions/")
+            ->query([ "limit" => 5, "end_date" => "2021-07-16T15:12:43Z" ])
+            ->reply(200, [ "status" => "ok" ]);
+
+        $result = self::$client->asyncActions->getList([ "limit" => 5, "end_date" => "2021-07-16T15:12:43Z" ]);
+
+        $this->assertEquals($result, (object)[ "status" => "ok" ]);
+
+        CurlMock::done();
+    }
+
+}