@appwrite.io/console 0.5.0 → 0.6.0-rc.10

package/src/services/assistant.ts

@@ -2,6 +2,7 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
+import { Query } from '../query';
 
 export class Assistant extends Service {
 

package/src/services/avatars.ts

@@ -2,6 +2,10 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
+import { Query } from '../query';
+import { Browser } from '../enums/browser';
+import { CreditCard } from '../enums/credit-card';
+import { Flag } from '../enums/flag';
 
 export class Avatars extends Service {
 
@@ -24,14 +28,14 @@ export class Avatars extends Service {
      * image at source quality. If dimensions are not specified, the default size
      * of image returned is 100x100px.
      *
-     * @param {string} code
+     * @param {Browser} code
      * @param {number} width
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getBrowser(code: string, width?: number, height?: number, quality?: number): URL {
+    getBrowser(code: Browser, width?: number, height?: number, quality?: number): URL {
         if (typeof code === 'undefined') {
             throw new AppwriteException('Missing required parameter: "code"');
         }
@@ -74,14 +78,14 @@ export class Avatars extends Service {
      * of image returned is 100x100px.
      * 
      *
-     * @param {string} code
+     * @param {CreditCard} code
      * @param {number} width
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getCreditCard(code: string, width?: number, height?: number, quality?: number): URL {
+    getCreditCard(code: CreditCard, width?: number, height?: number, quality?: number): URL {
         if (typeof code === 'undefined') {
             throw new AppwriteException('Missing required parameter: "code"');
         }
@@ -158,14 +162,14 @@ export class Avatars extends Service {
      * of image returned is 100x100px.
      * 
      *
-     * @param {string} code
+     * @param {Flag} code
      * @param {number} width
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getFlag(code: string, width?: number, height?: number, quality?: number): URL {
+    getFlag(code: Flag, width?: number, height?: number, quality?: number): URL {
         if (typeof code === 'undefined') {
             throw new AppwriteException('Missing required parameter: "code"');
         }

package/src/services/console.ts

@@ -2,6 +2,7 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
+import { Query } from '../query';
 
 export class Console extends Service {
 

package/src/services/databases.ts

@@ -2,6 +2,11 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
+import { Query } from '../query';
+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 class Databases extends Service {
 
@@ -85,11 +90,11 @@ export class Databases extends Service {
      * Get usage stats for the database
      *
      *
-     * @param {string} range
+     * @param {DatabaseUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async getUsage(range?: string): Promise<Models.UsageDatabases> {
+    async getUsage(range?: DatabaseUsageRange): Promise<Models.UsageDatabases> {
         const apiPath = '/databases/usage';
         const payload: Payload = {};
 
@@ -1269,15 +1274,15 @@ export 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}
     */
-    async createRelationshipAttribute(databaseId: string, collectionId: string, relatedCollectionId: string, type: string, twoWay?: boolean, key?: string, twoWayKey?: string, onDelete?: string): Promise<Models.AttributeRelationship> {
+    async createRelationshipAttribute(databaseId: string, collectionId: string, relatedCollectionId: string, type: RelationshipType, twoWay?: boolean, key?: string, twoWayKey?: string, onDelete?: RelationMutate): Promise<Models.AttributeRelationship> {
         if (typeof databaseId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "databaseId"');
         }
@@ -1635,11 +1640,11 @@ export class Databases extends Service {
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
-     * @param {string} onDelete
+     * @param {RelationMutate} onDelete
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: string): Promise<Models.AttributeRelationship> {
+    async updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate): Promise<Models.AttributeRelationship> {
         if (typeof databaseId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "databaseId"');
         }
@@ -1946,13 +1951,13 @@ export class Databases extends Service {
      * @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}
     */
-    async createIndex(databaseId: string, collectionId: string, key: string, type: string, attributes: string[], orders?: string[]): Promise<Models.Index> {
+    async createIndex(databaseId: string, collectionId: string, key: string, type: IndexType, attributes: string[], orders?: string[]): Promise<Models.Index> {
         if (typeof databaseId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "databaseId"');
         }
@@ -2101,11 +2106,11 @@ export class Databases extends Service {
      *
      * @param {string} databaseId
      * @param {string} collectionId
-     * @param {string} range
+     * @param {DatabaseUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async getCollectionUsage(databaseId: string, collectionId: string, range?: string): Promise<Models.UsageCollection> {
+    async getCollectionUsage(databaseId: string, collectionId: string, range?: DatabaseUsageRange): Promise<Models.UsageCollection> {
         if (typeof databaseId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "databaseId"');
         }
@@ -2160,11 +2165,11 @@ export class Databases extends Service {
      *
      *
      * @param {string} databaseId
-     * @param {string} range
+     * @param {DatabaseUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async getDatabaseUsage(databaseId: string, range?: string): Promise<Models.UsageDatabase> {
+    async getDatabaseUsage(databaseId: string, range?: DatabaseUsageRange): Promise<Models.UsageDatabase> {
         if (typeof databaseId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "databaseId"');
         }

package/src/services/functions.ts

@@ -2,6 +2,10 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
+import { Query } from '../query';
+import { Runtime } from '../enums/runtime';
+import { FunctionUsageRange } from '../enums/function-usage-range';
+import { ExecutionMethod } from '../enums/execution-method';
 
 export class Functions extends Service {
 
@@ -49,7 +53,7 @@ export 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
@@ -70,7 +74,7 @@ export class Functions extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async 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> {
+    async 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> {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
@@ -194,11 +198,11 @@ export class Functions extends Service {
      * Get functions usage
      *
      *
-     * @param {string} range
+     * @param {FunctionUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async getUsage(range?: string): Promise<Models.UsageFunctions> {
+    async getUsage(range?: FunctionUsageRange): Promise<Models.UsageFunctions> {
         const apiPath = '/functions/usage';
         const payload: Payload = {};
 
@@ -242,7 +246,7 @@ export 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
@@ -259,7 +263,7 @@ export class Functions extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async 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> {
+    async 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> {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
@@ -694,12 +698,12 @@ export 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}
     */
-    async createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: string, headers?: object): Promise<Models.Execution> {
+    async createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object): Promise<Models.Execution> {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
@@ -766,11 +770,11 @@ export class Functions extends Service {
      *
      *
      * @param {string} functionId
-     * @param {string} range
+     * @param {FunctionUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async getFunctionUsage(functionId: string, range?: string): Promise<Models.UsageFunction> {
+    async getFunctionUsage(functionId: string, range?: FunctionUsageRange): Promise<Models.UsageFunction> {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }

package/src/services/graphql.ts

@@ -2,6 +2,7 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
+import { Query } from '../query';
 
 export class Graphql extends Service {
 

package/src/services/health.ts

@@ -2,6 +2,8 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
+import { Query } from '../query';
+import { Name } from '../enums/name';
 
 export class Health extends Service {
 
@@ -65,6 +67,29 @@ export class Health extends Service {
         }, payload);
     }
 
+    /**
+     * Get the SSL certificate for a domain
+     *
+     * Get the SSL certificate for a domain
+     *
+     * @param {string} domain
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async getCertificate(domain?: string): Promise<Models.HealthCertificate> {
+        const apiPath = '/health/certificate';
+        const payload: Payload = {};
+
+        if (typeof domain !== 'undefined') {
+            payload['domain'] = domain;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('get', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Get DB
      *
@@ -222,6 +247,35 @@ export class Health extends Service {
         }, payload);
     }
 
+    /**
+     * 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}
+    */
+    async getFailedJobs(name: Name, threshold?: number): Promise<Models.HealthQueue> {
+        if (typeof name === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "name"');
+        }
+
+        const apiPath = '/health/queue/failed/{name}'.replace('{name}', name);
+        const payload: Payload = {};
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('get', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Get functions queue
      *

package/src/services/locale.ts

@@ -2,6 +2,7 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
+import { Query } from '../query';
 
 export class Locale extends Service {