@appwrite.io/console 0.3.0 → 0.4.1

package/types/services/health.d.ts

@@ -13,7 +13,7 @@ export declare class Health extends Service {
     */
     get(): Promise<Models.HealthStatus>;
     /**
-     * Get Antivirus
+     * Get antivirus
      *
      * Check the Appwrite Antivirus server is up and connection is successful.
      *
@@ -22,7 +22,7 @@ export declare class Health extends Service {
     */
     getAntivirus(): Promise<Models.HealthAntivirus>;
     /**
-     * Get Cache
+     * Get cache
      *
      * Check the Appwrite in-memory cache servers are up and connection is
      * successful.
@@ -41,7 +41,7 @@ export declare class Health extends Service {
     */
     getDB(): Promise<Models.HealthStatus>;
     /**
-     * Get PubSub
+     * Get pubsub
      *
      * Check the Appwrite pub-sub servers are up and connection is successful.
      *
@@ -50,7 +50,7 @@ export declare class Health extends Service {
     */
     getPubSub(): Promise<Models.HealthStatus>;
     /**
-     * Get Queue
+     * Get queue
      *
      * Check the Appwrite queue messaging servers are up and connection is
      * successful.
@@ -60,46 +60,117 @@ export declare class Health extends Service {
     */
     getQueue(): Promise<Models.HealthStatus>;
     /**
-     * Get Certificates Queue
+     * Get builds queue
+     *
+     * Get the number of builds that are waiting to be processed in the Appwrite
+     * internal queue server.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getQueueBuilds(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get certificates queue
      *
      * Get the number of certificates that are waiting to be issued against
      * [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue
      * server.
      *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getQueueCertificates(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get databases queue
+     *
+     * Get the number of database changes that are waiting to be processed in the
+     * Appwrite internal queue server.
+     *
+     * @param {string} name
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getQueueDatabases(name?: string, threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get deletes queue
+     *
+     * Get the number of background destructive changes that are waiting to be
+     * processed in the Appwrite internal queue server.
+     *
+     * @param {number} threshold
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getQueueCertificates(): Promise<Models.HealthQueue>;
+    getQueueDeletes(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get Functions Queue
+     * Get functions queue
      *
      *
+     * @param {number} threshold
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getQueueFunctions(): Promise<Models.HealthQueue>;
+    getQueueFunctions(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get Logs Queue
+     * Get logs queue
      *
      * Get the number of logs that are waiting to be processed in the Appwrite
      * internal queue server.
      *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getQueueLogs(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get mails queue
+     *
+     * Get the number of mails that are waiting to be processed in the Appwrite
+     * internal queue server.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getQueueMails(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get messaging queue
+     *
+     * Get the number of messages that are waiting to be processed in the Appwrite
+     * internal queue server.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getQueueMessaging(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get migrations queue
+     *
+     * Get the number of migrations that are waiting to be processed in the
+     * Appwrite internal queue server.
+     *
+     * @param {number} threshold
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getQueueLogs(): Promise<Models.HealthQueue>;
+    getQueueMigrations(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get Webhooks Queue
+     * Get webhooks queue
      *
      * Get the number of webhooks that are waiting to be processed in the Appwrite
      * internal queue server.
      *
+     * @param {number} threshold
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getQueueWebhooks(): Promise<Models.HealthQueue>;
+    getQueueWebhooks(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get Local Storage
+     * Get local storage
      *
      * Check the Appwrite local storage device is up and connection is successful.
      *
@@ -108,7 +179,7 @@ export declare class Health extends Service {
     */
     getStorageLocal(): Promise<Models.HealthStatus>;
     /**
-     * Get Time
+     * Get time
      *
      * Check the Appwrite server time is synced with Google remote NTP server. We
      * use this technology to smoothly handle leap seconds with no disruptive

package/types/services/locale.d.ts

@@ -4,7 +4,7 @@ import type { Models } from '../models';
 export declare class Locale extends Service {
     constructor(client: Client);
     /**
-     * Get User Locale
+     * Get user locale
      *
      * Get the current user location based on IP. Returns an object with user
      * country code, country name, continent name, continent code, ip address and
@@ -28,7 +28,7 @@ export declare class Locale extends Service {
     */
     listCodes(): Promise<Models.LocaleCodeList>;
     /**
-     * List Continents
+     * List continents
      *
      * List of all continents. You can use the locale header to get the data in a
      * supported language.
@@ -38,7 +38,7 @@ export declare class Locale extends Service {
     */
     listContinents(): Promise<Models.ContinentList>;
     /**
-     * List Countries
+     * List countries
      *
      * List of all countries. You can use the locale header to get the data in a
      * supported language.
@@ -48,7 +48,7 @@ export declare class Locale extends Service {
     */
     listCountries(): Promise<Models.CountryList>;
     /**
-     * List EU Countries
+     * List EU countries
      *
      * List of all countries that are currently members of the EU. You can use the
      * locale header to get the data in a supported language.
@@ -58,7 +58,7 @@ export declare class Locale extends Service {
     */
     listCountriesEU(): Promise<Models.CountryList>;
     /**
-     * List Countries Phone Codes
+     * List countries phone codes
      *
      * List of all countries phone codes. You can use the locale header to get the
      * data in a supported language.
@@ -68,7 +68,7 @@ export declare class Locale extends Service {
     */
     listCountriesPhones(): Promise<Models.PhoneList>;
     /**
-     * List Currencies
+     * List currencies
      *
      * List of all currencies, including currency symbol, name, plural, and
      * decimal digits for all major and minor currencies. You can use the locale
@@ -79,7 +79,7 @@ export declare class Locale extends Service {
     */
     listCurrencies(): Promise<Models.CurrencyList>;
     /**
-     * List Languages
+     * List languages
      *
      * List of all languages classified by ISO 639-1 including 2-letter code, name
      * in English, and name in the respective language.

package/types/services/project.d.ts

@@ -7,11 +7,13 @@ export declare class Project extends Service {
      * Get usage stats for a project
      *
      *
-     * @param {string} range
+     * @param {string} startDate
+     * @param {string} endDate
+     * @param {string} period
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getUsage(range?: string): Promise<Models.UsageProject>;
+    getUsage(startDate: string, endDate: string, period?: string): Promise<Models.UsageProject>;
     /**
      * List Variables
      *

package/types/services/projects.d.ts

@@ -4,7 +4,7 @@ import type { Models } from '../models';
 export declare class Projects extends Service {
     constructor(client: Client);
     /**
-     * List Projects
+     * List projects
      *
      *
      * @param {string[]} queries
@@ -14,7 +14,7 @@ export declare class Projects extends Service {
     */
     list(queries?: string[], search?: string): Promise<Models.ProjectList>;
     /**
-     * Create Project
+     * Create project
      *
      *
      * @param {string} projectId
@@ -35,7 +35,7 @@ export declare class Projects extends Service {
     */
     create(projectId: string, name: string, teamId: string, region?: string, description?: string, logo?: string, url?: string, legalName?: string, legalCountry?: string, legalState?: string, legalCity?: string, legalAddress?: string, legalTaxId?: string): Promise<Models.Project>;
     /**
-     * Get Project
+     * Get project
      *
      *
      * @param {string} projectId
@@ -44,7 +44,7 @@ export declare class Projects extends Service {
     */
     get(projectId: string): Promise<Models.Project>;
     /**
-     * Update Project
+     * Update project
      *
      *
      * @param {string} projectId
@@ -63,7 +63,7 @@ export declare class Projects extends Service {
     */
     update(projectId: string, name: string, description?: string, logo?: string, url?: string, legalName?: string, legalCountry?: string, legalState?: string, legalCity?: string, legalAddress?: string, legalTaxId?: string): Promise<Models.Project>;
     /**
-     * Delete Project
+     * Delete project
      *
      *
      * @param {string} projectId
@@ -72,7 +72,7 @@ export declare class Projects extends Service {
     */
     delete(projectId: string): Promise<{}>;
     /**
-     * Update Project Authentication Duration
+     * Update project authentication duration
      *
      *
      * @param {string} projectId
@@ -82,7 +82,7 @@ export declare class Projects extends Service {
     */
     updateAuthDuration(projectId: string, duration: number): Promise<Models.Project>;
     /**
-     * Update Project users limit
+     * Update project users limit
      *
      *
      * @param {string} projectId
@@ -92,7 +92,7 @@ export declare class Projects extends Service {
     */
     updateAuthLimit(projectId: string, limit: number): Promise<Models.Project>;
     /**
-     * Update Project user sessions limit
+     * Update project user sessions limit
      *
      *
      * @param {string} projectId
@@ -132,7 +132,7 @@ export declare class Projects extends Service {
     */
     updatePersonalDataCheck(projectId: string, enabled: boolean): Promise<Models.Project>;
     /**
-     * Update Project auth method status. Use this endpoint to enable or disable a given auth method for this project.
+     * Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.
      *
      *
      * @param {string} projectId
@@ -143,7 +143,7 @@ export declare class Projects extends Service {
     */
     updateAuthStatus(projectId: string, method: string, status: boolean): Promise<Models.Project>;
     /**
-     * List Keys
+     * List keys
      *
      *
      * @param {string} projectId
@@ -152,7 +152,7 @@ export declare class Projects extends Service {
     */
     listKeys(projectId: string): Promise<Models.KeyList>;
     /**
-     * Create Key
+     * Create key
      *
      *
      * @param {string} projectId
@@ -164,7 +164,7 @@ export declare class Projects extends Service {
     */
     createKey(projectId: string, name: string, scopes: string[], expire?: string): Promise<Models.Key>;
     /**
-     * Get Key
+     * Get key
      *
      *
      * @param {string} projectId
@@ -174,7 +174,7 @@ export declare class Projects extends Service {
     */
     getKey(projectId: string, keyId: string): Promise<Models.Key>;
     /**
-     * Update Key
+     * Update key
      *
      *
      * @param {string} projectId
@@ -187,7 +187,7 @@ export declare class Projects extends Service {
     */
     updateKey(projectId: string, keyId: string, name: string, scopes: string[], expire?: string): Promise<Models.Key>;
     /**
-     * Delete Key
+     * Delete key
      *
      *
      * @param {string} projectId
@@ -197,7 +197,7 @@ export declare class Projects extends Service {
     */
     deleteKey(projectId: string, keyId: string): Promise<{}>;
     /**
-     * Update Project OAuth2
+     * Update project OAuth2
      *
      *
      * @param {string} projectId
@@ -210,7 +210,7 @@ export declare class Projects extends Service {
     */
     updateOAuth2(projectId: string, provider: string, appId?: string, secret?: string, enabled?: boolean): Promise<Models.Project>;
     /**
-     * List Platforms
+     * List platforms
      *
      *
      * @param {string} projectId
@@ -219,7 +219,7 @@ export declare class Projects extends Service {
     */
     listPlatforms(projectId: string): Promise<Models.PlatformList>;
     /**
-     * Create Platform
+     * Create platform
      *
      *
      * @param {string} projectId
@@ -233,7 +233,7 @@ export declare class Projects extends Service {
     */
     createPlatform(projectId: string, type: string, name: string, key?: string, store?: string, hostname?: string): Promise<Models.Platform>;
     /**
-     * Get Platform
+     * Get platform
      *
      *
      * @param {string} projectId
@@ -243,7 +243,7 @@ export declare class Projects extends Service {
     */
     getPlatform(projectId: string, platformId: string): Promise<Models.Platform>;
     /**
-     * Update Platform
+     * Update platform
      *
      *
      * @param {string} projectId
@@ -257,7 +257,7 @@ export declare class Projects extends Service {
     */
     updatePlatform(projectId: string, platformId: string, name: string, key?: string, store?: string, hostname?: string): Promise<Models.Platform>;
     /**
-     * Delete Platform
+     * Delete platform
      *
      *
      * @param {string} projectId
@@ -388,17 +388,7 @@ export declare class Projects extends Service {
     */
     deleteSmsTemplate(projectId: string, type: string, locale: string): Promise<Models.SmsTemplate>;
     /**
-     * Get usage stats for a project
-     *
-     *
-     * @param {string} projectId
-     * @param {string} range
-     * @throws {AppwriteException}
-     * @returns {Promise}
-    */
-    getUsage(projectId: string, range?: string): Promise<Models.UsageProject>;
-    /**
-     * List Webhooks
+     * List webhooks
      *
      *
      * @param {string} projectId
@@ -407,7 +397,7 @@ export declare class Projects extends Service {
     */
     listWebhooks(projectId: string): Promise<Models.WebhookList>;
     /**
-     * Create Webhook
+     * Create webhook
      *
      *
      * @param {string} projectId
@@ -422,7 +412,7 @@ export declare class Projects extends Service {
     */
     createWebhook(projectId: string, name: string, events: string[], url: string, security: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
     /**
-     * Get Webhook
+     * Get webhook
      *
      *
      * @param {string} projectId
@@ -432,7 +422,7 @@ export declare class Projects extends Service {
     */
     getWebhook(projectId: string, webhookId: string): Promise<Models.Webhook>;
     /**
-     * Update Webhook
+     * Update webhook
      *
      *
      * @param {string} projectId
@@ -448,7 +438,7 @@ export declare class Projects extends Service {
     */
     updateWebhook(projectId: string, webhookId: string, name: string, events: string[], url: string, security: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
     /**
-     * Delete Webhook
+     * Delete webhook
      *
      *
      * @param {string} projectId
@@ -458,7 +448,7 @@ export declare class Projects extends Service {
     */
     deleteWebhook(projectId: string, webhookId: string): Promise<{}>;
     /**
-     * Update Webhook Signature Key
+     * Update webhook signature key
      *
      *
      * @param {string} projectId

package/types/services/storage.d.ts

@@ -36,7 +36,7 @@ export declare class Storage extends Service {
     */
     createBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: string, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket>;
     /**
-     * Get Bucket
+     * Get bucket
      *
      * Get a storage bucket by its unique ID. This endpoint response returns a
      * JSON object with the storage bucket metadata.
@@ -47,7 +47,7 @@ export declare class Storage extends Service {
     */
     getBucket(bucketId: string): Promise<Models.Bucket>;
     /**
-     * Update Bucket
+     * Update bucket
      *
      * Update a storage bucket by its unique ID.
      *
@@ -66,7 +66,7 @@ export declare class Storage extends Service {
     */
     updateBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: string, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket>;
     /**
-     * Delete Bucket
+     * Delete bucket
      *
      * Delete a storage bucket by its unique ID.
      *
@@ -76,7 +76,7 @@ export declare class Storage extends Service {
     */
     deleteBucket(bucketId: string): Promise<{}>;
     /**
-     * List Files
+     * List files
      *
      * Get a list of all the user files. You can use the query params to filter
      * your results.
@@ -89,12 +89,12 @@ export declare class Storage extends Service {
     */
     listFiles(bucketId: string, queries?: string[], search?: string): Promise<Models.FileList>;
     /**
-     * Create File
+     * Create file
      *
      * Create a new file. Before using this route, you should create a new bucket
      * resource using either a [server
-     * integration](/docs/server/storage#storageCreateBucket) API or directly from
-     * your Appwrite console.
+     * integration](https://appwrite.io/docs/server/storage#storageCreateBucket)
+     * API or directly from your Appwrite console.
      *
      * Larger files should be uploaded using multiple requests with the
      * [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range)
@@ -119,7 +119,7 @@ export declare class Storage extends Service {
     */
     createFile(bucketId: string, fileId: string, file: File, permissions?: string[], onProgress?: (progress: UploadProgress) => void): Promise<Models.File>;
     /**
-     * Get File
+     * Get file
      *
      * Get a file by its unique ID. This endpoint response returns a JSON object
      * with the file metadata.
@@ -131,7 +131,7 @@ export declare class Storage extends Service {
     */
     getFile(bucketId: string, fileId: string): Promise<Models.File>;
     /**
-     * Update File
+     * Update file
      *
      * Update a file by its unique ID. Only users with write permissions have
      * access to update this resource.
@@ -157,7 +157,7 @@ export declare class Storage extends Service {
     */
     deleteFile(bucketId: string, fileId: string): Promise<{}>;
     /**
-     * Get File for Download
+     * Get file for download
      *
      * Get a file content by its unique ID. The endpoint response return with a
      * 'Content-Disposition: attachment' header that tells the browser to start
@@ -170,7 +170,7 @@ export declare class Storage extends Service {
     */
     getFileDownload(bucketId: string, fileId: string): URL;
     /**
-     * Get File Preview
+     * Get file preview
      *
      * Get a file preview image. Currently, this method supports preview for image
      * files (jpg, png, and gif), other supported formats, like pdf, docs, slides,
@@ -196,7 +196,7 @@ export declare class Storage extends Service {
     */
     getFilePreview(bucketId: string, fileId: string, width?: number, height?: number, gravity?: string, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: string): URL;
     /**
-     * Get File for View
+     * Get file for view
      *
      * Get a file content by its unique ID. This endpoint is similar to the
      * download method but returns with no  'Content-Disposition: attachment'
@@ -218,7 +218,7 @@ export declare class Storage extends Service {
     */
     getUsage(range?: string): Promise<Models.UsageStorage>;
     /**
-     * Get usage stats for a storage bucket
+     * Get usage stats for storage bucket
      *
      *
      * @param {string} bucketId