@appwrite.io/console 0.6.0-rc.8 → 0.6.0

package/types/services/databases.d.ts

@@ -1,6 +1,10 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
+import { DatabaseUsageRange } from '../enums/database-usage-range';
+import { RelationshipType } from '../enums/relationship-type';
+import { RelationMutate } from '../enums/relation-mutate';
+import { IndexType } from '../enums/index-type';
 export declare class Databases extends Service {
     constructor(client: Client);
     /**
@@ -29,14 +33,14 @@ export declare class Databases extends Service {
     */
     create(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
     /**
-     * Get usage stats for the database
+     * Get databases usage stats
      *
      *
-     * @param {string} range
+     * @param {DatabaseUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getUsage(range?: string): Promise<Models.UsageDatabases>;
+    getUsage(range?: DatabaseUsageRange): Promise<Models.UsageDatabases>;
     /**
      * Get database
      *
@@ -144,6 +148,7 @@ export declare class Databases extends Service {
     /**
      * List attributes
      *
+     * List attributes in the collection.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -171,6 +176,8 @@ export declare class Databases extends Service {
     /**
      * Update boolean attribute
      *
+     * Update a boolean attribute. Changing the `default` value will not update
+     * already existing documents.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -184,6 +191,7 @@ export declare class Databases extends Service {
     /**
      * Create datetime attribute
      *
+     * Create a date time attribute according to the ISO 8601 standard.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -198,6 +206,8 @@ export declare class Databases extends Service {
     /**
      * Update dateTime attribute
      *
+     * Update a date time attribute. Changing the `default` value will not update
+     * already existing documents.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -243,6 +253,9 @@ export declare class Databases extends Service {
     /**
      * Create enum attribute
      *
+     * Create an enumeration attribute. The `elements` param acts as a white-list
+     * of accepted values for this attribute.
+     *
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -388,15 +401,15 @@ export declare class Databases extends Service {
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} relatedCollectionId
-     * @param {string} type
+     * @param {RelationshipType} type
      * @param {boolean} twoWay
      * @param {string} key
      * @param {string} twoWayKey
-     * @param {string} onDelete
+     * @param {RelationMutate} onDelete
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createRelationshipAttribute(databaseId: string, collectionId: string, relatedCollectionId: string, type: string, twoWay?: boolean, key?: string, twoWayKey?: string, onDelete?: string): Promise<Models.AttributeRelationship>;
+    createRelationshipAttribute(databaseId: string, collectionId: string, relatedCollectionId: string, type: RelationshipType, twoWay?: boolean, key?: string, twoWayKey?: string, onDelete?: RelationMutate): Promise<Models.AttributeRelationship>;
     /**
      * Create string attribute
      *
@@ -466,6 +479,7 @@ export declare class Databases extends Service {
     /**
      * Get attribute
      *
+     * Get attribute by ID.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -477,6 +491,7 @@ export declare class Databases extends Service {
     /**
      * Delete attribute
      *
+     * Deletes an attribute.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -495,11 +510,11 @@ export declare class Databases extends Service {
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
-     * @param {string} onDelete
+     * @param {RelationMutate} onDelete
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: string): Promise<Models.AttributeRelationship>;
+    updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate): Promise<Models.AttributeRelationship>;
     /**
      * List documents
      *
@@ -587,6 +602,7 @@ export declare class Databases extends Service {
     /**
      * List indexes
      *
+     * List indexes in the collection.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -598,20 +614,24 @@ export declare class Databases extends Service {
     /**
      * Create index
      *
+     * Creates an index on the attributes listed. Your index should include all
+     * the attributes you will query in a single request.
+     * Attributes can be `key`, `fulltext`, and `unique`.
      *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
-     * @param {string} type
+     * @param {IndexType} type
      * @param {string[]} attributes
      * @param {string[]} orders
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createIndex(databaseId: string, collectionId: string, key: string, type: string, attributes: string[], orders?: string[]): Promise<Models.Index>;
+    createIndex(databaseId: string, collectionId: string, key: string, type: IndexType, attributes: string[], orders?: string[]): Promise<Models.Index>;
     /**
      * Get index
      *
+     * Get index by ID.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -623,6 +643,7 @@ export declare class Databases extends Service {
     /**
      * Delete index
      *
+     * Delete an index.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -644,16 +665,16 @@ export declare class Databases extends Service {
     */
     listCollectionLogs(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * Get usage stats for a collection
+     * Get collection usage stats
      *
      *
      * @param {string} databaseId
      * @param {string} collectionId
-     * @param {string} range
+     * @param {DatabaseUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getCollectionUsage(databaseId: string, collectionId: string, range?: string): Promise<Models.UsageCollection>;
+    getCollectionUsage(databaseId: string, collectionId: string, range?: DatabaseUsageRange): Promise<Models.UsageCollection>;
     /**
      * List database logs
      *
@@ -666,13 +687,13 @@ export declare class Databases extends Service {
     */
     listLogs(databaseId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * Get usage stats for the database
+     * Get database usage stats
      *
      *
      * @param {string} databaseId
-     * @param {string} range
+     * @param {DatabaseUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getDatabaseUsage(databaseId: string, range?: string): Promise<Models.UsageDatabase>;
+    getDatabaseUsage(databaseId: string, range?: DatabaseUsageRange): Promise<Models.UsageDatabase>;
 }

package/types/services/functions.d.ts

@@ -2,6 +2,9 @@ import { Service } from '../service';
 import { Client } 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 {
     constructor(client: Client);
     /**
@@ -26,7 +29,7 @@ export declare class Functions extends Service {
      *
      * @param {string} functionId
      * @param {string} name
-     * @param {string} runtime
+     * @param {Runtime} runtime
      * @param {string[]} execute
      * @param {string[]} events
      * @param {string} schedule
@@ -47,7 +50,7 @@ export declare class Functions extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    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>;
+    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): Promise<Models.Function>;
     /**
      * List runtimes
      *
@@ -61,11 +64,11 @@ export declare class Functions extends Service {
      * Get functions usage
      *
      *
-     * @param {string} range
+     * @param {FunctionUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getUsage(range?: string): Promise<Models.UsageFunctions>;
+    getUsage(range?: FunctionUsageRange): Promise<Models.UsageFunctions>;
     /**
      * Get function
      *
@@ -83,7 +86,7 @@ export declare class Functions extends Service {
      *
      * @param {string} functionId
      * @param {string} name
-     * @param {string} runtime
+     * @param {Runtime} runtime
      * @param {string[]} execute
      * @param {string[]} events
      * @param {string} schedule
@@ -100,7 +103,7 @@ 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?: 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): Promise<Models.Function>;
     /**
      * Delete function
      *
@@ -232,12 +235,12 @@ export declare class Functions extends Service {
      * @param {string} body
      * @param {boolean} async
      * @param {string} xpath
-     * @param {string} method
+     * @param {ExecutionMethod} method
      * @param {object} headers
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: string, headers?: object): Promise<Models.Execution>;
+    createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object): Promise<Models.Execution>;
     /**
      * Get execution
      *
@@ -254,11 +257,11 @@ export declare class Functions extends Service {
      *
      *
      * @param {string} functionId
-     * @param {string} range
+     * @param {FunctionUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getFunctionUsage(functionId: string, range?: string): Promise<Models.UsageFunction>;
+    getFunctionUsage(functionId: string, range?: FunctionUsageRange): Promise<Models.UsageFunction>;
     /**
      * List variables
      *

package/types/services/health.d.ts

@@ -1,6 +1,7 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
+import { Name } from '../enums/name';
 export declare class Health extends Service {
     constructor(client: Client);
     /**
@@ -31,6 +32,16 @@ export declare class Health extends Service {
      * @returns {Promise}
     */
     getCache(): Promise<Models.HealthStatus>;
+    /**
+     * Get the SSL certificate for a domain
+     *
+     * Get the SSL certificate for a domain
+     *
+     * @param {string} domain
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getCertificate(domain?: string): Promise<Models.HealthCertificate>;
     /**
      * Get DB
      *
@@ -105,9 +116,23 @@ export declare class Health extends Service {
      * @returns {Promise}
     */
     getQueueDeletes(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get number of failed queue jobs
+     *
+     * Returns the amount of failed jobs in a given queue.
+     *
+     *
+     * @param {Name} name
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getFailedJobs(name: Name, threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Get functions queue
      *
+     * Get the number of function executions that are waiting to be processed in
+     * the Appwrite internal queue server.
      *
      * @param {number} threshold
      * @throws {AppwriteException}
@@ -158,6 +183,28 @@ export declare class Health extends Service {
      * @returns {Promise}
     */
     getQueueMigrations(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get usage queue
+     *
+     * Get the number of metrics that are waiting to be processed in the Appwrite
+     * internal queue server.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getQueueUsage(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get usage dump queue
+     *
+     * Get the number of projects containing metrics that are waiting to be
+     * processed in the Appwrite internal queue server.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getQueueUsageDump(threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Get webhooks queue
      *
@@ -169,6 +216,15 @@ export declare class Health extends Service {
      * @returns {Promise}
     */
     getQueueWebhooks(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get storage
+     *
+     * Check the Appwrite storage device is up and connection is successful.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getStorage(): Promise<Models.HealthStatus>;
     /**
      * Get local storage
      *