Merge pull request #16 from appwrite/dev

christyjacob4 · web-flow · commit 9bcfe973ceaf · 2022-09-06T21:10:33.000+04:00
feat: update for 1.0.0-RC1
diff --git a/docs/account.md b/docs/account.md
@@ -80,7 +80,7 @@ PATCH https://HOSTNAME/v1/account/phone
 
 | Field Name | Type | Description | Default |
 | --- | --- | --- | --- |
-| phone | string | Phone number. Format this number with a leading &#039;+&#039; and a country code, e.g., +16175551212. |  |
+| phone | string | Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212. |  |
 | password | string | User password. Must be at least 8 chars. |  |
 
 ## Get Account Preferences
@@ -167,7 +167,7 @@ GET https://HOSTNAME/v1/account/sessions/{sessionId}
 
 | Field Name | Type | Description | Default |
 | --- | --- | --- | --- |
-| sessionId | string | **Required** Session ID. Use the string &#039;current&#039; to get the current device session. |  |
+| sessionId | string | **Required** Session ID. Use the string 'current' to get the current device session. |  |
 
 ## Update Session (Refresh Tokens)
 
@@ -181,7 +181,7 @@ PATCH https://HOSTNAME/v1/account/sessions/{sessionId}
 
 | Field Name | Type | Description | Default |
 | --- | --- | --- | --- |
-| sessionId | string | **Required** Session ID. Use the string &#039;current&#039; to update the current device session. |  |
+| sessionId | string | **Required** Session ID. Use the string 'current' to update the current device session. |  |
 
 ## Delete Account Session
 
@@ -196,7 +196,7 @@ DELETE https://HOSTNAME/v1/account/sessions/{sessionId}
 
 | Field Name | Type | Description | Default |
 | --- | --- | --- | --- |
-| sessionId | string | **Required** Session ID. Use the string &#039;current&#039; to delete the current device session. |  |
+| sessionId | string | **Required** Session ID. Use the string 'current' to delete the current device session. |  |
 
 ## Update Account Status
 
diff --git a/docs/avatars.md b/docs/avatars.md
@@ -131,5 +131,5 @@ GET https://HOSTNAME/v1/avatars/qr
 | text | string | **Required** Plain text to be converted to QR code image. |  |
 | size | integer | QR code size. Pass an integer between 1 to 1000. Defaults to 400. | 400 |
 | margin | integer | Margin from edge. Pass an integer between 0 to 10. Defaults to 1. | 1 |
-| download | boolean | 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. |  |
+| download | boolean | Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0. |  |
 
diff --git a/docs/databases.md b/docs/databases.md
@@ -28,7 +28,7 @@ POST https://HOSTNAME/v1/databases
 
 | Field Name | Type | Description | Default |
 | --- | --- | --- | --- |
-| databaseId | string | Unique Id. Choose your own unique ID or pass the string &quot;unique()&quot; to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can&#039;t start with a special char. Max length is 36 chars. |  |
+| databaseId | string | Unique Id. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. |  |
 | name | string | Collection name. Max length: 128 chars. |  |
 
 ## Get Database
@@ -103,7 +103,7 @@ POST https://HOSTNAME/v1/databases/{databaseId}/collections
 | Field Name | Type | Description | Default |
 | --- | --- | --- | --- |
 | databaseId | string | **Required** Database ID. |  |
-| collectionId | string | Unique Id. Choose your own unique ID or pass the string &quot;unique()&quot; to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can&#039;t start with a special char. Max length is 36 chars. |  |
+| collectionId | string | Unique Id. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. |  |
 | name | string | Collection name. Max length: 128 chars. |  |
 | permissions | array | An array of permissions strings. By default no user is granted with any permissions. [Learn more about permissions](/docs/permissions). |  |
 | documentSecurity | boolean | Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](/docs/permissions). |  |
@@ -408,7 +408,7 @@ POST https://HOSTNAME/v1/databases/{databaseId}/collections/{collectionId}/docum
 | --- | --- | --- | --- |
 | databaseId | string | **Required** Database ID. |  |
 | collectionId | string | **Required** Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). Make sure to define attributes before creating documents. |  |
-| documentId | string | Document ID. Choose your own unique ID or pass the string &quot;unique()&quot; to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can&#039;t start with a special char. Max length is 36 chars. |  |
+| documentId | string | Document ID. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. |  |
 | data | object | Document data as JSON object. | {} |
 | permissions | array | An array of permissions strings. By default the current user is granted with all permissions. [Learn more about permissions](/docs/permissions). |  |
 
diff --git a/docs/functions.md b/docs/functions.md
@@ -27,7 +27,7 @@ POST https://HOSTNAME/v1/functions
 
 | Field Name | Type | Description | Default |
 | --- | --- | --- | --- |
-| functionId | string | Function ID. Choose your own unique ID or pass the string &quot;unique()&quot; to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can&#039;t start with a special char. Max length is 36 chars. |  |
+| functionId | string | Function ID. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. |  |
 | name | string | Function name. Max length: 128 chars. |  |
 | execute | array | An array of strings with execution roles. By default no user is granted with any execute permissions. [learn more about permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 64 characters long. |  |
 | runtime | string | Execution runtime. |  |
diff --git a/docs/storage.md b/docs/storage.md
@@ -27,16 +27,16 @@ POST https://HOSTNAME/v1/storage/buckets
 
 | Field Name | Type | Description | Default |
 | --- | --- | --- | --- |
-| bucketId | string | Unique Id. Choose your own unique ID or pass the string `unique()` to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can&#039;t start with a special char. Max length is 36 chars. |  |
+| bucketId | string | Unique Id. Choose your own unique ID or pass the string `unique()` to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. |  |
 | name | string | Bucket name |  |
 | permissions | array | An array of permission strings. By default no user is granted with any permissions. [Learn more about permissions](/docs/permissions). |  |
 | fileSecurity | boolean | Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](/docs/permissions). |  |
 | enabled | boolean | Is bucket enabled? | 1 |
 | maximumFileSize | integer | Maximum file size allowed in bytes. Maximum allowed value is 30MB. For self-hosted setups you can change the max limit by changing the `_APP_STORAGE_LIMIT` environment variable. [Learn more about storage environment variables](docs/environment-variables#storage) | 30000000 |
 | allowedFileExtensions | array | Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long. | [] |
-| compression | string | Compression algorithm choosen for compression. Can be one of none,  [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it&#039;s enabled | none |
-| encryption | boolean | Is encryption enabled? For file size above 20MB encryption is skipped even if it&#039;s enabled | 1 |
-| antivirus | boolean | Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it&#039;s enabled | 1 |
+| compression | string | Compression algorithm choosen for compression. Can be one of none,  [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled | none |
+| encryption | boolean | Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled | 1 |
+| antivirus | boolean | Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled | 1 |
 
 ## Get Bucket
 
@@ -71,9 +71,9 @@ PUT https://HOSTNAME/v1/storage/buckets/{bucketId}
 | enabled | boolean | Is bucket enabled? | 1 |
 | maximumFileSize | integer | Maximum file size allowed in bytes. Maximum allowed value is 30MB. For self hosted version you can change the limit by changing _APP_STORAGE_LIMIT environment variable. [Learn more about storage environment variables](docs/environment-variables#storage) |  |
 | allowedFileExtensions | array | Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long. | [] |
-| compression | string | Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it&#039;s enabled | none |
-| encryption | boolean | Is encryption enabled? For file size above 20MB encryption is skipped even if it&#039;s enabled | 1 |
-| antivirus | boolean | Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it&#039;s enabled | 1 |
+| compression | string | Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled | none |
+| encryption | boolean | Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled | 1 |
+| antivirus | boolean | Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled | 1 |
 
 ## Delete Bucket
 
@@ -125,7 +125,7 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
 | Field Name | Type | Description | Default |
 | --- | --- | --- | --- |
 | bucketId | string | **Required** Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](/docs/server/storage#createBucket). |  |
-| fileId | string | File ID. Choose your own unique ID or pass the string &quot;unique()&quot; to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can&#039;t start with a special char. Max length is 36 chars. |  |
+| fileId | string | File ID. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. |  |
 | file | file | Binary file. |  |
 | permissions | array | An array of permission strings. By default the current user is granted with all permissions. [Learn more about permissions](/docs/permissions). |  |
 
diff --git a/docs/teams.md b/docs/teams.md
@@ -29,7 +29,7 @@ POST https://HOSTNAME/v1/teams
 
 | Field Name | Type | Description | Default |
 | --- | --- | --- | --- |
-| teamId | string | Team ID. Choose your own unique ID or pass the string &quot;unique()&quot; to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can&#039;t start with a special char. Max length is 36 chars. |  |
+| teamId | string | Team ID. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. |  |
 | name | string | Team name. Max length: 128 chars. |  |
 | roles | array | Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long. | [&quot;owner&quot;] |
 
@@ -143,7 +143,7 @@ PATCH https://HOSTNAME/v1/teams/{teamId}/memberships/{membershipId}
 | --- | --- | --- | --- |
 | teamId | string | **Required** Team ID. |  |
 | membershipId | string | **Required** Membership ID. |  |
-| roles | array | An array of strings. Use this param to set the user&#039;s roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long. |  |
+| roles | array | An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long. |  |
 
 ## Delete Team Membership
 
diff --git a/docs/users.md b/docs/users.md
diff --git a/src/Appwrite/Client.php b/src/Appwrite/Client.php
