@appwrite.io/console 5.0.0 → 7.0.0-rc.1

package/docs/examples/databases/create-index.md

@@ -1,5 +1,5 @@
 ```javascript
-import { Client, Databases, IndexType, OrderBy } from "@appwrite.io/console";
+import { Client, Databases, DatabasesIndexType, OrderBy } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -11,7 +11,7 @@ const result = await databases.createIndex({
     databaseId: '<DATABASE_ID>',
     collectionId: '<COLLECTION_ID>',
     key: '',
-    type: IndexType.Key,
+    type: DatabasesIndexType.Key,
     attributes: [],
     orders: [OrderBy.Asc], // optional
     lengths: [] // optional

package/docs/examples/documentsdb/create-collection.md

@@ -0,0 +1,22 @@
+```javascript
+import { Client, DocumentsDB, Permission, Role } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.createCollection({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    name: '<NAME>',
+    permissions: [Permission.read(Role.any())], // optional
+    documentSecurity: false, // optional
+    enabled: false, // optional
+    attributes: [], // optional
+    indexes: [] // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/create-document.md

@@ -0,0 +1,25 @@
+```javascript
+import { Client, DocumentsDB, Permission, Role } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.createDocument({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documentId: '<DOCUMENT_ID>',
+    data: {
+        "username": "walter.obrien",
+        "email": "walter.obrien@example.com",
+        "fullName": "Walter O'Brien",
+        "age": 30,
+        "isAdmin": false
+    },
+    permissions: [Permission.read(Role.any())] // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/create-documents.md

@@ -0,0 +1,17 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.createDocuments({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documents: []
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/create-index.md

@@ -0,0 +1,21 @@
+```javascript
+import { Client, DocumentsDB, DocumentsDBIndexType, OrderBy } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.createIndex({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    key: '',
+    type: DocumentsDBIndexType.Key,
+    attributes: [],
+    orders: [OrderBy.Asc], // optional
+    lengths: [] // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/create-transaction.md

@@ -0,0 +1,15 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.createTransaction({
+    ttl: 60 // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/create.md

@@ -0,0 +1,17 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.create({
+    databaseId: '<DATABASE_ID>',
+    name: '<NAME>',
+    enabled: false // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/decrement-document-attribute.md

@@ -0,0 +1,21 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.decrementDocumentAttribute({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documentId: '<DOCUMENT_ID>',
+    attribute: '',
+    value: null, // optional
+    min: null, // optional
+    transactionId: '<TRANSACTION_ID>' // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/delete-collection.md

@@ -0,0 +1,16 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.deleteCollection({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>'
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/delete-document.md

@@ -0,0 +1,18 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.deleteDocument({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documentId: '<DOCUMENT_ID>',
+    transactionId: '<TRANSACTION_ID>' // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/delete-documents.md

@@ -0,0 +1,18 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.deleteDocuments({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    queries: [], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/delete-index.md

@@ -0,0 +1,17 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.deleteIndex({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    key: ''
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/delete-transaction.md

@@ -0,0 +1,15 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.deleteTransaction({
+    transactionId: '<TRANSACTION_ID>'
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/delete.md

@@ -0,0 +1,15 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.delete({
+    databaseId: '<DATABASE_ID>'
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/get-collection-usage.md

@@ -0,0 +1,17 @@
+```javascript
+import { Client, DocumentsDB, UsageRange } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.getCollectionUsage({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    range: UsageRange.TwentyFourHours // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/get-collection.md

@@ -0,0 +1,16 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.getCollection({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>'
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/get-document.md

@@ -0,0 +1,19 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.getDocument({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documentId: '<DOCUMENT_ID>',
+    queries: [], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/get-index.md

@@ -0,0 +1,17 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.getIndex({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    key: ''
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/get-transaction.md

@@ -0,0 +1,15 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.getTransaction({
+    transactionId: '<TRANSACTION_ID>'
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/get-usage.md

@@ -0,0 +1,16 @@
+```javascript
+import { Client, DocumentsDB, UsageRange } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.getUsage({
+    databaseId: '<DATABASE_ID>',
+    range: UsageRange.TwentyFourHours // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/get.md

@@ -0,0 +1,15 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.get({
+    databaseId: '<DATABASE_ID>'
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/increment-document-attribute.md

@@ -0,0 +1,21 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.incrementDocumentAttribute({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documentId: '<DOCUMENT_ID>',
+    attribute: '',
+    value: null, // optional
+    max: null, // optional
+    transactionId: '<TRANSACTION_ID>' // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/list-collection-logs.md

@@ -0,0 +1,17 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.listCollectionLogs({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    queries: [] // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/list-collections.md

@@ -0,0 +1,18 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.listCollections({
+    databaseId: '<DATABASE_ID>',
+    queries: [], // optional
+    search: '<SEARCH>', // optional
+    total: false // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/list-document-logs.md

@@ -0,0 +1,18 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.listDocumentLogs({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documentId: '<DOCUMENT_ID>',
+    queries: [] // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/list-documents.md

@@ -0,0 +1,20 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.listDocuments({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    queries: [], // optional
+    transactionId: '<TRANSACTION_ID>', // optional
+    total: false, // optional
+    ttl: 0 // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/list-indexes.md

@@ -0,0 +1,18 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.listIndexes({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    queries: [], // optional
+    total: false // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/list-transactions.md

@@ -0,0 +1,15 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.listTransactions({
+    queries: [] // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/list-usage.md

@@ -0,0 +1,15 @@
+```javascript
+import { Client, DocumentsDB, UsageRange } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.listUsage({
+    range: UsageRange.TwentyFourHours // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/list.md

@@ -0,0 +1,17 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.list({
+    queries: [], // optional
+    search: '<SEARCH>', // optional
+    total: false // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/update-collection.md

@@ -0,0 +1,20 @@
+```javascript
+import { Client, DocumentsDB, Permission, Role } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.updateCollection({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    name: '<NAME>',
+    permissions: [Permission.read(Role.any())], // optional
+    documentSecurity: false, // optional
+    enabled: false // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/update-document.md

@@ -0,0 +1,20 @@
+```javascript
+import { Client, DocumentsDB, Permission, Role } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.updateDocument({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documentId: '<DOCUMENT_ID>',
+    data: {}, // optional
+    permissions: [Permission.read(Role.any())], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/update-documents.md

@@ -0,0 +1,19 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.updateDocuments({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    data: {}, // optional
+    queries: [], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/update-transaction.md

@@ -0,0 +1,17 @@
+```javascript
+import { Client, DocumentsDB } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const documentsDB = new DocumentsDB(client);
+
+const result = await documentsDB.updateTransaction({
+    transactionId: '<TRANSACTION_ID>',
+    commit: false, // optional
+    rollback: false // optional
+});
+
+console.log(result);
+```