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

package/docs/examples/documentsdb/update.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.update({
+    databaseId: '<DATABASE_ID>',
+    name: '<NAME>',
+    enabled: false // optional
+});
+
+console.log(result);
+```

package/docs/examples/documentsdb/upsert-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.upsertDocument({
+    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/upsert-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.upsertDocuments({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documents: [],
+    transactionId: '<TRANSACTION_ID>' // optional
+});
+
+console.log(result);
+```

package/docs/examples/domains/update-purchase.md

@@ -0,0 +1,16 @@
+```javascript
+import { Client, Domains } 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 domains = new Domains(client);
+
+const result = await domains.updatePurchase({
+    domainId: '<DOMAIN_ID>',
+    organizationId: '<ORGANIZATION_ID>'
+});
+
+console.log(result);
+```

package/docs/examples/domains/update-transfer-in.md

@@ -0,0 +1,16 @@
+```javascript
+import { Client, Domains } 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 domains = new Domains(client);
+
+const result = await domains.updateTransferIn({
+    domainId: '<DOMAIN_ID>',
+    organizationId: '<ORGANIZATION_ID>'
+});
+
+console.log(result);
+```

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

@@ -1,5 +1,5 @@
 ```javascript
-import { Client, TablesDB, IndexType, OrderBy } from "@appwrite.io/console";
+import { Client, TablesDB, TablesDBIndexType, 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 tablesDB.createIndex({
     databaseId: '<DATABASE_ID>',
     tableId: '<TABLE_ID>',
     key: '',
-    type: IndexType.Key,
+    type: TablesDBIndexType.Key,
     columns: [],
     orders: [OrderBy.Asc], // optional
     lengths: [] // optional

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

@@ -0,0 +1,21 @@
+```javascript
+import { Client, VectorsDB, 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.createCollection({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    name: '<NAME>',
+    dimension: 1,
+    permissions: [Permission.read(Role.any())], // optional
+    documentSecurity: false, // optional
+    enabled: false // optional
+});
+
+console.log(result);
+```

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

@@ -0,0 +1,29 @@
+```javascript
+import { Client, VectorsDB, 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.createDocument({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documentId: '<DOCUMENT_ID>',
+    data: {
+        "embeddings": [
+            0.12,
+            -0.55,
+            0.88,
+            1.02
+        ],
+        "metadata": {
+            "key": "value"
+        }
+    },
+    permissions: [Permission.read(Role.any())] // optional
+});
+
+console.log(result);
+```

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

@@ -0,0 +1,17 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.createDocuments({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documents: []
+});
+
+console.log(result);
+```

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

@@ -0,0 +1,21 @@
+```javascript
+import { Client, VectorsDB, VectorsDBIndexType, 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.createIndex({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    key: '',
+    type: VectorsDBIndexType.HnswEuclidean,
+    attributes: [],
+    orders: [OrderBy.Asc], // optional
+    lengths: [] // optional
+});
+
+console.log(result);
+```

package/docs/examples/vectorsdb/create-operations.md

@@ -0,0 +1,26 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.createOperations({
+    transactionId: '<TRANSACTION_ID>',
+    operations: [
+	    {
+	        "action": "create",
+	        "databaseId": "<DATABASE_ID>",
+	        "collectionId": "<COLLECTION_ID>",
+	        "documentId": "<DOCUMENT_ID>",
+	        "data": {
+	            "name": "Walter O'Brien"
+	        }
+	    }
+	] // optional
+});
+
+console.log(result);
+```

package/docs/examples/vectorsdb/create-text-embeddings.md

@@ -0,0 +1,16 @@
+```javascript
+import { Client, VectorsDB, Model } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.createTextEmbeddings({
+    texts: [],
+    model: Model.Embeddinggemma // optional
+});
+
+console.log(result);
+```

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

@@ -0,0 +1,15 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.createTransaction({
+    ttl: 60 // optional
+});
+
+console.log(result);
+```

package/docs/examples/vectorsdb/create.md

@@ -0,0 +1,17 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.create({
+    databaseId: '<DATABASE_ID>',
+    name: '<NAME>',
+    enabled: false // optional
+});
+
+console.log(result);
+```

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

@@ -0,0 +1,16 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.deleteCollection({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>'
+});
+
+console.log(result);
+```

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

@@ -0,0 +1,18 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.deleteDocument({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documentId: '<DOCUMENT_ID>',
+    transactionId: '<TRANSACTION_ID>' // optional
+});
+
+console.log(result);
+```

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

@@ -0,0 +1,18 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.deleteDocuments({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    queries: [], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
+});
+
+console.log(result);
+```

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

@@ -0,0 +1,17 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.deleteIndex({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    key: ''
+});
+
+console.log(result);
+```

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

@@ -0,0 +1,15 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.deleteTransaction({
+    transactionId: '<TRANSACTION_ID>'
+});
+
+console.log(result);
+```

package/docs/examples/vectorsdb/delete.md

@@ -0,0 +1,15 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.delete({
+    databaseId: '<DATABASE_ID>'
+});
+
+console.log(result);
+```

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

@@ -0,0 +1,17 @@
+```javascript
+import { Client, VectorsDB, 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.getCollectionUsage({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    range: UsageRange.TwentyFourHours // optional
+});
+
+console.log(result);
+```

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

@@ -0,0 +1,16 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.getCollection({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>'
+});
+
+console.log(result);
+```

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

@@ -0,0 +1,19 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.getDocument({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documentId: '<DOCUMENT_ID>',
+    queries: [], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
+});
+
+console.log(result);
+```

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

@@ -0,0 +1,17 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.getIndex({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    key: ''
+});
+
+console.log(result);
+```

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

@@ -0,0 +1,15 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.getTransaction({
+    transactionId: '<TRANSACTION_ID>'
+});
+
+console.log(result);
+```

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

@@ -0,0 +1,16 @@
+```javascript
+import { Client, VectorsDB, 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.getUsage({
+    databaseId: '<DATABASE_ID>',
+    range: UsageRange.TwentyFourHours // optional
+});
+
+console.log(result);
+```

package/docs/examples/vectorsdb/get.md

@@ -0,0 +1,15 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.get({
+    databaseId: '<DATABASE_ID>'
+});
+
+console.log(result);
+```

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

@@ -0,0 +1,17 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.listCollectionLogs({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    queries: [] // optional
+});
+
+console.log(result);
+```

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

@@ -0,0 +1,18 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.listCollections({
+    databaseId: '<DATABASE_ID>',
+    queries: [], // optional
+    search: '<SEARCH>', // optional
+    total: false // optional
+});
+
+console.log(result);
+```

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

@@ -0,0 +1,20 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.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/vectorsdb/list-indexes.md

@@ -0,0 +1,18 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.listIndexes({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    queries: [], // optional
+    total: false // optional
+});
+
+console.log(result);
+```

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

@@ -0,0 +1,15 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.listTransactions({
+    queries: [] // optional
+});
+
+console.log(result);
+```

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

@@ -0,0 +1,15 @@
+```javascript
+import { Client, VectorsDB, 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.listUsage({
+    range: UsageRange.TwentyFourHours // optional
+});
+
+console.log(result);
+```

package/docs/examples/vectorsdb/list.md

@@ -0,0 +1,17 @@
+```javascript
+import { Client, VectorsDB } 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 vectorsDB = new VectorsDB(client);
+
+const result = await vectorsDB.list({
+    queries: [], // optional
+    search: '<SEARCH>', // optional
+    total: false // optional
+});
+
+console.log(result);
+```