@appwrite.io/console 0.2.0 → 0.3.0

package/types/services/functions.d.ts

@@ -14,7 +14,7 @@ export declare class Functions extends Service {
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     list(queries?: string[], search?: string): Promise<Models.FunctionList>;
     /**
      * Create Function
@@ -31,10 +31,22 @@ export declare class Functions extends Service {
      * @param {string} schedule
      * @param {number} timeout
      * @param {boolean} enabled
+     * @param {boolean} logging
+     * @param {string} entrypoint
+     * @param {string} commands
+     * @param {string} installationId
+     * @param {string} providerRepositoryId
+     * @param {string} providerBranch
+     * @param {boolean} providerSilentMode
+     * @param {string} providerRootDirectory
+     * @param {string} templateRepository
+     * @param {string} templateOwner
+     * @param {string} templateRootDirectory
+     * @param {string} templateBranch
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    create(functionId: string, name: string, runtime: string, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean): Promise<Models.Function>;
+    */
+    create(functionId: string, name: string, runtime: string, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateBranch?: string): Promise<Models.Function>;
     /**
      * List runtimes
      *
@@ -42,7 +54,7 @@ export declare class Functions extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listRuntimes(): Promise<Models.RuntimeList>;
     /**
      * Get Functions Usage
@@ -51,7 +63,7 @@ export declare class Functions extends Service {
      * @param {string} range
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getUsage(range?: string): Promise<Models.UsageFunctions>;
     /**
      * Get Function
@@ -61,7 +73,7 @@ export declare class Functions extends Service {
      * @param {string} functionId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     get(functionId: string): Promise<Models.Function>;
     /**
      * Update Function
@@ -70,15 +82,24 @@ export declare class Functions extends Service {
      *
      * @param {string} functionId
      * @param {string} name
+     * @param {string} runtime
      * @param {string[]} execute
      * @param {string[]} events
      * @param {string} schedule
      * @param {number} timeout
      * @param {boolean} enabled
+     * @param {boolean} logging
+     * @param {string} entrypoint
+     * @param {string} commands
+     * @param {string} installationId
+     * @param {string} providerRepositoryId
+     * @param {string} providerBranch
+     * @param {boolean} providerSilentMode
+     * @param {string} providerRootDirectory
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    update(functionId: string, name: string, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean): Promise<Models.Function>;
+    */
+    update(functionId: string, name: string, runtime: string, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string): Promise<Models.Function>;
     /**
      * Delete Function
      *
@@ -87,7 +108,7 @@ export declare class Functions extends Service {
      * @param {string} functionId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     delete(functionId: string): Promise<{}>;
     /**
      * List Deployments
@@ -100,7 +121,7 @@ export declare class Functions extends Service {
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listDeployments(functionId: string, queries?: string[], search?: string): Promise<Models.DeploymentList>;
     /**
      * Create Deployment
@@ -114,16 +135,17 @@ export declare class Functions extends Service {
      * learn more about code packaging in the [Appwrite Cloud Functions
      * tutorial](/docs/functions).
      *
-     * Use the "command" param to set the entry point used to execute your code.
+     * Use the "command" param to set the entrypoint used to execute your code.
      *
      * @param {string} functionId
-     * @param {string} entrypoint
      * @param {File} code
      * @param {boolean} activate
+     * @param {string} entrypoint
+     * @param {string} commands
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    createDeployment(functionId: string, entrypoint: string, code: File, activate: boolean, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
+    */
+    createDeployment(functionId: string, code: File, activate: boolean, entrypoint?: string, commands?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
     /**
      * Get Deployment
      *
@@ -133,7 +155,7 @@ export declare class Functions extends Service {
      * @param {string} deploymentId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment>;
     /**
      * Update Function Deployment
@@ -146,7 +168,7 @@ export declare class Functions extends Service {
      * @param {string} deploymentId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateDeployment(functionId: string, deploymentId: string): Promise<Models.Function>;
     /**
      * Delete Deployment
@@ -157,7 +179,7 @@ export declare class Functions extends Service {
      * @param {string} deploymentId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     deleteDeployment(functionId: string, deploymentId: string): Promise<{}>;
     /**
      * Create Build
@@ -168,8 +190,18 @@ export declare class Functions extends Service {
      * @param {string} buildId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createBuild(functionId: string, deploymentId: string, buildId: string): Promise<{}>;
+    /**
+     * Download Deployment
+     *
+     *
+     * @param {string} functionId
+     * @param {string} deploymentId
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    downloadDeployment(functionId: string, deploymentId: string): URL;
     /**
      * List Executions
      *
@@ -181,7 +213,7 @@ export declare class Functions extends Service {
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listExecutions(functionId: string, queries?: string[], search?: string): Promise<Models.ExecutionList>;
     /**
      * Create Execution
@@ -192,12 +224,15 @@ export declare class Functions extends Service {
      * function execution process will start asynchronously.
      *
      * @param {string} functionId
-     * @param {string} data
+     * @param {string} body
      * @param {boolean} async
+     * @param {string} path
+     * @param {string} method
+     * @param {object} headers
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    createExecution(functionId: string, data?: string, async?: boolean): Promise<Models.Execution>;
+    */
+    createExecution(functionId: string, body?: string, async?: boolean, path?: string, method?: string, headers?: object): Promise<Models.Execution>;
     /**
      * Get Execution
      *
@@ -207,7 +242,7 @@ export declare class Functions extends Service {
      * @param {string} executionId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getExecution(functionId: string, executionId: string): Promise<Models.Execution>;
     /**
      * Get Function Usage
@@ -217,7 +252,7 @@ export declare class Functions extends Service {
      * @param {string} range
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getFunctionUsage(functionId: string, range?: string): Promise<Models.UsageFunctions>;
     /**
      * List Variables
@@ -227,20 +262,20 @@ export declare class Functions extends Service {
      * @param {string} functionId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listVariables(functionId: string): Promise<Models.VariableList>;
     /**
      * Create Variable
      *
-     * Create a new function variable. These variables can be accessed within
-     * function in the `env` object under the request variable.
+     * Create a new function environment variable. These variables can be accessed
+     * in the function at runtime as environment variables.
      *
      * @param {string} functionId
      * @param {string} key
      * @param {string} value
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createVariable(functionId: string, key: string, value: string): Promise<Models.Variable>;
     /**
      * Get Variable
@@ -251,7 +286,7 @@ export declare class Functions extends Service {
      * @param {string} variableId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getVariable(functionId: string, variableId: string): Promise<Models.Variable>;
     /**
      * Update Variable
@@ -264,7 +299,7 @@ export declare class Functions extends Service {
      * @param {string} value
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateVariable(functionId: string, variableId: string, key: string, value?: string): Promise<Models.Variable>;
     /**
      * Delete Variable
@@ -275,6 +310,6 @@ export declare class Functions extends Service {
      * @param {string} variableId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     deleteVariable(functionId: string, variableId: string): Promise<{}>;
 }

package/types/services/graphql.d.ts

@@ -10,7 +10,7 @@ export declare class Graphql extends Service {
      * @param {object} query
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     query(query: object): Promise<{}>;
     /**
      * GraphQL Endpoint
@@ -20,6 +20,6 @@ export declare class Graphql extends Service {
      * @param {object} query
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     mutation(query: object): Promise<{}>;
 }

package/types/services/health.d.ts

@@ -10,7 +10,7 @@ export declare class Health extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     get(): Promise<Models.HealthStatus>;
     /**
      * Get Antivirus
@@ -19,7 +19,7 @@ export declare class Health extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getAntivirus(): Promise<Models.HealthAntivirus>;
     /**
      * Get Cache
@@ -29,7 +29,7 @@ export declare class Health extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getCache(): Promise<Models.HealthStatus>;
     /**
      * Get DB
@@ -38,7 +38,7 @@ export declare class Health extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getDB(): Promise<Models.HealthStatus>;
     /**
      * Get PubSub
@@ -47,7 +47,7 @@ export declare class Health extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getPubSub(): Promise<Models.HealthStatus>;
     /**
      * Get Queue
@@ -57,7 +57,7 @@ export declare class Health extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getQueue(): Promise<Models.HealthStatus>;
     /**
      * Get Certificates Queue
@@ -68,7 +68,7 @@ export declare class Health extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getQueueCertificates(): Promise<Models.HealthQueue>;
     /**
      * Get Functions Queue
@@ -76,7 +76,7 @@ export declare class Health extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getQueueFunctions(): Promise<Models.HealthQueue>;
     /**
      * Get Logs Queue
@@ -86,7 +86,7 @@ export declare class Health extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getQueueLogs(): Promise<Models.HealthQueue>;
     /**
      * Get Webhooks Queue
@@ -96,7 +96,7 @@ export declare class Health extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getQueueWebhooks(): Promise<Models.HealthQueue>;
     /**
      * Get Local Storage
@@ -105,7 +105,7 @@ export declare class Health extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getStorageLocal(): Promise<Models.HealthStatus>;
     /**
      * Get Time
@@ -120,6 +120,6 @@ export declare class Health extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getTime(): Promise<Models.HealthTime>;
 }

package/types/services/locale.d.ts

@@ -15,8 +15,18 @@ export declare class Locale extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     get(): Promise<Models.Locale>;
+    /**
+     * List Locale 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 Continents
      *
@@ -25,7 +35,7 @@ export declare class Locale extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listContinents(): Promise<Models.ContinentList>;
     /**
      * List Countries
@@ -35,7 +45,7 @@ export declare class Locale extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listCountries(): Promise<Models.CountryList>;
     /**
      * List EU Countries
@@ -45,7 +55,7 @@ export declare class Locale extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listCountriesEU(): Promise<Models.CountryList>;
     /**
      * List Countries Phone Codes
@@ -55,7 +65,7 @@ export declare class Locale extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listCountriesPhones(): Promise<Models.PhoneList>;
     /**
      * List Currencies
@@ -66,7 +76,7 @@ export declare class Locale extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listCurrencies(): Promise<Models.CurrencyList>;
     /**
      * List Languages
@@ -76,6 +86,6 @@ export declare class Locale extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listLanguages(): Promise<Models.LanguageList>;
 }

package/types/services/migrations.d.ts

@@ -0,0 +1,185 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Migrations extends Service {
+    constructor(client: Client);
+    /**
+     * List Migrations
+     *
+     *
+     * @param {string} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    list(queries?: string, search?: string): Promise<Models.MigrationList>;
+    /**
+     * Migrate Appwrite Data
+     *
+     *
+     * @param {string[]} resources
+     * @param {string} endpoint
+     * @param {string} projectId
+     * @param {string} apiKey
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createAppwriteMigration(resources: string[], endpoint: string, projectId: string, apiKey: string): Promise<Models.Migration>;
+    /**
+     * Generate a report on Appwrite Data
+     *
+     *
+     * @param {string[]} resources
+     * @param {string} endpoint
+     * @param {string} projectID
+     * @param {string} key
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getAppwriteReport(resources: string[], endpoint: string, projectID: string, key: string): Promise<Models.MigrationReport>;
+    /**
+     * Migrate Firebase Data (Service Account)
+     *
+     *
+     * @param {string[]} resources
+     * @param {string} serviceAccount
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createFirebaseMigration(resources: string[], serviceAccount: string): Promise<Models.Migration>;
+    /**
+     * Revoke Appwrite&#039;s authorization to access Firebase Projects
+     *
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    deleteFirebaseAuth(): Promise<{}>;
+    /**
+     * Migrate Firebase Data (OAuth)
+     *
+     *
+     * @param {string[]} resources
+     * @param {string} projectId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createFirebaseOAuthMigration(resources: string[], projectId: string): Promise<Models.Migration>;
+    /**
+     * List Firebase Projects
+     *
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listFirebaseProjects(): Promise<Models.FirebaseProjectList>;
+    /**
+     * Generate a report on Firebase Data
+     *
+     *
+     * @param {string[]} resources
+     * @param {string} serviceAccount
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getFirebaseReport(resources: string[], serviceAccount: string): Promise<Models.MigrationReport>;
+    /**
+     * Generate a report on Firebase Data using OAuth
+     *
+     *
+     * @param {string[]} resources
+     * @param {string} projectId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getFirebaseReportOAuth(resources: string[], projectId: string): Promise<Models.MigrationReport>;
+    /**
+     * Migrate NHost Data
+     *
+     *
+     * @param {string[]} resources
+     * @param {string} subdomain
+     * @param {string} region
+     * @param {string} adminSecret
+     * @param {string} database
+     * @param {string} username
+     * @param {string} password
+     * @param {number} port
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createNHostMigration(resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number): Promise<Models.Migration>;
+    /**
+     * Generate a report on NHost Data
+     *
+     *
+     * @param {string[]} resources
+     * @param {string} subdomain
+     * @param {string} region
+     * @param {string} adminSecret
+     * @param {string} database
+     * @param {string} username
+     * @param {string} password
+     * @param {number} port
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getNHostReport(resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number): Promise<Models.MigrationReport>;
+    /**
+     * Migrate Supabase Data
+     *
+     *
+     * @param {string[]} resources
+     * @param {string} endpoint
+     * @param {string} apiKey
+     * @param {string} databaseHost
+     * @param {string} username
+     * @param {string} password
+     * @param {number} port
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createSupabaseMigration(resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number): Promise<Models.Migration>;
+    /**
+     * Generate a report on Supabase Data
+     *
+     *
+     * @param {string[]} resources
+     * @param {string} endpoint
+     * @param {string} apiKey
+     * @param {string} databaseHost
+     * @param {string} username
+     * @param {string} password
+     * @param {number} port
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getSupabaseReport(resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number): Promise<Models.MigrationReport>;
+    /**
+     * Get Migration
+     *
+     *
+     * @param {string} migrationId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    get(migrationId: string): Promise<Models.Migration>;
+    /**
+     * Retry Migration
+     *
+     *
+     * @param {string} migrationId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    retry(migrationId: string): Promise<Models.Migration>;
+    /**
+     * Delete Migration
+     *
+     *
+     * @param {string} migrationId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    delete(migrationId: string): Promise<{}>;
+}