react-native-appwrite 0.11.0 → 0.12.0

package/types/services/avatars.d.ts

@@ -6,133 +6,228 @@ import { Flag } from '../enums/flag';
 export declare class Avatars extends Service {
     constructor(client: Client);
     /**
-     * You can use this endpoint to show different browser icons to your users.
-     * The code argument receives the browser code as it appears in your user [GET
-     * /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions)
-     * endpoint. Use width, height and quality arguments to change the output
-     * settings.
+     * You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.
      *
-     * When one dimension is specified and the other is 0, the image is scaled
-     * with preserved aspect ratio. If both dimensions are 0, the API provides an
-     * image at source quality. If dimensions are not specified, the default size
-     * of image returned is 100x100px.
+     * When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
      *
-     * @param {Browser} code
-     * @param {number} width
-     * @param {number} height
-     * @param {number} quality
+     * @param {Browser} params.code - Browser Code.
+     * @param {number} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
+     * @param {number} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
+     * @param {number} params.quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
      * @throws {AppwriteException}
      * @returns {ArrayBuffer}
      */
+    getBrowser(params: {
+        code: Browser;
+        width?: number;
+        height?: number;
+        quality?: number;
+    }): Promise<ArrayBuffer>;
+    /**
+     * You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.
+     *
+     * When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
+     *
+     * @param {Browser} code - Browser Code.
+     * @param {number} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
+     * @param {number} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
+     * @param {number} quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
+     * @throws {AppwriteException}
+     * @returns {Promise<ArrayBuffer>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getBrowser(code: Browser, width?: number, height?: number, quality?: number): Promise<ArrayBuffer>;
     /**
-     * The credit card endpoint will return you the icon of the credit card
-     * provider you need. Use width, height and quality arguments to change the
-     * output settings.
+     * The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.
      *
-     * When one dimension is specified and the other is 0, the image is scaled
-     * with preserved aspect ratio. If both dimensions are 0, the API provides an
-     * image at source quality. If dimensions are not specified, the default size
-     * of image returned is 100x100px.
+     * When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
      *
      *
-     * @param {CreditCard} code
-     * @param {number} width
-     * @param {number} height
-     * @param {number} quality
+     * @param {CreditCard} params.code - Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro, rupay.
+     * @param {number} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
+     * @param {number} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
+     * @param {number} params.quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
      * @throws {AppwriteException}
      * @returns {ArrayBuffer}
      */
+    getCreditCard(params: {
+        code: CreditCard;
+        width?: number;
+        height?: number;
+        quality?: number;
+    }): Promise<ArrayBuffer>;
+    /**
+     * The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.
+     *
+     * When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
+     *
+     *
+     * @param {CreditCard} code - Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro, rupay.
+     * @param {number} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
+     * @param {number} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
+     * @param {number} quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
+     * @throws {AppwriteException}
+     * @returns {Promise<ArrayBuffer>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getCreditCard(code: CreditCard, width?: number, height?: number, quality?: number): Promise<ArrayBuffer>;
     /**
-     * Use this endpoint to fetch the favorite icon (AKA favicon) of any remote
-     * website URL.
+     * Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.
      *
      * This endpoint does not follow HTTP redirects.
      *
-     * @param {string} url
+     * @param {string} params.url - Website URL which you want to fetch the favicon from.
      * @throws {AppwriteException}
      * @returns {ArrayBuffer}
      */
+    getFavicon(params: {
+        url: string;
+    }): Promise<ArrayBuffer>;
+    /**
+     * Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.
+     *
+     * This endpoint does not follow HTTP redirects.
+     *
+     * @param {string} url - Website URL which you want to fetch the favicon from.
+     * @throws {AppwriteException}
+     * @returns {Promise<ArrayBuffer>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getFavicon(url: string): Promise<ArrayBuffer>;
     /**
-     * You can use this endpoint to show different country flags icons to your
-     * users. The code argument receives the 2 letter country code. Use width,
-     * height and quality arguments to change the output settings. Country codes
-     * follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard.
+     * You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard.
      *
-     * When one dimension is specified and the other is 0, the image is scaled
-     * with preserved aspect ratio. If both dimensions are 0, the API provides an
-     * image at source quality. If dimensions are not specified, the default size
-     * of image returned is 100x100px.
+     * When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
      *
      *
-     * @param {Flag} code
-     * @param {number} width
-     * @param {number} height
-     * @param {number} quality
+     * @param {Flag} params.code - Country Code. ISO Alpha-2 country code format.
+     * @param {number} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
+     * @param {number} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
+     * @param {number} params.quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
      * @throws {AppwriteException}
      * @returns {ArrayBuffer}
      */
+    getFlag(params: {
+        code: Flag;
+        width?: number;
+        height?: number;
+        quality?: number;
+    }): Promise<ArrayBuffer>;
+    /**
+     * You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard.
+     *
+     * When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
+     *
+     *
+     * @param {Flag} code - Country Code. ISO Alpha-2 country code format.
+     * @param {number} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
+     * @param {number} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
+     * @param {number} quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
+     * @throws {AppwriteException}
+     * @returns {Promise<ArrayBuffer>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getFlag(code: Flag, width?: number, height?: number, quality?: number): Promise<ArrayBuffer>;
     /**
-     * Use this endpoint to fetch a remote image URL and crop it to any image size
-     * you want. This endpoint is very useful if you need to crop and display
-     * remote images in your app or in case you want to make sure a 3rd party
-     * image is properly served using a TLS protocol.
+     * Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.
      *
-     * When one dimension is specified and the other is 0, the image is scaled
-     * with preserved aspect ratio. If both dimensions are 0, the API provides an
-     * image at source quality. If dimensions are not specified, the default size
-     * of image returned is 400x400px.
+     * When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.
      *
      * This endpoint does not follow HTTP redirects.
      *
-     * @param {string} url
-     * @param {number} width
-     * @param {number} height
+     * @param {string} params.url - Image URL which you want to crop.
+     * @param {number} params.width - Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.
+     * @param {number} params.height - Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.
      * @throws {AppwriteException}
      * @returns {ArrayBuffer}
      */
+    getImage(params: {
+        url: string;
+        width?: number;
+        height?: number;
+    }): Promise<ArrayBuffer>;
+    /**
+     * Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.
+     *
+     * When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.
+     *
+     * This endpoint does not follow HTTP redirects.
+     *
+     * @param {string} url - Image URL which you want to crop.
+     * @param {number} width - Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.
+     * @param {number} height - Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.
+     * @throws {AppwriteException}
+     * @returns {Promise<ArrayBuffer>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getImage(url: string, width?: number, height?: number): Promise<ArrayBuffer>;
     /**
-     * Use this endpoint to show your user initials avatar icon on your website or
-     * app. By default, this route will try to print your logged-in user name or
-     * email initials. You can also overwrite the user name if you pass the 'name'
-     * parameter. If no name is given and no user is logged, an empty avatar will
-     * be returned.
+     * Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.
      *
-     * You can use the color and background params to change the avatar colors. By
-     * default, a random theme will be selected. The random theme will persist for
-     * the user's initials when reloading the same theme will always return for
-     * the same initials.
+     * You can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.
      *
-     * When one dimension is specified and the other is 0, the image is scaled
-     * with preserved aspect ratio. If both dimensions are 0, the API provides an
-     * image at source quality. If dimensions are not specified, the default size
-     * of image returned is 100x100px.
+     * When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
      *
      *
-     * @param {string} name
-     * @param {number} width
-     * @param {number} height
-     * @param {string} background
+     * @param {string} params.name - Full Name. When empty, current user name or email will be used. Max length: 128 chars.
+     * @param {number} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
+     * @param {number} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
+     * @param {string} params.background - Changes background color. By default a random color will be picked and stay will persistent to the given name.
      * @throws {AppwriteException}
      * @returns {ArrayBuffer}
      */
+    getInitials(params?: {
+        name?: string;
+        width?: number;
+        height?: number;
+        background?: string;
+    }): Promise<ArrayBuffer>;
+    /**
+     * Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.
+     *
+     * You can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.
+     *
+     * When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
+     *
+     *
+     * @param {string} name - Full Name. When empty, current user name or email will be used. Max length: 128 chars.
+     * @param {number} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
+     * @param {number} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
+     * @param {string} background - Changes background color. By default a random color will be picked and stay will persistent to the given name.
+     * @throws {AppwriteException}
+     * @returns {Promise<ArrayBuffer>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getInitials(name?: string, width?: number, height?: number, background?: string): Promise<ArrayBuffer>;
     /**
-     * Converts a given plain text to a QR code image. You can use the query
-     * parameters to change the size and style of the resulting image.
+     * Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.
      *
      *
-     * @param {string} text
-     * @param {number} size
-     * @param {number} margin
-     * @param {boolean} download
+     * @param {string} params.text - Plain text to be converted to QR code image.
+     * @param {number} params.size - QR code size. Pass an integer between 1 to 1000. Defaults to 400.
+     * @param {number} params.margin - Margin from edge. Pass an integer between 0 to 10. Defaults to 1.
+     * @param {boolean} params.download - Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.
      * @throws {AppwriteException}
      * @returns {ArrayBuffer}
      */
+    getQR(params: {
+        text: string;
+        size?: number;
+        margin?: number;
+        download?: boolean;
+    }): Promise<ArrayBuffer>;
+    /**
+     * Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.
+     *
+     *
+     * @param {string} text - Plain text to be converted to QR code image.
+     * @param {number} size - QR code size. Pass an integer between 1 to 1000. Defaults to 400.
+     * @param {number} margin - Margin from edge. Pass an integer between 0 to 10. Defaults to 1.
+     * @param {boolean} download - Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.
+     * @throws {AppwriteException}
+     * @returns {Promise<ArrayBuffer>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getQR(text: string, size?: number, margin?: number, download?: boolean): Promise<ArrayBuffer>;
     /**
      * You can use this endpoint to show different browser icons to your users.

package/types/services/databases.d.ts

@@ -4,109 +4,250 @@ import type { Models } from '../models';
 export declare class Databases extends Service {
     constructor(client: Client);
     /**
-     * Get a list of all the user's documents in a given collection. You can use
-     * the query params to filter your results.
+     * Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
      *
-     * @param {string} databaseId
-     * @param {string} collectionId
-     * @param {string[]} queries
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @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}
+     * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.listRows` instead.
+     */
+    listDocuments<Document extends Models.Document = Models.DefaultDocument>(params: {
+        databaseId: string;
+        collectionId: string;
+        queries?: string[];
+    }): Promise<Models.DocumentList<Document>>;
+    /**
+     * Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @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.DocumentList<Document>>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
     listDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.DocumentList<Document>>;
     /**
-     * Create a new Document. Before using this route, you should create a new
-     * collection resource using either a [server
-     * integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
-     * API or directly from your database console.
+     * Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
      *
-     * @param {string} databaseId
-     * @param {string} collectionId
-     * @param {string} documentId
-     * @param {object} data
-     * @param {string[]} permissions
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). Make sure to define attributes before creating documents.
+     * @param {string} params.documentId - Document 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 {Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Omit<Document, keyof Models.Document>} params.data - Document 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}
+     * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.createRow` instead.
      */
-    createDocument<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, documentId: string, data: object, permissions?: string[]): Promise<Document>;
+    createDocument<Document extends Models.Document = Models.DefaultDocument>(params: {
+        databaseId: string;
+        collectionId: string;
+        documentId: string;
+        data: Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Omit<Document, keyof Models.Document>;
+        permissions?: string[];
+    }): Promise<Document>;
     /**
-     * Get a document by its unique ID. This endpoint response returns a JSON
-     * object with the document data.
+     * Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
      *
-     * @param {string} databaseId
-     * @param {string} collectionId
-     * @param {string} documentId
-     * @param {string[]} queries
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). Make sure to define attributes before creating documents.
+     * @param {string} documentId - Document 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 {Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Omit<Document, keyof Models.Document>} data - Document 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<Document>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createDocument<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, documentId: string, data: Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Omit<Document, keyof Models.Document>, permissions?: string[]): Promise<Document>;
+    /**
+     * Get a document by its unique ID. This endpoint response returns a JSON object with the document data.
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string} params.documentId - Document 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}
+     * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.getRow` instead.
      */
-    getDocument<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Document>;
+    getDocument<Document extends Models.Document = Models.DefaultDocument>(params: {
+        databaseId: string;
+        collectionId: string;
+        documentId: string;
+        queries?: string[];
+    }): Promise<Document>;
     /**
-     * **WARNING: Experimental Feature** - This endpoint is experimental and not
-     * yet officially supported. It may be subject to breaking changes or removal
-     * in future versions.
+     * Get a document by its unique ID. This endpoint response returns a JSON object with the document data.
      *
-     * Create or update a Document. Before using this route, you should create a
-     * new collection resource using either a [server
-     * integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
-     * API or directly from your database console.
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string} documentId - Document 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<Document>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getDocument<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Document>;
+    /**
+     * Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
      *
-     * @param {string} databaseId
-     * @param {string} collectionId
-     * @param {string} documentId
-     * @param {object} data
-     * @param {string[]} permissions
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID.
+     * @param {string} params.documentId - Document ID.
+     * @param {Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Partial<Omit<Document, keyof Models.Document>>} params.data - Document data as JSON object. Include all required attributes of the document 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}
+     * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.upsertRow` instead.
      */
-    upsertDocument<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, documentId: string, data: object, permissions?: string[]): Promise<Document>;
+    upsertDocument<Document extends Models.Document = Models.DefaultDocument>(params: {
+        databaseId: string;
+        collectionId: string;
+        documentId: string;
+        data: Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Partial<Omit<Document, keyof Models.Document>>;
+        permissions?: string[];
+    }): Promise<Document>;
     /**
-     * Update a document by its unique ID. Using the patch method you can pass
-     * only specific fields that will get updated.
+     * Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
      *
-     * @param {string} databaseId
-     * @param {string} collectionId
-     * @param {string} documentId
-     * @param {object} data
-     * @param {string[]} permissions
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID.
+     * @param {string} documentId - Document ID.
+     * @param {Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Partial<Omit<Document, keyof Models.Document>>} data - Document data as JSON object. Include all required attributes of the document 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<Document>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    upsertDocument<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, documentId: string, data: Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Partial<Omit<Document, keyof Models.Document>>, permissions?: string[]): Promise<Document>;
+    /**
+     * Update a document 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.collectionId - Collection ID.
+     * @param {string} params.documentId - Document ID.
+     * @param {Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Partial<Omit<Document, keyof Models.Document>>} params.data - Document data as JSON object. Include only attribute 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}
+     * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateRow` instead.
+     */
+    updateDocument<Document extends Models.Document = Models.DefaultDocument>(params: {
+        databaseId: string;
+        collectionId: string;
+        documentId: string;
+        data?: Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Partial<Omit<Document, keyof Models.Document>>;
+        permissions?: string[];
+    }): Promise<Document>;
+    /**
+     * Update a document 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} collectionId - Collection ID.
+     * @param {string} documentId - Document ID.
+     * @param {Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Partial<Omit<Document, keyof Models.Document>>} data - Document data as JSON object. Include only attribute 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<Document>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
-    updateDocument<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, documentId: string, data?: object, permissions?: string[]): Promise<Document>;
+    updateDocument<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, documentId: string, data?: Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Partial<Omit<Document, keyof Models.Document>>, permissions?: string[]): Promise<Document>;
     /**
      * Delete a document by its unique ID.
      *
-     * @param {string} databaseId
-     * @param {string} collectionId
-     * @param {string} documentId
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string} params.documentId - Document ID.
      * @throws {AppwriteException}
      * @returns {Promise}
+     * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.deleteRow` instead.
+     */
+    deleteDocument(params: {
+        databaseId: string;
+        collectionId: string;
+        documentId: string;
+    }): Promise<{}>;
+    /**
+     * Delete a document by its unique ID.
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string} documentId - Document ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
     deleteDocument(databaseId: string, collectionId: string, documentId: string): Promise<{}>;
     /**
      * Decrement a specific attribute of a document by a given value.
      *
-     * @param {string} databaseId
-     * @param {string} collectionId
-     * @param {string} documentId
-     * @param {string} attribute
-     * @param {number} value
-     * @param {number} min
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID.
+     * @param {string} params.documentId - Document ID.
+     * @param {string} params.attribute - Attribute key.
+     * @param {number} params.value - Value to increment the attribute by. The value must be a number.
+     * @param {number} params.min - Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.
      * @throws {AppwriteException}
      * @returns {Promise}
+     * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.decrementRowColumn` instead.
+     */
+    decrementDocumentAttribute<Document extends Models.Document = Models.DefaultDocument>(params: {
+        databaseId: string;
+        collectionId: string;
+        documentId: string;
+        attribute: string;
+        value?: number;
+        min?: number;
+    }): Promise<Document>;
+    /**
+     * Decrement a specific attribute of a document by a given value.
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID.
+     * @param {string} documentId - Document ID.
+     * @param {string} attribute - Attribute key.
+     * @param {number} value - Value to increment the attribute by. The value must be a number.
+     * @param {number} min - Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.
+     * @throws {AppwriteException}
+     * @returns {Promise<Document>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
     decrementDocumentAttribute<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, documentId: string, attribute: string, value?: number, min?: number): Promise<Document>;
     /**
      * Increment a specific attribute of a document by a given value.
      *
-     * @param {string} databaseId
-     * @param {string} collectionId
-     * @param {string} documentId
-     * @param {string} attribute
-     * @param {number} value
-     * @param {number} max
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID.
+     * @param {string} params.documentId - Document ID.
+     * @param {string} params.attribute - Attribute key.
+     * @param {number} params.value - Value to increment the attribute by. The value must be a number.
+     * @param {number} params.max - Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.
      * @throws {AppwriteException}
      * @returns {Promise}
+     * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.incrementRowColumn` instead.
+     */
+    incrementDocumentAttribute<Document extends Models.Document = Models.DefaultDocument>(params: {
+        databaseId: string;
+        collectionId: string;
+        documentId: string;
+        attribute: string;
+        value?: number;
+        max?: number;
+    }): Promise<Document>;
+    /**
+     * Increment a specific attribute of a document by a given value.
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID.
+     * @param {string} documentId - Document ID.
+     * @param {string} attribute - Attribute key.
+     * @param {number} value - Value to increment the attribute by. The value must be a number.
+     * @param {number} max - Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.
+     * @throws {AppwriteException}
+     * @returns {Promise<Document>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
     incrementDocumentAttribute<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, documentId: string, attribute: string, value?: number, max?: number): Promise<Document>;
 }