@appwrite.io/console 0.2.0 → 0.3.0

package/types/services/project.d.ts

@@ -10,6 +10,61 @@ export declare class Project extends Service {
      * @param {string} range
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getUsage(range?: string): Promise<Models.UsageProject>;
+    /**
+     * List Variables
+     *
+     * Get a list of all project variables. These variables will be accessible in
+     * all Appwrite Functions at runtime.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listVariables(): Promise<Models.VariableList>;
+    /**
+     * Create Variable
+     *
+     * Create a new project variable. This variable will be accessible in all
+     * Appwrite Functions at runtime.
+     *
+     * @param {string} key
+     * @param {string} value
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createVariable(key: string, value: string): Promise<Models.Variable>;
+    /**
+     * Get Variable
+     *
+     * Get a project variable by its unique ID.
+     *
+     * @param {string} variableId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getVariable(variableId: string): Promise<Models.Variable>;
+    /**
+     * Update Variable
+     *
+     * Update project variable by its unique ID. This variable will be accessible
+     * in all Appwrite Functions at runtime.
+     *
+     * @param {string} variableId
+     * @param {string} key
+     * @param {string} value
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateVariable(variableId: string, key: string, value?: string): Promise<Models.Variable>;
+    /**
+     * Delete Variable
+     *
+     * Delete a project variable by its unique ID.
+     *
+     * @param {string} variableId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    deleteVariable(variableId: string): Promise<{}>;
 }

package/types/services/projects.d.ts

@@ -11,7 +11,7 @@ export declare class Projects extends Service {
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     list(queries?: string[], search?: string): Promise<Models.ProjectList>;
     /**
      * Create Project
@@ -32,7 +32,7 @@ export declare class Projects extends Service {
      * @param {string} legalTaxId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     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
@@ -41,7 +41,7 @@ export declare class Projects extends Service {
      * @param {string} projectId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     get(projectId: string): Promise<Models.Project>;
     /**
      * Update Project
@@ -60,18 +60,17 @@ export declare class Projects extends Service {
      * @param {string} legalTaxId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     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
      *
      *
      * @param {string} projectId
-     * @param {string} password
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    delete(projectId: string, password: string): Promise<{}>;
+    */
+    delete(projectId: string): Promise<{}>;
     /**
      * Update Project Authentication Duration
      *
@@ -80,7 +79,7 @@ export declare class Projects extends Service {
      * @param {number} duration
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateAuthDuration(projectId: string, duration: number): Promise<Models.Project>;
     /**
      * Update Project users limit
@@ -90,7 +89,7 @@ export declare class Projects extends Service {
      * @param {number} limit
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateAuthLimit(projectId: string, limit: number): Promise<Models.Project>;
     /**
      * Update Project user sessions limit
@@ -100,17 +99,17 @@ export declare class Projects extends Service {
      * @param {number} limit
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateAuthSessionsLimit(projectId: string, limit: number): Promise<Models.Project>;
     /**
-     * Update authentication password disctionary status. Use this endpoint to enable or disable the dicitonary check for user password
+     * Update authentication password dictionary status. Use this endpoint to enable or disable the dicitonary check for user password
      *
      *
      * @param {string} projectId
      * @param {boolean} enabled
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateAuthPasswordDictionary(projectId: string, enabled: boolean): Promise<Models.Project>;
     /**
      * Update authentication password history. Use this endpoint to set the number of password history to save and 0 to disable password history.
@@ -120,68 +119,29 @@ export declare class Projects extends Service {
      * @param {number} limit
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateAuthPasswordHistory(projectId: string, limit: number): Promise<Models.Project>;
     /**
-     * Update Project auth method status. Use this endpoint to enable or disable a given auth method for this project.
-     *
-     *
-     * @param {string} projectId
-     * @param {string} method
-     * @param {boolean} status
-     * @throws {AppwriteException}
-     * @returns {Promise}
-     */
-    updateAuthStatus(projectId: string, method: string, status: boolean): Promise<Models.Project>;
-    /**
-     * List Domains
-     *
-     *
-     * @param {string} projectId
-     * @throws {AppwriteException}
-     * @returns {Promise}
-     */
-    listDomains(projectId: string): Promise<Models.DomainList>;
-    /**
-     * Create Domain
-     *
-     *
-     * @param {string} projectId
-     * @param {string} domain
-     * @throws {AppwriteException}
-     * @returns {Promise}
-     */
-    createDomain(projectId: string, domain: string): Promise<Models.Domain>;
-    /**
-     * Get Domain
-     *
-     *
-     * @param {string} projectId
-     * @param {string} domainId
-     * @throws {AppwriteException}
-     * @returns {Promise}
-     */
-    getDomain(projectId: string, domainId: string): Promise<Models.Domain>;
-    /**
-     * Delete Domain
+     * Enable or disable checking user passwords for similarity with their personal data.
      *
      *
      * @param {string} projectId
-     * @param {string} domainId
+     * @param {boolean} enabled
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    deleteDomain(projectId: string, domainId: string): Promise<{}>;
+    */
+    updatePersonalDataCheck(projectId: string, enabled: boolean): Promise<Models.Project>;
     /**
-     * Update Domain Verification Status
+     * Update Project auth method status. Use this endpoint to enable or disable a given auth method for this project.
      *
      *
      * @param {string} projectId
-     * @param {string} domainId
+     * @param {string} method
+     * @param {boolean} status
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    updateDomainVerification(projectId: string, domainId: string): Promise<Models.Domain>;
+    */
+    updateAuthStatus(projectId: string, method: string, status: boolean): Promise<Models.Project>;
     /**
      * List Keys
      *
@@ -189,7 +149,7 @@ export declare class Projects extends Service {
      * @param {string} projectId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listKeys(projectId: string): Promise<Models.KeyList>;
     /**
      * Create Key
@@ -201,7 +161,7 @@ export declare class Projects extends Service {
      * @param {string} expire
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createKey(projectId: string, name: string, scopes: string[], expire?: string): Promise<Models.Key>;
     /**
      * Get Key
@@ -211,7 +171,7 @@ export declare class Projects extends Service {
      * @param {string} keyId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getKey(projectId: string, keyId: string): Promise<Models.Key>;
     /**
      * Update Key
@@ -224,7 +184,7 @@ export declare class Projects extends Service {
      * @param {string} expire
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateKey(projectId: string, keyId: string, name: string, scopes: string[], expire?: string): Promise<Models.Key>;
     /**
      * Delete Key
@@ -234,7 +194,7 @@ export declare class Projects extends Service {
      * @param {string} keyId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     deleteKey(projectId: string, keyId: string): Promise<{}>;
     /**
      * Update Project OAuth2
@@ -247,7 +207,7 @@ export declare class Projects extends Service {
      * @param {boolean} enabled
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateOAuth2(projectId: string, provider: string, appId?: string, secret?: string, enabled?: boolean): Promise<Models.Project>;
     /**
      * List Platforms
@@ -256,7 +216,7 @@ export declare class Projects extends Service {
      * @param {string} projectId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listPlatforms(projectId: string): Promise<Models.PlatformList>;
     /**
      * Create Platform
@@ -270,7 +230,7 @@ export declare class Projects extends Service {
      * @param {string} hostname
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createPlatform(projectId: string, type: string, name: string, key?: string, store?: string, hostname?: string): Promise<Models.Platform>;
     /**
      * Get Platform
@@ -280,7 +240,7 @@ export declare class Projects extends Service {
      * @param {string} platformId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getPlatform(projectId: string, platformId: string): Promise<Models.Platform>;
     /**
      * Update Platform
@@ -294,7 +254,7 @@ export declare class Projects extends Service {
      * @param {string} hostname
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updatePlatform(projectId: string, platformId: string, name: string, key?: string, store?: string, hostname?: string): Promise<Models.Platform>;
     /**
      * Delete Platform
@@ -304,7 +264,7 @@ export declare class Projects extends Service {
      * @param {string} platformId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     deletePlatform(projectId: string, platformId: string): Promise<{}>;
     /**
      * Update service status
@@ -315,8 +275,128 @@ export declare class Projects extends Service {
      * @param {boolean} status
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateServiceStatus(projectId: string, service: string, status: boolean): Promise<Models.Project>;
+    /**
+     * Update all service status
+     *
+     *
+     * @param {string} projectId
+     * @param {boolean} status
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateServiceStatusAll(projectId: string, status: boolean): Promise<Models.Project>;
+    /**
+     * Update SMTP configuration
+     *
+     *
+     * @param {string} projectId
+     * @param {boolean} enabled
+     * @param {string} senderName
+     * @param {string} senderEmail
+     * @param {string} replyTo
+     * @param {string} host
+     * @param {number} port
+     * @param {string} username
+     * @param {string} password
+     * @param {string} secure
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateSmtpConfiguration(projectId: string, enabled: boolean, senderName?: string, senderEmail?: string, replyTo?: string, host?: string, port?: number, username?: string, password?: string, secure?: string): Promise<Models.Project>;
+    /**
+     * Update Project Team
+     *
+     *
+     * @param {string} projectId
+     * @param {string} teamId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateTeam(projectId: string, teamId: string): Promise<Models.Project>;
+    /**
+     * Get custom email template
+     *
+     *
+     * @param {string} projectId
+     * @param {string} type
+     * @param {string} locale
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getEmailTemplate(projectId: string, type: string, locale: string): Promise<Models.EmailTemplate>;
+    /**
+     * Update custom email templates
+     *
+     *
+     * @param {string} projectId
+     * @param {string} type
+     * @param {string} locale
+     * @param {string} subject
+     * @param {string} message
+     * @param {string} senderName
+     * @param {string} senderEmail
+     * @param {string} replyTo
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateEmailTemplate(projectId: string, type: string, locale: string, subject: string, message: string, senderName?: string, senderEmail?: string, replyTo?: string): Promise<Models.Project>;
+    /**
+     * Reset custom email template
+     *
+     *
+     * @param {string} projectId
+     * @param {string} type
+     * @param {string} locale
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    deleteEmailTemplate(projectId: string, type: string, locale: string): Promise<Models.EmailTemplate>;
+    /**
+     * Get custom SMS template
+     *
+     *
+     * @param {string} projectId
+     * @param {string} type
+     * @param {string} locale
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getSmsTemplate(projectId: string, type: string, locale: string): Promise<Models.SmsTemplate>;
+    /**
+     * Update custom SMS template
+     *
+     *
+     * @param {string} projectId
+     * @param {string} type
+     * @param {string} locale
+     * @param {string} message
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateSmsTemplate(projectId: string, type: string, locale: string, message: string): Promise<Models.SmsTemplate>;
+    /**
+     * Reset custom SMS template
+     *
+     *
+     * @param {string} projectId
+     * @param {string} type
+     * @param {string} locale
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    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
      *
@@ -324,7 +404,7 @@ export declare class Projects extends Service {
      * @param {string} projectId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listWebhooks(projectId: string): Promise<Models.WebhookList>;
     /**
      * Create Webhook
@@ -339,7 +419,7 @@ export declare class Projects extends Service {
      * @param {string} httpPass
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createWebhook(projectId: string, name: string, events: string[], url: string, security: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
     /**
      * Get Webhook
@@ -349,7 +429,7 @@ export declare class Projects extends Service {
      * @param {string} webhookId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getWebhook(projectId: string, webhookId: string): Promise<Models.Webhook>;
     /**
      * Update Webhook
@@ -365,7 +445,7 @@ export declare class Projects extends Service {
      * @param {string} httpPass
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateWebhook(projectId: string, webhookId: string, name: string, events: string[], url: string, security: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
     /**
      * Delete Webhook
@@ -375,7 +455,7 @@ export declare class Projects extends Service {
      * @param {string} webhookId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     deleteWebhook(projectId: string, webhookId: string): Promise<{}>;
     /**
      * Update Webhook Signature Key
@@ -385,6 +465,6 @@ export declare class Projects extends Service {
      * @param {string} webhookId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateWebhookSignature(projectId: string, webhookId: string): Promise<Models.Webhook>;
 }

package/types/services/proxy.d.ts

@@ -0,0 +1,59 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Proxy extends Service {
+    constructor(client: Client);
+    /**
+     * List Rules
+     *
+     * Get a list of all the proxy rules. You can use the query params to filter
+     * your results.
+     *
+     * @param {string[]} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listRules(queries?: string[], search?: string): Promise<Models.ProxyRuleList>;
+    /**
+     * Create Rule
+     *
+     * Create a new proxy rule.
+     *
+     * @param {string} domain
+     * @param {string} resourceType
+     * @param {string} resourceId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createRule(domain: string, resourceType: string, resourceId?: string): Promise<Models.ProxyRule>;
+    /**
+     * Get Rule
+     *
+     * Get a proxy rule by its unique ID.
+     *
+     * @param {string} ruleId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getRule(ruleId: string): Promise<Models.ProxyRule>;
+    /**
+     * Delete Rule
+     *
+     * Delete a proxy rule by its unique ID.
+     *
+     * @param {string} ruleId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    deleteRule(ruleId: string): Promise<{}>;
+    /**
+     * Update Rule Verification Status
+     *
+     *
+     * @param {string} ruleId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateRuleVerification(ruleId: string): Promise<Models.ProxyRule>;
+}

package/types/services/storage.d.ts

@@ -14,7 +14,7 @@ export declare class Storage extends Service {
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listBuckets(queries?: string[], search?: string): Promise<Models.BucketList>;
     /**
      * Create bucket
@@ -33,7 +33,7 @@ export declare class Storage extends Service {
      * @param {boolean} antivirus
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     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
@@ -44,7 +44,7 @@ export declare class Storage extends Service {
      * @param {string} bucketId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getBucket(bucketId: string): Promise<Models.Bucket>;
     /**
      * Update Bucket
@@ -63,7 +63,7 @@ export declare class Storage extends Service {
      * @param {boolean} antivirus
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     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
@@ -73,7 +73,7 @@ export declare class Storage extends Service {
      * @param {string} bucketId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     deleteBucket(bucketId: string): Promise<{}>;
     /**
      * List Files
@@ -86,7 +86,7 @@ export declare class Storage extends Service {
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listFiles(bucketId: string, queries?: string[], search?: string): Promise<Models.FileList>;
     /**
      * Create File
@@ -116,7 +116,7 @@ export declare class Storage extends Service {
      * @param {string[]} permissions
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createFile(bucketId: string, fileId: string, file: File, permissions?: string[], onProgress?: (progress: UploadProgress) => void): Promise<Models.File>;
     /**
      * Get File
@@ -128,7 +128,7 @@ export declare class Storage extends Service {
      * @param {string} fileId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getFile(bucketId: string, fileId: string): Promise<Models.File>;
     /**
      * Update File
@@ -138,11 +138,12 @@ export declare class Storage extends Service {
      *
      * @param {string} bucketId
      * @param {string} fileId
+     * @param {string} name
      * @param {string[]} permissions
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    updateFile(bucketId: string, fileId: string, permissions?: string[]): Promise<Models.File>;
+    */
+    updateFile(bucketId: string, fileId: string, name?: string, permissions?: string[]): Promise<Models.File>;
     /**
      * Delete File
      *
@@ -153,7 +154,7 @@ export declare class Storage extends Service {
      * @param {string} fileId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     deleteFile(bucketId: string, fileId: string): Promise<{}>;
     /**
      * Get File for Download
@@ -166,7 +167,7 @@ export declare class Storage extends Service {
      * @param {string} fileId
      * @throws {AppwriteException}
      * @returns {URL}
-     */
+    */
     getFileDownload(bucketId: string, fileId: string): URL;
     /**
      * Get File Preview
@@ -192,7 +193,7 @@ export declare class Storage extends Service {
      * @param {string} output
      * @throws {AppwriteException}
      * @returns {URL}
-     */
+    */
     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
@@ -205,7 +206,7 @@ export declare class Storage extends Service {
      * @param {string} fileId
      * @throws {AppwriteException}
      * @returns {URL}
-     */
+    */
     getFileView(bucketId: string, fileId: string): URL;
     /**
      * Get usage stats for storage
@@ -214,16 +215,16 @@ export declare class Storage extends Service {
      * @param {string} range
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getUsage(range?: string): Promise<Models.UsageStorage>;
     /**
-     * Get usage stats for storage bucket
+     * Get usage stats for a storage bucket
      *
      *
      * @param {string} bucketId
      * @param {string} range
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getBucketUsage(bucketId: string, range?: string): Promise<Models.UsageBuckets>;
 }