Merge pull request #91 from appwrite/dev

feat: release 1.4.x
appwrite · Aug 30, 2023 · 4f21877 · 4f21877
2 parents b461997 + 22b31dd
commit 4f21877
Show file tree

Hide file tree

Showing 102 changed files with 3,105 additions and 666 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,12 @@
 # Appwrite Command Line SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-cli.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-1.3.0-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.4.0-blue.svg?style=flat-square)
 [![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
 [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
 
-**This SDK is compatible with Appwrite server version 1.3.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-cli/releases).**
+**This SDK is compatible with Appwrite server version 1.4.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-cli/releases).**
 
 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 Command Line SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
 
@@ -29,7 +29,7 @@ Once the installation is complete, you can verify the install using
 
 ```sh
 $ appwrite -v
-2.0.2
+3.0.0
 ```
 
 ### Install using prebuilt binaries
@@ -51,14 +51,19 @@ $ brew install --HEAD appwrite
 > Please note that `--HEAD` will be removed with official release.
 
 ### Windows
+Via Powershell
 ```powershell
 $ iwr -useb https://appwrite.io/cli/install.ps1 | iex
 ```
+Via [Scoop](https://scoop.sh)
+```powershell
+$ scoop install https://raw.githubusercontent.com/appwrite/sdk-for-cli/master/scoop/appwrite.json
+```
 
 Once the installation completes, you can verify your install using
 ```
 $ appwrite -v
-2.0.2
+3.0.0
 ```
 
 ## Getting Started 
@@ -222,7 +227,7 @@ $ cd sdk-generator
 $ docker run --rm --interactive --tty --volume "$(pwd)":/app composer install --ignore-platform-reqs --optimize-autoloader --no-plugins --no-scripts --prefer-dist
 
 # Generate the SDKs
-$ docker run --rm -v $(pwd):/app -w /app php:7.4-cli php example.php
+$ docker run --rm -v $(pwd):/app -w /app php:8.1-cli php example.php
 ```
 
 3. Head over to the generated SDK and install the dependencies.
@@ -242,4 +247,4 @@ $ appwrite -v
 ```
 ## License
 
-Please see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information.
+Please see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information.
diff --git a/docs/examples/account/delete-identity.md b/docs/examples/account/delete-identity.md
@@ -0,0 +1,2 @@
+appwrite account deleteIdentity \
+        --identityId [IDENTITY_ID]
diff --git a/docs/examples/account/list-identities.md b/docs/examples/account/list-identities.md
@@ -0,0 +1,2 @@
+appwrite account listIdentities \
+
diff --git a/docs/examples/assistant/chat.md b/docs/examples/assistant/chat.md
@@ -0,0 +1,2 @@
+appwrite assistant chat \
+        --prompt [PROMPT]
diff --git a/docs/examples/databases/create-collection.md b/docs/examples/databases/create-collection.md
@@ -4,3 +4,4 @@ appwrite databases createCollection \
         --name [NAME] \
 
 
+
diff --git a/docs/examples/databases/create-string-attribute.md b/docs/examples/databases/create-string-attribute.md
@@ -6,3 +6,4 @@ appwrite databases createStringAttribute \
         --required false \
 
 
+
diff --git a/docs/examples/databases/create.md b/docs/examples/databases/create.md
@@ -1,3 +1,4 @@
 appwrite databases create \
         --databaseId [DATABASE_ID] \
-        --name [NAME]
+        --name [NAME] \
+
diff --git a/docs/examples/databases/list-attributes.md b/docs/examples/databases/list-attributes.md
@@ -1,3 +1,4 @@
 appwrite databases listAttributes \
         --databaseId [DATABASE_ID] \
-        --collectionId [COLLECTION_ID]
+        --collectionId [COLLECTION_ID] \
+
diff --git a/docs/examples/databases/list-indexes.md b/docs/examples/databases/list-indexes.md
@@ -1,3 +1,4 @@
 appwrite databases listIndexes \
         --databaseId [DATABASE_ID] \
-        --collectionId [COLLECTION_ID]
+        --collectionId [COLLECTION_ID] \
+
diff --git a/docs/examples/databases/update.md b/docs/examples/databases/update.md
@@ -1,3 +1,4 @@
 appwrite databases update \
         --databaseId [DATABASE_ID] \
-        --name [NAME]
+        --name [NAME] \
+
diff --git a/docs/examples/functions/create-deployment.md b/docs/examples/functions/create-deployment.md
@@ -1,5 +1,6 @@
 appwrite functions createDeployment \
         --functionId [FUNCTION_ID] \
-        --entrypoint [ENTRYPOINT] \
         --code 'path/to/file.png' \
-        --activate false
+        --activate false \
+
+
diff --git a/docs/examples/functions/create-execution.md b/docs/examples/functions/create-execution.md
@@ -2,3 +2,6 @@ appwrite functions createExecution \
         --functionId [FUNCTION_ID] \
 
 
+
+
+
diff --git a/docs/examples/functions/create.md b/docs/examples/functions/create.md
@@ -7,3 +7,15 @@ appwrite functions create \
 
 
 
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/examples/functions/download-deployment.md b/docs/examples/functions/download-deployment.md
@@ -0,0 +1,3 @@
+appwrite functions downloadDeployment \
+        --functionId [FUNCTION_ID] \
+        --deploymentId [DEPLOYMENT_ID]
diff --git a/docs/examples/functions/update.md b/docs/examples/functions/update.md
@@ -1,6 +1,15 @@
 appwrite functions update \
         --functionId [FUNCTION_ID] \
         --name [NAME] \
+        --runtime node-14.5 \
+
+
+
+
+
+
+
+
 
 
 

diff --git a/docs/examples/health/get-pub-sub.md b/docs/examples/health/get-pub-sub.md
@@ -0,0 +1 @@
+appwrite health getPubSub
diff --git a/docs/examples/health/get-queue.md b/docs/examples/health/get-queue.md
@@ -0,0 +1 @@
+appwrite health getQueue
diff --git a/docs/examples/locale/list-codes.md b/docs/examples/locale/list-codes.md
@@ -0,0 +1 @@
+appwrite locale listCodes
diff --git a/docs/examples/migrations/create-appwrite-migration.md b/docs/examples/migrations/create-appwrite-migration.md
@@ -0,0 +1,5 @@
+appwrite migrations createAppwriteMigration \
+        --resources one two three \
+        --endpoint https://example.com \
+        --projectId [PROJECT_ID] \
+        --apiKey [API_KEY]
diff --git a/docs/examples/migrations/create-firebase-migration.md b/docs/examples/migrations/create-firebase-migration.md
@@ -0,0 +1,3 @@
+appwrite migrations createFirebaseMigration \
+        --resources one two three \
+        --serviceAccount [SERVICE_ACCOUNT]
diff --git a/docs/examples/migrations/create-firebase-o-auth-migration.md b/docs/examples/migrations/create-firebase-o-auth-migration.md
@@ -0,0 +1,3 @@
+appwrite migrations createFirebaseOAuthMigration \
+        --resources one two three \
+        --projectId [PROJECT_ID]
diff --git a/docs/examples/migrations/create-n-host-migration.md b/docs/examples/migrations/create-n-host-migration.md
@@ -0,0 +1,9 @@
+appwrite migrations createNHostMigration \
+        --resources one two three \
+        --subdomain [SUBDOMAIN] \
+        --region [REGION] \
+        --adminSecret [ADMIN_SECRET] \
+        --database [DATABASE] \
+        --username [USERNAME] \
+        --password [PASSWORD] \
+
diff --git a/docs/examples/migrations/create-supabase-migration.md b/docs/examples/migrations/create-supabase-migration.md
@@ -0,0 +1,8 @@
+appwrite migrations createSupabaseMigration \
+        --resources one two three \
+        --endpoint https://example.com \
+        --apiKey [API_KEY] \
+        --databaseHost [DATABASE_HOST] \
+        --username [USERNAME] \
+        --password [PASSWORD] \
+
diff --git a/docs/examples/migrations/delete-firebase-auth.md b/docs/examples/migrations/delete-firebase-auth.md
@@ -0,0 +1 @@
+appwrite migrations deleteFirebaseAuth
diff --git a/docs/examples/migrations/delete.md b/docs/examples/migrations/delete.md
@@ -0,0 +1,2 @@
+appwrite migrations delete \
+        --migrationId [MIGRATION_ID]
diff --git a/docs/examples/migrations/get-appwrite-report.md b/docs/examples/migrations/get-appwrite-report.md
@@ -0,0 +1,5 @@
+appwrite migrations getAppwriteReport \
+        --resources one two three \
+        --endpoint https://example.com \
+        --projectID [PROJECT_ID] \
+        --key [KEY]
diff --git a/docs/examples/migrations/get-firebase-report-o-auth.md b/docs/examples/migrations/get-firebase-report-o-auth.md
@@ -0,0 +1,3 @@
+appwrite migrations getFirebaseReportOAuth \
+        --resources one two three \
+        --projectId [PROJECT_ID]
diff --git a/docs/examples/migrations/get-firebase-report.md b/docs/examples/migrations/get-firebase-report.md
@@ -0,0 +1,3 @@
+appwrite migrations getFirebaseReport \
+        --resources one two three \
+        --serviceAccount [SERVICE_ACCOUNT]
diff --git a/docs/examples/migrations/get-n-host-report.md b/docs/examples/migrations/get-n-host-report.md
@@ -0,0 +1,9 @@
+appwrite migrations getNHostReport \
+        --resources one two three \
+        --subdomain [SUBDOMAIN] \
+        --region [REGION] \
+        --adminSecret [ADMIN_SECRET] \
+        --database [DATABASE] \
+        --username [USERNAME] \
+        --password [PASSWORD] \
+
diff --git a/docs/examples/migrations/get-supabase-report.md b/docs/examples/migrations/get-supabase-report.md
@@ -0,0 +1,8 @@
+appwrite migrations getSupabaseReport \
+        --resources one two three \
+        --endpoint https://example.com \
+        --apiKey [API_KEY] \
+        --databaseHost [DATABASE_HOST] \
+        --username [USERNAME] \
+        --password [PASSWORD] \
+
diff --git a/docs/examples/migrations/get.md b/docs/examples/migrations/get.md
@@ -0,0 +1,2 @@
+appwrite migrations get \
+        --migrationId [MIGRATION_ID]
diff --git a/docs/examples/migrations/list-firebase-projects.md b/docs/examples/migrations/list-firebase-projects.md
@@ -0,0 +1 @@
+appwrite migrations listFirebaseProjects
diff --git a/docs/examples/migrations/list.md b/docs/examples/migrations/list.md
@@ -0,0 +1,3 @@
+appwrite migrations list \
+
+
diff --git a/docs/examples/migrations/retry.md b/docs/examples/migrations/retry.md
@@ -0,0 +1,2 @@
+appwrite migrations retry \
+        --migrationId [MIGRATION_ID]
diff --git a/docs/examples/project/create-variable.md b/docs/examples/project/create-variable.md
@@ -0,0 +1,3 @@
+appwrite project createVariable \
+        --key [KEY] \
+        --value [VALUE]
diff --git a/docs/examples/project/delete-variable.md b/docs/examples/project/delete-variable.md
@@ -0,0 +1,2 @@
+appwrite project deleteVariable \
+        --variableId [VARIABLE_ID]
diff --git a/docs/examples/project/get-usage.md b/docs/examples/project/get-usage.md
@@ -0,0 +1,2 @@
+appwrite project getUsage \
+
diff --git a/docs/examples/project/get-variable.md b/docs/examples/project/get-variable.md
@@ -0,0 +1,2 @@
+appwrite project getVariable \
+        --variableId [VARIABLE_ID]
diff --git a/docs/examples/project/list-variables.md b/docs/examples/project/list-variables.md
@@ -0,0 +1 @@
+appwrite project listVariables
diff --git a/docs/examples/project/update-variable.md b/docs/examples/project/update-variable.md
@@ -0,0 +1,4 @@
+appwrite project updateVariable \
+        --variableId [VARIABLE_ID] \
+        --key [KEY] \
+
diff --git a/docs/examples/projects/create-domain.md b/docs/examples/projects/create-domain.md
diff --git a/docs/examples/projects/create.md b/docs/examples/projects/create.md
@@ -1,5 +1,5 @@
 appwrite projects create \
-        --projectId [PROJECT_ID] \
+        --projectId '' \
         --name [NAME] \
         --teamId [TEAM_ID] \
 

diff --git a/docs/examples/projects/delete-domain.md b/docs/examples/projects/delete-domain.md
diff --git a/docs/examples/projects/delete-email-template.md b/docs/examples/projects/delete-email-template.md
@@ -0,0 +1,4 @@
+appwrite projects deleteEmailTemplate \
+        --projectId [PROJECT_ID] \
+        --type verification \
+        --locale af
diff --git a/docs/examples/projects/delete-sms-template.md b/docs/examples/projects/delete-sms-template.md
@@ -0,0 +1,4 @@
+appwrite projects deleteSmsTemplate \
+        --projectId [PROJECT_ID] \
+        --type verification \
+        --locale af
diff --git a/docs/examples/projects/delete.md b/docs/examples/projects/delete.md
@@ -1,3 +1,2 @@
 appwrite projects delete \
-        --projectId [PROJECT_ID] \
-        --password password
+        --projectId [PROJECT_ID]
diff --git a/docs/examples/projects/get-domain.md b/docs/examples/projects/get-domain.md
diff --git a/docs/examples/projects/get-email-template.md b/docs/examples/projects/get-email-template.md
@@ -0,0 +1,4 @@
+appwrite projects getEmailTemplate \
+        --projectId [PROJECT_ID] \
+        --type verification \
+        --locale af
diff --git a/docs/examples/projects/get-sms-template.md b/docs/examples/projects/get-sms-template.md
@@ -0,0 +1,4 @@
+appwrite projects getSmsTemplate \
+        --projectId [PROJECT_ID] \
+        --type verification \
+        --locale af
diff --git a/docs/examples/projects/list-domains.md b/docs/examples/projects/list-domains.md
diff --git a/docs/examples/projects/update-domain-verification.md b/docs/examples/projects/update-domain-verification.md
diff --git a/docs/examples/projects/update-email-template.md b/docs/examples/projects/update-email-template.md
@@ -0,0 +1,9 @@
+appwrite projects updateEmailTemplate \
+        --projectId [PROJECT_ID] \
+        --type verification \
+        --locale af \
+        --subject [SUBJECT] \
+        --message [MESSAGE] \
+
+
+
diff --git a/docs/examples/projects/update-personal-data-check.md b/docs/examples/projects/update-personal-data-check.md
@@ -0,0 +1,3 @@
+appwrite projects updatePersonalDataCheck \
+        --projectId [PROJECT_ID] \
+        --enabled false
diff --git a/docs/examples/projects/update-service-status-all.md b/docs/examples/projects/update-service-status-all.md
@@ -0,0 +1,3 @@
+appwrite projects updateServiceStatusAll \
+        --projectId [PROJECT_ID] \
+        --status false
diff --git a/docs/examples/projects/update-sms-template.md b/docs/examples/projects/update-sms-template.md
@@ -0,0 +1,5 @@
+appwrite projects updateSmsTemplate \
+        --projectId [PROJECT_ID] \
+        --type verification \
+        --locale af \
+        --message [MESSAGE]
diff --git a/docs/examples/projects/update-smtp-configuration.md b/docs/examples/projects/update-smtp-configuration.md
@@ -0,0 +1,11 @@
+appwrite projects updateSmtpConfiguration \
+        --projectId [PROJECT_ID] \
+        --enabled false \
+
+
+
+
+
+
+
+
diff --git a/docs/examples/projects/update-team.md b/docs/examples/projects/update-team.md
@@ -0,0 +1,3 @@
+appwrite projects updateTeam \
+        --projectId [PROJECT_ID] \
+        --teamId [TEAM_ID]
diff --git a/docs/examples/proxy/create-rule.md b/docs/examples/proxy/create-rule.md
@@ -0,0 +1,4 @@
+appwrite proxy createRule \
+        --domain '' \
+        --resourceType api \
+
diff --git a/docs/examples/proxy/delete-rule.md b/docs/examples/proxy/delete-rule.md
@@ -0,0 +1,2 @@
+appwrite proxy deleteRule \
+        --ruleId [RULE_ID]
diff --git a/docs/examples/proxy/get-rule.md b/docs/examples/proxy/get-rule.md
@@ -0,0 +1,2 @@
+appwrite proxy getRule \
+        --ruleId [RULE_ID]
diff --git a/docs/examples/proxy/list-rules.md b/docs/examples/proxy/list-rules.md
@@ -0,0 +1,3 @@
+appwrite proxy listRules \
+
+
diff --git a/docs/examples/proxy/update-rule-verification.md b/docs/examples/proxy/update-rule-verification.md
@@ -0,0 +1,2 @@
+appwrite proxy updateRuleVerification \
+        --ruleId [RULE_ID]
diff --git a/docs/examples/storage/update-file.md b/docs/examples/storage/update-file.md
@@ -2,3 +2,4 @@ appwrite storage updateFile \
         --bucketId [BUCKET_ID] \
         --fileId [FILE_ID] \
 
+
diff --git a/...examples/teams/update-membership-roles.md → docs/examples/teams/update-membership.md b/...examples/teams/update-membership-roles.md → docs/examples/teams/update-membership.md
@@ -1,4 +1,4 @@
-appwrite teams updateMembershipRoles \
+appwrite teams updateMembership \
         --teamId [TEAM_ID] \
         --membershipId [MEMBERSHIP_ID] \
         --roles one two three
diff --git a/docs/examples/users/delete-identity.md b/docs/examples/users/delete-identity.md
@@ -0,0 +1,2 @@
+appwrite users deleteIdentity \
+        --identityId [IDENTITY_ID]
diff --git a/docs/examples/users/list-identities.md b/docs/examples/users/list-identities.md
@@ -0,0 +1,3 @@
+appwrite users listIdentities \
+
+
diff --git a/docs/examples/users/update-labels.md b/docs/examples/users/update-labels.md
@@ -0,0 +1,3 @@
+appwrite users updateLabels \
+        --userId [USER_ID] \
+        --labels one two three