node-appwrite 18.0.0 → 19.0.0

package/dist/services/tables-db.d.mts

@@ -808,6 +808,201 @@ declare class TablesDB {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     updateIpColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.ColumnIp>;
+    /**
+     * Create a geometric line column.
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {any[]} params.xdefault - Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnLine>}
+     */
+    createLineColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        xdefault?: any[];
+    }): Promise<Models.ColumnLine>;
+    /**
+     * Create a geometric line column.
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {any[]} xdefault - Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnLine>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createLineColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[]): Promise<Models.ColumnLine>;
+    /**
+     * Update a line 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 TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {any[]} params.xdefault - Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.
+     * @param {string} params.newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnLine>}
+     */
+    updateLineColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        xdefault?: any[];
+        newKey?: string;
+    }): Promise<Models.ColumnLine>;
+    /**
+     * Update a line 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 TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {any[]} xdefault - Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.
+     * @param {string} newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnLine>}
+     * @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 geometric point column.
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {any[]} params.xdefault - Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnPoint>}
+     */
+    createPointColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        xdefault?: any[];
+    }): Promise<Models.ColumnPoint>;
+    /**
+     * Create a geometric point column.
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {any[]} xdefault - Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnPoint>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createPointColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[]): Promise<Models.ColumnPoint>;
+    /**
+     * Update a point 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 TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {any[]} params.xdefault - Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
+     * @param {string} params.newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnPoint>}
+     */
+    updatePointColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        xdefault?: any[];
+        newKey?: string;
+    }): Promise<Models.ColumnPoint>;
+    /**
+     * Update a point 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 TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {any[]} xdefault - Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
+     * @param {string} newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnPoint>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updatePointColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[], newKey?: string): Promise<Models.ColumnPoint>;
+    /**
+     * Create a geometric polygon column.
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {any[]} params.xdefault - Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnPolygon>}
+     */
+    createPolygonColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        xdefault?: any[];
+    }): Promise<Models.ColumnPolygon>;
+    /**
+     * Create a geometric polygon column.
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {any[]} xdefault - Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnPolygon>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createPolygonColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[]): Promise<Models.ColumnPolygon>;
+    /**
+     * Update a polygon 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 TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {any[]} params.xdefault - Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.
+     * @param {string} params.newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnPolygon>}
+     */
+    updatePolygonColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        xdefault?: any[];
+        newKey?: string;
+    }): Promise<Models.ColumnPolygon>;
+    /**
+     * Update a polygon 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 TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {any[]} xdefault - Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.
+     * @param {string} newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnPolygon>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updatePolygonColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[], newKey?: string): Promise<Models.ColumnPolygon>;
     /**
      * Create relationship column. [Learn more about relationship columns](https://appwrite.io/docs/databases-relationships#relationship-columns).
      *

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

@@ -808,6 +808,201 @@ declare class TablesDB {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     updateIpColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.ColumnIp>;
+    /**
+     * Create a geometric line column.
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {any[]} params.xdefault - Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnLine>}
+     */
+    createLineColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        xdefault?: any[];
+    }): Promise<Models.ColumnLine>;
+    /**
+     * Create a geometric line column.
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {any[]} xdefault - Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnLine>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createLineColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[]): Promise<Models.ColumnLine>;
+    /**
+     * Update a line 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 TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {any[]} params.xdefault - Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.
+     * @param {string} params.newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnLine>}
+     */
+    updateLineColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        xdefault?: any[];
+        newKey?: string;
+    }): Promise<Models.ColumnLine>;
+    /**
+     * Update a line 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 TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {any[]} xdefault - Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.
+     * @param {string} newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnLine>}
+     * @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 geometric point column.
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {any[]} params.xdefault - Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnPoint>}
+     */
+    createPointColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        xdefault?: any[];
+    }): Promise<Models.ColumnPoint>;
+    /**
+     * Create a geometric point column.
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {any[]} xdefault - Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnPoint>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createPointColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[]): Promise<Models.ColumnPoint>;
+    /**
+     * Update a point 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 TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {any[]} params.xdefault - Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
+     * @param {string} params.newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnPoint>}
+     */
+    updatePointColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        xdefault?: any[];
+        newKey?: string;
+    }): Promise<Models.ColumnPoint>;
+    /**
+     * Update a point 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 TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {any[]} xdefault - Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
+     * @param {string} newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnPoint>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updatePointColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[], newKey?: string): Promise<Models.ColumnPoint>;
+    /**
+     * Create a geometric polygon column.
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {any[]} params.xdefault - Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnPolygon>}
+     */
+    createPolygonColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        xdefault?: any[];
+    }): Promise<Models.ColumnPolygon>;
+    /**
+     * Create a geometric polygon column.
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {any[]} xdefault - Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnPolygon>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createPolygonColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[]): Promise<Models.ColumnPolygon>;
+    /**
+     * Update a polygon 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 TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {any[]} params.xdefault - Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.
+     * @param {string} params.newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnPolygon>}
+     */
+    updatePolygonColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        xdefault?: any[];
+        newKey?: string;
+    }): Promise<Models.ColumnPolygon>;
+    /**
+     * Update a polygon 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 TablesDB service [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreate).
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {any[]} xdefault - Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.
+     * @param {string} newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnPolygon>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updatePolygonColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[], newKey?: string): Promise<Models.ColumnPolygon>;
     /**
      * Create relationship column. [Learn more about relationship columns](https://appwrite.io/docs/databases-relationships#relationship-columns).
      *