Formalise private API endpoints.

xivapi · Apr 17, 2019 · 9f741e9 · 9f741e9
1 parent 5897e91
commit 9f741e9
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -137,3 +137,5 @@ $api->pvpteam->get($id, $data = []);
 $api->pvpteam->update($id);
 $api->pvpteam->delete($id);
 ```
+
+> Note: The `_private` API is for internal use within XIVAPI and MogBoard. It cannot be used publicly and is locked behind an access key.
diff --git a/src/XIVAPI/Api/Market.php b/src/XIVAPI/Api/Market.php
@@ -66,15 +66,4 @@ public function categories()
     {
         return Guzzle::get("/market/categories");
     }
-
-    public function manualUpdateItem(string $accessKey, int $itemId, int $server)
-    {
-        return Guzzle::get("/private/market/item/update", [
-            RequestOptions::QUERY => [
-                'access'  => $accessKey,
-                'item_id' => $itemId,
-                'server'  => $server,
-            ]
-        ]);
-    }
 }
diff --git a/src/XIVAPI/Api/PrivateApi.php b/src/XIVAPI/Api/PrivateApi.php
@@ -0,0 +1,51 @@
+<?php
+
+namespace XIVAPI\Api;
+
+use GuzzleHttp\RequestOptions;
+use XIVAPI\Guzzle\Guzzle;
+
+class PrivateApi
+{
+    /**
+     * Request an item to be updated
+     */
+    public function manualItemUpdate(string $accessKey, int $itemId, string $server)
+    {
+        return Guzzle::get("/private/market/item/update", [
+            RequestOptions::QUERY => [
+                'companion_access_key' => $accessKey,
+                'item_id' => $itemId,
+                'server'  => $server,
+            ]
+        ]);
+    }
+
+    /**
+     * Request an item to be updated
+     */
+    public function itemPrices(string $accessKey, int $itemId, string $server)
+    {
+        return Guzzle::get("/private/market/item", [
+            RequestOptions::QUERY => [
+                'companion_access_key' => $accessKey,
+                'item_id' => $itemId,
+                'server'  => $server,
+            ]
+        ]);
+    }
+
+    /**
+     * Request an item to be updated
+     */
+    public function itemHistory(string $accessKey, int $itemId, string $server)
+    {
+        return Guzzle::get("/private/market/item/history", [
+            RequestOptions::QUERY => [
+                'companion_access_key' => $accessKey,
+                'item_id' => $itemId,
+                'server'  => $server,
+            ]
+        ]);
+    }
+}
diff --git a/src/XIVAPI/XIVAPI.php b/src/XIVAPI/XIVAPI.php
@@ -9,6 +9,7 @@
 use XIVAPI\Api\Lodestone;
 use XIVAPI\Api\Market;
 use XIVAPI\Api\PatchList;
+use XIVAPI\Api\PrivateApi;
 use XIVAPI\Api\PvPTeam;
 use XIVAPI\Api\Search;
 use XIVAPI\Api\Content;
@@ -44,6 +45,8 @@ class XIVAPI
     public $market;
     /** @var PatchList */
     public $patchlist;
+    /** @var PrivateApi */
+    public $_private;
 
     public function __construct(string $environment = self::PROD)
     {
@@ -61,6 +64,7 @@ public function __construct(string $environment = self::PROD)
         $this->lodestone    = new Lodestone();
         $this->market       = new Market();
         $this->patchlist    = new PatchList();
+        $this->_private     = new PrivateApi();
     }
 
     public function reset(): XIVAPI