react-native-appwrite 0.11.0 → 0.13.0

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

@@ -0,0 +1,245 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class TablesDB extends Service {
+    constructor(client: Client);
+    /**
+     * Get a list of all the user's rows in a given table. You can use the query params to filter your results.
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID. You can create a new table using the TableDB service [server integration](https://appwrite.io/docs/server/tablesdbdb#tablesdbCreate).
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listRows<Row extends Models.Row = Models.DefaultRow>(params: {
+        databaseId: string;
+        tableId: string;
+        queries?: string[];
+    }): Promise<Models.RowList<Row>>;
+    /**
+     * Get a list of all the user's rows in a given table. You can use the query params to filter your results.
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID. You can create a new table using the TableDB service [server integration](https://appwrite.io/docs/server/tablesdbdb#tablesdbCreate).
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.RowList<Row>>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[]): Promise<Models.RowList<Row>>;
+    /**
+     * Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreateTable) API or directly from your database console.
+     *
+     * @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/server/tablesdb#tablesDBCreate). Make sure to define columns before creating rows.
+     * @param {string} params.rowId - Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+     * @param {Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Omit<Row, keyof Models.Row>} params.data - Row data as JSON object.
+     * @param {string[]} params.permissions - An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createRow<Row extends Models.Row = Models.DefaultRow>(params: {
+        databaseId: string;
+        tableId: string;
+        rowId: string;
+        data: Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Omit<Row, keyof Models.Row>;
+        permissions?: string[];
+    }): Promise<Row>;
+    /**
+     * Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreateTable) API or directly from your database console.
+     *
+     * @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/server/tablesdb#tablesDBCreate). Make sure to define columns before creating rows.
+     * @param {string} rowId - Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+     * @param {Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Omit<Row, keyof Models.Row>} data - Row data as JSON object.
+     * @param {string[]} permissions - An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @throws {AppwriteException}
+     * @returns {Promise<Row>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createRow<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, rowId: string, data: Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Omit<Row, keyof Models.Row>, permissions?: string[]): Promise<Row>;
+    /**
+     * Get a row by its unique ID. This endpoint response returns a JSON object with the row data.
+     *
+     * @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/server/tablesdb#tablesDBCreate).
+     * @param {string} params.rowId - Row ID.
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getRow<Row extends Models.Row = Models.DefaultRow>(params: {
+        databaseId: string;
+        tableId: string;
+        rowId: string;
+        queries?: string[];
+    }): Promise<Row>;
+    /**
+     * Get a row by its unique ID. This endpoint response returns a JSON object with the row data.
+     *
+     * @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/server/tablesdb#tablesDBCreate).
+     * @param {string} rowId - Row ID.
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
+     * @throws {AppwriteException}
+     * @returns {Promise<Row>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getRow<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, rowId: string, queries?: string[]): Promise<Row>;
+    /**
+     * Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreateTable) API or directly from your database console.
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID.
+     * @param {string} params.rowId - Row ID.
+     * @param {Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Partial<Omit<Row, keyof Models.Row>>} params.data - Row data as JSON object. Include all required columns of the row to be created or updated.
+     * @param {string[]} params.permissions - An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    upsertRow<Row extends Models.Row = Models.DefaultRow>(params: {
+        databaseId: string;
+        tableId: string;
+        rowId: string;
+        data?: Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Partial<Omit<Row, keyof Models.Row>>;
+        permissions?: string[];
+    }): Promise<Row>;
+    /**
+     * Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreateTable) API or directly from your database console.
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID.
+     * @param {string} rowId - Row ID.
+     * @param {Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Partial<Omit<Row, keyof Models.Row>>} data - Row data as JSON object. Include all required columns of the row to be created or updated.
+     * @param {string[]} permissions - An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @throws {AppwriteException}
+     * @returns {Promise<Row>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    upsertRow<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, rowId: string, data?: Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Partial<Omit<Row, keyof Models.Row>>, permissions?: string[]): Promise<Row>;
+    /**
+     * Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID.
+     * @param {string} params.rowId - Row ID.
+     * @param {Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Partial<Omit<Row, keyof Models.Row>>} params.data - Row data as JSON object. Include only columns and value pairs to be updated.
+     * @param {string[]} params.permissions - An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateRow<Row extends Models.Row = Models.DefaultRow>(params: {
+        databaseId: string;
+        tableId: string;
+        rowId: string;
+        data?: Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Partial<Omit<Row, keyof Models.Row>>;
+        permissions?: string[];
+    }): Promise<Row>;
+    /**
+     * Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID.
+     * @param {string} rowId - Row ID.
+     * @param {Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Partial<Omit<Row, keyof Models.Row>>} data - Row data as JSON object. Include only columns and value pairs to be updated.
+     * @param {string[]} permissions - An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @throws {AppwriteException}
+     * @returns {Promise<Row>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateRow<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, rowId: string, data?: Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Partial<Omit<Row, keyof Models.Row>>, permissions?: string[]): Promise<Row>;
+    /**
+     * Delete a row by its unique ID.
+     *
+     * @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/server/tablesdb#tablesDBCreate).
+     * @param {string} params.rowId - Row ID.
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    deleteRow(params: {
+        databaseId: string;
+        tableId: string;
+        rowId: string;
+    }): Promise<{}>;
+    /**
+     * Delete a row by its unique ID.
+     *
+     * @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/server/tablesdb#tablesDBCreate).
+     * @param {string} rowId - Row ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteRow(databaseId: string, tableId: string, rowId: string): Promise<{}>;
+    /**
+     * Decrement a specific column of a row by a given value.
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID.
+     * @param {string} params.rowId - Row ID.
+     * @param {string} params.column - Column key.
+     * @param {number} params.value - Value to increment the column by. The value must be a number.
+     * @param {number} params.min - Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    decrementRowColumn<Row extends Models.Row = Models.DefaultRow>(params: {
+        databaseId: string;
+        tableId: string;
+        rowId: string;
+        column: string;
+        value?: number;
+        min?: number;
+    }): Promise<Row>;
+    /**
+     * Decrement a specific column of a row by a given value.
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID.
+     * @param {string} rowId - Row ID.
+     * @param {string} column - Column key.
+     * @param {number} value - Value to increment the column by. The value must be a number.
+     * @param {number} min - Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.
+     * @throws {AppwriteException}
+     * @returns {Promise<Row>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    decrementRowColumn<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, rowId: string, column: string, value?: number, min?: number): Promise<Row>;
+    /**
+     * Increment a specific column of a row by a given value.
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID.
+     * @param {string} params.rowId - Row ID.
+     * @param {string} params.column - Column key.
+     * @param {number} params.value - Value to increment the column by. The value must be a number.
+     * @param {number} params.max - Maximum value for the column. If the current value is greater than this value, an error will be thrown.
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    incrementRowColumn<Row extends Models.Row = Models.DefaultRow>(params: {
+        databaseId: string;
+        tableId: string;
+        rowId: string;
+        column: string;
+        value?: number;
+        max?: number;
+    }): Promise<Row>;
+    /**
+     * Increment a specific column of a row by a given value.
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID.
+     * @param {string} rowId - Row ID.
+     * @param {string} column - Column key.
+     * @param {number} value - Value to increment the column by. The value must be a number.
+     * @param {number} max - Maximum value for the column. If the current value is greater than this value, an error will be thrown.
+     * @throws {AppwriteException}
+     * @returns {Promise<Row>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    incrementRowColumn<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, rowId: string, column: string, value?: number, max?: number): Promise<Row>;
+}