@appwrite.io/console 2.1.3 → 2.3.0

package/types/services/functions.d.ts

@@ -1,6 +1,9 @@
 import { Client, UploadProgress } from '../client';
 import type { Models } from '../models';
 import { Runtime } from '../enums/runtime';
+import { Scopes } from '../enums/scopes';
+import { Runtimes } from '../enums/runtimes';
+import { UseCases } from '../enums/use-cases';
 import { UsageRange } from '../enums/usage-range';
 import { TemplateReferenceType } from '../enums/template-reference-type';
 import { VCSReferenceType } from '../enums/vcs-reference-type';
@@ -48,7 +51,7 @@ export declare class Functions {
      * @param {boolean} params.logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
      * @param {string} params.entrypoint - Entrypoint File. This path is relative to the "providerRootDirectory".
      * @param {string} params.commands - Build Commands.
-     * @param {string[]} params.scopes - List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.
+     * @param {Scopes[]} params.scopes - List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.
      * @param {string} params.installationId - Appwrite Installation ID for VCS (Version Control System) deployment.
      * @param {string} params.providerRepositoryId - Repository ID of the repo linked to the function.
      * @param {string} params.providerBranch - Production branch for the repo linked to the function.
@@ -70,7 +73,7 @@ export declare class Functions {
         logging?: boolean;
         entrypoint?: string;
         commands?: string;
-        scopes?: string[];
+        scopes?: Scopes[];
         installationId?: string;
         providerRepositoryId?: string;
         providerBranch?: string;
@@ -92,7 +95,7 @@ export declare class Functions {
      * @param {boolean} logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
      * @param {string} entrypoint - Entrypoint File. This path is relative to the "providerRootDirectory".
      * @param {string} commands - Build Commands.
-     * @param {string[]} scopes - List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.
+     * @param {Scopes[]} scopes - List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.
      * @param {string} installationId - Appwrite Installation ID for VCS (Version Control System) deployment.
      * @param {string} providerRepositoryId - Repository ID of the repo linked to the function.
      * @param {string} providerBranch - Production branch for the repo linked to the function.
@@ -103,7 +106,7 @@ export declare class Functions {
      * @returns {Promise<Models.Function>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Function>;
+    create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: Scopes[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Function>;
     /**
      * Get a list of all runtimes that are currently active on your instance.
      *
@@ -121,8 +124,8 @@ export declare class Functions {
     /**
      * List available function templates. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
      *
-     * @param {string[]} params.runtimes - List of runtimes allowed for filtering function templates. Maximum of 100 runtimes are allowed.
-     * @param {string[]} params.useCases - List of use cases allowed for filtering function templates. Maximum of 100 use cases are allowed.
+     * @param {Runtimes[]} params.runtimes - List of runtimes allowed for filtering function templates. Maximum of 100 runtimes are allowed.
+     * @param {UseCases[]} params.useCases - List of use cases allowed for filtering function templates. Maximum of 100 use cases are allowed.
      * @param {number} params.limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
      * @param {number} params.offset - Offset the list of returned templates. Maximum offset is 5000.
      * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
@@ -130,8 +133,8 @@ export declare class Functions {
      * @returns {Promise<Models.TemplateFunctionList>}
      */
     listTemplates(params?: {
-        runtimes?: string[];
-        useCases?: string[];
+        runtimes?: Runtimes[];
+        useCases?: UseCases[];
         limit?: number;
         offset?: number;
         total?: boolean;
@@ -139,8 +142,8 @@ export declare class Functions {
     /**
      * List available function templates. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
      *
-     * @param {string[]} runtimes - List of runtimes allowed for filtering function templates. Maximum of 100 runtimes are allowed.
-     * @param {string[]} useCases - List of use cases allowed for filtering function templates. Maximum of 100 use cases are allowed.
+     * @param {Runtimes[]} runtimes - List of runtimes allowed for filtering function templates. Maximum of 100 runtimes are allowed.
+     * @param {UseCases[]} useCases - List of use cases allowed for filtering function templates. Maximum of 100 use cases are allowed.
      * @param {number} limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
      * @param {number} offset - Offset the list of returned templates. Maximum offset is 5000.
      * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
@@ -148,7 +151,7 @@ export declare class Functions {
      * @returns {Promise<Models.TemplateFunctionList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listTemplates(runtimes?: string[], useCases?: string[], limit?: number, offset?: number, total?: boolean): Promise<Models.TemplateFunctionList>;
+    listTemplates(runtimes?: Runtimes[], useCases?: UseCases[], limit?: number, offset?: number, total?: boolean): Promise<Models.TemplateFunctionList>;
     /**
      * Get a function template using ID. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
      *
@@ -220,7 +223,7 @@ export declare class Functions {
      * @param {boolean} params.logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
      * @param {string} params.entrypoint - Entrypoint File. This path is relative to the "providerRootDirectory".
      * @param {string} params.commands - Build Commands.
-     * @param {string[]} params.scopes - List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.
+     * @param {Scopes[]} params.scopes - List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.
      * @param {string} params.installationId - Appwrite Installation ID for VCS (Version Controle System) deployment.
      * @param {string} params.providerRepositoryId - Repository ID of the repo linked to the function
      * @param {string} params.providerBranch - Production branch for the repo linked to the function
@@ -242,7 +245,7 @@ export declare class Functions {
         logging?: boolean;
         entrypoint?: string;
         commands?: string;
-        scopes?: string[];
+        scopes?: Scopes[];
         installationId?: string;
         providerRepositoryId?: string;
         providerBranch?: string;
@@ -264,7 +267,7 @@ export declare class Functions {
      * @param {boolean} logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
      * @param {string} entrypoint - Entrypoint File. This path is relative to the "providerRootDirectory".
      * @param {string} commands - Build Commands.
-     * @param {string[]} scopes - List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.
+     * @param {Scopes[]} scopes - List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.
      * @param {string} installationId - Appwrite Installation ID for VCS (Version Controle System) deployment.
      * @param {string} providerRepositoryId - Repository ID of the repo linked to the function
      * @param {string} providerBranch - Production branch for the repo linked to the function
@@ -275,7 +278,7 @@ export declare class Functions {
      * @returns {Promise<Models.Function>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Function>;
+    update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: Scopes[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Function>;
     /**
      * Delete a function by its unique ID.
      *

package/types/services/health.d.ts

@@ -59,6 +59,7 @@ export declare class Health {
      */
     getPubSub(): Promise<Models.HealthStatusList>;
     /**
+     * Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.
      *
      * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
      * @throws {AppwriteException}
@@ -68,6 +69,7 @@ export declare class Health {
         threshold?: number;
     }): Promise<Models.HealthQueue>;
     /**
+     * Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.
      *
      * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
      * @throws {AppwriteException}

package/types/services/migrations.d.ts

@@ -1,5 +1,6 @@
 import { Client } from '../client';
 import type { Models } from '../models';
+import { Resources } from '../enums/resources';
 export declare class Migrations {
     client: Client;
     constructor(client: Client);
@@ -31,7 +32,7 @@ export declare class Migrations {
     /**
      * Migrate data from another Appwrite project to your current project. This endpoint allows you to migrate resources like databases, collections, documents, users, and files from an existing Appwrite project.
      *
-     * @param {string[]} params.resources - List of resources to migrate
+     * @param {Resources[]} params.resources - List of resources to migrate
      * @param {string} params.endpoint - Source Appwrite endpoint
      * @param {string} params.projectId - Source Project ID
      * @param {string} params.apiKey - Source API Key
@@ -39,7 +40,7 @@ export declare class Migrations {
      * @returns {Promise<Models.Migration>}
      */
     createAppwriteMigration(params: {
-        resources: string[];
+        resources: Resources[];
         endpoint: string;
         projectId: string;
         apiKey: string;
@@ -47,7 +48,7 @@ export declare class Migrations {
     /**
      * Migrate data from another Appwrite project to your current project. This endpoint allows you to migrate resources like databases, collections, documents, users, and files from an existing Appwrite project.
      *
-     * @param {string[]} resources - List of resources to migrate
+     * @param {Resources[]} resources - List of resources to migrate
      * @param {string} endpoint - Source Appwrite endpoint
      * @param {string} projectId - Source Project ID
      * @param {string} apiKey - Source API Key
@@ -55,11 +56,11 @@ export declare class Migrations {
      * @returns {Promise<Models.Migration>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createAppwriteMigration(resources: string[], endpoint: string, projectId: string, apiKey: string): Promise<Models.Migration>;
+    createAppwriteMigration(resources: Resources[], endpoint: string, projectId: string, apiKey: string): Promise<Models.Migration>;
     /**
      * Generate a report of the data in an Appwrite project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
      *
-     * @param {string[]} params.resources - List of resources to migrate
+     * @param {Resources[]} params.resources - List of resources to migrate
      * @param {string} params.endpoint - Source's Appwrite Endpoint
      * @param {string} params.projectID - Source's Project ID
      * @param {string} params.key - Source's API Key
@@ -67,7 +68,7 @@ export declare class Migrations {
      * @returns {Promise<Models.MigrationReport>}
      */
     getAppwriteReport(params: {
-        resources: string[];
+        resources: Resources[];
         endpoint: string;
         projectID: string;
         key: string;
@@ -75,7 +76,7 @@ export declare class Migrations {
     /**
      * Generate a report of the data in an Appwrite project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
      *
-     * @param {string[]} resources - List of resources to migrate
+     * @param {Resources[]} resources - List of resources to migrate
      * @param {string} endpoint - Source's Appwrite Endpoint
      * @param {string} projectID - Source's Project ID
      * @param {string} key - Source's API Key
@@ -83,7 +84,7 @@ export declare class Migrations {
      * @returns {Promise<Models.MigrationReport>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    getAppwriteReport(resources: string[], endpoint: string, projectID: string, key: string): Promise<Models.MigrationReport>;
+    getAppwriteReport(resources: Resources[], endpoint: string, projectID: string, key: string): Promise<Models.MigrationReport>;
     /**
      * Export documents to a CSV file from your Appwrite database. This endpoint allows you to export documents to a CSV file stored in a secure internal bucket. You'll receive an email with a download link when the export is complete.
      *
@@ -158,51 +159,51 @@ export declare class Migrations {
     /**
      * Migrate data from a Firebase project to your Appwrite project. This endpoint allows you to migrate resources like authentication and other supported services from a Firebase project.
      *
-     * @param {string[]} params.resources - List of resources to migrate
+     * @param {Resources[]} params.resources - List of resources to migrate
      * @param {string} params.serviceAccount - JSON of the Firebase service account credentials
      * @throws {AppwriteException}
      * @returns {Promise<Models.Migration>}
      */
     createFirebaseMigration(params: {
-        resources: string[];
+        resources: Resources[];
         serviceAccount: string;
     }): Promise<Models.Migration>;
     /**
      * Migrate data from a Firebase project to your Appwrite project. This endpoint allows you to migrate resources like authentication and other supported services from a Firebase project.
      *
-     * @param {string[]} resources - List of resources to migrate
+     * @param {Resources[]} resources - List of resources to migrate
      * @param {string} serviceAccount - JSON of the Firebase service account credentials
      * @throws {AppwriteException}
      * @returns {Promise<Models.Migration>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createFirebaseMigration(resources: string[], serviceAccount: string): Promise<Models.Migration>;
+    createFirebaseMigration(resources: Resources[], serviceAccount: string): Promise<Models.Migration>;
     /**
      * Generate a report of the data in a Firebase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
      *
-     * @param {string[]} params.resources - List of resources to migrate
+     * @param {Resources[]} params.resources - List of resources to migrate
      * @param {string} params.serviceAccount - JSON of the Firebase service account credentials
      * @throws {AppwriteException}
      * @returns {Promise<Models.MigrationReport>}
      */
     getFirebaseReport(params: {
-        resources: string[];
+        resources: Resources[];
         serviceAccount: string;
     }): Promise<Models.MigrationReport>;
     /**
      * Generate a report of the data in a Firebase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
      *
-     * @param {string[]} resources - List of resources to migrate
+     * @param {Resources[]} resources - List of resources to migrate
      * @param {string} serviceAccount - JSON of the Firebase service account credentials
      * @throws {AppwriteException}
      * @returns {Promise<Models.MigrationReport>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    getFirebaseReport(resources: string[], serviceAccount: string): Promise<Models.MigrationReport>;
+    getFirebaseReport(resources: Resources[], serviceAccount: string): Promise<Models.MigrationReport>;
     /**
      * Migrate data from an NHost project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from an NHost project.
      *
-     * @param {string[]} params.resources - List of resources to migrate
+     * @param {Resources[]} params.resources - List of resources to migrate
      * @param {string} params.subdomain - Source's Subdomain
      * @param {string} params.region - Source's Region
      * @param {string} params.adminSecret - Source's Admin Secret
@@ -214,7 +215,7 @@ export declare class Migrations {
      * @returns {Promise<Models.Migration>}
      */
     createNHostMigration(params: {
-        resources: string[];
+        resources: Resources[];
         subdomain: string;
         region: string;
         adminSecret: string;
@@ -226,7 +227,7 @@ export declare class Migrations {
     /**
      * Migrate data from an NHost project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from an NHost project.
      *
-     * @param {string[]} resources - List of resources to migrate
+     * @param {Resources[]} resources - List of resources to migrate
      * @param {string} subdomain - Source's Subdomain
      * @param {string} region - Source's Region
      * @param {string} adminSecret - Source's Admin Secret
@@ -238,11 +239,11 @@ export declare class Migrations {
      * @returns {Promise<Models.Migration>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createNHostMigration(resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number): Promise<Models.Migration>;
+    createNHostMigration(resources: Resources[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number): Promise<Models.Migration>;
     /**
      * Generate a detailed report of the data in an NHost project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
      *
-     * @param {string[]} params.resources - List of resources to migrate.
+     * @param {Resources[]} params.resources - List of resources to migrate.
      * @param {string} params.subdomain - Source's Subdomain.
      * @param {string} params.region - Source's Region.
      * @param {string} params.adminSecret - Source's Admin Secret.
@@ -254,7 +255,7 @@ export declare class Migrations {
      * @returns {Promise<Models.MigrationReport>}
      */
     getNHostReport(params: {
-        resources: string[];
+        resources: Resources[];
         subdomain: string;
         region: string;
         adminSecret: string;
@@ -266,7 +267,7 @@ export declare class Migrations {
     /**
      * Generate a detailed report of the data in an NHost project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
      *
-     * @param {string[]} resources - List of resources to migrate.
+     * @param {Resources[]} resources - List of resources to migrate.
      * @param {string} subdomain - Source's Subdomain.
      * @param {string} region - Source's Region.
      * @param {string} adminSecret - Source's Admin Secret.
@@ -278,11 +279,11 @@ export declare class Migrations {
      * @returns {Promise<Models.MigrationReport>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    getNHostReport(resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number): Promise<Models.MigrationReport>;
+    getNHostReport(resources: Resources[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number): Promise<Models.MigrationReport>;
     /**
      * Migrate data from a Supabase project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from a Supabase project.
      *
-     * @param {string[]} params.resources - List of resources to migrate
+     * @param {Resources[]} params.resources - List of resources to migrate
      * @param {string} params.endpoint - Source's Supabase Endpoint
      * @param {string} params.apiKey - Source's API Key
      * @param {string} params.databaseHost - Source's Database Host
@@ -293,7 +294,7 @@ export declare class Migrations {
      * @returns {Promise<Models.Migration>}
      */
     createSupabaseMigration(params: {
-        resources: string[];
+        resources: Resources[];
         endpoint: string;
         apiKey: string;
         databaseHost: string;
@@ -304,7 +305,7 @@ export declare class Migrations {
     /**
      * Migrate data from a Supabase project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from a Supabase project.
      *
-     * @param {string[]} resources - List of resources to migrate
+     * @param {Resources[]} resources - List of resources to migrate
      * @param {string} endpoint - Source's Supabase Endpoint
      * @param {string} apiKey - Source's API Key
      * @param {string} databaseHost - Source's Database Host
@@ -315,11 +316,11 @@ export declare class Migrations {
      * @returns {Promise<Models.Migration>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createSupabaseMigration(resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number): Promise<Models.Migration>;
+    createSupabaseMigration(resources: Resources[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number): Promise<Models.Migration>;
     /**
      * Generate a report of the data in a Supabase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
      *
-     * @param {string[]} params.resources - List of resources to migrate
+     * @param {Resources[]} params.resources - List of resources to migrate
      * @param {string} params.endpoint - Source's Supabase Endpoint.
      * @param {string} params.apiKey - Source's API Key.
      * @param {string} params.databaseHost - Source's Database Host.
@@ -330,7 +331,7 @@ export declare class Migrations {
      * @returns {Promise<Models.MigrationReport>}
      */
     getSupabaseReport(params: {
-        resources: string[];
+        resources: Resources[];
         endpoint: string;
         apiKey: string;
         databaseHost: string;
@@ -341,7 +342,7 @@ export declare class Migrations {
     /**
      * Generate a report of the data in a Supabase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
      *
-     * @param {string[]} resources - List of resources to migrate
+     * @param {Resources[]} resources - List of resources to migrate
      * @param {string} endpoint - Source's Supabase Endpoint.
      * @param {string} apiKey - Source's API Key.
      * @param {string} databaseHost - Source's Database Host.
@@ -352,7 +353,7 @@ export declare class Migrations {
      * @returns {Promise<Models.MigrationReport>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    getSupabaseReport(resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number): Promise<Models.MigrationReport>;
+    getSupabaseReport(resources: Resources[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number): Promise<Models.MigrationReport>;
     /**
      * Get a migration by its unique ID. This endpoint returns detailed information about a specific migration including its current status, progress, and any errors that occurred during the migration process.
      *