Upgraded to support Appwrite 0.6

eldadfux · eldadfux · commit 432608a4fc20 · 2020-05-18T19:54:54.000+03:00
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
-# Appwrite SDK for PHP
+# Appwrite PHP SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-php.svg?v=1)
-![Version](https://img.shields.io/badge/api%20version-0.5.3-blue.svg?v=1)
+![Version](https://img.shields.io/badge/api%20version-0.6.0-blue.svg?v=1)
 
 Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way.
                         Use the PHP SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools.
diff --git a/composer.json b/composer.json
@@ -7,7 +7,7 @@
     "license": "BSD-3-Clause",
     "support": {
         "url": "https://appwrite.io/support",
-        "email": "team@appwrite.io"
+        "email": "team@localhost.test"
     },
     "autoload": {
         "psr-4": {
diff --git a/docs/avatars.md b/docs/avatars.md
@@ -95,6 +95,6 @@ GET https://appwrite.io/v1/avatars/qr
 | --- | --- | --- | --- |
 | text | string | **Required** Plain text to be converted to QR code image. |  |
 | size | integer | QR code size. Pass an integer between 0 to 1000. Defaults to 400. | 400 |
-| margin | integer | Margin From Edge. Pass an integer between 0 to 10. Defaults to 1. | 1 |
+| margin | integer | Margin from edge. Pass an integer between 0 to 10. Defaults to 1. | 1 |
 | download | integer | Return resulting image with &#039;Content-Disposition: attachment &#039; headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0. | 0 |
 
diff --git a/docs/database.md b/docs/database.md
@@ -96,12 +96,12 @@ GET https://appwrite.io/v1/database/collections/{collectionId}/documents
 | filters | array | Array of filter strings. Each filter is constructed from a key name, comparison operator (=, !=, &gt;, &lt;, &lt;=, &gt;=) and a value. You can also use a dot (.) separator in attribute names to filter by child document attributes. Examples: &#039;name=John Doe&#039; or &#039;category.$id&gt;=5bed2d152c362&#039;. | [] |
 | offset | integer | Offset value. Use this value to manage pagination. | 0 |
 | limit | integer | Maximum number of documents to return in response.  Use this value to manage pagination. | 50 |
-| order-field | string | Document field that results will be sorted by. | $id |
-| order-type | string | Order direction. Possible values are DESC for descending order, or ASC for ascending order. | ASC |
-| order-cast | string | Order field type casting. Possible values are int, string, date, time or datetime. The database will attempt to cast the order field to the value you pass here. The default value is a string. | string |
+| orderField | string | Document field that results will be sorted by. | $id |
+| orderType | string | Order direction. Possible values are DESC for descending order, or ASC for ascending order. | ASC |
+| orderCast | string | Order field type casting. Possible values are int, string, date, time or datetime. The database will attempt to cast the order field to the value you pass here. The default value is a string. | string |
 | search | string | Search query. Enter any free text search. The database will try to find a match against all document attributes and children. |  |
-| first | integer | Return only first document. Pass 1 for true or 0 for false. The default value is 0. | 0 |
-| last | integer | Return only last document. Pass 1 for true or 0 for false. The default value is 0. | 0 |
+| first | integer | Return only the first document. Pass 1 for true or 0 for false. The default value is 0. | 0 |
+| last | integer | Return only the last document. Pass 1 for true or 0 for false. The default value is 0. | 0 |
 
 ## Create Document
 
@@ -169,3 +169,15 @@ DELETE https://appwrite.io/v1/database/collections/{collectionId}/documents/{doc
 | collectionId | string | **Required** Collection unique ID. You can create a new collection with validation rules using the Database service [server integration](/docs/database?platform=server#createCollection). |  |
 | documentId | string | **Required** Document unique ID. |  |
 
+## Get Collection Logs
+
+```http request
+GET https://appwrite.io/v1/database/collections/{collectionId}/logs
+```
+
+### Parameters
+
+| Field Name | Type | Description | Default |
+| --- | --- | --- | --- |
+| collectionId | string | **Required** Collection unique ID. |  |
+
diff --git a/docs/examples/database/get-collection-logs.md b/docs/examples/database/get-collection-logs.md
@@ -0,0 +1,15 @@
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Database;
+
+$client = new Client();
+
+$client
+    ->setProject('5df5acd0d48c2') // Your project ID
+    ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+$database = new Database($client);
+
+$result = $database->getCollectionLogs('[COLLECTION_ID]');
diff --git a/docs/examples/health/get-anti-virus.md b/docs/examples/health/get-anti-virus.md
@@ -0,0 +1,15 @@
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Health;
+
+$client = new Client();
+
+$client
+    ->setProject('5df5acd0d48c2') // Your project ID
+    ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+$health = new Health($client);
+
+$result = $health->getAntiVirus();
diff --git a/docs/examples/health/get-cache.md b/docs/examples/health/get-cache.md
@@ -0,0 +1,15 @@
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Health;
+
+$client = new Client();
+
+$client
+    ->setProject('5df5acd0d48c2') // Your project ID
+    ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+$health = new Health($client);
+
+$result = $health->getCache();
diff --git a/docs/examples/health/get-d-b.md b/docs/examples/health/get-d-b.md
@@ -0,0 +1,15 @@
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Health;
+
+$client = new Client();
+
+$client
+    ->setProject('5df5acd0d48c2') // Your project ID
+    ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+$health = new Health($client);
+
+$result = $health->getDB();
diff --git a/docs/examples/health/get-queue-certificates.md b/docs/examples/health/get-queue-certificates.md
@@ -0,0 +1,15 @@
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Health;
+
+$client = new Client();
+
+$client
+    ->setProject('5df5acd0d48c2') // Your project ID
+    ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+$health = new Health($client);
+
+$result = $health->getQueueCertificates();
diff --git a/docs/examples/health/get-queue-functions.md b/docs/examples/health/get-queue-functions.md
@@ -0,0 +1,15 @@
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Health;
+
+$client = new Client();
+
+$client
+    ->setProject('5df5acd0d48c2') // Your project ID
+    ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+$health = new Health($client);
+
+$result = $health->getQueueFunctions();
diff --git a/docs/examples/health/get-queue-logs.md b/docs/examples/health/get-queue-logs.md
@@ -0,0 +1,15 @@
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Health;
+
+$client = new Client();
+
+$client
+    ->setProject('5df5acd0d48c2') // Your project ID
+    ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+$health = new Health($client);
+
+$result = $health->getQueueLogs();
diff --git a/docs/examples/health/get-queue-tasks.md b/docs/examples/health/get-queue-tasks.md
@@ -0,0 +1,15 @@
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Health;
+
+$client = new Client();
+
+$client
+    ->setProject('5df5acd0d48c2') // Your project ID
+    ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+$health = new Health($client);
+
+$result = $health->getQueueTasks();
diff --git a/docs/examples/health/get-queue-usage.md b/docs/examples/health/get-queue-usage.md
@@ -0,0 +1,15 @@
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Health;
+
+$client = new Client();
+
+$client
+    ->setProject('5df5acd0d48c2') // Your project ID
+    ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+$health = new Health($client);
+
+$result = $health->getQueueUsage();
diff --git a/docs/examples/health/get-queue-webhooks.md b/docs/examples/health/get-queue-webhooks.md
@@ -0,0 +1,15 @@
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Health;
+
+$client = new Client();
+
+$client
+    ->setProject('5df5acd0d48c2') // Your project ID
+    ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+$health = new Health($client);
+
+$result = $health->getQueueWebhooks();
diff --git a/docs/examples/health/get-storage-anti-virus.md b/docs/examples/health/get-storage-anti-virus.md
@@ -0,0 +1,15 @@
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Health;
+
+$client = new Client();
+
+$client
+    ->setProject('5df5acd0d48c2') // Your project ID
+    ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+$health = new Health($client);
+
+$result = $health->getStorageAntiVirus();
diff --git a/docs/examples/health/get-storage-local.md b/docs/examples/health/get-storage-local.md
@@ -0,0 +1,15 @@
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Health;
+
+$client = new Client();
+
+$client
+    ->setProject('5df5acd0d48c2') // Your project ID
+    ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+$health = new Health($client);
+
+$result = $health->getStorageLocal();
diff --git a/docs/examples/health/get-time.md b/docs/examples/health/get-time.md
@@ -0,0 +1,15 @@
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Health;
+
+$client = new Client();
+
+$client
+    ->setProject('5df5acd0d48c2') // Your project ID
+    ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+$health = new Health($client);
+
+$result = $health->getTime();
diff --git a/docs/examples/health/get.md b/docs/examples/health/get.md
@@ -0,0 +1,15 @@
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Health;
+
+$client = new Client();
+
+$client
+    ->setProject('5df5acd0d48c2') // Your project ID
+    ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+$health = new Health($client);
+
+$result = $health->get();
diff --git a/docs/health.md b/docs/health.md
@@ -0,0 +1,96 @@
+# Health Service
+
+## Get HTTP
+
+```http request
+GET https://appwrite.io/v1/health
+```
+
+** Check the Appwrite HTTP server is up and responsive. **
+
+## Get Anti virus
+
+```http request
+GET https://appwrite.io/v1/health/anti-virus
+```
+
+** Check the Appwrite Anti Virus server is up and connection is successful. **
+
+## Get Cache
+
+```http request
+GET https://appwrite.io/v1/health/cache
+```
+
+** Check the Appwrite in-memory cache server is up and connection is successful. **
+
+## Get DB
+
+```http request
+GET https://appwrite.io/v1/health/db
+```
+
+** Check the Appwrite database server is up and connection is successful. **
+
+## Get Certificate Queue
+
+```http request
+GET https://appwrite.io/v1/health/queue/certificates
+```
+
+** Get the number of certificates that are waiting to be issued against [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue server. **
+
+## Get Functions Queue
+
+```http request
+GET https://appwrite.io/v1/health/queue/functions
+```
+
+## Get Logs Queue
+
+```http request
+GET https://appwrite.io/v1/health/queue/logs
+```
+
+** Get the number of logs that are waiting to be processed in the Appwrite internal queue server. **
+
+## Get Tasks Queue
+
+```http request
+GET https://appwrite.io/v1/health/queue/tasks
+```
+
+** Get the number of tasks that are waiting to be processed in the Appwrite internal queue server. **
+
+## Get Usage Queue
+
+```http request
+GET https://appwrite.io/v1/health/queue/usage
+```
+
+** Get the number of usage stats that are waiting to be processed in the Appwrite internal queue server. **
+
+## Get Webhooks Queue
+
+```http request
+GET https://appwrite.io/v1/health/queue/webhooks
+```
+
+** Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server. **
+
+## Get Local Storage
+
+```http request
+GET https://appwrite.io/v1/health/storage/local
+```
+
+** Check the Appwrite local storage device is up and connection is successful. **
+
+## Get Time
+
+```http request
+GET https://appwrite.io/v1/health/time
+```
+
+** Check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The [Network Time Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP. **
+
diff --git a/docs/locale.md b/docs/locale.md
diff --git a/docs/users.md b/docs/users.md
diff --git a/src/Appwrite/Client.php b/src/Appwrite/Client.php
diff --git a/src/Appwrite/Services/Database.php b/src/Appwrite/Services/Database.php
diff --git a/src/Appwrite/Services/Health.php b/src/Appwrite/Services/Health.php
diff --git a/src/Appwrite/Services/Locale.php b/src/Appwrite/Services/Locale.php
diff --git a/src/Appwrite/Services/Users.php b/src/Appwrite/Services/Users.php
