Merge pull request #55 from appwrite/dev

Author: ChiragAgg5k

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 19.0.0
+
+* Rename `VCSDeploymentType` enum to `VCSReferenceType`
+* Change `createTemplateDeployment` method signature: replace `version` parameter with `type` (TemplateReferenceType) and `reference` parameters
+* Add `Theme`, `Timezone` and `Output` enums
+
 ## 18.0.1
 
 * Fix `TablesDB` service to use correct file name

docs/account.md

@@ -182,7 +182,7 @@ DELETE https://cloud.appwrite.io/v1/account/mfa/authenticators/{type}
 
 
 ```http request
-POST https://cloud.appwrite.io/v1/account/mfa/challenge
+POST https://cloud.appwrite.io/v1/account/mfa/challenges
 ```
 
 ** Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) method. **
@@ -195,7 +195,7 @@ POST https://cloud.appwrite.io/v1/account/mfa/challenge
 
 
 ```http request
-POST https://cloud.appwrite.io/v1/account/mfa/challenge
+POST https://cloud.appwrite.io/v1/account/mfa/challenges
 ```
 
 ** Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) method. **
@@ -208,7 +208,7 @@ POST https://cloud.appwrite.io/v1/account/mfa/challenge
 
 
 ```http request
-PUT https://cloud.appwrite.io/v1/account/mfa/challenge
+PUT https://cloud.appwrite.io/v1/account/mfa/challenges
 ```
 
 ** Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method. **
@@ -222,7 +222,7 @@ PUT https://cloud.appwrite.io/v1/account/mfa/challenge
 
 
 ```http request
-PUT https://cloud.appwrite.io/v1/account/mfa/challenge
+PUT https://cloud.appwrite.io/v1/account/mfa/challenges
 ```
 
 ** Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method. **

docs/examples/avatars/get-screenshot.md

@@ -15,23 +15,26 @@ $avatars = new Avatars($client);
 
 $result = $avatars->getScreenshot(
     url: 'https://example.com',
-    headers: [], // optional
-    viewportWidth: 1, // optional
-    viewportHeight: 1, // optional
-    scale: 0.1, // optional
+    headers: [
+        'Authorization' => 'Bearer token123',
+        'X-Custom-Header' => 'value'
+    ], // optional
+    viewportWidth: 1920, // optional
+    viewportHeight: 1080, // optional
+    scale: 2, // optional
     theme: Theme::LIGHT(), // optional
-    userAgent: '<USER_AGENT>', // optional
-    fullpage: false, // optional
-    locale: '<LOCALE>', // optional
+    userAgent: 'Mozilla/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit/605.1.15', // optional
+    fullpage: true, // optional
+    locale: 'en-US', // optional
     timezone: Timezone::AFRICAABIDJAN(), // optional
-    latitude: -90, // optional
-    longitude: -180, // optional
-    accuracy: 0, // optional
-    touch: false, // optional
-    permissions: [], // optional
-    sleep: 0, // optional
-    width: 0, // optional
-    height: 0, // optional
-    quality: -1, // optional
+    latitude: 37.7749, // optional
+    longitude: -122.4194, // optional
+    accuracy: 100, // optional
+    touch: true, // optional
+    permissions: ["geolocation","notifications"], // optional
+    sleep: 3, // optional
+    width: 800, // optional
+    height: 600, // optional
+    quality: 85, // optional
     output: Output::JPG() // optional
 );

docs/examples/functions/create-template-deployment.md

@@ -2,6 +2,7 @@
 
 use Appwrite\Client;
 use Appwrite\Services\Functions;
+use Appwrite\Enums\TemplateReferenceType;
 
 $client = (new Client())
     ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -15,6 +16,7 @@ $result = $functions->createTemplateDeployment(
     repository: '<REPOSITORY>',
     owner: '<OWNER>',
     rootDirectory: '<ROOT_DIRECTORY>',
-    version: '<VERSION>',
+    type: TemplateReferenceType::COMMIT(),
+    reference: '<REFERENCE>',
     activate: false // optional
 );

docs/examples/functions/create-vcs-deployment.md

@@ -2,7 +2,7 @@
 
 use Appwrite\Client;
 use Appwrite\Services\Functions;
-use Appwrite\Enums\VCSDeploymentType;
+use Appwrite\Enums\VCSReferenceType;
 
 $client = (new Client())
     ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -13,7 +13,7 @@ $functions = new Functions($client);
 
 $result = $functions->createVcsDeployment(
     functionId: '<FUNCTION_ID>',
-    type: VCSDeploymentType::BRANCH(),
+    type: VCSReferenceType::BRANCH(),
     reference: '<REFERENCE>',
     activate: false // optional
 );

docs/examples/sites/create-template-deployment.md

@@ -2,6 +2,7 @@
 
 use Appwrite\Client;
 use Appwrite\Services\Sites;
+use Appwrite\Enums\TemplateReferenceType;
 
 $client = (new Client())
     ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -15,6 +16,7 @@ $result = $sites->createTemplateDeployment(
     repository: '<REPOSITORY>',
     owner: '<OWNER>',
     rootDirectory: '<ROOT_DIRECTORY>',
-    version: '<VERSION>',
+    type: TemplateReferenceType::BRANCH(),
+    reference: '<REFERENCE>',
     activate: false // optional
 );

docs/examples/sites/create-vcs-deployment.md

@@ -2,7 +2,7 @@
 
 use Appwrite\Client;
 use Appwrite\Services\Sites;
-use Appwrite\Enums\VCSDeploymentType;
+use Appwrite\Enums\VCSReferenceType;
 
 $client = (new Client())
     ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -13,7 +13,7 @@ $sites = new Sites($client);
 
 $result = $sites->createVcsDeployment(
     siteId: '<SITE_ID>',
-    type: VCSDeploymentType::BRANCH(),
+    type: VCSReferenceType::BRANCH(),
     reference: '<REFERENCE>',
     activate: false // optional
 );

docs/examples/storage/create-bucket.md

@@ -23,5 +23,6 @@ $result = $storage->createBucket(
     allowedFileExtensions: [], // optional
     compression: Compression::NONE(), // optional
     encryption: false, // optional
-    antivirus: false // optional
+    antivirus: false, // optional
+    transformations: false // optional
 );

docs/examples/storage/update-bucket.md

@@ -23,5 +23,6 @@ $result = $storage->updateBucket(
     allowedFileExtensions: [], // optional
     compression: Compression::NONE(), // optional
     encryption: false, // optional
-    antivirus: false // optional
+    antivirus: false, // optional
+    transformations: false // optional
 );

docs/functions.md

@@ -198,7 +198,8 @@ Use this endpoint with combination of [listTemplates](https://appwrite.io/docs/p
 | repository | string | Repository name of the template. |  |
 | owner | string | The name of the owner of the template. |  |
 | rootDirectory | string | Path to function code in the template repo. |  |
-| version | string | Version (tag) for the repo linked to the function template. |  |
+| type | string | Type for the reference provided. Can be commit, branch, or tag |  |
+| reference | string | Reference value, can be a commit hash, branch name, or release tag |  |
 | activate | boolean | Automatically activate the deployment when it is finished building. |  |