react-native-appwrite 0.10.1 → 0.12.0

package/types/services/functions.d.ts

@@ -5,39 +5,84 @@ import { ExecutionMethod } from '../enums/execution-method';
 export declare class Functions extends Service {
     constructor(client: Client);
     /**
-     * Get a list of all the current user function execution logs. You can use the
-     * query params to filter your results.
+     * Get a list of all the current user function execution logs. You can use the query params to filter your results.
      *
-     * @param {string} functionId
-     * @param {string[]} queries
+     * @param {string} params.functionId - Function 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. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId
      * @throws {AppwriteException}
      * @returns {Promise}
-    */
+     */
+    listExecutions(params: {
+        functionId: string;
+        queries?: string[];
+    }): Promise<Models.ExecutionList>;
+    /**
+     * Get a list of all the current user function execution logs. You can use the query params to filter your results.
+     *
+     * @param {string} functionId - Function 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. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ExecutionList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     listExecutions(functionId: string, queries?: string[]): Promise<Models.ExecutionList>;
     /**
-     * Trigger a function execution. The returned object will return you the
-     * current execution status. You can ping the `Get Execution` endpoint to get
-     * updates on the current execution status. Once this endpoint is called, your
-     * function execution process will start asynchronously.
+     * Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.
      *
-     * @param {string} functionId
-     * @param {string} body
-     * @param {boolean} async
-     * @param {string} xpath
-     * @param {ExecutionMethod} method
-     * @param {object} headers
-     * @param {string} scheduledAt
+     * @param {string} params.functionId - Function ID.
+     * @param {string} params.body - HTTP body of execution. Default value is empty string.
+     * @param {boolean} params.async - Execute code in the background. Default value is false.
+     * @param {string} params.xpath - HTTP path of execution. Path can include query params. Default value is /
+     * @param {ExecutionMethod} params.method - HTTP method of execution. Default value is GET.
+     * @param {object} params.headers - HTTP headers of execution. Defaults to empty.
+     * @param {string} params.scheduledAt - Scheduled execution time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.
      * @throws {AppwriteException}
      * @returns {Promise}
-    */
+     */
+    createExecution(params: {
+        functionId: string;
+        body?: string;
+        async?: boolean;
+        xpath?: string;
+        method?: ExecutionMethod;
+        headers?: object;
+        scheduledAt?: string;
+    }): Promise<Models.Execution>;
+    /**
+     * Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.
+     *
+     * @param {string} functionId - Function ID.
+     * @param {string} body - HTTP body of execution. Default value is empty string.
+     * @param {boolean} async - Execute code in the background. Default value is false.
+     * @param {string} xpath - HTTP path of execution. Path can include query params. Default value is /
+     * @param {ExecutionMethod} method - HTTP method of execution. Default value is GET.
+     * @param {object} headers - HTTP headers of execution. Defaults to empty.
+     * @param {string} scheduledAt - Scheduled execution time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Execution>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object, scheduledAt?: string): Promise<Models.Execution>;
     /**
      * Get a function execution log by its unique ID.
      *
-     * @param {string} functionId
-     * @param {string} executionId
+     * @param {string} params.functionId - Function ID.
+     * @param {string} params.executionId - Execution ID.
      * @throws {AppwriteException}
      * @returns {Promise}
-    */
+     */
+    getExecution(params: {
+        functionId: string;
+        executionId: string;
+    }): Promise<Models.Execution>;
+    /**
+     * Get a function execution log by its unique ID.
+     *
+     * @param {string} functionId - Function ID.
+     * @param {string} executionId - Execution ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Execution>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getExecution(functionId: string, executionId: string): Promise<Models.Execution>;
 }

package/types/services/graphql.d.ts

@@ -5,17 +5,39 @@ export declare class Graphql extends Service {
     /**
      * Execute a GraphQL mutation.
      *
-     * @param {object} query
+     * @param {object} params.query - The query or queries to execute.
      * @throws {AppwriteException}
      * @returns {Promise}
-    */
+     */
+    query(params: {
+        query: object;
+    }): Promise<{}>;
+    /**
+     * Execute a GraphQL mutation.
+     *
+     * @param {object} query - The query or queries to execute.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     query(query: object): Promise<{}>;
     /**
      * Execute a GraphQL mutation.
      *
-     * @param {object} query
+     * @param {object} params.query - The query or queries to execute.
      * @throws {AppwriteException}
      * @returns {Promise}
-    */
+     */
+    mutation(params: {
+        query: object;
+    }): Promise<{}>;
+    /**
+     * Execute a GraphQL mutation.
+     *
+     * @param {object} query - The query or queries to execute.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     mutation(query: object): Promise<{}>;
 }

package/types/services/locale.d.ts

@@ -4,72 +4,61 @@ import type { Models } from '../models';
 export declare class Locale extends Service {
     constructor(client: Client);
     /**
-     * Get the current user location based on IP. Returns an object with user
-     * country code, country name, continent name, continent code, ip address and
-     * suggested currency. You can use the locale header to get the data in a
-     * supported language.
+     * Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.
      *
      * ([IP Geolocation by DB-IP](https://db-ip.com))
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-    */
+     */
     get(): Promise<Models.Locale>;
     /**
-     * List of all locale codes in [ISO
-     * 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
+     * List of all locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-    */
+     */
     listCodes(): Promise<Models.LocaleCodeList>;
     /**
-     * List of all continents. You can use the locale header to get the data in a
-     * supported language.
+     * List of all continents. You can use the locale header to get the data in a supported language.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-    */
+     */
     listContinents(): Promise<Models.ContinentList>;
     /**
-     * List of all countries. You can use the locale header to get the data in a
-     * supported language.
+     * List of all countries. You can use the locale header to get the data in a supported language.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-    */
+     */
     listCountries(): Promise<Models.CountryList>;
     /**
-     * List of all countries that are currently members of the EU. You can use the
-     * locale header to get the data in a supported language.
+     * List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-    */
+     */
     listCountriesEU(): Promise<Models.CountryList>;
     /**
-     * List of all countries phone codes. You can use the locale header to get the
-     * data in a supported language.
+     * List of all countries phone codes. You can use the locale header to get the data in a supported language.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-    */
+     */
     listCountriesPhones(): Promise<Models.PhoneList>;
     /**
-     * List of all currencies, including currency symbol, name, plural, and
-     * decimal digits for all major and minor currencies. You can use the locale
-     * header to get the data in a supported language.
+     * List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-    */
+     */
     listCurrencies(): Promise<Models.CurrencyList>;
     /**
-     * List of all languages classified by ISO 639-1 including 2-letter code, name
-     * in English, and name in the respective language.
+     * List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-    */
+     */
     listLanguages(): Promise<Models.LanguageList>;
 }

package/types/services/messaging.d.ts

@@ -6,20 +6,48 @@ export declare class Messaging extends Service {
     /**
      * Create a new subscriber.
      *
-     * @param {string} topicId
-     * @param {string} subscriberId
-     * @param {string} targetId
+     * @param {string} params.topicId - Topic ID. The topic ID to subscribe to.
+     * @param {string} params.subscriberId - Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.
+     * @param {string} params.targetId - Target ID. The target ID to link to the specified Topic ID.
      * @throws {AppwriteException}
      * @returns {Promise}
-    */
+     */
+    createSubscriber(params: {
+        topicId: string;
+        subscriberId: string;
+        targetId: string;
+    }): Promise<Models.Subscriber>;
+    /**
+     * Create a new subscriber.
+     *
+     * @param {string} topicId - Topic ID. The topic ID to subscribe to.
+     * @param {string} subscriberId - Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.
+     * @param {string} targetId - Target ID. The target ID to link to the specified Topic ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Subscriber>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     createSubscriber(topicId: string, subscriberId: string, targetId: string): Promise<Models.Subscriber>;
     /**
      * Delete a subscriber by its unique ID.
      *
-     * @param {string} topicId
-     * @param {string} subscriberId
+     * @param {string} params.topicId - Topic ID. The topic ID subscribed to.
+     * @param {string} params.subscriberId - Subscriber ID.
      * @throws {AppwriteException}
      * @returns {Promise}
-    */
+     */
+    deleteSubscriber(params: {
+        topicId: string;
+        subscriberId: string;
+    }): Promise<{}>;
+    /**
+     * Delete a subscriber by its unique ID.
+     *
+     * @param {string} topicId - Topic ID. The topic ID subscribed to.
+     * @param {string} subscriberId - Subscriber ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     deleteSubscriber(topicId: string, subscriberId: string): Promise<{}>;
 }

package/types/services/storage.d.ts

@@ -7,43 +7,77 @@ import { ImageFormat } from '../enums/image-format';
 export declare class Storage extends Service {
     constructor(client: Client);
     /**
-     * Get a list of all the user files. You can use the query params to filter
-     * your results.
+     * Get a list of all the user files. You can use the query params to filter your results.
      *
-     * @param {string} bucketId
-     * @param {string[]} queries
-     * @param {string} search
+     * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @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. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
+     * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
      * @throws {AppwriteException}
      * @returns {Promise}
-    */
+     */
+    listFiles(params: {
+        bucketId: string;
+        queries?: string[];
+        search?: string;
+    }): Promise<Models.FileList>;
+    /**
+     * Get a list of all the user files. You can use the query params to filter your results.
+     *
+     * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @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. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
+     * @param {string} search - Search term to filter your list results. Max length: 256 chars.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.FileList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     listFiles(bucketId: string, queries?: string[], search?: string): Promise<Models.FileList>;
     /**
-     * Create a new file. Before using this route, you should create a new bucket
-     * resource using either a [server
-     * integration](https://appwrite.io/docs/server/storage#storageCreateBucket)
-     * API or directly from your Appwrite console.
+     * Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https://appwrite.io/docs/server/storage#storageCreateBucket) API or directly from your Appwrite console.
      *
-     * Larger files should be uploaded using multiple requests with the
-     * [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range)
-     * header to send a partial request with a maximum supported chunk of `5MB`.
-     * The `content-range` header values should always be in bytes.
+     * Larger files should be uploaded using multiple requests with the [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.
      *
-     * When the first request is sent, the server will return the **File** object,
-     * and the subsequent part request must include the file's **id** in
-     * `x-appwrite-id` header to allow the server to know that the partial upload
-     * is for the existing file and not for a new one.
+     * When the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.
      *
-     * If you're creating a new file using one of the Appwrite SDKs, all the
-     * chunking logic will be managed by the SDK internally.
+     * If you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.
      *
      *
-     * @param {string} bucketId
-     * @param {string} fileId
-     * @param {{name: string, type: string, size: number, uri: string}} file
-     * @param {string[]} permissions
+     * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @param {string} params.fileId - File 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 {{name: string, type: string, size: number, uri: string}} params.file - Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https://appwrite.io/docs/products/storage/upload-download#input-file).
+     * @param {string[]} params.permissions - An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
      * @throws {AppwriteException}
      * @returns {Promise}
-    */
+     */
+    createFile(params: {
+        bucketId: string;
+        fileId: string;
+        file: {
+            name: string;
+            type: string;
+            size: number;
+            uri: string;
+        };
+        permissions?: string[];
+        onProgress?: (progress: UploadProgress) => void;
+    }): Promise<Models.File>;
+    /**
+     * Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https://appwrite.io/docs/server/storage#storageCreateBucket) API or directly from your Appwrite console.
+     *
+     * Larger files should be uploaded using multiple requests with the [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.
+     *
+     * When the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.
+     *
+     * If you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.
+     *
+     *
+     * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @param {string} fileId - File 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 {{name: string, type: string, size: number, uri: string}} file - Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https://appwrite.io/docs/products/storage/upload-download#input-file).
+     * @param {string[]} permissions - An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.File>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     createFile(bucketId: string, fileId: string, file: {
         name: string;
         type: string;
@@ -51,85 +85,184 @@ export declare class Storage extends Service {
         uri: string;
     }, permissions?: string[], onProgress?: (progress: UploadProgress) => void): Promise<Models.File>;
     /**
-     * Get a file by its unique ID. This endpoint response returns a JSON object
-     * with the file metadata.
+     * Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.
      *
-     * @param {string} bucketId
-     * @param {string} fileId
+     * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @param {string} params.fileId - File ID.
      * @throws {AppwriteException}
      * @returns {Promise}
-    */
+     */
+    getFile(params: {
+        bucketId: string;
+        fileId: string;
+    }): Promise<Models.File>;
+    /**
+     * Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.
+     *
+     * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @param {string} fileId - File ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.File>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getFile(bucketId: string, fileId: string): Promise<Models.File>;
     /**
-     * Update a file by its unique ID. Only users with write permissions have
-     * access to update this resource.
+     * Update a file by its unique ID. Only users with write permissions have access to update this resource.
      *
-     * @param {string} bucketId
-     * @param {string} fileId
-     * @param {string} name
-     * @param {string[]} permissions
+     * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @param {string} params.fileId - File unique ID.
+     * @param {string} params.name - Name of the file
+     * @param {string[]} params.permissions - An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
      * @throws {AppwriteException}
      * @returns {Promise}
-    */
+     */
+    updateFile(params: {
+        bucketId: string;
+        fileId: string;
+        name?: string;
+        permissions?: string[];
+    }): Promise<Models.File>;
+    /**
+     * Update a file by its unique ID. Only users with write permissions have access to update this resource.
+     *
+     * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @param {string} fileId - File unique ID.
+     * @param {string} name - Name of the file
+     * @param {string[]} permissions - An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.File>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     updateFile(bucketId: string, fileId: string, name?: string, permissions?: string[]): Promise<Models.File>;
     /**
-     * Delete a file by its unique ID. Only users with write permissions have
-     * access to delete this resource.
+     * Delete a file by its unique ID. Only users with write permissions have access to delete this resource.
      *
-     * @param {string} bucketId
-     * @param {string} fileId
+     * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @param {string} params.fileId - File ID.
      * @throws {AppwriteException}
      * @returns {Promise}
-    */
+     */
+    deleteFile(params: {
+        bucketId: string;
+        fileId: string;
+    }): Promise<{}>;
+    /**
+     * Delete a file by its unique ID. Only users with write permissions have access to delete this resource.
+     *
+     * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @param {string} fileId - File ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     deleteFile(bucketId: string, fileId: string): Promise<{}>;
     /**
-     * Get a file content by its unique ID. The endpoint response return with a
-     * 'Content-Disposition: attachment' header that tells the browser to start
-     * downloading the file to user downloads directory.
+     * Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.
      *
-     * @param {string} bucketId
-     * @param {string} fileId
-     * @param {string} token
+     * @param {string} params.bucketId - Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @param {string} params.fileId - File ID.
+     * @param {string} params.token - File token for accessing this file.
      * @throws {AppwriteException}
      * @returns {ArrayBuffer}
-    */
+     */
+    getFileDownload(params: {
+        bucketId: string;
+        fileId: string;
+        token?: string;
+    }): Promise<ArrayBuffer>;
+    /**
+     * Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.
+     *
+     * @param {string} bucketId - Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @param {string} fileId - File ID.
+     * @param {string} token - File token for accessing this file.
+     * @throws {AppwriteException}
+     * @returns {Promise<ArrayBuffer>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getFileDownload(bucketId: string, fileId: string, token?: string): Promise<ArrayBuffer>;
     /**
-     * Get a file preview image. Currently, this method supports preview for image
-     * files (jpg, png, and gif), other supported formats, like pdf, docs, slides,
-     * and spreadsheets, will return the file icon image. You can also pass query
-     * string arguments for cutting and resizing your preview image. Preview is
-     * supported only for image files smaller than 10MB.
+     * Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.
      *
-     * @param {string} bucketId
-     * @param {string} fileId
-     * @param {number} width
-     * @param {number} height
-     * @param {ImageGravity} gravity
-     * @param {number} quality
-     * @param {number} borderWidth
-     * @param {string} borderColor
-     * @param {number} borderRadius
-     * @param {number} opacity
-     * @param {number} rotation
-     * @param {string} background
-     * @param {ImageFormat} output
-     * @param {string} token
+     * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @param {string} params.fileId - File ID
+     * @param {number} params.width - Resize preview image width, Pass an integer between 0 to 4000.
+     * @param {number} params.height - Resize preview image height, Pass an integer between 0 to 4000.
+     * @param {ImageGravity} params.gravity - Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right
+     * @param {number} params.quality - Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
+     * @param {number} params.borderWidth - Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.
+     * @param {string} params.borderColor - Preview image border color. Use a valid HEX color, no # is needed for prefix.
+     * @param {number} params.borderRadius - Preview image border radius in pixels. Pass an integer between 0 to 4000.
+     * @param {number} params.opacity - Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.
+     * @param {number} params.rotation - Preview image rotation in degrees. Pass an integer between -360 and 360.
+     * @param {string} params.background - Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.
+     * @param {ImageFormat} params.output - Output format type (jpeg, jpg, png, gif and webp).
+     * @param {string} params.token - File token for accessing this file.
      * @throws {AppwriteException}
      * @returns {ArrayBuffer}
-    */
+     */
+    getFilePreview(params: {
+        bucketId: string;
+        fileId: string;
+        width?: number;
+        height?: number;
+        gravity?: ImageGravity;
+        quality?: number;
+        borderWidth?: number;
+        borderColor?: string;
+        borderRadius?: number;
+        opacity?: number;
+        rotation?: number;
+        background?: string;
+        output?: ImageFormat;
+        token?: string;
+    }): Promise<ArrayBuffer>;
+    /**
+     * Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.
+     *
+     * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @param {string} fileId - File ID
+     * @param {number} width - Resize preview image width, Pass an integer between 0 to 4000.
+     * @param {number} height - Resize preview image height, Pass an integer between 0 to 4000.
+     * @param {ImageGravity} gravity - Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right
+     * @param {number} quality - Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
+     * @param {number} borderWidth - Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.
+     * @param {string} borderColor - Preview image border color. Use a valid HEX color, no # is needed for prefix.
+     * @param {number} borderRadius - Preview image border radius in pixels. Pass an integer between 0 to 4000.
+     * @param {number} opacity - Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.
+     * @param {number} rotation - Preview image rotation in degrees. Pass an integer between -360 and 360.
+     * @param {string} background - Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.
+     * @param {ImageFormat} output - Output format type (jpeg, jpg, png, gif and webp).
+     * @param {string} token - File token for accessing this file.
+     * @throws {AppwriteException}
+     * @returns {Promise<ArrayBuffer>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getFilePreview(bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat, token?: string): Promise<ArrayBuffer>;
     /**
-     * Get a file content by its unique ID. This endpoint is similar to the
-     * download method but returns with no  'Content-Disposition: attachment'
-     * header.
+     * Get a file content by its unique ID. This endpoint is similar to the download method but returns with no  'Content-Disposition: attachment' header.
      *
-     * @param {string} bucketId
-     * @param {string} fileId
-     * @param {string} token
+     * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @param {string} params.fileId - File ID.
+     * @param {string} params.token - File token for accessing this file.
      * @throws {AppwriteException}
      * @returns {ArrayBuffer}
-    */
+     */
+    getFileView(params: {
+        bucketId: string;
+        fileId: string;
+        token?: string;
+    }): Promise<ArrayBuffer>;
+    /**
+     * Get a file content by its unique ID. This endpoint is similar to the download method but returns with no  'Content-Disposition: attachment' header.
+     *
+     * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @param {string} fileId - File ID.
+     * @param {string} token - File token for accessing this file.
+     * @throws {AppwriteException}
+     * @returns {Promise<ArrayBuffer>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getFileView(bucketId: string, fileId: string, token?: string): Promise<ArrayBuffer>;
     /**
      * Get a file content by its unique ID. The endpoint response return with a