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

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

@@ -1,17 +0,0 @@
-```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

@@ -1,16 +0,0 @@
-```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

@@ -1,19 +0,0 @@
-```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

@@ -1,17 +0,0 @@
-```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

@@ -1,15 +0,0 @@
-```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

@@ -1,16 +0,0 @@
-```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

@@ -1,15 +0,0 @@
-```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

@@ -1,21 +0,0 @@
-```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

@@ -1,17 +0,0 @@
-```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

@@ -1,18 +0,0 @@
-```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

@@ -1,18 +0,0 @@
-```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

@@ -1,20 +0,0 @@
-```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

@@ -1,18 +0,0 @@
-```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

@@ -1,15 +0,0 @@
-```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

@@ -1,15 +0,0 @@
-```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

@@ -1,17 +0,0 @@
-```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

@@ -1,20 +0,0 @@
-```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

@@ -1,20 +0,0 @@
-```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

@@ -1,19 +0,0 @@
-```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

@@ -1,17 +0,0 @@
-```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);
-```

package/docs/examples/documentsdb/update.md

@@ -1,17 +0,0 @@
-```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

@@ -1,20 +0,0 @@
-```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

@@ -1,18 +0,0 @@
-```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/confirm-transfer-in.md

@@ -1,16 +0,0 @@
-```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.confirmTransferIn({
-    domainId: '<DOMAIN_ID>',
-    organizationId: '<ORGANIZATION_ID>'
-});
-
-console.log(result);
-```

package/docs/examples/projects/create-webhook.md

@@ -1,22 +0,0 @@
-```javascript
-import { Client, Projects } 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 projects = new Projects(client);
-
-const result = await projects.createWebhook({
-    projectId: '<PROJECT_ID>',
-    name: '<NAME>',
-    events: [],
-    url: '',
-    security: false,
-    enabled: false, // optional
-    httpUser: '<HTTP_USER>', // optional
-    httpPass: '<HTTP_PASS>' // optional
-});
-
-console.log(result);
-```

package/docs/examples/projects/delete-webhook.md

@@ -1,16 +0,0 @@
-```javascript
-import { Client, Projects } 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 projects = new Projects(client);
-
-const result = await projects.deleteWebhook({
-    projectId: '<PROJECT_ID>',
-    webhookId: '<WEBHOOK_ID>'
-});
-
-console.log(result);
-```

package/docs/examples/projects/get-webhook.md

@@ -1,16 +0,0 @@
-```javascript
-import { Client, Projects } 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 projects = new Projects(client);
-
-const result = await projects.getWebhook({
-    projectId: '<PROJECT_ID>',
-    webhookId: '<WEBHOOK_ID>'
-});
-
-console.log(result);
-```

package/docs/examples/projects/list-webhooks.md

@@ -1,16 +0,0 @@
-```javascript
-import { Client, Projects } 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 projects = new Projects(client);
-
-const result = await projects.listWebhooks({
-    projectId: '<PROJECT_ID>',
-    total: false // optional
-});
-
-console.log(result);
-```

package/docs/examples/projects/update-webhook-signature.md

@@ -1,16 +0,0 @@
-```javascript
-import { Client, Projects } 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 projects = new Projects(client);
-
-const result = await projects.updateWebhookSignature({
-    projectId: '<PROJECT_ID>',
-    webhookId: '<WEBHOOK_ID>'
-});
-
-console.log(result);
-```

package/docs/examples/projects/update-webhook.md

@@ -1,23 +0,0 @@
-```javascript
-import { Client, Projects } 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 projects = new Projects(client);
-
-const result = await projects.updateWebhook({
-    projectId: '<PROJECT_ID>',
-    webhookId: '<WEBHOOK_ID>',
-    name: '<NAME>',
-    events: [],
-    url: '',
-    security: false,
-    enabled: false, // optional
-    httpUser: '<HTTP_USER>', // optional
-    httpPass: '<HTTP_PASS>' // optional
-});
-
-console.log(result);
-```

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

@@ -1,21 +0,0 @@
-```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

@@ -1,29 +0,0 @@
-```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

@@ -1,17 +0,0 @@
-```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);
-```