@appwrite.io/console 2.1.2 → 2.2.0

package/types/services/account.d.ts

@@ -1,5 +1,6 @@
 import { Client } from '../client';
 import type { Models } from '../models';
+import { Scopes } from '../enums/scopes';
 import { AuthenticatorType } from '../enums/authenticator-type';
 import { AuthenticationFactor } from '../enums/authentication-factor';
 import { OAuthProvider } from '../enums/o-auth-provider';
@@ -300,6 +301,116 @@ export declare class Account {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     createJWT(duration?: number): Promise<Models.Jwt>;
+    /**
+     * Get a list of all API keys from the current account.
+     *
+     * @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.KeyList>}
+     */
+    listKeys(params?: {
+        total?: boolean;
+    }): Promise<Models.KeyList>;
+    /**
+     * Get a list of all API keys from the current account.
+     *
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.KeyList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listKeys(total?: boolean): Promise<Models.KeyList>;
+    /**
+     * Create a new account API key.
+     *
+     * @param {string} params.name - Key name. Max length: 128 chars.
+     * @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
+     * @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Key>}
+     */
+    createKey(params: {
+        name: string;
+        scopes: Scopes[];
+        expire?: string;
+    }): Promise<Models.Key>;
+    /**
+     * Create a new account API key.
+     *
+     * @param {string} name - Key name. Max length: 128 chars.
+     * @param {Scopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
+     * @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Key>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createKey(name: string, scopes: Scopes[], expire?: string): Promise<Models.Key>;
+    /**
+     * Get a key by its unique ID. This endpoint returns details about a specific API key in your account including it's scopes.
+     *
+     * @param {string} params.keyId - Key unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Key>}
+     */
+    getKey(params: {
+        keyId: string;
+    }): Promise<Models.Key>;
+    /**
+     * Get a key by its unique ID. This endpoint returns details about a specific API key in your account including it's scopes.
+     *
+     * @param {string} keyId - Key unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Key>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getKey(keyId: string): Promise<Models.Key>;
+    /**
+     * Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
+     *
+     * @param {string} params.keyId - Key unique ID.
+     * @param {string} params.name - Key name. Max length: 128 chars.
+     * @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
+     * @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Key>}
+     */
+    updateKey(params: {
+        keyId: string;
+        name: string;
+        scopes: Scopes[];
+        expire?: string;
+    }): Promise<Models.Key>;
+    /**
+     * Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
+     *
+     * @param {string} keyId - Key unique ID.
+     * @param {string} name - Key name. Max length: 128 chars.
+     * @param {Scopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
+     * @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Key>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateKey(keyId: string, name: string, scopes: Scopes[], expire?: string): Promise<Models.Key>;
+    /**
+     * Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
+     *
+     * @param {string} params.keyId - Key unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteKey(params: {
+        keyId: string;
+    }): Promise<{}>;
+    /**
+     * Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
+     *
+     * @param {string} keyId - Key unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteKey(keyId: string): Promise<{}>;
     /**
      * Get the list of latest security activity logs for the currently logged in user. Each log returns user IP address, location and date and time of log.
      *

package/types/services/avatars.d.ts

@@ -4,6 +4,7 @@ import { CreditCard } from '../enums/credit-card';
 import { Flag } from '../enums/flag';
 import { Theme } from '../enums/theme';
 import { Timezone } from '../enums/timezone';
+import { BrowserPermission } from '../enums/browser-permission';
 import { ImageFormat } from '../enums/image-format';
 export declare class Avatars {
     client: Client;
@@ -253,7 +254,7 @@ export declare class Avatars {
      * @param {number} params.longitude - Geolocation longitude. Pass a number between -180 to 180. Defaults to 0.
      * @param {number} params.accuracy - Geolocation accuracy in meters. Pass a number between 0 to 100000. Defaults to 0.
      * @param {boolean} params.touch - Enable touch support. Pass 0 for no touch, or 1 for touch enabled. Defaults to 0.
-     * @param {string[]} params.permissions - Browser permissions to grant. Pass an array of permission names like ["geolocation", "camera", "microphone"]. Defaults to empty.
+     * @param {BrowserPermission[]} params.permissions - Browser permissions to grant. Pass an array of permission names like ["geolocation", "camera", "microphone"]. Defaults to empty.
      * @param {number} params.sleep - Wait time in seconds before taking the screenshot. Pass an integer between 0 to 10. Defaults to 0.
      * @param {number} params.width - Output image width. Pass 0 to use original width, or an integer between 1 to 2000. Defaults to 0 (original width).
      * @param {number} params.height - Output image height. Pass 0 to use original height, or an integer between 1 to 2000. Defaults to 0 (original height).
@@ -277,7 +278,7 @@ export declare class Avatars {
         longitude?: number;
         accuracy?: number;
         touch?: boolean;
-        permissions?: string[];
+        permissions?: BrowserPermission[];
         sleep?: number;
         width?: number;
         height?: number;
@@ -305,7 +306,7 @@ export declare class Avatars {
      * @param {number} longitude - Geolocation longitude. Pass a number between -180 to 180. Defaults to 0.
      * @param {number} accuracy - Geolocation accuracy in meters. Pass a number between 0 to 100000. Defaults to 0.
      * @param {boolean} touch - Enable touch support. Pass 0 for no touch, or 1 for touch enabled. Defaults to 0.
-     * @param {string[]} permissions - Browser permissions to grant. Pass an array of permission names like ["geolocation", "camera", "microphone"]. Defaults to empty.
+     * @param {BrowserPermission[]} permissions - Browser permissions to grant. Pass an array of permission names like ["geolocation", "camera", "microphone"]. Defaults to empty.
      * @param {number} sleep - Wait time in seconds before taking the screenshot. Pass an integer between 0 to 10. Defaults to 0.
      * @param {number} width - Output image width. Pass 0 to use original width, or an integer between 1 to 2000. Defaults to 0 (original width).
      * @param {number} height - Output image height. Pass 0 to use original height, or an integer between 1 to 2000. Defaults to 0 (original height).
@@ -315,5 +316,5 @@ export declare class Avatars {
      * @returns {string}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    getScreenshot(url: string, headers?: object, viewportWidth?: number, viewportHeight?: number, scale?: number, theme?: Theme, userAgent?: string, fullpage?: boolean, locale?: string, timezone?: Timezone, latitude?: number, longitude?: number, accuracy?: number, touch?: boolean, permissions?: string[], sleep?: number, width?: number, height?: number, quality?: number, output?: ImageFormat): string;
+    getScreenshot(url: string, headers?: object, viewportWidth?: number, viewportHeight?: number, scale?: number, theme?: Theme, userAgent?: string, fullpage?: boolean, locale?: string, timezone?: Timezone, latitude?: number, longitude?: number, accuracy?: number, touch?: boolean, permissions?: BrowserPermission[], sleep?: number, width?: number, height?: number, quality?: number, output?: ImageFormat): string;
 }

package/types/services/backups.d.ts

@@ -1,5 +1,6 @@
 import { Client } from '../client';
 import type { Models } from '../models';
+import { Services } from '../enums/services';
 export declare class Backups {
     client: Client;
     constructor(client: Client);
@@ -25,25 +26,25 @@ export declare class Backups {
     /**
      * Create a new archive asynchronously for a project.
      *
-     * @param {string[]} params.services - Array of services to backup
+     * @param {Services[]} params.services - Array of services to backup
      * @param {string} params.resourceId - Resource ID. When set, only this single resource will be backed up.
      * @throws {AppwriteException}
      * @returns {Promise<Models.BackupArchive>}
      */
     createArchive(params: {
-        services: string[];
+        services: Services[];
         resourceId?: string;
     }): Promise<Models.BackupArchive>;
     /**
      * Create a new archive asynchronously for a project.
      *
-     * @param {string[]} services - Array of services to backup
+     * @param {Services[]} services - Array of services to backup
      * @param {string} resourceId - Resource ID. When set, only this single resource will be backed up.
      * @throws {AppwriteException}
      * @returns {Promise<Models.BackupArchive>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createArchive(services: string[], resourceId?: string): Promise<Models.BackupArchive>;
+    createArchive(services: Services[], resourceId?: string): Promise<Models.BackupArchive>;
     /**
      * Get a backup archive using it's ID.
      *
@@ -105,7 +106,7 @@ export declare class Backups {
      * Create a new backup policy.
      *
      * @param {string} params.policyId - Policy 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 {string[]} params.services - Array of services to backup
+     * @param {Services[]} params.services - Array of services to backup
      * @param {number} params.retention - Days to keep backups before deletion
      * @param {string} params.schedule - Schedule CRON syntax.
      * @param {string} params.name - Policy name. Max length: 128 chars.
@@ -116,7 +117,7 @@ export declare class Backups {
      */
     createPolicy(params: {
         policyId: string;
-        services: string[];
+        services: Services[];
         retention: number;
         schedule: string;
         name?: string;
@@ -127,7 +128,7 @@ export declare class Backups {
      * Create a new backup policy.
      *
      * @param {string} policyId - Policy 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 {string[]} services - Array of services to backup
+     * @param {Services[]} services - Array of services to backup
      * @param {number} retention - Days to keep backups before deletion
      * @param {string} schedule - Schedule CRON syntax.
      * @param {string} name - Policy name. Max length: 128 chars.
@@ -137,7 +138,7 @@ export declare class Backups {
      * @returns {Promise<Models.BackupPolicy>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createPolicy(policyId: string, services: string[], retention: number, schedule: string, name?: string, resourceId?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
+    createPolicy(policyId: string, services: Services[], retention: number, schedule: string, name?: string, resourceId?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
     /**
      * Get a backup policy using it's ID.
      *
@@ -211,7 +212,7 @@ export declare class Backups {
      * Create and trigger a new restoration for a backup on a project.
      *
      * @param {string} params.archiveId - Backup archive ID to restore
-     * @param {string[]} params.services - Array of services to restore
+     * @param {Services[]} params.services - Array of services to restore
      * @param {string} params.newResourceId - Unique 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 {string} params.newResourceName - Database name. Max length: 128 chars.
      * @throws {AppwriteException}
@@ -219,7 +220,7 @@ export declare class Backups {
      */
     createRestoration(params: {
         archiveId: string;
-        services: string[];
+        services: Services[];
         newResourceId?: string;
         newResourceName?: string;
     }): Promise<Models.BackupRestoration>;
@@ -227,14 +228,14 @@ export declare class Backups {
      * Create and trigger a new restoration for a backup on a project.
      *
      * @param {string} archiveId - Backup archive ID to restore
-     * @param {string[]} services - Array of services to restore
+     * @param {Services[]} services - Array of services to restore
      * @param {string} newResourceId - Unique 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 {string} newResourceName - Database name. Max length: 128 chars.
      * @throws {AppwriteException}
      * @returns {Promise<Models.BackupRestoration>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createRestoration(archiveId: string, services: string[], newResourceId?: string, newResourceName?: string): Promise<Models.BackupRestoration>;
+    createRestoration(archiveId: string, services: Services[], newResourceId?: string, newResourceName?: string): Promise<Models.BackupRestoration>;
     /**
      * List all backup restorations for a project.
      *

package/types/services/console.d.ts

@@ -122,22 +122,10 @@ export declare class Console {
     /**
      * Get all available regions for the console.
      *
-     * @param {string} params.organizationId - Team ID.
      * @throws {AppwriteException}
      * @returns {Promise<Models.ConsoleRegionList>}
      */
-    getRegions(params: {
-        organizationId: string;
-    }): Promise<Models.ConsoleRegionList>;
-    /**
-     * Get all available regions for the console.
-     *
-     * @param {string} organizationId - Team ID.
-     * @throws {AppwriteException}
-     * @returns {Promise<Models.ConsoleRegionList>}
-     * @deprecated Use the object parameter style method for a better developer experience.
-     */
-    getRegions(organizationId: string): Promise<Models.ConsoleRegionList>;
+    listRegions(): Promise<Models.ConsoleRegionList>;
     /**
      * Check if a resource ID is available.
      *