@appwrite.io/console 0.6.4 → 0.7.0-rc.2

package/types/services/functions.d.ts

@@ -1,31 +1,26 @@
-import { Service } from '../service';
-import { Client } from '../client';
+import { Client, UploadProgress } from '../client';
 import type { Models } from '../models';
-import type { UploadProgress } from '../client';
 import { Runtime } from '../enums/runtime';
 import { FunctionUsageRange } from '../enums/function-usage-range';
 import { ExecutionMethod } from '../enums/execution-method';
-export declare class Functions extends Service {
+export declare class Functions {
+    client: Client;
     constructor(client: Client);
     /**
      * List functions
      *
-     * Get a list of all the project's functions. You can use the query params to
-     * filter your results.
+     * Get a list of all the project's functions. You can use the query params to filter your results.
      *
      * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.FunctionList>}
+     */
     list(queries?: string[], search?: string): Promise<Models.FunctionList>;
     /**
      * Create function
      *
-     * Create a new function. You can pass a list of
-     * [permissions](https://appwrite.io/docs/permissions) to allow different
-     * project users or team with access to execute the function using the client
-     * API.
+     * Create a new function. You can pass a list of [permissions](https://appwrite.io/docs/permissions) to allow different project users or team with access to execute the function using the client API.
      *
      * @param {string} functionId
      * @param {string} name
@@ -38,6 +33,7 @@ export declare class Functions extends Service {
      * @param {boolean} logging
      * @param {string} entrypoint
      * @param {string} commands
+     * @param {string[]} scopes
      * @param {string} installationId
      * @param {string} providerRepositoryId
      * @param {string} providerBranch
@@ -46,39 +42,51 @@ export declare class Functions extends Service {
      * @param {string} templateRepository
      * @param {string} templateOwner
      * @param {string} templateRootDirectory
-     * @param {string} templateBranch
-     * @param {string} specification
+     * @param {string} templateVersion
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
-    create(functionId: string, name: string, runtime: Runtime, 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, specification?: string): Promise<Models.Function>;
+     * @returns {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?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateVersion?: string): Promise<Models.Function>;
     /**
      * List runtimes
      *
      * Get a list of all runtimes that are currently active on your instance.
      *
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.RuntimeList>}
+     */
     listRuntimes(): Promise<Models.RuntimeList>;
     /**
-     * Get available function runtime specifications
+     * List function templates
      *
-     * Get allowed function specifications for this instance.
+     * List available function templates. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
      *
+     * @param {string[]} runtimes
+     * @param {string[]} useCases
+     * @param {number} limit
+     * @param {number} offset
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.TemplateFunctionList>}
+     */
+    listTemplates(runtimes?: string[], useCases?: string[], limit?: number, offset?: number): Promise<Models.TemplateFunctionList>;
+    /**
+     * Get function template
+     *
+     * Get a function template using ID. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
      *
+     * @param {string} templateId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
-    getSpecifications(): Promise<Models.SpecificationList>;
+     * @returns {Promise<Models.TemplateFunction>}
+     */
+    getTemplate(templateId: string): Promise<Models.TemplateFunction>;
     /**
      * Get functions usage
      *
      *
      * @param {FunctionUsageRange} range
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.UsageFunctions>}
+     */
     getUsage(range?: FunctionUsageRange): Promise<Models.UsageFunctions>;
     /**
      * Get function
@@ -87,8 +95,8 @@ export declare class Functions extends Service {
      *
      * @param {string} functionId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Function>}
+     */
     get(functionId: string): Promise<Models.Function>;
     /**
      * Update function
@@ -106,16 +114,16 @@ export declare class Functions extends Service {
      * @param {boolean} logging
      * @param {string} entrypoint
      * @param {string} commands
+     * @param {string[]} scopes
      * @param {string} installationId
      * @param {string} providerRepositoryId
      * @param {string} providerBranch
      * @param {boolean} providerSilentMode
      * @param {string} providerRootDirectory
-     * @param {string} specification
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
-    update(functionId: string, name: string, runtime?: Runtime, 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, specification?: string): Promise<Models.Function>;
+     * @returns {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?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string): Promise<Models.Function>;
     /**
      * Delete function
      *
@@ -123,35 +131,29 @@ export declare class Functions extends Service {
      *
      * @param {string} functionId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<{}>}
+     */
     delete(functionId: string): Promise<{}>;
     /**
      * List deployments
      *
-     * Get a list of all the project's code deployments. You can use the query
-     * params to filter your results.
+     * Get a list of all the project&#039;s code deployments. You can use the query params to filter your results.
      *
      * @param {string} functionId
      * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.DeploymentList>}
+     */
     listDeployments(functionId: string, queries?: string[], search?: string): Promise<Models.DeploymentList>;
     /**
      * Create deployment
      *
-     * Create a new function code deployment. Use this endpoint to upload a new
-     * version of your code function. To execute your newly uploaded code, you'll
-     * need to update the function's deployment to use your new deployment UID.
-     *
-     * This endpoint accepts a tar.gz file compressed with your code. Make sure to
-     * include any dependencies your code has within the compressed file. You can
-     * learn more about code packaging in the [Appwrite Cloud Functions
-     * tutorial](https://appwrite.io/docs/functions).
-     *
-     * Use the "command" param to set the entrypoint used to execute your code.
+     * Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you&#039;ll need to update the function&#039;s deployment to use your new deployment UID.
+
+This endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](https://appwrite.io/docs/functions).
+
+Use the &quot;command&quot; param to set the entrypoint used to execute your code.
      *
      * @param {string} functionId
      * @param {File} code
@@ -159,8 +161,8 @@ export declare class Functions extends Service {
      * @param {string} entrypoint
      * @param {string} commands
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Deployment>}
+     */
     createDeployment(functionId: string, code: File, activate: boolean, entrypoint?: string, commands?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
     /**
      * Get deployment
@@ -170,21 +172,19 @@ export declare class Functions extends Service {
      * @param {string} functionId
      * @param {string} deploymentId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Deployment>}
+     */
     getDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment>;
     /**
      * Update deployment
      *
-     * Update the function code deployment ID using the unique function ID. Use
-     * this endpoint to switch the code deployment that should be executed by the
-     * execution endpoint.
+     * Update the function code deployment ID using the unique function ID. Use this endpoint to switch the code deployment that should be executed by the execution endpoint.
      *
      * @param {string} functionId
      * @param {string} deploymentId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Function>}
+     */
     updateDeployment(functionId: string, deploymentId: string): Promise<Models.Function>;
     /**
      * Delete deployment
@@ -194,54 +194,57 @@ export declare class Functions extends Service {
      * @param {string} functionId
      * @param {string} deploymentId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<{}>}
+     */
     deleteDeployment(functionId: string, deploymentId: string): Promise<{}>;
     /**
-     * Create build
+     * Rebuild deployment
      *
-     * Create a new build for an Appwrite Function deployment. This endpoint can
-     * be used to retry a failed build.
      *
      * @param {string} functionId
      * @param {string} deploymentId
      * @param {string} buildId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
-    createBuild(functionId: string, deploymentId: string, buildId: string): Promise<{}>;
+     * @returns {Promise<{}>}
+     */
+    createBuild(functionId: string, deploymentId: string, buildId?: string): Promise<{}>;
+    /**
+     * Cancel deployment
+     *
+     *
+     * @param {string} functionId
+     * @param {string} deploymentId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Build>}
+     */
+    updateDeploymentBuild(functionId: string, deploymentId: string): Promise<Models.Build>;
     /**
      * Download deployment
      *
-     * Get a Deployment's contents by its unique ID. This endpoint supports range
-     * requests for partial or streaming file download.
+     * Get a Deployment&#039;s contents by its unique ID. This endpoint supports range requests for partial or streaming file download.
      *
      * @param {string} functionId
      * @param {string} deploymentId
      * @throws {AppwriteException}
-     * @returns {URL}
-    */
-    downloadDeployment(functionId: string, deploymentId: string): URL;
+     * @returns {string}
+     */
+    getDeploymentDownload(functionId: string, deploymentId: string): string;
     /**
      * List executions
      *
-     * 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} search
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.ExecutionList>}
+     */
     listExecutions(functionId: string, queries?: string[], search?: string): Promise<Models.ExecutionList>;
     /**
      * Create 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.
+     * 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
@@ -249,10 +252,11 @@ export declare class Functions extends Service {
      * @param {string} xpath
      * @param {ExecutionMethod} method
      * @param {object} headers
+     * @param {string} scheduledAt
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
-    createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object): Promise<Models.Execution>;
+     * @returns {Promise<Models.Execution>}
+     */
+    createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object, scheduledAt?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.Execution>;
     /**
      * Get execution
      *
@@ -261,9 +265,21 @@ export declare class Functions extends Service {
      * @param {string} functionId
      * @param {string} executionId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Execution>}
+     */
     getExecution(functionId: string, executionId: string): Promise<Models.Execution>;
+    /**
+     * Delete execution
+     *
+     * Delete a function execution by its unique ID.
+
+     *
+     * @param {string} functionId
+     * @param {string} executionId
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteExecution(functionId: string, executionId: string): Promise<{}>;
     /**
      * Get function usage
      *
@@ -271,8 +287,8 @@ export declare class Functions extends Service {
      * @param {string} functionId
      * @param {FunctionUsageRange} range
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.UsageFunction>}
+     */
     getFunctionUsage(functionId: string, range?: FunctionUsageRange): Promise<Models.UsageFunction>;
     /**
      * List variables
@@ -281,21 +297,20 @@ export declare class Functions extends Service {
      *
      * @param {string} functionId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.VariableList>}
+     */
     listVariables(functionId: string): Promise<Models.VariableList>;
     /**
      * Create variable
      *
-     * Create a new function environment variable. These variables can be accessed
-     * in the function at runtime as environment variables.
+     * 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}
-    */
+     * @returns {Promise<Models.Variable>}
+     */
     createVariable(functionId: string, key: string, value: string): Promise<Models.Variable>;
     /**
      * Get variable
@@ -305,8 +320,8 @@ export declare class Functions extends Service {
      * @param {string} functionId
      * @param {string} variableId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Variable>}
+     */
     getVariable(functionId: string, variableId: string): Promise<Models.Variable>;
     /**
      * Update variable
@@ -318,8 +333,8 @@ export declare class Functions extends Service {
      * @param {string} key
      * @param {string} value
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Variable>}
+     */
     updateVariable(functionId: string, variableId: string, key: string, value?: string): Promise<Models.Variable>;
     /**
      * Delete variable
@@ -329,7 +344,7 @@ export declare class Functions extends Service {
      * @param {string} functionId
      * @param {string} variableId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<{}>}
+     */
     deleteVariable(functionId: string, variableId: string): Promise<{}>;
 }

package/types/services/graphql.d.ts

@@ -1,6 +1,6 @@
-import { Service } from '../service';
 import { Client } from '../client';
-export declare class Graphql extends Service {
+export declare class Graphql {
+    client: Client;
     constructor(client: Client);
     /**
      * GraphQL endpoint
@@ -9,8 +9,8 @@ export declare class Graphql extends Service {
      *
      * @param {object} query
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<{}>}
+     */
     query(query: object): Promise<{}>;
     /**
      * GraphQL endpoint
@@ -19,7 +19,7 @@ export declare class Graphql extends Service {
      *
      * @param {object} query
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<{}>}
+     */
     mutation(query: object): Promise<{}>;
 }