@appwrite.io/console 2.1.3 → 2.3.0

package/types/services/tables-db.d.ts

@@ -4,6 +4,7 @@ import { UsageRange } from '../enums/usage-range';
 import { RelationshipType } from '../enums/relationship-type';
 import { RelationMutate } from '../enums/relation-mutate';
 import { IndexType } from '../enums/index-type';
+import { OrderBy } from '../enums/order-by';
 export declare class TablesDB {
     client: Client;
     constructor(client: Client);
@@ -231,7 +232,7 @@ export declare class TablesDB {
      */
     update(params: {
         databaseId: string;
-        name: string;
+        name?: string;
         enabled?: boolean;
     }): Promise<Models.Database>;
     /**
@@ -244,7 +245,7 @@ export declare class TablesDB {
      * @returns {Promise<Models.Database>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    update(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
+    update(databaseId: string, name?: string, enabled?: boolean): Promise<Models.Database>;
     /**
      * Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.
      *
@@ -369,7 +370,7 @@ export declare class TablesDB {
     updateTable(params: {
         databaseId: string;
         tableId: string;
-        name: string;
+        name?: string;
         permissions?: string[];
         rowSecurity?: boolean;
         enabled?: boolean;
@@ -387,7 +388,7 @@ export declare class TablesDB {
      * @returns {Promise<Models.Table>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    updateTable(databaseId: string, tableId: string, name: string, permissions?: string[], rowSecurity?: boolean, enabled?: boolean): Promise<Models.Table>;
+    updateTable(databaseId: string, tableId: string, name?: string, permissions?: string[], rowSecurity?: boolean, enabled?: boolean): Promise<Models.Table>;
     /**
      * Delete a table by its unique ID. Only users with write permissions have access to delete this resource.
      *
@@ -1029,6 +1030,150 @@ export declare class TablesDB {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     updateLineColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[], newKey?: string): Promise<Models.ColumnLine>;
+    /**
+     * Create a longtext column.
+     *
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
+     * @param {boolean} params.array - Is column an array?
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnLongtext>}
+     */
+    createLongtextColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        xdefault?: string;
+        array?: boolean;
+    }): Promise<Models.ColumnLongtext>;
+    /**
+     * Create a longtext column.
+     *
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
+     * @param {boolean} array - Is column an array?
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnLongtext>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createLongtextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.ColumnLongtext>;
+    /**
+     * Update a longtext column. Changing the `default` value will not update already existing rows.
+     *
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
+     * @param {string} params.newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnLongtext>}
+     */
+    updateLongtextColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        xdefault?: string;
+        newKey?: string;
+    }): Promise<Models.ColumnLongtext>;
+    /**
+     * Update a longtext column. Changing the `default` value will not update already existing rows.
+     *
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
+     * @param {string} newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnLongtext>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateLongtextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.ColumnLongtext>;
+    /**
+     * Create a mediumtext column.
+     *
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
+     * @param {boolean} params.array - Is column an array?
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnMediumtext>}
+     */
+    createMediumtextColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        xdefault?: string;
+        array?: boolean;
+    }): Promise<Models.ColumnMediumtext>;
+    /**
+     * Create a mediumtext column.
+     *
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
+     * @param {boolean} array - Is column an array?
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnMediumtext>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createMediumtextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.ColumnMediumtext>;
+    /**
+     * Update a mediumtext column. Changing the `default` value will not update already existing rows.
+     *
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
+     * @param {string} params.newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnMediumtext>}
+     */
+    updateMediumtextColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        xdefault?: string;
+        newKey?: string;
+    }): Promise<Models.ColumnMediumtext>;
+    /**
+     * Update a mediumtext column. Changing the `default` value will not update already existing rows.
+     *
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
+     * @param {string} newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnMediumtext>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateMediumtextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.ColumnMediumtext>;
     /**
      * Create a geometric point column.
      *
@@ -1215,6 +1360,7 @@ export declare class TablesDB {
      * @param {boolean} params.encrypt - Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.
      * @throws {AppwriteException}
      * @returns {Promise<Models.ColumnString>}
+     * @deprecated This API has been deprecated since 1.9.0. Please use `TablesDB.createTextColumn` instead.
      */
     createStringColumn(params: {
         databaseId: string;
@@ -1256,6 +1402,7 @@ export declare class TablesDB {
      * @param {string} params.newKey - New Column Key.
      * @throws {AppwriteException}
      * @returns {Promise<Models.ColumnString>}
+     * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateTextColumn` instead.
      */
     updateStringColumn(params: {
         databaseId: string;
@@ -1282,6 +1429,78 @@ export declare class TablesDB {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     updateStringColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, size?: number, newKey?: string): Promise<Models.ColumnString>;
+    /**
+     * Create a text column.
+     *
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
+     * @param {boolean} params.array - Is column an array?
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnText>}
+     */
+    createTextColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        xdefault?: string;
+        array?: boolean;
+    }): Promise<Models.ColumnText>;
+    /**
+     * Create a text column.
+     *
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
+     * @param {boolean} array - Is column an array?
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnText>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createTextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.ColumnText>;
+    /**
+     * Update a text column. Changing the `default` value will not update already existing rows.
+     *
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
+     * @param {string} params.newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnText>}
+     */
+    updateTextColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        xdefault?: string;
+        newKey?: string;
+    }): Promise<Models.ColumnText>;
+    /**
+     * Update a text column. Changing the `default` value will not update already existing rows.
+     *
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
+     * @param {string} newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnText>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateTextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.ColumnText>;
     /**
      * Create a URL column.
      *
@@ -1354,6 +1573,84 @@ export declare class TablesDB {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     updateUrlColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.ColumnUrl>;
+    /**
+     * Create a varchar column.
+     *
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
+     * @param {string} params.key - Column Key.
+     * @param {number} params.size - Column size for varchar columns, in number of characters. Maximum size is 16381.
+     * @param {boolean} params.required - Is column required?
+     * @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
+     * @param {boolean} params.array - Is column an array?
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnVarchar>}
+     */
+    createVarcharColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        size: number;
+        required: boolean;
+        xdefault?: string;
+        array?: boolean;
+    }): Promise<Models.ColumnVarchar>;
+    /**
+     * Create a varchar column.
+     *
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
+     * @param {string} key - Column Key.
+     * @param {number} size - Column size for varchar columns, in number of characters. Maximum size is 16381.
+     * @param {boolean} required - Is column required?
+     * @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
+     * @param {boolean} array - Is column an array?
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnVarchar>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createVarcharColumn(databaseId: string, tableId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean): Promise<Models.ColumnVarchar>;
+    /**
+     * Update a varchar column. Changing the `default` value will not update already existing rows.
+     *
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
+     * @param {number} params.size - Maximum size of the varchar column.
+     * @param {string} params.newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnVarchar>}
+     */
+    updateVarcharColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        xdefault?: string;
+        size?: number;
+        newKey?: string;
+    }): Promise<Models.ColumnVarchar>;
+    /**
+     * Update a varchar column. Changing the `default` value will not update already existing rows.
+     *
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
+     * @param {number} size - Maximum size of the varchar column.
+     * @param {string} newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnVarchar>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateVarcharColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, size?: number, newKey?: string): Promise<Models.ColumnVarchar>;
     /**
      * Get column by ID.
      *
@@ -1474,7 +1771,7 @@ export declare class TablesDB {
      * @param {string} params.key - Index Key.
      * @param {IndexType} params.type - Index type.
      * @param {string[]} params.columns - Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
-     * @param {string[]} params.orders - Array of index orders. Maximum of 100 orders are allowed.
+     * @param {OrderBy[]} params.orders - Array of index orders. Maximum of 100 orders are allowed.
      * @param {number[]} params.lengths - Length of index. Maximum of 100
      * @throws {AppwriteException}
      * @returns {Promise<Models.ColumnIndex>}
@@ -1485,7 +1782,7 @@ export declare class TablesDB {
         key: string;
         type: IndexType;
         columns: string[];
-        orders?: string[];
+        orders?: OrderBy[];
         lengths?: number[];
     }): Promise<Models.ColumnIndex>;
     /**
@@ -1497,13 +1794,13 @@ export declare class TablesDB {
      * @param {string} key - Index Key.
      * @param {IndexType} type - Index type.
      * @param {string[]} columns - Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
-     * @param {string[]} orders - Array of index orders. Maximum of 100 orders are allowed.
+     * @param {OrderBy[]} orders - Array of index orders. Maximum of 100 orders are allowed.
      * @param {number[]} lengths - Length of index. Maximum of 100
      * @throws {AppwriteException}
      * @returns {Promise<Models.ColumnIndex>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createIndex(databaseId: string, tableId: string, key: string, type: IndexType, columns: string[], orders?: string[], lengths?: number[]): Promise<Models.ColumnIndex>;
+    createIndex(databaseId: string, tableId: string, key: string, type: IndexType, columns: string[], orders?: OrderBy[], lengths?: number[]): Promise<Models.ColumnIndex>;
     /**
      * Get index by ID.
      *

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

@@ -1,14 +0,0 @@
-import { Client, Projects, Status } 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.updateStatus({
-    projectId: '<PROJECT_ID>',
-    status: Status.Active
-});
-
-console.log(result);

package/src/enums/billing-plan.ts

@@ -1,17 +0,0 @@
-export enum BillingPlan {
-    Tier0 = 'tier-0',
-    Tier1 = 'tier-1',
-    Tier2 = 'tier-2',
-    Imaginetier0 = 'imagine-tier-0',
-    Imaginetier1 = 'imagine-tier-1',
-    Imaginetier150 = 'imagine-tier-1-50',
-    Imaginetier1100 = 'imagine-tier-1-100',
-    Imaginetier1200 = 'imagine-tier-1-200',
-    Imaginetier1290 = 'imagine-tier-1-290',
-    Imaginetier1480 = 'imagine-tier-1-480',
-    Imaginetier1700 = 'imagine-tier-1-700',
-    Imaginetier1900 = 'imagine-tier-1-900',
-    Imaginetier11100 = 'imagine-tier-1-1100',
-    Imaginetier11650 = 'imagine-tier-1-1650',
-    Imaginetier12200 = 'imagine-tier-1-2200',
-}

package/src/enums/status.ts

@@ -1,4 +0,0 @@
-export enum Status {
-    Active = 'active',
-    Archived = 'archived',
-}

package/types/enums/billing-plan.d.ts

@@ -1,17 +0,0 @@
-export declare enum BillingPlan {
-    Tier0 = "tier-0",
-    Tier1 = "tier-1",
-    Tier2 = "tier-2",
-    Imaginetier0 = "imagine-tier-0",
-    Imaginetier1 = "imagine-tier-1",
-    Imaginetier150 = "imagine-tier-1-50",
-    Imaginetier1100 = "imagine-tier-1-100",
-    Imaginetier1200 = "imagine-tier-1-200",
-    Imaginetier1290 = "imagine-tier-1-290",
-    Imaginetier1480 = "imagine-tier-1-480",
-    Imaginetier1700 = "imagine-tier-1-700",
-    Imaginetier1900 = "imagine-tier-1-900",
-    Imaginetier11100 = "imagine-tier-1-1100",
-    Imaginetier11650 = "imagine-tier-1-1650",
-    Imaginetier12200 = "imagine-tier-1-2200"
-}

package/types/enums/status.d.ts

@@ -1,4 +0,0 @@
-export declare enum Status {
-    Active = "active",
-    Archived = "archived"
-}