@appwrite.io/console 1.10.0 → 2.0.0

package/docs/examples/storage/update-bucket.md

@@ -1,4 +1,4 @@
-import { Client, Storage,  } from "@appwrite.io/console";
+import { Client, Storage, Compression, Permission, Role } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -6,17 +6,18 @@ const client = new Client()
 
 const storage = new Storage(client);
 
-const result = await storage.updateBucket(
-    '<BUCKET_ID>', // bucketId
-    '<NAME>', // name
-    ["read("any")"], // permissions (optional)
-    false, // fileSecurity (optional)
-    false, // enabled (optional)
-    1, // maximumFileSize (optional)
-    [], // allowedFileExtensions (optional)
-    .None, // compression (optional)
-    false, // encryption (optional)
-    false // antivirus (optional)
-);
+const result = await storage.updateBucket({
+    bucketId: '<BUCKET_ID>',
+    name: '<NAME>',
+    permissions: [Permission.read(Role.any())], // optional
+    fileSecurity: false, // optional
+    enabled: false, // optional
+    maximumFileSize: 1, // optional
+    allowedFileExtensions: [], // optional
+    compression: Compression.None, // optional
+    encryption: false, // optional
+    antivirus: false, // optional
+    transformations: false // optional
+});
 
 console.log(result);

package/docs/examples/storage/update-file.md

@@ -1,4 +1,4 @@
-import { Client, Storage } from "@appwrite.io/console";
+import { Client, Storage, Permission, Role } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -6,11 +6,11 @@ const client = new Client()
 
 const storage = new Storage(client);
 
-const result = await storage.updateFile(
-    '<BUCKET_ID>', // bucketId
-    '<FILE_ID>', // fileId
-    '<NAME>', // name (optional)
-    ["read("any")"] // permissions (optional)
-);
+const result = await storage.updateFile({
+    bucketId: '<BUCKET_ID>',
+    fileId: '<FILE_ID>',
+    name: '<NAME>', // optional
+    permissions: [Permission.read(Role.any())] // optional
+});
 
 console.log(result);

package/docs/examples/tablesdb/create-boolean-column.md

@@ -0,0 +1,18 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createBooleanColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    required: false,
+    default: false, // optional
+    array: false // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/create-datetime-column.md

@@ -0,0 +1,18 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createDatetimeColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    required: false,
+    default: '', // optional
+    array: false // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/create-email-column.md

@@ -0,0 +1,18 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createEmailColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    required: false,
+    default: 'email@example.com', // optional
+    array: false // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/create-enum-column.md

@@ -0,0 +1,19 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createEnumColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    elements: [],
+    required: false,
+    default: '<DEFAULT>', // optional
+    array: false // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/create-float-column.md

@@ -0,0 +1,20 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createFloatColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    required: false,
+    min: null, // optional
+    max: null, // optional
+    default: null, // optional
+    array: false // optional
+});
+
+console.log(result);

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

@@ -0,0 +1,19 @@
+import { Client, TablesDB, IndexType } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createIndex({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    type: IndexType.Key,
+    columns: [],
+    orders: [], // optional
+    lengths: [] // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/create-integer-column.md

@@ -0,0 +1,20 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createIntegerColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    required: false,
+    min: null, // optional
+    max: null, // optional
+    default: null, // optional
+    array: false // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/create-ip-column.md

@@ -0,0 +1,18 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createIpColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    required: false,
+    default: '', // optional
+    array: false // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/create-line-column.md

@@ -0,0 +1,17 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createLineColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    required: false,
+    default: [[1, 2], [3, 4], [5, 6]] // optional
+});
+
+console.log(result);

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

@@ -0,0 +1,24 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createOperations({
+    transactionId: '<TRANSACTION_ID>',
+    operations: [
+	    {
+	        "action": "create",
+	        "databaseId": "<DATABASE_ID>",
+	        "tableId": "<TABLE_ID>",
+	        "rowId": "<ROW_ID>",
+	        "data": {
+	            "name": "Walter O'Brien"
+	        }
+	    }
+	] // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/create-point-column.md

@@ -0,0 +1,17 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createPointColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    required: false,
+    default: [1, 2] // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/create-polygon-column.md

@@ -0,0 +1,17 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createPolygonColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    required: false,
+    default: [[[1, 2], [3, 4], [5, 6], [1, 2]]] // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/create-relationship-column.md

@@ -0,0 +1,20 @@
+import { Client, TablesDB, RelationshipType, RelationMutate } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createRelationshipColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    relatedTableId: '<RELATED_TABLE_ID>',
+    type: RelationshipType.OneToOne,
+    twoWay: false, // optional
+    key: '', // optional
+    twoWayKey: '', // optional
+    onDelete: RelationMutate.Cascade // optional
+});
+
+console.log(result);

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

@@ -0,0 +1,24 @@
+import { Client, TablesDB, 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createRow({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    rowId: '<ROW_ID>',
+    data: {
+        "username": "walter.obrien",
+        "email": "walter.obrien@example.com",
+        "fullName": "Walter O'Brien",
+        "age": 30,
+        "isAdmin": false
+    },
+    permissions: [Permission.read(Role.any())], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
+});
+
+console.log(result);

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

@@ -0,0 +1,16 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createRows({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    rows: [],
+    transactionId: '<TRANSACTION_ID>' // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/create-string-column.md

@@ -0,0 +1,20 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createStringColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    size: 1,
+    required: false,
+    default: '<DEFAULT>', // optional
+    array: false, // optional
+    encrypt: false // optional
+});
+
+console.log(result);

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

@@ -0,0 +1,20 @@
+import { Client, TablesDB, 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createTable({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    name: '<NAME>',
+    permissions: [Permission.read(Role.any())], // optional
+    rowSecurity: false, // optional
+    enabled: false, // optional
+    columns: [], // optional
+    indexes: [] // optional
+});
+
+console.log(result);

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

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

package/docs/examples/tablesdb/create-url-column.md

@@ -0,0 +1,18 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createUrlColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    required: false,
+    default: 'https://example.com', // optional
+    array: false // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/create.md

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

package/docs/examples/tablesdb/decrement-row-column.md

@@ -0,0 +1,19 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.decrementRowColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    rowId: '<ROW_ID>',
+    column: '',
+    value: null, // optional
+    min: null, // optional
+    transactionId: '<TRANSACTION_ID>' // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/delete-column.md

@@ -0,0 +1,15 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.deleteColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: ''
+});
+
+console.log(result);

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

@@ -0,0 +1,15 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.deleteIndex({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: ''
+});
+
+console.log(result);

package/docs/examples/tablesdb/delete-row.md

@@ -0,0 +1,16 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.deleteRow({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    rowId: '<ROW_ID>',
+    transactionId: '<TRANSACTION_ID>' // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/delete-rows.md

@@ -0,0 +1,16 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.deleteRows({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    queries: [], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/delete-table.md

@@ -0,0 +1,14 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.deleteTable({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>'
+});
+
+console.log(result);

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

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

package/docs/examples/tablesdb/delete.md

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

package/docs/examples/tablesdb/get-column.md

@@ -0,0 +1,15 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.getColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: ''
+});
+
+console.log(result);

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

@@ -0,0 +1,15 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.getIndex({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: ''
+});
+
+console.log(result);

package/docs/examples/tablesdb/get-row.md

@@ -0,0 +1,17 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.getRow({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    rowId: '<ROW_ID>',
+    queries: [], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
+});
+
+console.log(result);