@appwrite.io/console 18.1.0 → 18.3.0-rc.1

package/types/services/avatars.d.ts

@@ -1,4 +1,5 @@
-import { Client } from '../client';
+import { Client, UploadProgress } from '../client';
+import type { Models } from '../models';
 import { Browser } from '../enums/browser';
 import { CreditCard } from '../enums/credit-card';
 import { Flag } from '../enums/flag';
@@ -204,7 +205,7 @@ export declare class Avatars {
      */
     getInitials(name?: string, width?: number, height?: number, background?: string): string;
     /**
-     * Returns the best available profile photo for a user. The endpoint tries each source in priority order and returns the first successful result: OAuth2 identity photo, Gravatar, Libravatar, Appwrite Initials, built-in static fallback.
+     * Returns the best available profile photo for a user. The endpoint tries each source in priority order and returns the first successful result: a custom uploaded photo (see avatars.updatePhoto), OAuth2 identity photo, Gravatar, Libravatar, Appwrite Initials, built-in static fallback.
      *
      * Passing `userId` — `current()` for the authenticated user — resolves the photo from everything known about that user: identity photos, email, and name. An explicit `emailHash` or `name` then overrides just that value, and the user's remaining sources stay in the chain. Without `userId`, passing `emailHash` and/or `name` resolves the avatar from those values alone: the hash is looked up on Gravatar and Libravatar, the name is rendered as initials, and the session user stays out of the chain so their own photo never shadows the avatar being asked for. When nothing is passed, the photo resolves for the currently authenticated user. Emails are only ever accepted pre-hashed, so no address ends up in a URL.
      *
@@ -230,7 +231,7 @@ export declare class Avatars {
         name?: string;
     }): string;
     /**
-     * Returns the best available profile photo for a user. The endpoint tries each source in priority order and returns the first successful result: OAuth2 identity photo, Gravatar, Libravatar, Appwrite Initials, built-in static fallback.
+     * Returns the best available profile photo for a user. The endpoint tries each source in priority order and returns the first successful result: a custom uploaded photo (see avatars.updatePhoto), OAuth2 identity photo, Gravatar, Libravatar, Appwrite Initials, built-in static fallback.
      *
      * Passing `userId` — `current()` for the authenticated user — resolves the photo from everything known about that user: identity photos, email, and name. An explicit `emailHash` or `name` then overrides just that value, and the user's remaining sources stay in the chain. Without `userId`, passing `emailHash` and/or `name` resolves the avatar from those values alone: the hash is looked up on Gravatar and Libravatar, the name is rendered as initials, and the session user stays out of the chain so their own photo never shadows the avatar being asked for. When nothing is passed, the photo resolves for the currently authenticated user. Emails are only ever accepted pre-hashed, so no address ends up in a URL.
      *
@@ -247,6 +248,33 @@ export declare class Avatars {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     getPhoto(width?: number, height?: number, quality?: number, output?: string, rating?: string, userId?: string, emailHash?: string, name?: string): string;
+    /**
+     * Update the profile photo of the currently authenticated user. The uploaded image takes priority over every other photo source, including OAuth2 identity photos, Gravatar, and Libravatar. Updating an already customized photo replaces it. The image must be at most 5MB and is sent in a single request.
+     *
+     * @param {File} params.file - Binary image file of at most 5MB. Allowed file types are png, jpg, jpeg, and webp.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Account<Preferences>>}
+     */
+    updatePhoto<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
+        file: File;
+        onProgress?: (progress: UploadProgress) => void;
+    }): Promise<Models.Account<Preferences>>;
+    /**
+     * Update the profile photo of the currently authenticated user. The uploaded image takes priority over every other photo source, including OAuth2 identity photos, Gravatar, and Libravatar. Updating an already customized photo replaces it. The image must be at most 5MB and is sent in a single request.
+     *
+     * @param {File} file - Binary image file of at most 5MB. Allowed file types are png, jpg, jpeg, and webp.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Account<Preferences>>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updatePhoto<Preferences extends Models.Preferences = Models.DefaultPreferences>(file: File, onProgress?: (progress: UploadProgress) => void): Promise<Models.Account<Preferences>>;
+    /**
+     * Delete the profile photo of the currently authenticated user and store the built-in static placeholder in its place. The placeholder is the user's photo from then on, so it takes priority over every other photo source — OAuth2 identity photos, Gravatar, Libravatar, and initials — until a new photo is uploaded with avatars.updatePhoto.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deletePhoto(): Promise<{}>;
     /**
      * 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.
      *
@@ -285,7 +313,7 @@ export declare class Avatars {
      * When width and height are specified, the image is resized accordingly. If both dimensions are 0, the API provides an image at original size. If dimensions are not specified, the default viewport size is 1280x720px.
      *
      * @param {string} params.url - Website URL which you want to capture.
-     * @param {object} params.headers - HTTP headers to send with the browser request. Defaults to empty.
+     * @param {object} params.headers - HTTP headers to send with the browser request. Only Accept and Accept-Language are allowed. Defaults to empty.
      * @param {number} params.viewportWidth - Browser viewport width. Pass an integer between 1 to 1920. Defaults to 1280.
      * @param {number} params.viewportHeight - Browser viewport height. Pass an integer between 1 to 1080. Defaults to 720.
      * @param {number} params.scale - Browser scale factor. Pass a number between 0.1 to 3. Defaults to 1.
@@ -337,7 +365,7 @@ export declare class Avatars {
      * When width and height are specified, the image is resized accordingly. If both dimensions are 0, the API provides an image at original size. If dimensions are not specified, the default viewport size is 1280x720px.
      *
      * @param {string} url - Website URL which you want to capture.
-     * @param {object} headers - HTTP headers to send with the browser request. Defaults to empty.
+     * @param {object} headers - HTTP headers to send with the browser request. Only Accept and Accept-Language are allowed. Defaults to empty.
      * @param {number} viewportWidth - Browser viewport width. Pass an integer between 1 to 1920. Defaults to 1280.
      * @param {number} viewportHeight - Browser viewport height. Pass an integer between 1 to 1080. Defaults to 720.
      * @param {number} scale - Browser scale factor. Pass a number between 0.1 to 3. Defaults to 1.

package/types/services/console.d.ts

@@ -76,10 +76,22 @@ export declare class Console {
     /**
      * List all OAuth2 providers supported by the Appwrite server, along with the parameters required to configure each provider. The response excludes mock providers but includes sandbox providers.
      *
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.ConsoleOAuth2ProviderList>}
      */
-    listOAuth2Providers(): Promise<Models.ConsoleOAuth2ProviderList>;
+    listOAuth2Providers(params?: {
+        total?: boolean;
+    }): Promise<Models.ConsoleOAuth2ProviderList>;
+    /**
+     * List all OAuth2 providers supported by the Appwrite server, along with the parameters required to configure each provider. The response excludes mock providers but includes sandbox providers.
+     *
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ConsoleOAuth2ProviderList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listOAuth2Providers(total?: boolean): Promise<Models.ConsoleOAuth2ProviderList>;
     /**
      * Return a list of all available plans.
      *
@@ -196,17 +208,41 @@ export declare class Console {
     /**
      * List all scopes available for organization API keys, along with a description for each scope.
      *
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ConsoleKeyScopeList>}
+     */
+    listOrganizationScopes(params?: {
+        total?: boolean;
+    }): Promise<Models.ConsoleKeyScopeList>;
+    /**
+     * List all scopes available for organization API keys, along with a description for each scope.
+     *
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.ConsoleKeyScopeList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listOrganizationScopes(): Promise<Models.ConsoleKeyScopeList>;
+    listOrganizationScopes(total?: boolean): Promise<Models.ConsoleKeyScopeList>;
     /**
      * List all scopes available for project API keys, along with a description for each scope.
      *
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.ConsoleKeyScopeList>}
      */
-    listProjectScopes(): Promise<Models.ConsoleKeyScopeList>;
+    listProjectScopes(params?: {
+        total?: boolean;
+    }): Promise<Models.ConsoleKeyScopeList>;
+    /**
+     * List all scopes available for project API keys, along with a description for each scope.
+     *
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ConsoleKeyScopeList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listProjectScopes(total?: boolean): Promise<Models.ConsoleKeyScopeList>;
     /**
      * Create a new source.
      *

package/types/services/databases.d.ts

@@ -65,22 +65,25 @@ export declare class Databases {
      * List transactions across all databases.
      *
      * @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).
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.TransactionList>}
      * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.listTransactions` instead.
      */
     listTransactions(params?: {
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.TransactionList>;
     /**
      * List transactions across all databases.
      *
      * @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).
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.TransactionList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listTransactions(queries?: string[]): Promise<Models.TransactionList>;
+    listTransactions(queries?: string[], total?: boolean): Promise<Models.TransactionList>;
     /**
      * Create a new transaction.
      *

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

@@ -74,21 +74,24 @@ export declare class DocumentsDB {
      * List transactions across all databases.
      *
      * @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).
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.TransactionList>}
      */
     listTransactions(params?: {
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.TransactionList>;
     /**
      * List transactions across all databases.
      *
      * @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).
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.TransactionList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listTransactions(queries?: string[]): Promise<Models.TransactionList>;
+    listTransactions(queries?: string[], total?: boolean): Promise<Models.TransactionList>;
     /**
      * Create a new transaction.
      *

package/types/services/functions.d.ts

@@ -120,29 +120,44 @@ export declare class Functions {
     /**
      * Get a list of all runtimes that are currently active on your instance.
      *
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.RuntimeList>}
      */
-    listRuntimes(): Promise<Models.RuntimeList>;
+    listRuntimes(params?: {
+        total?: boolean;
+    }): Promise<Models.RuntimeList>;
+    /**
+     * Get a list of all runtimes that are currently active on your instance.
+     *
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.RuntimeList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listRuntimes(total?: boolean): Promise<Models.RuntimeList>;
     /**
      * List allowed function specifications for this instance.
      *
      * @param {string} params.type - Specification type to list. Can be one of: runtimes, builds. Defaults to runtimes.
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.SpecificationList>}
      */
     listSpecifications(params?: {
         type?: string;
+        total?: boolean;
     }): Promise<Models.SpecificationList>;
     /**
      * List allowed function specifications for this instance.
      *
      * @param {string} type - Specification type to list. Can be one of: runtimes, builds. Defaults to runtimes.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.SpecificationList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listSpecifications(type?: string): Promise<Models.SpecificationList>;
+    listSpecifications(type?: string, total?: boolean): Promise<Models.SpecificationList>;
     /**
      * List available function templates. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
      *

package/types/services/locale.d.ts

@@ -15,50 +15,134 @@ export declare class Locale {
     /**
      * List of all locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
      *
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.LocaleCodeList>}
      */
-    listCodes(): Promise<Models.LocaleCodeList>;
+    listCodes(params?: {
+        total?: boolean;
+    }): Promise<Models.LocaleCodeList>;
+    /**
+     * List of all locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
+     *
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.LocaleCodeList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listCodes(total?: boolean): Promise<Models.LocaleCodeList>;
     /**
      * List of all continents. You can use the locale header to get the data in a supported language.
      *
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.ContinentList>}
      */
-    listContinents(): Promise<Models.ContinentList>;
+    listContinents(params?: {
+        total?: boolean;
+    }): Promise<Models.ContinentList>;
+    /**
+     * List of all continents. You can use the locale header to get the data in a supported language.
+     *
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ContinentList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listContinents(total?: boolean): Promise<Models.ContinentList>;
+    /**
+     * List of all countries. You can use the locale header to get the data in a supported language.
+     *
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.CountryList>}
+     */
+    listCountries(params?: {
+        total?: boolean;
+    }): Promise<Models.CountryList>;
     /**
      * List of all countries. You can use the locale header to get the data in a supported language.
      *
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.CountryList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listCountries(total?: boolean): 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.
+     *
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.CountryList>}
      */
-    listCountries(): Promise<Models.CountryList>;
+    listCountriesEU(params?: {
+        total?: boolean;
+    }): 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.
      *
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.CountryList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listCountriesEU(): Promise<Models.CountryList>;
+    listCountriesEU(total?: boolean): Promise<Models.CountryList>;
     /**
      * List of all countries phone codes. You can use the locale header to get the data in a supported language.
      *
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.PhoneList>}
      */
-    listCountriesPhones(): Promise<Models.PhoneList>;
+    listCountriesPhones(params?: {
+        total?: boolean;
+    }): Promise<Models.PhoneList>;
+    /**
+     * List of all countries phone codes. You can use the locale header to get the data in a supported language.
+     *
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.PhoneList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listCountriesPhones(total?: boolean): 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.
      *
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.CurrencyList>}
      */
-    listCurrencies(): Promise<Models.CurrencyList>;
+    listCurrencies(params?: {
+        total?: boolean;
+    }): Promise<Models.CurrencyList>;
+    /**
+     * 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.
+     *
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.CurrencyList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listCurrencies(total?: boolean): 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.
+     *
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.LanguageList>}
+     */
+    listLanguages(params?: {
+        total?: boolean;
+    }): Promise<Models.LanguageList>;
     /**
      * List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.
      *
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.LanguageList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listLanguages(): Promise<Models.LanguageList>;
+    listLanguages(total?: boolean): Promise<Models.LanguageList>;
 }