@appwrite.io/console 0.3.0 → 0.4.1

package/types/services/databases.d.ts

@@ -4,7 +4,7 @@ import type { Models } from '../models';
 export declare class Databases extends Service {
     constructor(client: Client);
     /**
-     * List Databases
+     * List databases
      *
      * Get a list of all databases from the current Appwrite project. You can use
      * the search parameter to filter your results.
@@ -16,7 +16,7 @@ export declare class Databases extends Service {
     */
     list(queries?: string[], search?: string): Promise<Models.DatabaseList>;
     /**
-     * Create Database
+     * Create database
      *
      * Create a new Database.
      *
@@ -38,7 +38,7 @@ export declare class Databases extends Service {
     */
     getUsage(range?: string): Promise<Models.UsageDatabases>;
     /**
-     * Get Database
+     * Get database
      *
      * Get a database by its unique ID. This endpoint response returns a JSON
      * object with the database metadata.
@@ -49,7 +49,7 @@ export declare class Databases extends Service {
     */
     get(databaseId: string): Promise<Models.Database>;
     /**
-     * Update Database
+     * Update database
      *
      * Update a database by its unique ID.
      *
@@ -61,7 +61,7 @@ export declare class Databases extends Service {
     */
     update(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
     /**
-     * Delete Database
+     * Delete database
      *
      * Delete a database by its unique ID. Only API keys with with databases.write
      * scope can delete a database.
@@ -72,7 +72,7 @@ export declare class Databases extends Service {
     */
     delete(databaseId: string): Promise<{}>;
     /**
-     * List Collections
+     * List collections
      *
      * Get a list of all collections that belong to the provided databaseId. You
      * can use the search parameter to filter your results.
@@ -85,12 +85,12 @@ export declare class Databases extends Service {
     */
     listCollections(databaseId: string, queries?: string[], search?: string): Promise<Models.CollectionList>;
     /**
-     * Create Collection
+     * Create collection
      *
      * Create a new Collection. Before using this route, you should create a new
      * database resource using either a [server
-     * integration](/docs/server/databases#databasesCreateCollection) API or
-     * directly from your database console.
+     * integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
+     * API or directly from your database console.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -103,7 +103,7 @@ export declare class Databases extends Service {
     */
     createCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.Collection>;
     /**
-     * Get Collection
+     * Get collection
      *
      * Get a collection by its unique ID. This endpoint response returns a JSON
      * object with the collection metadata.
@@ -115,7 +115,7 @@ export declare class Databases extends Service {
     */
     getCollection(databaseId: string, collectionId: string): Promise<Models.Collection>;
     /**
-     * Update Collection
+     * Update collection
      *
      * Update a collection by its unique ID.
      *
@@ -130,7 +130,7 @@ export declare class Databases extends Service {
     */
     updateCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.Collection>;
     /**
-     * Delete Collection
+     * Delete collection
      *
      * Delete a collection by its unique ID. Only users with write permissions
      * have access to delete this resource.
@@ -142,7 +142,7 @@ export declare class Databases extends Service {
     */
     deleteCollection(databaseId: string, collectionId: string): Promise<{}>;
     /**
-     * List Attributes
+     * List attributes
      *
      *
      * @param {string} databaseId
@@ -153,7 +153,7 @@ export declare class Databases extends Service {
     */
     listAttributes(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.AttributeList>;
     /**
-     * Create Boolean Attribute
+     * Create boolean attribute
      *
      * Create a boolean attribute.
      *
@@ -169,7 +169,7 @@ export declare class Databases extends Service {
     */
     createBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean, array?: boolean): Promise<Models.AttributeBoolean>;
     /**
-     * Update Boolean Attribute
+     * Update boolean attribute
      *
      *
      * @param {string} databaseId
@@ -182,7 +182,7 @@ export declare class Databases extends Service {
     */
     updateBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean): Promise<Models.AttributeBoolean>;
     /**
-     * Create DateTime Attribute
+     * Create datetime attribute
      *
      *
      * @param {string} databaseId
@@ -196,7 +196,7 @@ export declare class Databases extends Service {
     */
     createDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeDatetime>;
     /**
-     * Update DateTime Attribute
+     * Update dateTime attribute
      *
      *
      * @param {string} databaseId
@@ -209,7 +209,7 @@ export declare class Databases extends Service {
     */
     updateDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeDatetime>;
     /**
-     * Create Email Attribute
+     * Create email attribute
      *
      * Create an email attribute.
      *
@@ -225,7 +225,7 @@ export declare class Databases extends Service {
     */
     createEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeEmail>;
     /**
-     * Update Email Attribute
+     * Update email attribute
      *
      * Update an email attribute. Changing the `default` value will not update
      * already existing documents.
@@ -241,7 +241,7 @@ export declare class Databases extends Service {
     */
     updateEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeEmail>;
     /**
-     * Create Enum Attribute
+     * Create enum attribute
      *
      *
      * @param {string} databaseId
@@ -256,7 +256,7 @@ export declare class Databases extends Service {
     */
     createEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeEnum>;
     /**
-     * Update Enum Attribute
+     * Update enum attribute
      *
      * Update an enum attribute. Changing the `default` value will not update
      * already existing documents.
@@ -273,7 +273,7 @@ export declare class Databases extends Service {
     */
     updateEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string): Promise<Models.AttributeEnum>;
     /**
-     * Create Float Attribute
+     * Create float attribute
      *
      * Create a float attribute. Optionally, minimum and maximum values can be
      * provided.
@@ -292,7 +292,7 @@ export declare class Databases extends Service {
     */
     createFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min?: number, max?: number, xdefault?: number, array?: boolean): Promise<Models.AttributeFloat>;
     /**
-     * Update Float Attribute
+     * Update float attribute
      *
      * Update a float attribute. Changing the `default` value will not update
      * already existing documents.
@@ -310,7 +310,7 @@ export declare class Databases extends Service {
     */
     updateFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number): Promise<Models.AttributeFloat>;
     /**
-     * Create Integer Attribute
+     * Create integer attribute
      *
      * Create an integer attribute. Optionally, minimum and maximum values can be
      * provided.
@@ -329,7 +329,7 @@ export declare class Databases extends Service {
     */
     createIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min?: number, max?: number, xdefault?: number, array?: boolean): Promise<Models.AttributeInteger>;
     /**
-     * Update Integer Attribute
+     * Update integer attribute
      *
      * Update an integer attribute. Changing the `default` value will not update
      * already existing documents.
@@ -347,7 +347,7 @@ export declare class Databases extends Service {
     */
     updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number): Promise<Models.AttributeInteger>;
     /**
-     * Create IP Address Attribute
+     * Create IP address attribute
      *
      * Create IP address attribute.
      *
@@ -363,7 +363,7 @@ export declare class Databases extends Service {
     */
     createIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeIp>;
     /**
-     * Update IP Address Attribute
+     * Update IP address attribute
      *
      * Update an ip attribute. Changing the `default` value will not update
      * already existing documents.
@@ -379,10 +379,10 @@ export declare class Databases extends Service {
     */
     updateIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeIp>;
     /**
-     * Create Relationship Attribute
+     * Create relationship attribute
      *
      * Create relationship attribute. [Learn more about relationship
-     * attributes](/docs/databases-relationships#relationship-attributes).
+     * attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
      *
      *
      * @param {string} databaseId
@@ -398,7 +398,7 @@ export declare class Databases extends Service {
     */
     createRelationshipAttribute(databaseId: string, collectionId: string, relatedCollectionId: string, type: string, twoWay?: boolean, key?: string, twoWayKey?: string, onDelete?: string): Promise<Models.AttributeRelationship>;
     /**
-     * Create String Attribute
+     * Create string attribute
      *
      * Create a string attribute.
      *
@@ -416,7 +416,7 @@ export declare class Databases extends Service {
     */
     createStringAttribute(databaseId: string, collectionId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.AttributeString>;
     /**
-     * Update String Attribute
+     * Update string attribute
      *
      * Update a string attribute. Changing the `default` value will not update
      * already existing documents.
@@ -432,7 +432,7 @@ export declare class Databases extends Service {
     */
     updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeString>;
     /**
-     * Create URL Attribute
+     * Create URL attribute
      *
      * Create a URL attribute.
      *
@@ -448,7 +448,7 @@ export declare class Databases extends Service {
     */
     createUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeUrl>;
     /**
-     * Update URL Attribute
+     * Update URL attribute
      *
      * Update an url attribute. Changing the `default` value will not update
      * already existing documents.
@@ -464,7 +464,7 @@ export declare class Databases extends Service {
     */
     updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeUrl>;
     /**
-     * Get Attribute
+     * Get attribute
      *
      *
      * @param {string} databaseId
@@ -475,7 +475,7 @@ export declare class Databases extends Service {
     */
     getAttribute(databaseId: string, collectionId: string, key: string): Promise<{}>;
     /**
-     * Delete Attribute
+     * Delete attribute
      *
      *
      * @param {string} databaseId
@@ -486,10 +486,10 @@ export declare class Databases extends Service {
     */
     deleteAttribute(databaseId: string, collectionId: string, key: string): Promise<{}>;
     /**
-     * Update Relationship Attribute
+     * Update relationship attribute
      *
      * Update relationship attribute. [Learn more about relationship
-     * attributes](/docs/databases-relationships#relationship-attributes).
+     * attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
      *
      *
      * @param {string} databaseId
@@ -501,7 +501,7 @@ export declare class Databases extends Service {
     */
     updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: string): Promise<Models.AttributeRelationship>;
     /**
-     * List Documents
+     * List documents
      *
      * Get a list of all the user's documents in a given collection. You can use
      * the query params to filter your results.
@@ -514,12 +514,12 @@ export declare class Databases extends Service {
     */
     listDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.DocumentList<Document>>;
     /**
-     * Create Document
+     * Create document
      *
      * Create a new Document. Before using this route, you should create a new
      * collection resource using either a [server
-     * integration](/docs/server/databases#databasesCreateCollection) API or
-     * directly from your database console.
+     * integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
+     * API or directly from your database console.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -531,7 +531,7 @@ export declare class Databases extends Service {
     */
     createDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data: Omit<Document, keyof Models.Document>, permissions?: string[]): Promise<Document>;
     /**
-     * Get Document
+     * Get document
      *
      * Get a document by its unique ID. This endpoint response returns a JSON
      * object with the document data.
@@ -545,7 +545,7 @@ export declare class Databases extends Service {
     */
     getDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Document>;
     /**
-     * Update Document
+     * Update document
      *
      * Update a document by its unique ID. Using the patch method you can pass
      * only specific fields that will get updated.
@@ -560,7 +560,7 @@ export declare class Databases extends Service {
     */
     updateDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data?: Partial<Omit<Document, keyof Models.Document>>, permissions?: string[]): Promise<Document>;
     /**
-     * Delete Document
+     * Delete document
      *
      * Delete a document by its unique ID.
      *
@@ -572,7 +572,7 @@ export declare class Databases extends Service {
     */
     deleteDocument(databaseId: string, collectionId: string, documentId: string): Promise<{}>;
     /**
-     * List Document Logs
+     * List document logs
      *
      * Get the document activity logs list by its unique ID.
      *
@@ -585,7 +585,7 @@ export declare class Databases extends Service {
     */
     listDocumentLogs(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * List Indexes
+     * List indexes
      *
      *
      * @param {string} databaseId
@@ -596,7 +596,7 @@ export declare class Databases extends Service {
     */
     listIndexes(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.IndexList>;
     /**
-     * Create Index
+     * Create index
      *
      *
      * @param {string} databaseId
@@ -610,7 +610,7 @@ export declare class Databases extends Service {
     */
     createIndex(databaseId: string, collectionId: string, key: string, type: string, attributes: string[], orders?: string[]): Promise<Models.Index>;
     /**
-     * Get Index
+     * Get index
      *
      *
      * @param {string} databaseId
@@ -621,7 +621,7 @@ export declare class Databases extends Service {
     */
     getIndex(databaseId: string, collectionId: string, key: string): Promise<Models.Index>;
     /**
-     * Delete Index
+     * Delete index
      *
      *
      * @param {string} databaseId
@@ -632,7 +632,7 @@ export declare class Databases extends Service {
     */
     deleteIndex(databaseId: string, collectionId: string, key: string): Promise<{}>;
     /**
-     * List Collection Logs
+     * List collection logs
      *
      * Get the collection activity logs list by its unique ID.
      *
@@ -655,7 +655,7 @@ export declare class Databases extends Service {
     */
     getCollectionUsage(databaseId: string, collectionId: string, range?: string): Promise<Models.UsageCollection>;
     /**
-     * List Database Logs
+     * List database logs
      *
      * Get the database activity logs list by its unique ID.
      *

package/types/services/functions.d.ts

@@ -5,7 +5,7 @@ import type { UploadProgress } from '../client';
 export declare class Functions extends Service {
     constructor(client: Client);
     /**
-     * List Functions
+     * List functions
      *
      * Get a list of all the project's functions. You can use the query params to
      * filter your results.
@@ -17,11 +17,12 @@ export declare class Functions extends Service {
     */
     list(queries?: string[], search?: string): Promise<Models.FunctionList>;
     /**
-     * Create Function
+     * Create function
      *
      * Create a new function. You can pass a list of
-     * [permissions](/docs/permissions) to allow different project users or team
-     * with access to execute the function using the client API.
+     * [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
@@ -57,7 +58,7 @@ export declare class Functions extends Service {
     */
     listRuntimes(): Promise<Models.RuntimeList>;
     /**
-     * Get Functions Usage
+     * Get functions usage
      *
      *
      * @param {string} range
@@ -66,7 +67,7 @@ export declare class Functions extends Service {
     */
     getUsage(range?: string): Promise<Models.UsageFunctions>;
     /**
-     * Get Function
+     * Get function
      *
      * Get a function by its unique ID.
      *
@@ -76,7 +77,7 @@ export declare class Functions extends Service {
     */
     get(functionId: string): Promise<Models.Function>;
     /**
-     * Update Function
+     * Update function
      *
      * Update function by its unique ID.
      *
@@ -99,9 +100,9 @@ export declare class Functions extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    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>;
+    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
+     * Delete function
      *
      * Delete a function by its unique ID.
      *
@@ -111,7 +112,7 @@ export declare class Functions extends Service {
     */
     delete(functionId: string): Promise<{}>;
     /**
-     * List Deployments
+     * List deployments
      *
      * Get a list of all the project's code deployments. You can use the query
      * params to filter your results.
@@ -124,7 +125,7 @@ export declare class Functions extends Service {
     */
     listDeployments(functionId: string, queries?: string[], search?: string): Promise<Models.DeploymentList>;
     /**
-     * Create Deployment
+     * 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
@@ -133,7 +134,7 @@ export declare class Functions extends Service {
      * 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](/docs/functions).
+     * tutorial](https://appwrite.io/docs/functions).
      *
      * Use the "command" param to set the entrypoint used to execute your code.
      *
@@ -147,7 +148,7 @@ export declare class Functions extends Service {
     */
     createDeployment(functionId: string, code: File, activate: boolean, entrypoint?: string, commands?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
     /**
-     * Get Deployment
+     * Get deployment
      *
      * Get a code deployment by its unique ID.
      *
@@ -158,7 +159,7 @@ export declare class Functions extends Service {
     */
     getDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment>;
     /**
-     * Update Function Deployment
+     * Update function 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
@@ -171,7 +172,7 @@ export declare class Functions extends Service {
     */
     updateDeployment(functionId: string, deploymentId: string): Promise<Models.Function>;
     /**
-     * Delete Deployment
+     * Delete deployment
      *
      * Delete a code deployment by its unique ID.
      *
@@ -182,8 +183,10 @@ export declare class Functions extends Service {
     */
     deleteDeployment(functionId: string, deploymentId: string): Promise<{}>;
     /**
-     * Create Build
+     * Create build
      *
+     * 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
@@ -195,6 +198,8 @@ export declare class Functions extends Service {
     /**
      * Download Deployment
      *
+     * Get a Deployment's contents by its unique ID. This endpoint supports range
+     * requests for partial or streaming file download.
      *
      * @param {string} functionId
      * @param {string} deploymentId
@@ -203,7 +208,7 @@ export declare class Functions extends Service {
     */
     downloadDeployment(functionId: string, deploymentId: string): URL;
     /**
-     * List Executions
+     * List executions
      *
      * Get a list of all the current user function execution logs. You can use the
      * query params to filter your results.
@@ -216,7 +221,7 @@ export declare class Functions extends Service {
     */
     listExecutions(functionId: string, queries?: string[], search?: string): Promise<Models.ExecutionList>;
     /**
-     * Create Execution
+     * 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
@@ -226,15 +231,15 @@ export declare class Functions extends Service {
      * @param {string} functionId
      * @param {string} body
      * @param {boolean} async
-     * @param {string} path
+     * @param {string} xpath
      * @param {string} method
      * @param {object} headers
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createExecution(functionId: string, body?: string, async?: boolean, path?: string, method?: string, headers?: object): Promise<Models.Execution>;
+    createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: string, headers?: object): Promise<Models.Execution>;
     /**
-     * Get Execution
+     * Get execution
      *
      * Get a function execution log by its unique ID.
      *
@@ -245,7 +250,7 @@ export declare class Functions extends Service {
     */
     getExecution(functionId: string, executionId: string): Promise<Models.Execution>;
     /**
-     * Get Function Usage
+     * Get function usage
      *
      *
      * @param {string} functionId
@@ -255,7 +260,7 @@ export declare class Functions extends Service {
     */
     getFunctionUsage(functionId: string, range?: string): Promise<Models.UsageFunctions>;
     /**
-     * List Variables
+     * List variables
      *
      * Get a list of all variables of a specific function.
      *
@@ -265,7 +270,7 @@ export declare class Functions extends Service {
     */
     listVariables(functionId: string): Promise<Models.VariableList>;
     /**
-     * Create Variable
+     * Create variable
      *
      * Create a new function environment variable. These variables can be accessed
      * in the function at runtime as environment variables.
@@ -278,7 +283,7 @@ export declare class Functions extends Service {
     */
     createVariable(functionId: string, key: string, value: string): Promise<Models.Variable>;
     /**
-     * Get Variable
+     * Get variable
      *
      * Get a variable by its unique ID.
      *
@@ -289,7 +294,7 @@ export declare class Functions extends Service {
     */
     getVariable(functionId: string, variableId: string): Promise<Models.Variable>;
     /**
-     * Update Variable
+     * Update variable
      *
      * Update variable by its unique ID.
      *
@@ -302,7 +307,7 @@ export declare class Functions extends Service {
     */
     updateVariable(functionId: string, variableId: string, key: string, value?: string): Promise<Models.Variable>;
     /**
-     * Delete Variable
+     * Delete variable
      *
      * Delete a variable by its unique ID.
      *

package/types/services/graphql.d.ts

@@ -3,7 +3,7 @@ import { Client } from '../client';
 export declare class Graphql extends Service {
     constructor(client: Client);
     /**
-     * GraphQL Endpoint
+     * GraphQL endpoint
      *
      * Execute a GraphQL mutation.
      *
@@ -13,7 +13,7 @@ export declare class Graphql extends Service {
     */
     query(query: object): Promise<{}>;
     /**
-     * GraphQL Endpoint
+     * GraphQL endpoint
      *
      * Execute a GraphQL mutation.
      *